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 | 23232 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: codestar
using AWS.Compat
using AWS.UUIDs
"""
associate_team_member(project_id, project_role, user_arn)
associate_team_member(project_id, project_role, user_arn, params::Dict{String,<:Any})
Adds an IAM user to the team for an AWS CodeStar project.
# Arguments
- `project_id`: The ID of the project to which you will add the IAM user.
- `project_role`: The AWS CodeStar project role that will apply to this user. This role
determines what actions a user can take in an AWS CodeStar project.
- `user_arn`: The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS
CodeStar project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A user- or system-generated token that identifies the entity that
requested the team member association to the project. This token can be used to repeat the
request.
- `"remoteAccessAllowed"`: Whether the team member is allowed to use an SSH public/private
key pair to remotely access project resources, for example Amazon EC2 instances.
"""
function associate_team_member(
projectId, projectRole, userArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"AssociateTeamMember",
Dict{String,Any}(
"projectId" => projectId, "projectRole" => projectRole, "userArn" => userArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_team_member(
projectId,
projectRole,
userArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar(
"AssociateTeamMember",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"projectId" => projectId,
"projectRole" => projectRole,
"userArn" => userArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project(id, name)
create_project(id, name, params::Dict{String,<:Any})
Creates a project, including project resources. This action creates a project based on a
submitted project request. A set of source code files and a toolchain template file can be
included with the project request. If these are not provided, an empty project is created.
# Arguments
- `id`: The ID of the project to be created in AWS CodeStar.
- `name`: The display name for the project to be created in AWS CodeStar.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A user- or system-generated token that identifies the entity that
requested project creation. This token can be used to repeat the request.
- `"description"`: The description of the project, if any.
- `"sourceCode"`: A list of the Code objects submitted with the project request. If this
parameter is specified, the request must also include the toolchain parameter.
- `"tags"`: The tags created for the project.
- `"toolchain"`: The name of the toolchain template file submitted with the project
request. If this parameter is specified, the request must also include the sourceCode
parameter.
"""
function create_project(id, name; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"CreateProject",
Dict{String,Any}("id" => id, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project(
id,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar(
"CreateProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("id" => id, "name" => name), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_profile(display_name, email_address, user_arn)
create_user_profile(display_name, email_address, user_arn, params::Dict{String,<:Any})
Creates a profile for a user that includes user preferences, such as the display name and
email address assocciated with the user, in AWS CodeStar. The user profile is not
project-specific. Information in the user profile is displayed wherever the user's
information appears to other users in AWS CodeStar.
# Arguments
- `display_name`: The name that will be displayed as the friendly name for the user in AWS
CodeStar.
- `email_address`: The email address that will be displayed as part of the user's profile
in AWS CodeStar.
- `user_arn`: The Amazon Resource Name (ARN) of the user in IAM.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"sshPublicKey"`: The SSH public key associated with the user in AWS CodeStar. If a
project owner allows the user remote access to project resources, this public key will be
used along with the user's private key for SSH access.
"""
function create_user_profile(
displayName, emailAddress, userArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"CreateUserProfile",
Dict{String,Any}(
"displayName" => displayName,
"emailAddress" => emailAddress,
"userArn" => userArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_profile(
displayName,
emailAddress,
userArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar(
"CreateUserProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"displayName" => displayName,
"emailAddress" => emailAddress,
"userArn" => userArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project(id)
delete_project(id, params::Dict{String,<:Any})
Deletes a project, including project resources. Does not delete users associated with the
project, but does delete the IAM roles that allowed access to the project.
# Arguments
- `id`: The ID of the project to be deleted in AWS CodeStar.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A user- or system-generated token that identifies the entity that
requested project deletion. This token can be used to repeat the request.
- `"deleteStack"`: Whether to send a delete request for the primary stack in AWS
CloudFormation originally used to generate the project and its resources. This option will
delete all AWS resources for the project (except for any buckets in Amazon S3) as well as
deleting the project itself. Recommended for most use cases.
"""
function delete_project(id; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"DeleteProject",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"DeleteProject",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_profile(user_arn)
delete_user_profile(user_arn, params::Dict{String,<:Any})
Deletes a user profile in AWS CodeStar, including all personal preference data associated
with that profile, such as display name and email address. It does not delete the history
of that user, for example the history of commits made by that user.
# Arguments
- `user_arn`: The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.
"""
function delete_user_profile(userArn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"DeleteUserProfile",
Dict{String,Any}("userArn" => userArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_profile(
userArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"DeleteUserProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("userArn" => userArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_project(id)
describe_project(id, params::Dict{String,<:Any})
Describes a project and its resources.
# Arguments
- `id`: The ID of the project.
"""
function describe_project(id; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"DescribeProject",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_project(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"DescribeProject",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user_profile(user_arn)
describe_user_profile(user_arn, params::Dict{String,<:Any})
Describes a user in AWS CodeStar and the user attributes across all projects.
# Arguments
- `user_arn`: The Amazon Resource Name (ARN) of the user.
"""
function describe_user_profile(userArn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"DescribeUserProfile",
Dict{String,Any}("userArn" => userArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user_profile(
userArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"DescribeUserProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("userArn" => userArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_team_member(project_id, user_arn)
disassociate_team_member(project_id, user_arn, params::Dict{String,<:Any})
Removes a user from a project. Removing a user from a project also removes the IAM policies
from that user that allowed access to the project and its resources. Disassociating a team
member does not remove that user's profile from AWS CodeStar. It does not remove the user
from IAM.
# Arguments
- `project_id`: The ID of the AWS CodeStar project from which you want to remove a team
member.
- `user_arn`: The Amazon Resource Name (ARN) of the IAM user or group whom you want to
remove from the project.
"""
function disassociate_team_member(
projectId, userArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"DisassociateTeamMember",
Dict{String,Any}("projectId" => projectId, "userArn" => userArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_team_member(
projectId,
userArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar(
"DisassociateTeamMember",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("projectId" => projectId, "userArn" => userArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_projects()
list_projects(params::Dict{String,<:Any})
Lists all projects in AWS CodeStar associated with your AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum amount of data that can be contained in a single set of
results.
- `"nextToken"`: The continuation token to be used to return the next set of results, if
the results cannot be returned in one response.
"""
function list_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return codestar("ListProjects"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_projects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"ListProjects", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_resources(project_id)
list_resources(project_id, params::Dict{String,<:Any})
Lists resources associated with a project in AWS CodeStar.
# 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 amount of data that can be contained in a single set of
results.
- `"nextToken"`: The continuation token for the next set of results, if the results cannot
be returned in one response.
"""
function list_resources(projectId; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"ListResources",
Dict{String,Any}("projectId" => projectId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resources(
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar(
"ListResources",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("projectId" => projectId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_project(id)
list_tags_for_project(id, params::Dict{String,<:Any})
Gets the tags for a project.
# Arguments
- `id`: The ID of the project to get tags for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Reserved for future use.
- `"nextToken"`: Reserved for future use.
"""
function list_tags_for_project(id; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"ListTagsForProject",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_project(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"ListTagsForProject",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_team_members(project_id)
list_team_members(project_id, params::Dict{String,<:Any})
Lists all team members associated with a project.
# Arguments
- `project_id`: The ID of the project for which you want to list team members.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of team members you want returned in a response.
- `"nextToken"`: The continuation token for the next set of results, if the results cannot
be returned in one response.
"""
function list_team_members(projectId; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"ListTeamMembers",
Dict{String,Any}("projectId" => projectId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_team_members(
projectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar(
"ListTeamMembers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("projectId" => projectId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_user_profiles()
list_user_profiles(params::Dict{String,<:Any})
Lists all the user profiles configured for your AWS account in AWS CodeStar.
# 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 response.
- `"nextToken"`: The continuation token for the next set of results, if the results cannot
be returned in one response.
"""
function list_user_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"ListUserProfiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_user_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"ListUserProfiles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
tag_project(id, tags)
tag_project(id, tags, params::Dict{String,<:Any})
Adds tags to a project.
# Arguments
- `id`: The ID of the project you want to add a tag to.
- `tags`: The tags you want to add to the project.
"""
function tag_project(id, tags; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"TagProject",
Dict{String,Any}("id" => id, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_project(
id,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar(
"TagProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("id" => id, "tags" => tags), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_project(id, tags)
untag_project(id, tags, params::Dict{String,<:Any})
Removes tags from a project.
# Arguments
- `id`: The ID of the project to remove tags from.
- `tags`: The tags to remove from the project.
"""
function untag_project(id, tags; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"UntagProject",
Dict{String,Any}("id" => id, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_project(
id,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar(
"UntagProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("id" => id, "tags" => tags), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_project(id)
update_project(id, params::Dict{String,<:Any})
Updates a project in AWS CodeStar.
# Arguments
- `id`: The ID of the project you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the project, if any.
- `"name"`: The name of the project you want to update.
"""
function update_project(id; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"UpdateProject",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_project(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"UpdateProject",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_team_member(project_id, user_arn)
update_team_member(project_id, user_arn, params::Dict{String,<:Any})
Updates a team member's attributes in an AWS CodeStar project. For example, you can change
a team member's role in the project, or change whether they have remote access to project
resources.
# Arguments
- `project_id`: The ID of the project.
- `user_arn`: The Amazon Resource Name (ARN) of the user for whom you want to change team
membership attributes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"projectRole"`: The role assigned to the user in the project. Project roles have
different levels of access. For more information, see Working with Teams in the AWS
CodeStar User Guide.
- `"remoteAccessAllowed"`: Whether a team member is allowed to remotely access project
resources using the SSH public key associated with the user's profile. Even if this is set
to True, the user must associate a public key with their profile before the user can access
resources.
"""
function update_team_member(
projectId, userArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"UpdateTeamMember",
Dict{String,Any}("projectId" => projectId, "userArn" => userArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_team_member(
projectId,
userArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar(
"UpdateTeamMember",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("projectId" => projectId, "userArn" => userArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_profile(user_arn)
update_user_profile(user_arn, params::Dict{String,<:Any})
Updates a user's profile in AWS CodeStar. The user profile is not project-specific.
Information in the user profile is displayed wherever the user's information appears to
other users in AWS CodeStar.
# Arguments
- `user_arn`: The name that will be displayed as the friendly name for the user in AWS
CodeStar.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"displayName"`: The name that is displayed as the friendly name for the user in AWS
CodeStar.
- `"emailAddress"`: The email address that is displayed as part of the user's profile in
AWS CodeStar.
- `"sshPublicKey"`: The SSH public key associated with the user in AWS CodeStar. If a
project owner allows the user remote access to project resources, this public key will be
used along with the user's private key for SSH access.
"""
function update_user_profile(userArn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar(
"UpdateUserProfile",
Dict{String,Any}("userArn" => userArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_profile(
userArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar(
"UpdateUserProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("userArn" => userArn), 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 | 38556 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: codestar_connections
using AWS.Compat
using AWS.UUIDs
"""
create_connection(connection_name)
create_connection(connection_name, params::Dict{String,<:Any})
Creates a connection that can then be given to other Amazon Web Services services like
CodePipeline so that it can access third-party code repositories. The connection is in
pending status until the third-party connection handshake is completed from the console.
# Arguments
- `connection_name`: The name of the connection to be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HostArn"`: The Amazon Resource Name (ARN) of the host associated with the connection to
be created.
- `"ProviderType"`: The name of the external provider where your third-party code
repository is configured.
- `"Tags"`: The key-value pair to use when tagging the resource.
"""
function create_connection(
ConnectionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"CreateConnection",
Dict{String,Any}("ConnectionName" => ConnectionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connection(
ConnectionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"CreateConnection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectionName" => ConnectionName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_host(name, provider_endpoint, provider_type)
create_host(name, provider_endpoint, provider_type, params::Dict{String,<:Any})
Creates a resource that represents the infrastructure where a third-party provider is
installed. The host is used when you create connections to an installed third-party
provider type, such as GitHub Enterprise Server. You create one host for all connections to
that provider. A host created through the CLI or the SDK is in `PENDING` status by
default. You can make its status `AVAILABLE` by setting up the host in the console.
# Arguments
- `name`: The name of the host to be created.
- `provider_endpoint`: The endpoint of the infrastructure to be represented by the host
after it is created.
- `provider_type`: The name of the installed provider to be associated with your
connection. The host resource represents the infrastructure where your provider type is
installed. The valid provider type is GitHub Enterprise Server.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Tags for the host to be created.
- `"VpcConfiguration"`: The VPC configuration to be provisioned for the host. A VPC must be
configured and the infrastructure to be represented by the host must already be connected
to the VPC.
"""
function create_host(
Name, ProviderEndpoint, ProviderType; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"CreateHost",
Dict{String,Any}(
"Name" => Name,
"ProviderEndpoint" => ProviderEndpoint,
"ProviderType" => ProviderType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_host(
Name,
ProviderEndpoint,
ProviderType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"CreateHost",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"ProviderEndpoint" => ProviderEndpoint,
"ProviderType" => ProviderType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_repository_link(connection_arn, owner_id, repository_name)
create_repository_link(connection_arn, owner_id, repository_name, params::Dict{String,<:Any})
Creates a link to a specified external Git repository. A repository link allows Git sync to
monitor and sync changes to files in a specified Git repository.
# Arguments
- `connection_arn`: The Amazon Resource Name (ARN) of the connection to be associated with
the repository link.
- `owner_id`: The owner ID for the repository associated with a specific sync
configuration, such as the owner ID in GitHub.
- `repository_name`: The name of the repository to be associated with the repository link.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EncryptionKeyArn"`: The Amazon Resource Name (ARN) encryption key for the repository to
be associated with the repository link.
- `"Tags"`: The tags for the repository to be associated with the repository link.
"""
function create_repository_link(
ConnectionArn,
OwnerId,
RepositoryName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"CreateRepositoryLink",
Dict{String,Any}(
"ConnectionArn" => ConnectionArn,
"OwnerId" => OwnerId,
"RepositoryName" => RepositoryName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_repository_link(
ConnectionArn,
OwnerId,
RepositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"CreateRepositoryLink",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectionArn" => ConnectionArn,
"OwnerId" => OwnerId,
"RepositoryName" => RepositoryName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sync_configuration(branch, config_file, repository_link_id, resource_name, role_arn, sync_type)
create_sync_configuration(branch, config_file, repository_link_id, resource_name, role_arn, sync_type, params::Dict{String,<:Any})
Creates a sync configuration which allows Amazon Web Services to sync content from a Git
repository to update a specified Amazon Web Services resource. Parameters for the sync
configuration are determined by the sync type.
# Arguments
- `branch`: The branch in the repository from which changes will be synced.
- `config_file`: The file name of the configuration file that manages syncing between the
connection and the repository. This configuration file is stored in the repository.
- `repository_link_id`: The ID of the repository link created for the connection. A
repository link allows Git sync to monitor and sync changes to files in a specified Git
repository.
- `resource_name`: The name of the Amazon Web Services resource (for example, a
CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the
linked repository.
- `role_arn`: The ARN of the IAM role that grants permission for Amazon Web Services to use
Git sync to update a given Amazon Web Services resource on your behalf.
- `sync_type`: The type of sync configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PublishDeploymentStatus"`: Whether to enable or disable publishing of deployment status
to source providers.
- `"TriggerResourceUpdateOn"`: When to trigger Git sync to begin the stack update.
"""
function create_sync_configuration(
Branch,
ConfigFile,
RepositoryLinkId,
ResourceName,
RoleArn,
SyncType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"CreateSyncConfiguration",
Dict{String,Any}(
"Branch" => Branch,
"ConfigFile" => ConfigFile,
"RepositoryLinkId" => RepositoryLinkId,
"ResourceName" => ResourceName,
"RoleArn" => RoleArn,
"SyncType" => SyncType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sync_configuration(
Branch,
ConfigFile,
RepositoryLinkId,
ResourceName,
RoleArn,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"CreateSyncConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Branch" => Branch,
"ConfigFile" => ConfigFile,
"RepositoryLinkId" => RepositoryLinkId,
"ResourceName" => ResourceName,
"RoleArn" => RoleArn,
"SyncType" => SyncType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connection(connection_arn)
delete_connection(connection_arn, params::Dict{String,<:Any})
The connection to be deleted.
# Arguments
- `connection_arn`: The Amazon Resource Name (ARN) of the connection to be deleted. The
ARN is never reused if the connection is deleted.
"""
function delete_connection(ConnectionArn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_connections(
"DeleteConnection",
Dict{String,Any}("ConnectionArn" => ConnectionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connection(
ConnectionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"DeleteConnection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectionArn" => ConnectionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_host(host_arn)
delete_host(host_arn, params::Dict{String,<:Any})
The host to be deleted. Before you delete a host, all connections associated to the host
must be deleted. A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or
VPC_CONFIG_DELETING state.
# Arguments
- `host_arn`: The Amazon Resource Name (ARN) of the host to be deleted.
"""
function delete_host(HostArn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_connections(
"DeleteHost",
Dict{String,Any}("HostArn" => HostArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_host(
HostArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"DeleteHost",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HostArn" => HostArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_repository_link(repository_link_id)
delete_repository_link(repository_link_id, params::Dict{String,<:Any})
Deletes the association between your connection and a specified external Git repository.
# Arguments
- `repository_link_id`: The ID of the repository link to be deleted.
"""
function delete_repository_link(
RepositoryLinkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"DeleteRepositoryLink",
Dict{String,Any}("RepositoryLinkId" => RepositoryLinkId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_repository_link(
RepositoryLinkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"DeleteRepositoryLink",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RepositoryLinkId" => RepositoryLinkId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sync_configuration(resource_name, sync_type)
delete_sync_configuration(resource_name, sync_type, params::Dict{String,<:Any})
Deletes the sync configuration for a specified repository and connection.
# Arguments
- `resource_name`: The name of the Amazon Web Services resource associated with the sync
configuration to be deleted.
- `sync_type`: The type of sync configuration to be deleted.
"""
function delete_sync_configuration(
ResourceName, SyncType; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"DeleteSyncConfiguration",
Dict{String,Any}("ResourceName" => ResourceName, "SyncType" => SyncType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sync_configuration(
ResourceName,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"DeleteSyncConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "SyncType" => SyncType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connection(connection_arn)
get_connection(connection_arn, params::Dict{String,<:Any})
Returns the connection ARN and details such as status, owner, and provider type.
# Arguments
- `connection_arn`: The Amazon Resource Name (ARN) of a connection.
"""
function get_connection(ConnectionArn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_connections(
"GetConnection",
Dict{String,Any}("ConnectionArn" => ConnectionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connection(
ConnectionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"GetConnection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectionArn" => ConnectionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_host(host_arn)
get_host(host_arn, params::Dict{String,<:Any})
Returns the host ARN and details such as status, provider type, endpoint, and, if
applicable, the VPC configuration.
# Arguments
- `host_arn`: The Amazon Resource Name (ARN) of the requested host.
"""
function get_host(HostArn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_connections(
"GetHost",
Dict{String,Any}("HostArn" => HostArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_host(
HostArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"GetHost",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HostArn" => HostArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_repository_link(repository_link_id)
get_repository_link(repository_link_id, params::Dict{String,<:Any})
Returns details about a repository link. A repository link allows Git sync to monitor and
sync changes from files in a specified Git repository.
# Arguments
- `repository_link_id`: The ID of the repository link to get.
"""
function get_repository_link(
RepositoryLinkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"GetRepositoryLink",
Dict{String,Any}("RepositoryLinkId" => RepositoryLinkId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_repository_link(
RepositoryLinkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"GetRepositoryLink",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RepositoryLinkId" => RepositoryLinkId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_repository_sync_status(branch, repository_link_id, sync_type)
get_repository_sync_status(branch, repository_link_id, sync_type, params::Dict{String,<:Any})
Returns details about the sync status for a repository. A repository sync uses Git sync to
push and pull changes from your remote repository.
# Arguments
- `branch`: The branch of the repository link for the requested repository sync status.
- `repository_link_id`: The repository link ID for the requested repository sync status.
- `sync_type`: The sync type of the requested sync status.
"""
function get_repository_sync_status(
Branch, RepositoryLinkId, SyncType; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"GetRepositorySyncStatus",
Dict{String,Any}(
"Branch" => Branch,
"RepositoryLinkId" => RepositoryLinkId,
"SyncType" => SyncType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_repository_sync_status(
Branch,
RepositoryLinkId,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"GetRepositorySyncStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Branch" => Branch,
"RepositoryLinkId" => RepositoryLinkId,
"SyncType" => SyncType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_sync_status(resource_name, sync_type)
get_resource_sync_status(resource_name, sync_type, params::Dict{String,<:Any})
Returns the status of the sync with the Git repository for a specific Amazon Web Services
resource.
# Arguments
- `resource_name`: The name of the Amazon Web Services resource for the sync status with
the Git repository.
- `sync_type`: The sync type for the sync status with the Git repository.
"""
function get_resource_sync_status(
ResourceName, SyncType; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"GetResourceSyncStatus",
Dict{String,Any}("ResourceName" => ResourceName, "SyncType" => SyncType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_sync_status(
ResourceName,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"GetResourceSyncStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "SyncType" => SyncType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sync_blocker_summary(resource_name, sync_type)
get_sync_blocker_summary(resource_name, sync_type, params::Dict{String,<:Any})
Returns a list of the most recent sync blockers.
# Arguments
- `resource_name`: The name of the Amazon Web Services resource currently blocked from
automatically being synced from a Git repository.
- `sync_type`: The sync type for the sync blocker summary.
"""
function get_sync_blocker_summary(
ResourceName, SyncType; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"GetSyncBlockerSummary",
Dict{String,Any}("ResourceName" => ResourceName, "SyncType" => SyncType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sync_blocker_summary(
ResourceName,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"GetSyncBlockerSummary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "SyncType" => SyncType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sync_configuration(resource_name, sync_type)
get_sync_configuration(resource_name, sync_type, params::Dict{String,<:Any})
Returns details about a sync configuration, including the sync type and resource name. A
sync configuration allows the configuration to sync (push and pull) changes from the remote
repository for a specified branch in a Git repository.
# Arguments
- `resource_name`: The name of the Amazon Web Services resource for the sync configuration
for which you want to retrieve information.
- `sync_type`: The sync type for the sync configuration for which you want to retrieve
information.
"""
function get_sync_configuration(
ResourceName, SyncType; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"GetSyncConfiguration",
Dict{String,Any}("ResourceName" => ResourceName, "SyncType" => SyncType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sync_configuration(
ResourceName,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"GetSyncConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "SyncType" => SyncType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_connections()
list_connections(params::Dict{String,<:Any})
Lists the connections associated with your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HostArnFilter"`: Filters the list of connections to those associated with a specified
host.
- `"MaxResults"`: The maximum number of results to return in a single call. To retrieve the
remaining results, make another call with the returned nextToken value.
- `"NextToken"`: The token that was returned from the previous ListConnections call, which
can be used to return the next set of connections in the list.
- `"ProviderTypeFilter"`: Filters the list of connections to those associated with a
specified provider, such as Bitbucket.
"""
function list_connections(; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_connections(
"ListConnections"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"ListConnections", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_hosts()
list_hosts(params::Dict{String,<:Any})
Lists the hosts associated with your 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 in a single call. To retrieve the
remaining results, make another call with the returned nextToken value.
- `"NextToken"`: The token that was returned from the previous ListHosts call, which can be
used to return the next set of hosts in the list.
"""
function list_hosts(; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_connections(
"ListHosts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_hosts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"ListHosts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_repository_links()
list_repository_links(params::Dict{String,<:Any})
Lists the repository links created for connections in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: A non-zero, non-negative integer used to limit the number of returned
results.
- `"NextToken"`: An enumeration token that, when provided in a request, returns the next
batch of the results.
"""
function list_repository_links(; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_connections(
"ListRepositoryLinks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_repository_links(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"ListRepositoryLinks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_repository_sync_definitions(repository_link_id, sync_type)
list_repository_sync_definitions(repository_link_id, sync_type, params::Dict{String,<:Any})
Lists the repository sync definitions for repository links in your account.
# Arguments
- `repository_link_id`: The ID of the repository link for the sync definition for which you
want to retrieve information.
- `sync_type`: The sync type of the repository link for the the sync definition for which
you want to retrieve information.
"""
function list_repository_sync_definitions(
RepositoryLinkId, SyncType; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"ListRepositorySyncDefinitions",
Dict{String,Any}("RepositoryLinkId" => RepositoryLinkId, "SyncType" => SyncType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_repository_sync_definitions(
RepositoryLinkId,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"ListRepositorySyncDefinitions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RepositoryLinkId" => RepositoryLinkId, "SyncType" => SyncType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sync_configurations(repository_link_id, sync_type)
list_sync_configurations(repository_link_id, sync_type, params::Dict{String,<:Any})
Returns a list of sync configurations for a specified repository.
# Arguments
- `repository_link_id`: The ID of the repository link for the requested list of sync
configurations.
- `sync_type`: The sync type for the requested list of sync configurations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: A non-zero, non-negative integer used to limit the number of returned
results.
- `"NextToken"`: An enumeration token that allows the operation to batch the results of the
operation.
"""
function list_sync_configurations(
RepositoryLinkId, SyncType; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"ListSyncConfigurations",
Dict{String,Any}("RepositoryLinkId" => RepositoryLinkId, "SyncType" => SyncType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sync_configurations(
RepositoryLinkId,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"ListSyncConfigurations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RepositoryLinkId" => RepositoryLinkId, "SyncType" => SyncType
),
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 set of key-value pairs (metadata) that are used to manage the resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which you want to get
information about tags, if any.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"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 codestar_connections(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("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 to or modifies the tags of the given resource. Tags are metadata that can be used to
manage a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to which you want to add
or update tags.
- `tags`: The tags you want to modify or add to the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_connections(
"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 codestar_connections(
"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 tags from an Amazon Web Services resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to remove tags from.
- `tag_keys`: The list of keys for the tags to be removed from the resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"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 codestar_connections(
"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_host(host_arn)
update_host(host_arn, params::Dict{String,<:Any})
Updates a specified host with the provided configurations.
# Arguments
- `host_arn`: The Amazon Resource Name (ARN) of the host to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ProviderEndpoint"`: The URL or endpoint of the host to be updated.
- `"VpcConfiguration"`: The VPC configuration of the host to be updated. A VPC must be
configured and the infrastructure to be represented by the host must already be connected
to the VPC.
"""
function update_host(HostArn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_connections(
"UpdateHost",
Dict{String,Any}("HostArn" => HostArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_host(
HostArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"UpdateHost",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("HostArn" => HostArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_repository_link(repository_link_id)
update_repository_link(repository_link_id, params::Dict{String,<:Any})
Updates the association between your connection and a specified external Git repository. A
repository link allows Git sync to monitor and sync changes to files in a specified Git
repository.
# Arguments
- `repository_link_id`: The ID of the repository link to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionArn"`: The Amazon Resource Name (ARN) of the connection for the repository
link to be updated. The updated connection ARN must have the same providerType (such as
GitHub) as the original connection ARN for the repo link.
- `"EncryptionKeyArn"`: The Amazon Resource Name (ARN) of the encryption key for the
repository link to be updated.
"""
function update_repository_link(
RepositoryLinkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"UpdateRepositoryLink",
Dict{String,Any}("RepositoryLinkId" => RepositoryLinkId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_repository_link(
RepositoryLinkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"UpdateRepositoryLink",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RepositoryLinkId" => RepositoryLinkId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sync_blocker(id, resolved_reason, resource_name, sync_type)
update_sync_blocker(id, resolved_reason, resource_name, sync_type, params::Dict{String,<:Any})
Allows you to update the status of a sync blocker, resolving the blocker and allowing
syncing to continue.
# Arguments
- `id`: The ID of the sync blocker to be updated.
- `resolved_reason`: The reason for resolving the sync blocker.
- `resource_name`: The name of the resource for the sync blocker to be updated.
- `sync_type`: The sync type of the sync blocker to be updated.
"""
function update_sync_blocker(
Id,
ResolvedReason,
ResourceName,
SyncType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"UpdateSyncBlocker",
Dict{String,Any}(
"Id" => Id,
"ResolvedReason" => ResolvedReason,
"ResourceName" => ResourceName,
"SyncType" => SyncType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sync_blocker(
Id,
ResolvedReason,
ResourceName,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"UpdateSyncBlocker",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Id" => Id,
"ResolvedReason" => ResolvedReason,
"ResourceName" => ResourceName,
"SyncType" => SyncType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sync_configuration(resource_name, sync_type)
update_sync_configuration(resource_name, sync_type, params::Dict{String,<:Any})
Updates the sync configuration for your connection and a specified external Git repository.
# Arguments
- `resource_name`: The name of the Amazon Web Services resource for the sync configuration
to be updated.
- `sync_type`: The sync type for the sync configuration to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Branch"`: The branch for the sync configuration to be updated.
- `"ConfigFile"`: The configuration file for the sync configuration to be updated.
- `"PublishDeploymentStatus"`: Whether to enable or disable publishing of deployment status
to source providers.
- `"RepositoryLinkId"`: The ID of the repository link for the sync configuration to be
updated.
- `"RoleArn"`: The ARN of the IAM role for the sync configuration to be updated.
- `"TriggerResourceUpdateOn"`: When to trigger Git sync to begin the stack update.
"""
function update_sync_configuration(
ResourceName, SyncType; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_connections(
"UpdateSyncConfiguration",
Dict{String,Any}("ResourceName" => ResourceName, "SyncType" => SyncType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sync_configuration(
ResourceName,
SyncType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_connections(
"UpdateSyncConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "SyncType" => SyncType),
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 | 18797 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: codestar_notifications
using AWS.Compat
using AWS.UUIDs
"""
create_notification_rule(detail_type, event_type_ids, name, resource, targets)
create_notification_rule(detail_type, event_type_ids, name, resource, targets, params::Dict{String,<:Any})
Creates a notification rule for a resource. The rule specifies the events you want
notifications about and the targets (such as Chatbot topics or Chatbot clients configured
for Slack) where you want to receive them.
# Arguments
- `detail_type`: The level of detail to include in the notifications for this resource.
BASIC will include only the contents of the event as it would appear in Amazon CloudWatch.
FULL will include any supplemental information provided by AWS CodeStar Notifications
and/or the service for the resource for which the notification is created.
- `event_type_ids`: A list of event types associated with this notification rule. For a
list of allowed events, see EventTypeSummary.
- `name`: The name for the notification rule. Notification rule names must be unique in
your Amazon Web Services account.
- `resource`: The Amazon Resource Name (ARN) of the resource to associate with the
notification rule. Supported resources include pipelines in CodePipeline, repositories in
CodeCommit, and build projects in CodeBuild.
- `targets`: A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service
topics and Chatbot clients to associate with the notification rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique, client-generated idempotency token that, when provided
in a request, ensures the request cannot be repeated with a changed parameter. If a request
with the same parameters is received and a token is included, the request returns
information about the initial request that used that token. The Amazon Web Services SDKs
prepopulate client request tokens. If you are using an Amazon Web Services SDK, an
idempotency token is created for you.
- `"Status"`: The status of the notification rule. The default value is ENABLED. If the
status is set to DISABLED, notifications aren't sent for the notification rule.
- `"Tags"`: A list of tags to apply to this notification rule. Key names cannot start with
\"aws\".
"""
function create_notification_rule(
DetailType,
EventTypeIds,
Name,
Resource,
Targets;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_notifications(
"POST",
"/createNotificationRule",
Dict{String,Any}(
"DetailType" => DetailType,
"EventTypeIds" => EventTypeIds,
"Name" => Name,
"Resource" => Resource,
"Targets" => Targets,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_notification_rule(
DetailType,
EventTypeIds,
Name,
Resource,
Targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_notifications(
"POST",
"/createNotificationRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DetailType" => DetailType,
"EventTypeIds" => EventTypeIds,
"Name" => Name,
"Resource" => Resource,
"Targets" => Targets,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_notification_rule(arn)
delete_notification_rule(arn, params::Dict{String,<:Any})
Deletes a notification rule for a resource.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the notification rule you want to delete.
"""
function delete_notification_rule(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST",
"/deleteNotificationRule",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_notification_rule(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_notifications(
"POST",
"/deleteNotificationRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_target(target_address)
delete_target(target_address, params::Dict{String,<:Any})
Deletes a specified target for notifications.
# Arguments
- `target_address`: The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client
to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceUnsubscribeAll"`: A Boolean value that can be used to delete all associations with
this Chatbot topic. The default value is FALSE. If set to TRUE, all associations between
that target and every notification rule in your Amazon Web Services account are deleted.
"""
function delete_target(TargetAddress; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST",
"/deleteTarget",
Dict{String,Any}("TargetAddress" => TargetAddress);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_target(
TargetAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_notifications(
"POST",
"/deleteTarget",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TargetAddress" => TargetAddress), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_notification_rule(arn)
describe_notification_rule(arn, params::Dict{String,<:Any})
Returns information about a specified notification rule.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the notification rule.
"""
function describe_notification_rule(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST",
"/describeNotificationRule",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_notification_rule(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_notifications(
"POST",
"/describeNotificationRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_event_types()
list_event_types(params::Dict{String,<:Any})
Returns information about the event types available for configuring notifications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The filters to use to return information by service or resource type.
- `"MaxResults"`: A non-negative integer used to limit the number of returned results. The
default number is 50. The maximum number of results that can be returned is 100.
- `"NextToken"`: An enumeration token that, when provided in a request, returns the next
batch of the results.
"""
function list_event_types(; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST", "/listEventTypes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_event_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_notifications(
"POST",
"/listEventTypes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_notification_rules()
list_notification_rules(params::Dict{String,<:Any})
Returns a list of the notification rules for an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The filters to use to return information by service or resource type. For
valid values, see ListNotificationRulesFilter. A filter with the same name can appear more
than once when used with OR statements. Filters with different names should be applied with
AND statements.
- `"MaxResults"`: A non-negative integer used to limit the number of returned results. The
maximum number of results that can be returned is 100.
- `"NextToken"`: An enumeration token that, when provided in a request, returns the next
batch of the results.
"""
function list_notification_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST",
"/listNotificationRules";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_notification_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_notifications(
"POST",
"/listNotificationRules",
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})
Returns a list of the tags associated with a notification rule.
# Arguments
- `arn`: The Amazon Resource Name (ARN) for the notification rule.
"""
function list_tags_for_resource(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST",
"/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 codestar_notifications(
"POST",
"/listTagsForResource",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_targets()
list_targets(params::Dict{String,<:Any})
Returns a list of the notification rule targets for an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The filters to use to return information by service or resource type. Valid
filters include target type, target address, and target status. A filter with the same
name can appear more than once when used with OR statements. Filters with different names
should be applied with AND statements.
- `"MaxResults"`: A non-negative integer used to limit the number of returned results. The
maximum number of results that can be returned is 100.
- `"NextToken"`: An enumeration token that, when provided in a request, returns the next
batch of the results.
"""
function list_targets(; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST", "/listTargets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_targets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_notifications(
"POST",
"/listTargets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
subscribe(arn, target)
subscribe(arn, target, params::Dict{String,<:Any})
Creates an association between a notification rule and an Chatbot topic or Chatbot client
so that the associated target can receive notifications when the events described in the
rule are triggered.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the notification rule for which you want to
create the association.
- `target`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: An enumeration token that, when provided in a request, returns
the next batch of the results.
"""
function subscribe(Arn, Target; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST",
"/subscribe",
Dict{String,Any}("Arn" => Arn, "Target" => Target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function subscribe(
Arn,
Target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_notifications(
"POST",
"/subscribe",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Arn" => Arn, "Target" => Target), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(arn, tags)
tag_resource(arn, tags, params::Dict{String,<:Any})
Associates a set of provided tags with a notification rule.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the notification rule to tag.
- `tags`: The list of tags to associate with the resource. Tag key names cannot start with
\"aws\".
"""
function tag_resource(Arn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST",
"/tagResource",
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 codestar_notifications(
"POST",
"/tagResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Arn" => Arn, "Tags" => Tags), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unsubscribe(arn, target_address)
unsubscribe(arn, target_address, params::Dict{String,<:Any})
Removes an association between a notification rule and an Chatbot topic so that subscribers
to that topic stop receiving notifications when the events described in the rule are
triggered.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the notification rule.
- `target_address`: The ARN of the Chatbot topic to unsubscribe from the notification rule.
"""
function unsubscribe(Arn, TargetAddress; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST",
"/unsubscribe",
Dict{String,Any}("Arn" => Arn, "TargetAddress" => TargetAddress);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unsubscribe(
Arn,
TargetAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codestar_notifications(
"POST",
"/unsubscribe",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Arn" => Arn, "TargetAddress" => TargetAddress),
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 association between one or more provided tags and a notification rule.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the notification rule from which to
remove the tags.
- `tag_keys`: The key names of the tags to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_notifications(
"POST",
"/untagResource/$(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 codestar_notifications(
"POST",
"/untagResource/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_notification_rule(arn)
update_notification_rule(arn, params::Dict{String,<:Any})
Updates a notification rule for a resource. You can change the events that trigger the
notification rule, the status of the rule, and the targets that receive the notifications.
To add or remove tags for a notification rule, you must use TagResource and UntagResource.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the notification rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DetailType"`: The level of detail to include in the notifications for this resource.
BASIC will include only the contents of the event as it would appear in Amazon CloudWatch.
FULL will include any supplemental information provided by AWS CodeStar Notifications
and/or the service for the resource for which the notification is created.
- `"EventTypeIds"`: A list of event types associated with this notification rule. For a
complete list of event types and IDs, see Notification concepts in the Developer Tools
Console User Guide.
- `"Name"`: The name of the notification rule.
- `"Status"`: The status of the notification rule. Valid statuses include enabled (sending
notifications) or disabled (not sending notifications).
- `"Targets"`: The address and type of the targets to receive notifications from this
notification rule.
"""
function update_notification_rule(Arn; aws_config::AbstractAWSConfig=global_aws_config())
return codestar_notifications(
"POST",
"/updateNotificationRule",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_notification_rule(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codestar_notifications(
"POST",
"/updateNotificationRule",
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 | 43695 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: cognito_identity
using AWS.Compat
using AWS.UUIDs
"""
create_identity_pool(allow_unauthenticated_identities, identity_pool_name)
create_identity_pool(allow_unauthenticated_identities, identity_pool_name, params::Dict{String,<:Any})
Creates a new identity pool. The identity pool is a store of user identity information that
is specific to your AWS account. The keys for SupportedLoginProviders are as follows:
Facebook: graph.facebook.com Google: accounts.google.com Amazon: www.amazon.com
Twitter: api.twitter.com Digits: www.digits.com You must use AWS Developer
credentials to call this API.
# Arguments
- `allow_unauthenticated_identities`: TRUE if the identity pool supports unauthenticated
logins.
- `identity_pool_name`: A string that you provide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowClassicFlow"`: Enables or disables the Basic (Classic) authentication flow. For
more information, see Identity Pools (Federated Identities) Authentication Flow in the
Amazon Cognito Developer Guide.
- `"CognitoIdentityProviders"`: An array of Amazon Cognito user pools and their client IDs.
- `"DeveloperProviderName"`: The \"domain\" by which Cognito will refer to your users. This
name acts as a placeholder that allows your backend and the Cognito service to communicate
about the developer provider. For the DeveloperProviderName, you can use letters as well as
period (.), underscore (_), and dash (-). Once you have set a developer provider name, you
cannot change it. Please take care in setting this parameter.
- `"IdentityPoolTags"`: Tags to assign to the identity pool. A tag is a label that you can
apply to identity pools to categorize and manage them in different ways, such as by
purpose, owner, environment, or other criteria.
- `"OpenIdConnectProviderARNs"`: The Amazon Resource Names (ARN) of the OpenID Connect
providers.
- `"SamlProviderARNs"`: An array of Amazon Resource Names (ARNs) of the SAML provider for
your identity pool.
- `"SupportedLoginProviders"`: Optional key:value pairs mapping provider names to provider
app IDs.
"""
function create_identity_pool(
AllowUnauthenticatedIdentities,
IdentityPoolName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"CreateIdentityPool",
Dict{String,Any}(
"AllowUnauthenticatedIdentities" => AllowUnauthenticatedIdentities,
"IdentityPoolName" => IdentityPoolName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_identity_pool(
AllowUnauthenticatedIdentities,
IdentityPoolName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"CreateIdentityPool",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AllowUnauthenticatedIdentities" => AllowUnauthenticatedIdentities,
"IdentityPoolName" => IdentityPoolName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_identities(identity_ids_to_delete)
delete_identities(identity_ids_to_delete, params::Dict{String,<:Any})
Deletes identities from an identity pool. You can specify a list of 1-60 identities that
you want to delete. You must use AWS Developer credentials to call this API.
# Arguments
- `identity_ids_to_delete`: A list of 1-60 identities that you want to delete.
"""
function delete_identities(
IdentityIdsToDelete; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"DeleteIdentities",
Dict{String,Any}("IdentityIdsToDelete" => IdentityIdsToDelete);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_identities(
IdentityIdsToDelete,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"DeleteIdentities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IdentityIdsToDelete" => IdentityIdsToDelete),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_identity_pool(identity_pool_id)
delete_identity_pool(identity_pool_id, params::Dict{String,<:Any})
Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate
with the pool. You must use AWS Developer credentials to call this API.
# Arguments
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
"""
function delete_identity_pool(
IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"DeleteIdentityPool",
Dict{String,Any}("IdentityPoolId" => IdentityPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_identity_pool(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"DeleteIdentityPool",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IdentityPoolId" => IdentityPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_identity(identity_id)
describe_identity(identity_id, params::Dict{String,<:Any})
Returns metadata related to the given identity, including when the identity was created and
any associated linked logins. You must use AWS Developer credentials to call this API.
# Arguments
- `identity_id`: A unique identifier in the format REGION:GUID.
"""
function describe_identity(IdentityId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity(
"DescribeIdentity",
Dict{String,Any}("IdentityId" => IdentityId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_identity(
IdentityId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"DescribeIdentity",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IdentityId" => IdentityId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_identity_pool(identity_pool_id)
describe_identity_pool(identity_pool_id, params::Dict{String,<:Any})
Gets details about a particular identity pool, including the pool name, ID description,
creation date, and current number of users. You must use AWS Developer credentials to call
this API.
# Arguments
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
"""
function describe_identity_pool(
IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"DescribeIdentityPool",
Dict{String,Any}("IdentityPoolId" => IdentityPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_identity_pool(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"DescribeIdentityPool",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IdentityPoolId" => IdentityPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_credentials_for_identity(identity_id)
get_credentials_for_identity(identity_id, params::Dict{String,<:Any})
Returns credentials for the provided identity ID. Any provided logins will be validated
against supported login providers. If the token is for cognito-identity.amazonaws.com, it
will be passed through to AWS Security Token Service with the appropriate role for the
token. This is a public API. You do not need any credentials to call this API.
# Arguments
- `identity_id`: A unique identifier in the format REGION:GUID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomRoleArn"`: The Amazon Resource Name (ARN) of the role to be assumed when multiple
roles were received in the token from the identity provider. For example, a SAML-based
identity provider. This parameter is optional for identity providers that do not support
role customization.
- `"Logins"`: A set of optional name-value pairs that map provider names to provider
tokens. The name-value pair will follow the syntax \"provider_name\":
\"provider_user_identifier\". Logins should not be specified when trying to get credentials
for an unauthenticated identity. The Logins parameter is required when using identities
associated with external identity providers such as Facebook. For examples of Logins maps,
see the code examples in the External Identity Providers section of the Amazon Cognito
Developer Guide.
"""
function get_credentials_for_identity(
IdentityId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"GetCredentialsForIdentity",
Dict{String,Any}("IdentityId" => IdentityId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_credentials_for_identity(
IdentityId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"GetCredentialsForIdentity",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IdentityId" => IdentityId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_id(identity_pool_id)
get_id(identity_pool_id, params::Dict{String,<:Any})
Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit
linked account. This is a public API. You do not need any credentials to call this API.
# Arguments
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountId"`: A standard AWS account ID (9+ digits).
- `"Logins"`: A set of optional name-value pairs that map provider names to provider
tokens. The available provider names for Logins are as follows: Facebook:
graph.facebook.com Amazon Cognito user pool:
cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>, for example,
cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789. Google: accounts.google.com
Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com
"""
function get_id(IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity(
"GetId",
Dict{String,Any}("IdentityPoolId" => IdentityPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_id(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"GetId",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IdentityPoolId" => IdentityPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_identity_pool_roles(identity_pool_id)
get_identity_pool_roles(identity_pool_id, params::Dict{String,<:Any})
Gets the roles for an identity pool. You must use AWS Developer credentials to call this
API.
# Arguments
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
"""
function get_identity_pool_roles(
IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"GetIdentityPoolRoles",
Dict{String,Any}("IdentityPoolId" => IdentityPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_identity_pool_roles(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"GetIdentityPoolRoles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IdentityPoolId" => IdentityPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_open_id_token(identity_id)
get_open_id_token(identity_id, params::Dict{String,<:Any})
Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId.
You can optionally add additional logins for the identity. Supplying multiple logins
creates an implicit link. The OpenID token is valid for 10 minutes. This is a public API.
You do not need any credentials to call this API.
# Arguments
- `identity_id`: A unique identifier in the format REGION:GUID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Logins"`: A set of optional name-value pairs that map provider names to provider
tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned
from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool
provider, or any other OpenID Connect provider, always include the id_token.
"""
function get_open_id_token(IdentityId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity(
"GetOpenIdToken",
Dict{String,Any}("IdentityId" => IdentityId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_open_id_token(
IdentityId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"GetOpenIdToken",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IdentityId" => IdentityId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_open_id_token_for_developer_identity(identity_pool_id, logins)
get_open_id_token_for_developer_identity(identity_pool_id, logins, params::Dict{String,<:Any})
Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user
authenticated by your backend authentication process. Supplying multiple logins will create
an implicit linked account. You can only specify one developer provider as part of the
Logins map, which is linked to the identity pool. The developer provider is the \"domain\"
by which Cognito will refer to your users. You can use GetOpenIdTokenForDeveloperIdentity
to create a new identity and to link new logins (that is, user credentials issued by a
public provider or developer provider) to an existing identity. When you want to create a
new identity, the IdentityId should be null. When you want to associate a new login with an
existing authenticated/unauthenticated identity, you can do so by providing the existing
IdentityId. This API will create the identity in the specified IdentityPoolId. You must use
AWS Developer credentials to call this API.
# Arguments
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
- `logins`: A set of optional name-value pairs that map provider names to provider tokens.
Each name-value pair represents a user from a public provider or developer provider. If the
user is from a developer provider, the name-value pair will follow the syntax
\"developer_provider_name\": \"developer_user_identifier\". The developer provider is the
\"domain\" by which Cognito will refer to your users; you provided this domain while
creating/updating the identity pool. The developer user identifier is an identifier from
your backend that uniquely identifies a user. When you create an identity pool, you can
specify the supported logins.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdentityId"`: A unique identifier in the format REGION:GUID.
- `"PrincipalTags"`: Use this operation to configure attribute mappings for custom
providers.
- `"TokenDuration"`: The expiration time of the token, in seconds. You can specify a custom
expiration time for the token so that you can cache it. If you don't provide an expiration
time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for
temporary AWS credentials, which are valid for a maximum of one hour. The maximum token
duration you can set is 24 hours. You should take care in setting the expiration time for a
token, as there are significant security implications: an attacker could use a leaked token
to access your AWS resources for the token's duration. Please provide for a small grace
period, usually no more than 5 minutes, to account for clock skew.
"""
function get_open_id_token_for_developer_identity(
IdentityPoolId, Logins; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"GetOpenIdTokenForDeveloperIdentity",
Dict{String,Any}("IdentityPoolId" => IdentityPoolId, "Logins" => Logins);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_open_id_token_for_developer_identity(
IdentityPoolId,
Logins,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"GetOpenIdTokenForDeveloperIdentity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IdentityPoolId" => IdentityPoolId, "Logins" => Logins),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_principal_tag_attribute_map(identity_pool_id, identity_provider_name)
get_principal_tag_attribute_map(identity_pool_id, identity_provider_name, params::Dict{String,<:Any})
Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user
attributes.
# Arguments
- `identity_pool_id`: You can use this operation to get the ID of the Identity Pool you
setup attribute mappings for.
- `identity_provider_name`: You can use this operation to get the provider name.
"""
function get_principal_tag_attribute_map(
IdentityPoolId, IdentityProviderName; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"GetPrincipalTagAttributeMap",
Dict{String,Any}(
"IdentityPoolId" => IdentityPoolId,
"IdentityProviderName" => IdentityProviderName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_principal_tag_attribute_map(
IdentityPoolId,
IdentityProviderName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"GetPrincipalTagAttributeMap",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityPoolId" => IdentityPoolId,
"IdentityProviderName" => IdentityProviderName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_identities(identity_pool_id, max_results)
list_identities(identity_pool_id, max_results, params::Dict{String,<:Any})
Lists the identities in an identity pool. You must use AWS Developer credentials to call
this API.
# Arguments
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
- `max_results`: The maximum number of identities to return.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HideDisabled"`: An optional boolean parameter that allows you to hide disabled
identities. If omitted, the ListIdentities API will include disabled identities in the
response.
- `"NextToken"`: A pagination token.
"""
function list_identities(
IdentityPoolId, MaxResults; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"ListIdentities",
Dict{String,Any}("IdentityPoolId" => IdentityPoolId, "MaxResults" => MaxResults);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_identities(
IdentityPoolId,
MaxResults,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"ListIdentities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityPoolId" => IdentityPoolId, "MaxResults" => MaxResults
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_identity_pools(max_results)
list_identity_pools(max_results, params::Dict{String,<:Any})
Lists all of the Cognito identity pools registered for your account. You must use AWS
Developer credentials to call this API.
# Arguments
- `max_results`: The maximum number of identities to return.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: A pagination token.
"""
function list_identity_pools(MaxResults; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity(
"ListIdentityPools",
Dict{String,Any}("MaxResults" => MaxResults);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_identity_pools(
MaxResults,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"ListIdentityPools",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MaxResults" => MaxResults), 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 that are assigned to an Amazon Cognito identity pool. A tag is a label that
you can apply to identity pools to categorize and manage them in different ways, such as by
purpose, owner, environment, or other criteria. You can use this action up to 10 times per
second, per account.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the identity pool that the tags are
assigned to.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"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 cognito_identity(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
lookup_developer_identity(identity_pool_id)
lookup_developer_identity(identity_pool_id, params::Dict{String,<:Any})
Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of
DeveloperUserIdentifier values associated with an IdentityId for an existing identity.
Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of
these values, the other value will be searched in the database and returned as a part of
the response. If you supply both, DeveloperUserIdentifier will be matched against
IdentityID. If the values are verified against the database, the response returns both
values and is the same as the request. Otherwise a ResourceConflictException is thrown.
LookupDeveloperIdentity is intended for low-throughput control plane operations: for
example, to enable customer service to locate an identity ID by username. If you are using
it for higher-volume operations such as user authentication, your requests are likely to be
throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume
operations for user authentication. You must use AWS Developer credentials to call this API.
# Arguments
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeveloperUserIdentifier"`: A unique ID used by your backend authentication process to
identify a user. Typically, a developer identity provider would issue many developer user
identifiers, in keeping with the number of users.
- `"IdentityId"`: A unique identifier in the format REGION:GUID.
- `"MaxResults"`: The maximum number of identities to return.
- `"NextToken"`: A pagination token. The first call you make will have NextToken set to
null. After that the service will return NextToken values as needed. For example, let's say
you make a request with MaxResults set to 10, and there are 20 matches in the database. The
service will return a pagination token as a part of the response. This token can be used to
call the API again and get results starting from the 11th match.
"""
function lookup_developer_identity(
IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"LookupDeveloperIdentity",
Dict{String,Any}("IdentityPoolId" => IdentityPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function lookup_developer_identity(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"LookupDeveloperIdentity",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IdentityPoolId" => IdentityPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
merge_developer_identities(destination_user_identifier, developer_provider_name, identity_pool_id, source_user_identifier)
merge_developer_identities(destination_user_identifier, developer_provider_name, identity_pool_id, source_user_identifier, params::Dict{String,<:Any})
Merges two users having different IdentityIds, existing in the same identity pool, and
identified by the same developer provider. You can use this action to request that discrete
users be merged and identified as a single user in the Cognito environment. Cognito
associates the given source user (SourceUserIdentifier) with the IdentityId of the
DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users
to be merged are associated with the same public provider, but as two different users, an
exception will be thrown. The number of linked logins is limited to 20. So, the number of
linked logins for the source user, SourceUserIdentifier, and the destination user,
DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception
will be thrown. You must use AWS Developer credentials to call this API.
# Arguments
- `destination_user_identifier`: User identifier for the destination user. The value should
be a DeveloperUserIdentifier.
- `developer_provider_name`: The \"domain\" by which Cognito will refer to your users. This
is a (pseudo) domain name that you provide while creating an identity pool. This name acts
as a placeholder that allows your backend and the Cognito service to communicate about the
developer provider. For the DeveloperProviderName, you can use letters as well as period
(.), underscore (_), and dash (-).
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
- `source_user_identifier`: User identifier for the source user. The value should be a
DeveloperUserIdentifier.
"""
function merge_developer_identities(
DestinationUserIdentifier,
DeveloperProviderName,
IdentityPoolId,
SourceUserIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"MergeDeveloperIdentities",
Dict{String,Any}(
"DestinationUserIdentifier" => DestinationUserIdentifier,
"DeveloperProviderName" => DeveloperProviderName,
"IdentityPoolId" => IdentityPoolId,
"SourceUserIdentifier" => SourceUserIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function merge_developer_identities(
DestinationUserIdentifier,
DeveloperProviderName,
IdentityPoolId,
SourceUserIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"MergeDeveloperIdentities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationUserIdentifier" => DestinationUserIdentifier,
"DeveloperProviderName" => DeveloperProviderName,
"IdentityPoolId" => IdentityPoolId,
"SourceUserIdentifier" => SourceUserIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_identity_pool_roles(identity_pool_id, roles)
set_identity_pool_roles(identity_pool_id, roles, params::Dict{String,<:Any})
Sets the roles for an identity pool. These roles are used when making calls to
GetCredentialsForIdentity action. You must use AWS Developer credentials to call this API.
# Arguments
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
- `roles`: The map of roles associated with this pool. For a given role, the key will be
either \"authenticated\" or \"unauthenticated\" and the value will be the Role ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RoleMappings"`: How users for a specific identity provider are to mapped to roles. This
is a string to RoleMapping object map. The string identifies the identity provider, for
example, \"graph.facebook.com\" or
\"cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\". Up to 25 rules
can be specified per identity provider.
"""
function set_identity_pool_roles(
IdentityPoolId, Roles; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"SetIdentityPoolRoles",
Dict{String,Any}("IdentityPoolId" => IdentityPoolId, "Roles" => Roles);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_identity_pool_roles(
IdentityPoolId,
Roles,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"SetIdentityPoolRoles",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IdentityPoolId" => IdentityPoolId, "Roles" => Roles),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_principal_tag_attribute_map(identity_pool_id, identity_provider_name)
set_principal_tag_attribute_map(identity_pool_id, identity_provider_name, params::Dict{String,<:Any})
You can use this operation to use default (username and clientID) attribute or custom
attribute mappings.
# Arguments
- `identity_pool_id`: The ID of the Identity Pool you want to set attribute mappings for.
- `identity_provider_name`: The provider name you want to use for attribute mappings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PrincipalTags"`: You can use this operation to add principal tags.
- `"UseDefaults"`: You can use this operation to use default (username and clientID)
attribute mappings.
"""
function set_principal_tag_attribute_map(
IdentityPoolId, IdentityProviderName; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"SetPrincipalTagAttributeMap",
Dict{String,Any}(
"IdentityPoolId" => IdentityPoolId,
"IdentityProviderName" => IdentityProviderName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_principal_tag_attribute_map(
IdentityPoolId,
IdentityProviderName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"SetPrincipalTagAttributeMap",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityPoolId" => IdentityPoolId,
"IdentityProviderName" => IdentityProviderName,
),
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 a set of tags to the specified Amazon Cognito identity pool. A tag is a label that
you can use to categorize and manage identity pools in different ways, such as by purpose,
owner, environment, or other criteria. Each tag consists of a key and value, both of which
you define. A key is a general category for more specific values. For example, if you have
two versions of an identity pool, one for testing and another for production, you might
assign an Environment tag key to both identity pools. The value of this key might be Test
for one identity pool and Production for the other. Tags are useful for cost tracking and
access control. You can activate your tags so that they appear on the Billing and Cost
Management console, where you can track the costs associated with your identity pools. In
an IAM policy, you can constrain permissions for identity pools based on specific tags or
tag values. You can use this action up to 5 times per second, per account. An identity pool
can have as many as 50 tags.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the identity pool.
- `tags`: The tags to assign to the identity pool.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity(
"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 cognito_identity(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unlink_developer_identity(developer_provider_name, developer_user_identifier, identity_id, identity_pool_id)
unlink_developer_identity(developer_provider_name, developer_user_identifier, identity_id, identity_pool_id, params::Dict{String,<:Any})
Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will
be considered new identities next time they are seen. If, for a given Cognito identity, you
remove all federated identities as well as the developer user identifier, the Cognito
identity becomes inaccessible. You must use AWS Developer credentials to call this API.
# Arguments
- `developer_provider_name`: The \"domain\" by which Cognito will refer to your users.
- `developer_user_identifier`: A unique ID used by your backend authentication process to
identify a user.
- `identity_id`: A unique identifier in the format REGION:GUID.
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
"""
function unlink_developer_identity(
DeveloperProviderName,
DeveloperUserIdentifier,
IdentityId,
IdentityPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"UnlinkDeveloperIdentity",
Dict{String,Any}(
"DeveloperProviderName" => DeveloperProviderName,
"DeveloperUserIdentifier" => DeveloperUserIdentifier,
"IdentityId" => IdentityId,
"IdentityPoolId" => IdentityPoolId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unlink_developer_identity(
DeveloperProviderName,
DeveloperUserIdentifier,
IdentityId,
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"UnlinkDeveloperIdentity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeveloperProviderName" => DeveloperProviderName,
"DeveloperUserIdentifier" => DeveloperUserIdentifier,
"IdentityId" => IdentityId,
"IdentityPoolId" => IdentityPoolId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unlink_identity(identity_id, logins, logins_to_remove)
unlink_identity(identity_id, logins, logins_to_remove, params::Dict{String,<:Any})
Unlinks a federated identity from an existing account. Unlinked logins will be considered
new identities next time they are seen. Removing the last linked login will make this
identity inaccessible. This is a public API. You do not need any credentials to call this
API.
# Arguments
- `identity_id`: A unique identifier in the format REGION:GUID.
- `logins`: A set of optional name-value pairs that map provider names to provider tokens.
- `logins_to_remove`: Provider names to unlink from this identity.
"""
function unlink_identity(
IdentityId, Logins, LoginsToRemove; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"UnlinkIdentity",
Dict{String,Any}(
"IdentityId" => IdentityId,
"Logins" => Logins,
"LoginsToRemove" => LoginsToRemove,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unlink_identity(
IdentityId,
Logins,
LoginsToRemove,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"UnlinkIdentity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityId" => IdentityId,
"Logins" => Logins,
"LoginsToRemove" => LoginsToRemove,
),
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 Amazon Cognito identity pool. You can use
this action up to 5 times per second, per account
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the identity pool.
- `tag_keys`: The keys of the tags to remove from the user pool.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity(
"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 cognito_identity(
"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_identity_pool(allow_unauthenticated_identities, identity_pool_id, identity_pool_name)
update_identity_pool(allow_unauthenticated_identities, identity_pool_id, identity_pool_name, params::Dict{String,<:Any})
Updates an identity pool. You must use AWS Developer credentials to call this API.
# Arguments
- `allow_unauthenticated_identities`: TRUE if the identity pool supports unauthenticated
logins.
- `identity_pool_id`: An identity pool ID in the format REGION:GUID.
- `identity_pool_name`: A string that you provide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowClassicFlow"`: Enables or disables the Basic (Classic) authentication flow. For
more information, see Identity Pools (Federated Identities) Authentication Flow in the
Amazon Cognito Developer Guide.
- `"CognitoIdentityProviders"`: A list representing an Amazon Cognito user pool and its
client ID.
- `"DeveloperProviderName"`: The \"domain\" by which Cognito will refer to your users.
- `"IdentityPoolTags"`: The tags that are assigned to the identity pool. A tag is a label
that you can apply to identity pools to categorize and manage them in different ways, such
as by purpose, owner, environment, or other criteria.
- `"OpenIdConnectProviderARNs"`: The ARNs of the OpenID Connect providers.
- `"SamlProviderARNs"`: An array of Amazon Resource Names (ARNs) of the SAML provider for
your identity pool.
- `"SupportedLoginProviders"`: Optional key:value pairs mapping provider names to provider
app IDs.
"""
function update_identity_pool(
AllowUnauthenticatedIdentities,
IdentityPoolId,
IdentityPoolName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"UpdateIdentityPool",
Dict{String,Any}(
"AllowUnauthenticatedIdentities" => AllowUnauthenticatedIdentities,
"IdentityPoolId" => IdentityPoolId,
"IdentityPoolName" => IdentityPoolName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_identity_pool(
AllowUnauthenticatedIdentities,
IdentityPoolId,
IdentityPoolName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity(
"UpdateIdentityPool",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AllowUnauthenticatedIdentities" => AllowUnauthenticatedIdentities,
"IdentityPoolId" => IdentityPoolId,
"IdentityPoolName" => IdentityPoolName,
),
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 | 306999 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: cognito_identity_provider
using AWS.Compat
using AWS.UUIDs
"""
add_custom_attributes(custom_attributes, user_pool_id)
add_custom_attributes(custom_attributes, user_pool_id, params::Dict{String,<:Any})
Adds additional user attributes to the user pool schema. Amazon Cognito evaluates Identity
and Access Management (IAM) policies in requests for this API operation. For this
operation, you must use IAM credentials to authorize requests, and you must grant yourself
the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services
API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `custom_attributes`: An array of custom attributes, such as Mutable and Name.
- `user_pool_id`: The user pool ID for the user pool where you want to add custom
attributes.
"""
function add_custom_attributes(
CustomAttributes, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AddCustomAttributes",
Dict{String,Any}(
"CustomAttributes" => CustomAttributes, "UserPoolId" => UserPoolId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_custom_attributes(
CustomAttributes,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AddCustomAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CustomAttributes" => CustomAttributes, "UserPoolId" => UserPoolId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_add_user_to_group(group_name, user_pool_id, username)
admin_add_user_to_group(group_name, user_pool_id, username, params::Dict{String,<:Any})
Adds a user to a group. A user who is in a group can present a preferred-role claim to an
identity pool, and populates a cognito:groups claim to their access and identity tokens.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this
API operation. For this operation, you must use IAM credentials to authorize requests, and
you must grant yourself the corresponding IAM permission in a policy. Learn more
Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and
user pool endpoints
# Arguments
- `group_name`: The name of the group that you want to add your user to.
- `user_pool_id`: The user pool ID for the user pool.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_add_user_to_group(
GroupName, UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminAddUserToGroup",
Dict{String,Any}(
"GroupName" => GroupName, "UserPoolId" => UserPoolId, "Username" => Username
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_add_user_to_group(
GroupName,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminAddUserToGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupName" => GroupName,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_confirm_sign_up(user_pool_id, username)
admin_confirm_sign_up(user_pool_id, username, params::Dict{String,<:Any})
This IAM-authenticated API operation provides a code that Amazon Cognito sent to your user
when they signed up in your user pool. After your user enters their code, they confirm
ownership of the email address or phone number that they provided, and their user account
becomes active. Depending on your user pool configuration, your users will receive their
confirmation code in an email or SMS message. Local users who signed up in your user pool
are the only type of user who can confirm sign-up with a code. Users who federate through
an external identity provider (IdP) have already been confirmed by their IdP.
Administrator-created users confirm their accounts when they respond to their invitation
email message and choose a password. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for which you want to confirm user registration.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. If your user pool configuration includes
triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified
for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a
JSON payload, which the function receives as input. In this payload, the clientMetadata
attribute provides the data that you assigned to the ClientMetadata parameter in your
AdminConfirmSignUp request. In your function code in Lambda, you can process the
ClientMetadata value to enhance your workflow for your specific needs. For more
information, see Customizing user pool Workflows with Lambda Triggers in the Amazon
Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon
Cognito won't do the following: Store the ClientMetadata value. This data is available
only to Lambda triggers that are assigned to a user pool to support custom workflows. If
your user pool configuration doesn't include triggers, the ClientMetadata parameter serves
no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't
use Amazon Cognito to provide sensitive information.
"""
function admin_confirm_sign_up(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminConfirmSignUp",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_confirm_sign_up(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminConfirmSignUp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_create_user(user_pool_id, username)
admin_create_user(user_pool_id, username, params::Dict{String,<:Any})
Creates a new user in the specified user pool. If MessageAction isn't set, the default is
to send a welcome message via email or phone (SMS). This action might generate an SMS text
message. Starting June 1, 2021, US telecom carriers require you to register an origination
phone number before you can send SMS messages to US phone numbers. If you use SMS text
messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon
Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
receive SMS messages might not be able to sign up, activate their accounts, or sign in. If
you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox
mode , you can send messages only to verified phone numbers. After you test your app while
in the sandbox environment, you can move out of the sandbox and into production. For more
information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito
Developer Guide. This message is based on a template that you configured in your call to
create or update a user pool. This template includes your custom sign-up instructions and
placeholders for user name and temporary password. Alternatively, you can call
AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won't
send any email. In either case, the user will be in the FORCE_CHANGE_PASSWORD state until
they sign in and change their password. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool where the user will be created.
- `username`: The value that you want to set as the username sign-in attribute. The
following conditions apply to the username parameter. The username can't be a duplicate
of another username in the same user pool. You can't change the value of a username after
you create it. You can only provide a value if usernames are a valid sign-in attribute
for your user pool. If your user pool only supports phone numbers or email addresses as
sign-in attributes, Amazon Cognito automatically generates a username value. For more
information, see Customizing sign-in attributes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the AdminCreateUser API action, Amazon
Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon
Cognito invokes this function, it passes a JSON payload, which the function receives as
input. This payload contains a clientMetadata attribute, which provides the data that you
assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function
code in Lambda, you can process the clientMetadata value to enhance your workflow for your
specific needs. For more information, see Customizing user pool Workflows with Lambda
Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter,
remember that Amazon Cognito won't do the following: Store the ClientMetadata value. This
data is available only to Lambda triggers that are assigned to a user pool to support
custom workflows. If your user pool configuration doesn't include triggers, the
ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt
the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
- `"DesiredDeliveryMediums"`: Specify \"EMAIL\" if email will be used to send the welcome
message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\".
You can specify more than one value.
- `"ForceAliasCreation"`: This parameter is used only if the phone_number_verified or
email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set
to True and the phone number or email address specified in the UserAttributes parameter
already exists as an alias with a different user, the API call will migrate the alias from
the previous user to the newly created user. The previous user will no longer be able to
log in using that alias. If this parameter is set to False, the API throws an
AliasExistsException error if the alias already exists. The default value is False.
- `"MessageAction"`: Set to RESEND to resend the invitation message to a user that already
exists and reset the expiration limit on the user's account. Set to SUPPRESS to suppress
sending the message. You can specify only one value.
- `"TemporaryPassword"`: The user's temporary password. This password must conform to the
password policy that you specified when you created the user pool. The temporary password
is valid only once. To complete the Admin Create User flow, the user must enter the
temporary password in the sign-in page, along with a new password to be used in all future
sign-ins. This parameter isn't required. If you don't specify a value, Amazon Cognito
generates one for you. The temporary password can only be used until the user account
expiration limit that you set for your user pool. To reset the account after that time
limit, you must call AdminCreateUser again and specify RESEND for the MessageAction
parameter.
- `"UserAttributes"`: An array of name-value pairs that contain user attributes and
attribute values to be set for the user to be created. You can create a user without
specifying any attributes other than Username. However, any attributes that you specify as
required (when creating a user pool or in the Attributes tab of the console) either you
should supply (in your call to AdminCreateUser) or the user should supply (when they sign
up in response to your welcome message). For custom attributes, you must prepend the
custom: prefix to the attribute name. To send a message inviting the user to sign up, you
must specify the user's email address or phone number. You can do this in your call to
AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user
pools. In your call to AdminCreateUser, you can set the email_verified attribute to True,
and you can set the phone_number_verified attribute to True. You can also do this by
calling AdminUpdateUserAttributes. email: The email address of the user to whom the
message that contains the code and username will be sent. Required if the email_verified
attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums
parameter. phone_number: The phone number of the user to whom the message that contains
the code and username will be sent. Required if the phone_number_verified attribute is set
to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
- `"ValidationData"`: Temporary user attributes that contribute to the outcomes of your pre
sign-up Lambda trigger. This set of key-value pairs are for custom validation of
information that you collect from your users but don't need to retain. Your Lambda function
can analyze this additional data and act on it. Your function might perform external API
operations like logging user attributes and validation data to Amazon CloudWatch Logs.
Validation data might also affect the response that your function returns to Amazon
Cognito, like automatically confirming the user if they sign up from within your network.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
"""
function admin_create_user(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminCreateUser",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_create_user(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminCreateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_delete_user(user_pool_id, username)
admin_delete_user(user_pool_id, username, params::Dict{String,<:Any})
Deletes a user as an administrator. Works on any user. Amazon Cognito evaluates Identity
and Access Management (IAM) policies in requests for this API operation. For this
operation, you must use IAM credentials to authorize requests, and you must grant yourself
the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services
API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool where you want to delete the user.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_delete_user(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminDeleteUser",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_delete_user(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminDeleteUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_delete_user_attributes(user_attribute_names, user_pool_id, username)
admin_delete_user_attributes(user_attribute_names, user_pool_id, username, params::Dict{String,<:Any})
Deletes the user attributes in a user pool as an administrator. Works on any user. Amazon
Cognito evaluates Identity and Access Management (IAM) policies in requests for this API
operation. For this operation, you must use IAM credentials to authorize requests, and you
must grant yourself the corresponding IAM permission in a policy. Learn more Signing
Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool
endpoints
# Arguments
- `user_attribute_names`: An array of strings representing the user attribute names you
want to delete. For custom attributes, you must prepend the custom: prefix to the attribute
name.
- `user_pool_id`: The user pool ID for the user pool where you want to delete user
attributes.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_delete_user_attributes(
UserAttributeNames,
UserPoolId,
Username;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminDeleteUserAttributes",
Dict{String,Any}(
"UserAttributeNames" => UserAttributeNames,
"UserPoolId" => UserPoolId,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_delete_user_attributes(
UserAttributeNames,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminDeleteUserAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"UserAttributeNames" => UserAttributeNames,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_disable_provider_for_user(user, user_pool_id)
admin_disable_provider_for_user(user, user_pool_id, params::Dict{String,<:Any})
Prevents the user from signing in with the specified external (SAML or social) identity
provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools
native username + password user, they can't use their password to sign in. If the user to
deactivate is a linked external IdP user, any link between that user and an existing user
is removed. When the external user signs in again, and the user is no longer attached to
the previously linked DestinationUser, the user must create a new user account. See
AdminLinkProviderForUser. The ProviderName must match the value specified when creating an
IdP for the pool. To deactivate a native username + password user, the ProviderName value
must be Cognito and the ProviderAttributeName must be Cognito_Subject. The
ProviderAttributeValue must be the name that is used in the user pool for the user. The
ProviderAttributeName must always be Cognito_Subject for social IdPs. The
ProviderAttributeValue must always be the exact subject that was used when the user was
originally linked as a source user. For de-linking a SAML identity, there are two
scenarios. If the linked identity has not yet been used to sign in, the
ProviderAttributeName and ProviderAttributeValue must be the same values that were used for
the SourceUser when the identities were originally linked using AdminLinkProviderForUser
call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same
applies here). However, if the user has already signed in, the ProviderAttributeName must
be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this
API operation. For this operation, you must use IAM credentials to authorize requests, and
you must grant yourself the corresponding IAM permission in a policy. Learn more
Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and
user pool endpoints
# Arguments
- `user`: The user to be disabled.
- `user_pool_id`: The user pool ID for the user pool.
"""
function admin_disable_provider_for_user(
User, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminDisableProviderForUser",
Dict{String,Any}("User" => User, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_disable_provider_for_user(
User,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminDisableProviderForUser",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("User" => User, "UserPoolId" => UserPoolId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_disable_user(user_pool_id, username)
admin_disable_user(user_pool_id, username, params::Dict{String,<:Any})
Deactivates a user and revokes all access tokens for the user. A deactivated user can't
sign in, but still appears in the responses to GetUser and ListUsers API requests. Amazon
Cognito evaluates Identity and Access Management (IAM) policies in requests for this API
operation. For this operation, you must use IAM credentials to authorize requests, and you
must grant yourself the corresponding IAM permission in a policy. Learn more Signing
Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool
endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool where you want to disable the user.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_disable_user(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminDisableUser",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_disable_user(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminDisableUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_enable_user(user_pool_id, username)
admin_enable_user(user_pool_id, username, params::Dict{String,<:Any})
Enables the specified user as an administrator. Works on any user. Amazon Cognito
evaluates Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you must use IAM credentials to authorize requests, and you must grant
yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web
Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool where you want to enable the user.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_enable_user(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminEnableUser",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_enable_user(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminEnableUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_forget_device(device_key, user_pool_id, username)
admin_forget_device(device_key, user_pool_id, username, params::Dict{String,<:Any})
Forgets the device, as an administrator. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `device_key`: The device key.
- `user_pool_id`: The user pool ID.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_forget_device(
DeviceKey, UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminForgetDevice",
Dict{String,Any}(
"DeviceKey" => DeviceKey, "UserPoolId" => UserPoolId, "Username" => Username
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_forget_device(
DeviceKey,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminForgetDevice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceKey" => DeviceKey,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_get_device(device_key, user_pool_id, username)
admin_get_device(device_key, user_pool_id, username, params::Dict{String,<:Any})
Gets the device, as an administrator. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `device_key`: The device key.
- `user_pool_id`: The user pool ID.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_get_device(
DeviceKey, UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminGetDevice",
Dict{String,Any}(
"DeviceKey" => DeviceKey, "UserPoolId" => UserPoolId, "Username" => Username
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_get_device(
DeviceKey,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminGetDevice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceKey" => DeviceKey,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_get_user(user_pool_id, username)
admin_get_user(user_pool_id, username, params::Dict{String,<:Any})
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for
this API operation. For this operation, you must use IAM credentials to authorize requests,
and you must grant yourself the corresponding IAM permission in a policy. Learn more
Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and
user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool where you want to get information
about the user.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_get_user(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminGetUser",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_get_user(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminGetUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_initiate_auth(auth_flow, client_id, user_pool_id)
admin_initiate_auth(auth_flow, client_id, user_pool_id, params::Dict{String,<:Any})
Initiates the authentication flow, as an administrator. This action might generate an SMS
text message. Starting June 1, 2021, US telecom carriers require you to register an
origination phone number before you can send SMS messages to US phone numbers. If you use
SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint.
Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users
who must receive SMS messages might not be able to sign up, activate their accounts, or
sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon
Web Service, Amazon Simple Notification Service might place your account in the SMS
sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you
test your app while in the sandbox environment, you can move out of the sandbox and into
production. For more information, see SMS message settings for Amazon Cognito user pools
in the Amazon Cognito Developer Guide. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `auth_flow`: The authentication flow for this call to run. The API action will depend on
this value. For example: REFRESH_TOKEN_AUTH will take in a valid refresh token and
return new tokens. USER_SRP_AUTH will take in USERNAME and SRP_A and return the Secure
Remote Password (SRP) protocol variables to be used for next challenge execution.
ADMIN_USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge
or tokens. Valid values include: USER_SRP_AUTH: Authentication flow for the Secure
Remote Password (SRP) protocol. REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow
for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow. ADMIN_NO_SRP_AUTH: Non-SRP authentication flow;
you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the
app client. ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This
replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives
the password in the request instead of using the SRP process to verify passwords.
- `client_id`: The app client ID.
- `user_pool_id`: The ID of the Amazon Cognito user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyticsMetadata"`: The analytics metadata for collecting Amazon Pinpoint metrics for
AdminInitiateAuth calls.
- `"AuthParameters"`: The authentication parameters. These are inputs corresponding to the
AuthFlow that you're invoking. The required values depend on the value of AuthFlow: For
USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app
client is configured with a client secret), DEVICE_KEY. For ADMIN_USER_PASSWORD_AUTH:
USERNAME (required), PASSWORD (required), SECRET_HASH (required if the app client is
configured with a client secret), DEVICE_KEY. For REFRESH_TOKEN_AUTH/REFRESH_TOKEN:
REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a
client secret), DEVICE_KEY. For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app
client is configured with client secret), DEVICE_KEY. To start the authentication flow with
password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value). For
more information about SECRET_HASH, see Computing secret hash values. For information about
DEVICE_KEY, see Working with user devices in your user pool.
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for
certain custom workflows that this action triggers. You create custom workflows by
assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API
action, Amazon Cognito invokes the Lambda functions that are specified for various
triggers. The ClientMetadata value is passed as input to the functions for only the
following triggers: Pre signup Pre authentication User migration When Amazon
Cognito invokes the functions for these triggers, it passes a JSON payload, which the
function receives as input. This payload contains a validationData attribute, which
provides the data that you assigned to the ClientMetadata parameter in your
AdminInitiateAuth request. In your function code in Lambda, you can process the
validationData value to enhance your workflow for your specific needs. When you use the
AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following
triggers, but it doesn't provide the ClientMetadata value as input: Post authentication
Custom message Pre token generation Create auth challenge Define auth challenge For
more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon
Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon
Cognito won't do the following: Store the ClientMetadata value. This data is available
only to Lambda triggers that are assigned to a user pool to support custom workflows. If
your user pool configuration doesn't include triggers, the ClientMetadata parameter serves
no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't
use Amazon Cognito to provide sensitive information.
- `"ContextData"`: Contextual data about your user session, such as the device fingerprint,
IP address, or location. Amazon Cognito advanced security evaluates the risk of an
authentication event based on the context that your app generates and passes to Amazon
Cognito when it makes API requests.
"""
function admin_initiate_auth(
AuthFlow, ClientId, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminInitiateAuth",
Dict{String,Any}(
"AuthFlow" => AuthFlow, "ClientId" => ClientId, "UserPoolId" => UserPoolId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_initiate_auth(
AuthFlow,
ClientId,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminInitiateAuth",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthFlow" => AuthFlow,
"ClientId" => ClientId,
"UserPoolId" => UserPoolId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_link_provider_for_user(destination_user, source_user, user_pool_id)
admin_link_provider_for_user(destination_user, source_user, user_pool_id, params::Dict{String,<:Any})
Links an existing user account in a user pool (DestinationUser) to an identity from an
external IdP (SourceUser) based on a specified attribute name and value from the external
IdP. This allows you to create a link from the existing user account to an external
federated user identity that has not yet been used to sign in. You can then use the
federated user identity to sign in as the existing user account. For example, if there is
an existing user with a username and password, this API links that user to a federated user
identity. When the user signs in with a federated user identity, they sign in as the
existing user account. The maximum number of federated identities linked to a user is
five. Because this API allows a user with an external federated identity to sign in as an
existing user in the user pool, it is critical that it only be used with external IdPs and
provider attributes that have been trusted by the application owner. Amazon Cognito
evaluates Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you must use IAM credentials to authorize requests, and you must grant
yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web
Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `destination_user`: The existing user in the user pool that you want to assign to the
external IdP user account. This user can be a local (Username + Password) Amazon Cognito
user pools user or a federated user (for example, a SAML or Facebook user). If the user
doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when
the new user (with the linked IdP attribute) signs in. For a native username + password
user, the ProviderAttributeValue for the DestinationUser should be the username in the user
pool. For a federated user, it should be the provider-specific user_id. The
ProviderAttributeName of the DestinationUser is ignored. The ProviderName should be set to
Cognito for users in Cognito user pools. All attributes in the DestinationUser profile
must be mutable. If you have assigned the user any immutable custom attributes, the
operation won't succeed.
- `source_user`: An external IdP account for a user who doesn't exist yet in the user pool.
This user must be a federated user (for example, a SAML or Facebook user), not another
native user. If the SourceUser is using a federated social IdP, such as Facebook, Google,
or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject. For social
IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Amazon Cognito
will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub,
and user_id, respectively. The ProviderAttributeValue for the user must be the same value
as the id, sub, or user_id value found in the social IdP token. For OIDC, the
ProviderAttributeName can be any value that matches a claim in the ID token, or that your
app retrieves from the userInfo endpoint. You must map the claim to a user pool attribute
in your IdP configuration, and set the user pool attribute name as the value of
ProviderAttributeName in your AdminLinkProviderForUser request. For SAML, the
ProviderAttributeName can be any value that matches a claim in the SAML assertion. To link
SAML users based on the subject of the SAML assertion, map the subject to a claim through
the SAML IdP and set that claim name as the value of ProviderAttributeName in your
AdminLinkProviderForUser request. For both OIDC and SAML users, when you set
ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the
default unique identifier found in the subject from the IdP token.
- `user_pool_id`: The user pool ID for the user pool.
"""
function admin_link_provider_for_user(
DestinationUser,
SourceUser,
UserPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminLinkProviderForUser",
Dict{String,Any}(
"DestinationUser" => DestinationUser,
"SourceUser" => SourceUser,
"UserPoolId" => UserPoolId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_link_provider_for_user(
DestinationUser,
SourceUser,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminLinkProviderForUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationUser" => DestinationUser,
"SourceUser" => SourceUser,
"UserPoolId" => UserPoolId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_list_devices(user_pool_id, username)
admin_list_devices(user_pool_id, username, params::Dict{String,<:Any})
Lists devices, as an administrator. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The limit of the devices request.
- `"PaginationToken"`: This API operation returns a limited number of results. The
pagination token is an identifier that you can present in an additional API request with
the same parameters. When you include the pagination token, Amazon Cognito returns the next
set of items after the current list. Subsequent requests return a new pagination token. By
use of this token, you can paginate through the full list of items.
"""
function admin_list_devices(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminListDevices",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_list_devices(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminListDevices",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_list_groups_for_user(user_pool_id, username)
admin_list_groups_for_user(user_pool_id, username, params::Dict{String,<:Any})
Lists the groups that a user belongs to. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The limit of the request to list groups.
- `"NextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function admin_list_groups_for_user(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminListGroupsForUser",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_list_groups_for_user(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminListGroupsForUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_list_user_auth_events(user_pool_id, username)
admin_list_user_auth_events(user_pool_id, username, params::Dict{String,<:Any})
A history of user activity and any risks detected as part of Amazon Cognito advanced
security. Amazon Cognito evaluates Identity and Access Management (IAM) policies in
requests for this API operation. For this operation, you must use IAM credentials to
authorize requests, and you must grant yourself the corresponding IAM permission in a
policy. Learn more Signing Amazon Web Services API Requests Using the Amazon
Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of authentication events to return. Returns 60 events
if you set MaxResults to 0, or if you don't include a MaxResults parameter.
- `"NextToken"`: A pagination token.
"""
function admin_list_user_auth_events(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminListUserAuthEvents",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_list_user_auth_events(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminListUserAuthEvents",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_remove_user_from_group(group_name, user_pool_id, username)
admin_remove_user_from_group(group_name, user_pool_id, username, params::Dict{String,<:Any})
Removes the specified user from the specified group. Amazon Cognito evaluates Identity and
Access Management (IAM) policies in requests for this API operation. For this operation,
you must use IAM credentials to authorize requests, and you must grant yourself the
corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API
Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `group_name`: The group name.
- `user_pool_id`: The user pool ID for the user pool.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_remove_user_from_group(
GroupName, UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminRemoveUserFromGroup",
Dict{String,Any}(
"GroupName" => GroupName, "UserPoolId" => UserPoolId, "Username" => Username
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_remove_user_from_group(
GroupName,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminRemoveUserFromGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupName" => GroupName,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_reset_user_password(user_pool_id, username)
admin_reset_user_password(user_pool_id, username, params::Dict{String,<:Any})
Resets the specified user's password in a user pool as an administrator. Works on any user.
To use this API operation, your user pool must have self-service account recovery
configured. Use AdminSetUserPassword if you manage passwords as an administrator. This
action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
require you to register an origination phone number before you can send SMS messages to US
phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone
number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically.
Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up,
activate their accounts, or sign in. If you have never used SMS text messages with Amazon
Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place
your account in the SMS sandbox. In sandbox mode , you can send messages only to verified
phone numbers. After you test your app while in the sandbox environment, you can move out
of the sandbox and into production. For more information, see SMS message settings for
Amazon Cognito user pools in the Amazon Cognito Developer Guide. Deactivates a user's
password, requiring them to change it. If a user tries to sign in after the API is called,
Amazon Cognito responds with a PasswordResetRequiredException error. Your app must then
perform the actions that reset your user's password: the forgot-password flow. In addition,
if the user pool has phone verification selected and a verified phone number exists for the
user, or if email verification is selected and a verified email exists for the user,
calling this API will also result in sending a message to the end user with the code to
change their password. Amazon Cognito evaluates Identity and Access Management (IAM)
policies in requests for this API operation. For this operation, you must use IAM
credentials to authorize requests, and you must grant yourself the corresponding IAM
permission in a policy. Learn more Signing Amazon Web Services API Requests Using
the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool where you want to reset the user's
password.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon
Cognito invokes the function that is assigned to the custom message trigger. When Amazon
Cognito invokes this function, it passes a JSON payload, which the function receives as
input. This payload contains a clientMetadata attribute, which provides the data that you
assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your
function code in Lambda, you can process the clientMetadata value to enhance your workflow
for your specific needs. For more information, see Customizing user pool Workflows with
Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata
parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata
value. This data is available only to Lambda triggers that are assigned to a user pool to
support custom workflows. If your user pool configuration doesn't include triggers, the
ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt
the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
"""
function admin_reset_user_password(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminResetUserPassword",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_reset_user_password(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminResetUserPassword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_respond_to_auth_challenge(challenge_name, client_id, user_pool_id)
admin_respond_to_auth_challenge(challenge_name, client_id, user_pool_id, params::Dict{String,<:Any})
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for
device authentication that bypasses MFA, or for a custom authentication challenge. An
AdminRespondToAuthChallenge API request provides the answer to that challenge, like a code
or a secure remote password (SRP). The parameters of a response to an authentication
challenge vary with the type of challenge. For more information about custom authentication
challenges, see Custom authentication challenge Lambda triggers. This action might
generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to
register an origination phone number before you can send SMS messages to US phone numbers.
If you use SMS text messages in Amazon Cognito, you must register a phone number with
Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon
Cognito users who must receive SMS messages might not be able to sign up, activate their
accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any
other Amazon Web Service, Amazon Simple Notification Service might place your account in
the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers.
After you test your app while in the sandbox environment, you can move out of the sandbox
and into production. For more information, see SMS message settings for Amazon Cognito
user pools in the Amazon Cognito Developer Guide. Amazon Cognito evaluates Identity and
Access Management (IAM) policies in requests for this API operation. For this operation,
you must use IAM credentials to authorize requests, and you must grant yourself the
corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API
Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `challenge_name`: The challenge name. For more information, see AdminInitiateAuth.
- `client_id`: The app client ID.
- `user_pool_id`: The ID of the Amazon Cognito user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyticsMetadata"`: The analytics metadata for collecting Amazon Pinpoint metrics for
AdminRespondToAuthChallenge calls.
- `"ChallengeResponses"`: The responses to the challenge that you received in the previous
request. Each challenge has its own required response parameters. The following examples
are partial JSON request bodies that highlight challenge-response parameters. You must
provide a SECRET_HASH parameter in all challenge responses to an app client that has a
client secret. SMS_MFA \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\":
{\"SMS_MFA_CODE\": \"[SMS_code]\", \"USERNAME\": \"[username]\"} PASSWORD_VERIFIER
\"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":
{\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\":
\"[secret_block]\", \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"} Add
\"DEVICE_KEY\" when you sign in with a remembered device. CUSTOM_CHALLENGE
\"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\": {\"USERNAME\":
\"[username]\", \"ANSWER\": \"[challenge_answer]\"} Add \"DEVICE_KEY\" when you sign in
with a remembered device. NEW_PASSWORD_REQUIRED \"ChallengeName\":
\"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\": {\"NEW_PASSWORD\": \"[new_password]\",
\"USERNAME\": \"[username]\"} To set any required attributes that InitiateAuth returned in
an requiredAttributes parameter, add \"userAttributes.[attribute_name]\":
\"[attribute_value]\". This parameter can also set values for writable attributes that
aren't required by your user pool. In a NEW_PASSWORD_REQUIRED challenge response, you
can't modify a required attribute that already has a value. In RespondToAuthChallenge, set
a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then
use the UpdateUserAttributes API operation to modify the value of any additional
attributes. SOFTWARE_TOKEN_MFA \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\",
\"ChallengeResponses\": {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":
[authenticator_code]} DEVICE_SRP_AUTH \"ChallengeName\": \"DEVICE_SRP_AUTH\",
\"ChallengeResponses\": {\"USERNAME\": \"[username]\", \"DEVICE_KEY\": \"[device_key]\",
\"SRP_A\": \"[srp_a]\"} DEVICE_PASSWORD_VERIFIER \"ChallengeName\":
\"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\": {\"DEVICE_KEY\": \"[device_key]\",
\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\":
\"[secret_block]\", \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"} MFA_SETUP
\"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\": \"[username]\"},
\"SESSION\": \"[Session ID from VerifySoftwareToken]\" SELECT_MFA_TYPE
\"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":
\"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"} For more information
about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see
Working with user devices in your user pool.
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action,
Amazon Cognito invokes any functions that you have assigned to the following triggers:
pre sign-up custom message post authentication user migration pre token generation
define auth challenge create auth challenge verify auth challenge response When
Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function
receives as input. This payload contains a clientMetadata attribute that provides the data
that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge
request. In your function code in Lambda, you can process the clientMetadata value to
enhance your workflow for your specific needs. For more information, see Customizing user
pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use
the ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store
the ClientMetadata value. This data is available only to Lambda triggers that are assigned
to a user pool to support custom workflows. If your user pool configuration doesn't include
triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata
value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive
information.
- `"ContextData"`: Contextual data about your user session, such as the device fingerprint,
IP address, or location. Amazon Cognito advanced security evaluates the risk of an
authentication event based on the context that your app generates and passes to Amazon
Cognito when it makes API requests.
- `"Session"`: The session that should be passed both ways in challenge-response calls to
the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the
caller must pass another challenge, it returns a session with other challenge parameters.
This session should be passed as it is to the next RespondToAuthChallenge API call.
"""
function admin_respond_to_auth_challenge(
ChallengeName, ClientId, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminRespondToAuthChallenge",
Dict{String,Any}(
"ChallengeName" => ChallengeName,
"ClientId" => ClientId,
"UserPoolId" => UserPoolId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_respond_to_auth_challenge(
ChallengeName,
ClientId,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminRespondToAuthChallenge",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChallengeName" => ChallengeName,
"ClientId" => ClientId,
"UserPoolId" => UserPoolId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_set_user_mfapreference(user_pool_id, username)
admin_set_user_mfapreference(user_pool_id, username, params::Dict{String,<:Any})
The user's multi-factor authentication (MFA) preference, including which MFA options are
activated, and if any are preferred. Only one factor can be set as preferred. The preferred
MFA factor will be used to authenticate a user if multiple factors are activated. If
multiple options are activated and no preference is set, a challenge to choose an MFA
option will be returned during sign-in. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SMSMfaSettings"`: The SMS text message MFA settings.
- `"SoftwareTokenMfaSettings"`: The time-based one-time password software token MFA
settings.
"""
function admin_set_user_mfapreference(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminSetUserMFAPreference",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_set_user_mfapreference(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminSetUserMFAPreference",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_set_user_password(password, user_pool_id, username)
admin_set_user_password(password, user_pool_id, username, params::Dict{String,<:Any})
Sets the specified user's password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status enters the
FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the
InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge.
If the user doesn't sign in before it expires, the user won't be able to sign in, and an
administrator must reset their password. Once the user has set a new password, or the
password is permanent, the user status is set to Confirmed. AdminSetUserPassword can set a
password for the user profile that Amazon Cognito creates for third-party federated users.
When you set a password, the federated user's status changes from EXTERNAL_PROVIDER to
CONFIRMED. A user in this state can sign in as a federated user, and initiate
authentication flows in the API like a linked native user. They can also modify their
password and attributes in token-authenticated API requests like ChangePassword and
UpdateUserAttributes. As a best security practice and to keep users in sync with your
external IdP, don't set passwords on federated user profiles. To set up a federated user
for native sign-in with a linked native user, refer to Linking federated users to an
existing user profile. Amazon Cognito evaluates Identity and Access Management (IAM)
policies in requests for this API operation. For this operation, you must use IAM
credentials to authorize requests, and you must grant yourself the corresponding IAM
permission in a policy. Learn more Signing Amazon Web Services API Requests Using
the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `password`: The password for the user.
- `user_pool_id`: The user pool ID for the user pool where you want to set the user's
password.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Permanent"`: True if the password is permanent, False if it is temporary.
"""
function admin_set_user_password(
Password, UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminSetUserPassword",
Dict{String,Any}(
"Password" => Password, "UserPoolId" => UserPoolId, "Username" => Username
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_set_user_password(
Password,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminSetUserPassword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Password" => Password,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_set_user_settings(mfaoptions, user_pool_id, username)
admin_set_user_settings(mfaoptions, user_pool_id, username, params::Dict{String,<:Any})
This action is no longer supported. You can use it to configure only SMS MFA. You can't
use it to configure time-based one-time password (TOTP) software token MFA. To configure
either type of MFA, use AdminSetUserMFAPreference instead. Amazon Cognito evaluates
Identity and Access Management (IAM) policies in requests for this API operation. For this
operation, you must use IAM credentials to authorize requests, and you must grant yourself
the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services
API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `mfaoptions`: You can use this parameter only to set an SMS configuration that uses SMS
for delivery.
- `user_pool_id`: The ID of the user pool that contains the user whose options you're
setting.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_set_user_settings(
MFAOptions, UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminSetUserSettings",
Dict{String,Any}(
"MFAOptions" => MFAOptions, "UserPoolId" => UserPoolId, "Username" => Username
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_set_user_settings(
MFAOptions,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminSetUserSettings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MFAOptions" => MFAOptions,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_update_auth_event_feedback(event_id, feedback_value, user_pool_id, username)
admin_update_auth_event_feedback(event_id, feedback_value, user_pool_id, username, params::Dict{String,<:Any})
Provides feedback for an authentication event indicating if it was from a valid user. This
feedback is used for improving the risk evaluation decision for the user pool as part of
Amazon Cognito advanced security. Amazon Cognito evaluates Identity and Access Management
(IAM) policies in requests for this API operation. For this operation, you must use IAM
credentials to authorize requests, and you must grant yourself the corresponding IAM
permission in a policy. Learn more Signing Amazon Web Services API Requests Using
the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `event_id`: The authentication event ID.
- `feedback_value`: The authentication event feedback value. When you provide a
FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where
Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of
invalid, you tell Amazon Cognito that you don't trust a user session, or you don't believe
that Amazon Cognito evaluated a high-enough risk level.
- `user_pool_id`: The user pool ID.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_update_auth_event_feedback(
EventId,
FeedbackValue,
UserPoolId,
Username;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminUpdateAuthEventFeedback",
Dict{String,Any}(
"EventId" => EventId,
"FeedbackValue" => FeedbackValue,
"UserPoolId" => UserPoolId,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_update_auth_event_feedback(
EventId,
FeedbackValue,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminUpdateAuthEventFeedback",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EventId" => EventId,
"FeedbackValue" => FeedbackValue,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_update_device_status(device_key, user_pool_id, username)
admin_update_device_status(device_key, user_pool_id, username, params::Dict{String,<:Any})
Updates the device status as an administrator. Amazon Cognito evaluates Identity and
Access Management (IAM) policies in requests for this API operation. For this operation,
you must use IAM credentials to authorize requests, and you must grant yourself the
corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API
Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `device_key`: The device key.
- `user_pool_id`: The user pool ID.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeviceRememberedStatus"`: The status indicating whether a device has been remembered or
not.
"""
function admin_update_device_status(
DeviceKey, UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminUpdateDeviceStatus",
Dict{String,Any}(
"DeviceKey" => DeviceKey, "UserPoolId" => UserPoolId, "Username" => Username
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_update_device_status(
DeviceKey,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminUpdateDeviceStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeviceKey" => DeviceKey,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_update_user_attributes(user_attributes, user_pool_id, username)
admin_update_user_attributes(user_attributes, user_pool_id, username, params::Dict{String,<:Any})
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
require you to register an origination phone number before you can send SMS messages to US
phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone
number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically.
Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up,
activate their accounts, or sign in. If you have never used SMS text messages with Amazon
Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place
your account in the SMS sandbox. In sandbox mode , you can send messages only to verified
phone numbers. After you test your app while in the sandbox environment, you can move out
of the sandbox and into production. For more information, see SMS message settings for
Amazon Cognito user pools in the Amazon Cognito Developer Guide. Updates the specified
user's attributes, including developer attributes, as an administrator. Works on any user.
To delete an attribute from your user, submit the attribute in your API request with a
blank value. For custom attributes, you must prepend the custom: prefix to the attribute
name. In addition to updating user attributes, this API can also be used to mark phone and
email as verified. Amazon Cognito evaluates Identity and Access Management (IAM) policies
in requests for this API operation. For this operation, you must use IAM credentials to
authorize requests, and you must grant yourself the corresponding IAM permission in a
policy. Learn more Signing Amazon Web Services API Requests Using the Amazon
Cognito user pools API and user pool endpoints
# Arguments
- `user_attributes`: An array of name-value pairs representing user attributes. For custom
attributes, you must prepend the custom: prefix to the attribute name. If your user pool
requires verification before Amazon Cognito updates an attribute value that you specify in
this request, Amazon Cognito doesn’t immediately update the value of that attribute.
After your user receives and responds to a verification message to verify the new value,
Amazon Cognito updates the attribute value. Your user can sign in and receive messages with
the original attribute value until they verify the new value. To update the value of an
attribute that requires verification in the same API request, include the email_verified or
phone_number_verified attribute, with a value of true. If you set the email_verified or
phone_number_verified value for an email or phone_number attribute that requires
verification to true, Amazon Cognito doesn’t send a verification message to your user.
- `user_pool_id`: The user pool ID for the user pool where you want to update user
attributes.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the AdminUpdateUserAttributes API action,
Amazon Cognito invokes the function that is assigned to the custom message trigger. When
Amazon Cognito invokes this function, it passes a JSON payload, which the function receives
as input. This payload contains a clientMetadata attribute, which provides the data that
you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In
your function code in Lambda, you can process the clientMetadata value to enhance your
workflow for your specific needs. For more information, see Customizing user pool
Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the
ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the
ClientMetadata value. This data is available only to Lambda triggers that are assigned to a
user pool to support custom workflows. If your user pool configuration doesn't include
triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata
value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive
information.
"""
function admin_update_user_attributes(
UserAttributes, UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminUpdateUserAttributes",
Dict{String,Any}(
"UserAttributes" => UserAttributes,
"UserPoolId" => UserPoolId,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_update_user_attributes(
UserAttributes,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminUpdateUserAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"UserAttributes" => UserAttributes,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
admin_user_global_sign_out(user_pool_id, username)
admin_user_global_sign_out(user_pool_id, username, params::Dict{String,<:Any})
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.
Call this operation with your administrative credentials when your user signs out of your
app. This results in the following behavior. Amazon Cognito no longer accepts
token-authorized user operations that you authorize with a signed-out user's access tokens.
For more information, see Using the Amazon Cognito user pools API and user pool endpoints.
Amazon Cognito returns an Access Token has been revoked error when your app attempts to
authorize a user pools API request with a revoked access token that contains the scope
aws.cognito.signin.user.admin. Amazon Cognito no longer accepts a signed-out user's ID
token in a GetId request to an identity pool with ServerSideTokenCheck enabled for its
user pool IdP configuration in CognitoIdentityProvider. Amazon Cognito no longer accepts
a signed-out user's refresh tokens in refresh requests. Other requests might be valid
until your user's token expires. Amazon Cognito evaluates Identity and Access Management
(IAM) policies in requests for this API operation. For this operation, you must use IAM
credentials to authorize requests, and you must grant yourself the corresponding IAM
permission in a policy. Learn more Signing Amazon Web Services API Requests Using
the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function admin_user_global_sign_out(
UserPoolId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AdminUserGlobalSignOut",
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function admin_user_global_sign_out(
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"AdminUserGlobalSignOut",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("UserPoolId" => UserPoolId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_software_token()
associate_software_token(params::Dict{String,<:Any})
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a
user, with a unique private key that Amazon Cognito generates and returns in the API
response. You can authorize an AssociateSoftwareToken request with either the user's access
token, or a session string from a challenge response that you received from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a
VerifySoftwareToken API request. If you don't verify the software token and your user pool
doesn't require MFA, the user can then authenticate with user name and password credentials
alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or
SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with
AssociateSoftwareToken and VerifySoftwareToken. After you set up software token MFA for
your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate.
Respond to this challenge with your user's TOTP. Amazon Cognito doesn't evaluate Identity
and Access Management (IAM) policies in requests for this API operation. For this
operation, you can't use IAM credentials to authorize requests, and you can't grant IAM
permissions in policies. For more information about authorization models in Amazon Cognito,
see Using the Amazon Cognito user pools API and user pool endpoints.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessToken"`: A valid access token that Amazon Cognito issued to the user whose
software token you want to generate.
- `"Session"`: The session that should be passed both ways in challenge-response calls to
the service. This allows authentication of the user as part of the MFA setup process.
"""
function associate_software_token(; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"AssociateSoftwareToken"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function associate_software_token(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"AssociateSoftwareToken",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
change_password(access_token, previous_password, proposed_password)
change_password(access_token, previous_password, proposed_password, params::Dict{String,<:Any})
Changes the password for a specified user in a user pool. Authorize this action with a
signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests
for this API operation. For this operation, you can't use IAM credentials to authorize
requests, and you can't grant IAM permissions in policies. For more information about
authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and
user pool endpoints.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user whose
password you want to change.
- `previous_password`: The old password.
- `proposed_password`: The new password.
"""
function change_password(
AccessToken,
PreviousPassword,
ProposedPassword;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ChangePassword",
Dict{String,Any}(
"AccessToken" => AccessToken,
"PreviousPassword" => PreviousPassword,
"ProposedPassword" => ProposedPassword,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function change_password(
AccessToken,
PreviousPassword,
ProposedPassword,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ChangePassword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessToken" => AccessToken,
"PreviousPassword" => PreviousPassword,
"ProposedPassword" => ProposedPassword,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_device(access_token, device_key)
confirm_device(access_token, device_key, params::Dict{String,<:Any})
Confirms tracking of the device. This API call is the call that begins device tracking. For
more information about device authentication, see Working with user devices in your user
pool. Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you can't
use IAM credentials to authorize requests, and you can't grant IAM permissions in policies.
For more information about authorization models in Amazon Cognito, see Using the Amazon
Cognito user pools API and user pool endpoints.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user whose device
you want to confirm.
- `device_key`: The device key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeviceName"`: The device name.
- `"DeviceSecretVerifierConfig"`: The configuration of the device secret verifier.
"""
function confirm_device(
AccessToken, DeviceKey; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"ConfirmDevice",
Dict{String,Any}("AccessToken" => AccessToken, "DeviceKey" => DeviceKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function confirm_device(
AccessToken,
DeviceKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ConfirmDevice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccessToken" => AccessToken, "DeviceKey" => DeviceKey),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_forgot_password(client_id, confirmation_code, password, username)
confirm_forgot_password(client_id, confirmation_code, password, username, params::Dict{String,<:Any})
Allows a user to enter a confirmation code to reset a forgotten password. Amazon Cognito
doesn't evaluate Identity and Access Management (IAM) policies in requests for this API
operation. For this operation, you can't use IAM credentials to authorize requests, and you
can't grant IAM permissions in policies. For more information about authorization models in
Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
# Arguments
- `client_id`: The app client ID of the app associated with the user pool.
- `confirmation_code`: The confirmation code from your user's request to reset their
password. For more information, see ForgotPassword.
- `password`: The new password that your user wants to set.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyticsMetadata"`: The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword calls.
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon
Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon
Cognito invokes this function, it passes a JSON payload, which the function receives as
input. This payload contains a clientMetadata attribute, which provides the data that you
assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your
function code in Lambda, you can process the clientMetadata value to enhance your workflow
for your specific needs. For more information, see Customizing user pool Workflows with
Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata
parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata
value. This data is available only to Lambda triggers that are assigned to a user pool to
support custom workflows. If your user pool configuration doesn't include triggers, the
ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt
the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
- `"SecretHash"`: A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the message. For more
information about SecretHash, see Computing secret hash values.
- `"UserContextData"`: Contextual data about your user session, such as the device
fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk
of an authentication event based on the context that your app generates and passes to
Amazon Cognito when it makes API requests.
"""
function confirm_forgot_password(
ClientId,
ConfirmationCode,
Password,
Username;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ConfirmForgotPassword",
Dict{String,Any}(
"ClientId" => ClientId,
"ConfirmationCode" => ConfirmationCode,
"Password" => Password,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function confirm_forgot_password(
ClientId,
ConfirmationCode,
Password,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ConfirmForgotPassword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientId" => ClientId,
"ConfirmationCode" => ConfirmationCode,
"Password" => Password,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_sign_up(client_id, confirmation_code, username)
confirm_sign_up(client_id, confirmation_code, username, params::Dict{String,<:Any})
This public API operation provides a code that Amazon Cognito sent to your user when they
signed up in your user pool via the SignUp API operation. After your user enters their
code, they confirm ownership of the email address or phone number that they provided, and
their user account becomes active. Depending on your user pool configuration, your users
will receive their confirmation code in an email or SMS message. Local users who signed up
in your user pool are the only type of user who can confirm sign-up with a code. Users who
federate through an external identity provider (IdP) have already been confirmed by their
IdP. Administrator-created users, users created with the AdminCreateUser API operation,
confirm their accounts when they respond to their invitation email message and choose a
password. They do not receive a confirmation code. Instead, they receive a temporary
password. Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in
requests for this API operation. For this operation, you can't use IAM credentials to
authorize requests, and you can't grant IAM permissions in policies. For more information
about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API
and user pool endpoints.
# Arguments
- `client_id`: The ID of the app client associated with the user pool.
- `confirmation_code`: The confirmation code sent by a user's request to confirm
registration.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyticsMetadata"`: The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmSignUp calls.
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito
invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito
invokes this function, it passes a JSON payload, which the function receives as input. This
payload contains a clientMetadata attribute, which provides the data that you assigned to
the ClientMetadata parameter in your ConfirmSignUp request. In your function code in
Lambda, you can process the clientMetadata value to enhance your workflow for your specific
needs. For more information, see Customizing user pool Workflows with Lambda Triggers in
the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember
that Amazon Cognito won't do the following: Store the ClientMetadata value. This data is
available only to Lambda triggers that are assigned to a user pool to support custom
workflows. If your user pool configuration doesn't include triggers, the ClientMetadata
parameter serves no purpose. Validate the ClientMetadata value. Encrypt the
ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
- `"ForceAliasCreation"`: Boolean to be specified to force user confirmation irrespective
of existing alias. By default set to False. If this parameter is set to True and the phone
number/email used for sign up confirmation already exists as an alias with a different
user, the API call will migrate the alias from the previous user to the newly created user
being confirmed. If set to False, the API will throw an AliasExistsException error.
- `"SecretHash"`: A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the message.
- `"UserContextData"`: Contextual data about your user session, such as the device
fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk
of an authentication event based on the context that your app generates and passes to
Amazon Cognito when it makes API requests.
"""
function confirm_sign_up(
ClientId, ConfirmationCode, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"ConfirmSignUp",
Dict{String,Any}(
"ClientId" => ClientId,
"ConfirmationCode" => ConfirmationCode,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function confirm_sign_up(
ClientId,
ConfirmationCode,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ConfirmSignUp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientId" => ClientId,
"ConfirmationCode" => ConfirmationCode,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group(group_name, user_pool_id)
create_group(group_name, user_pool_id, params::Dict{String,<:Any})
Creates a new group in the specified user pool. Amazon Cognito evaluates Identity and
Access Management (IAM) policies in requests for this API operation. For this operation,
you must use IAM credentials to authorize requests, and you must grant yourself the
corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API
Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `group_name`: The name of the group. Must be unique.
- `user_pool_id`: The user pool ID for the user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A string containing the description of the group.
- `"Precedence"`: A non-negative integer value that specifies the precedence of this group
relative to the other groups that a user can belong to in the user pool. Zero is the
highest precedence value. Groups with lower Precedence values take precedence over groups
with higher or null Precedence values. If a user belongs to two or more groups, it is the
group with the lowest precedence value whose role ARN is given in the user's tokens for the
cognito:roles and cognito:preferred_role claims. Two groups can have the same Precedence
value. If this happens, neither group takes precedence over the other. If two groups with
the same Precedence have the same role ARN, that role is used in the cognito:preferred_role
claim in tokens for users in each group. If the two groups have different role ARNs, the
cognito:preferred_role claim isn't set in users' tokens. The default Precedence value is
null. The maximum Precedence value is 2^31-1.
- `"RoleArn"`: The role Amazon Resource Name (ARN) for the group.
"""
function create_group(
GroupName, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"CreateGroup",
Dict{String,Any}("GroupName" => GroupName, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group(
GroupName,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"CreateGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_identity_provider(provider_details, provider_name, provider_type, user_pool_id)
create_identity_provider(provider_details, provider_name, provider_type, user_pool_id, params::Dict{String,<:Any})
Adds a configuration and trust relationship between a third-party identity provider (IdP)
and a user pool. Amazon Cognito evaluates Identity and Access Management (IAM) policies in
requests for this API operation. For this operation, you must use IAM credentials to
authorize requests, and you must grant yourself the corresponding IAM permission in a
policy. Learn more Signing Amazon Web Services API Requests Using the Amazon
Cognito user pools API and user pool endpoints
# Arguments
- `provider_details`: The scopes, URLs, and identifiers for your external identity
provider. The following examples describe the provider detail keys for each IdP type. These
values and their schema are subject to change. Social IdP authorize_scopes values must
match the values listed here. OpenID Connect (OIDC) Amazon Cognito accepts the following
elements when it can't discover endpoint URLs from oidc_issuer: attributes_url,
authorize_url, jwks_uri, token_url. Create or update request: \"ProviderDetails\": {
\"attributes_request_method\": \"GET\", \"attributes_url\":
\"https://auth.example.com/userInfo\", \"authorize_scopes\": \"openid profile email\",
\"authorize_url\": \"https://auth.example.com/authorize\", \"client_id\":
\"1example23456789\", \"client_secret\": \"provider-app-client-secret\", \"jwks_uri\":
\"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":
\"https://auth.example.com\", \"token_url\": \"https://example.com/token\" } Describe
response: \"ProviderDetails\": { \"attributes_request_method\": \"GET\",
\"attributes_url\": \"https://auth.example.com/userInfo\",
\"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"openid profile
email\", \"authorize_url\": \"https://auth.example.com/authorize\", \"client_id\":
\"1example23456789\", \"client_secret\": \"provider-app-client-secret\", \"jwks_uri\":
\"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":
\"https://auth.example.com\", \"token_url\": \"https://example.com/token\" } SAML Create
or update request with Metadata URL: \"ProviderDetails\": { \"IDPInit\": \"true\",
\"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"MetadataURL\":
\"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\": \"rsa-sha256\"
} Create or update request with Metadata file: \"ProviderDetails\": { \"IDPInit\":
\"true\", \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"MetadataFile\":
\"[metadata XML]\", \"RequestSigningAlgorithm\": \"rsa-sha256\" } The value of
MetadataFile must be the plaintext metadata document with all quote (\") characters escaped
by backslashes. Describe response: \"ProviderDetails\": { \"IDPInit\": \"true\",
\"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\",
\"ActiveEncryptionCertificate\": \"[certificate]\", \"MetadataURL\":
\"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\":
\"rsa-sha256\", \"SLORedirectBindingURI\": \"https://auth.example.com/slo/saml\",
\"SSORedirectBindingURI\": \"https://auth.example.com/sso/saml\" } LoginWithAmazon
Create or update request: \"ProviderDetails\": { \"authorize_scopes\": \"profile
postal_code\", \"client_id\": \"amzn1.application-oa2-client.1example23456789\",
\"client_secret\": \"provider-app-client-secret\" Describe response: \"ProviderDetails\":
{ \"attributes_url\": \"https://api.amazon.com/user/profile\",
\"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"profile
postal_code\", \"authorize_url\": \"https://www.amazon.com/ap/oa\", \"client_id\":
\"amzn1.application-oa2-client.1example23456789\", \"client_secret\":
\"provider-app-client-secret\", \"token_request_method\": \"POST\", \"token_url\":
\"https://api.amazon.com/auth/o2/token\" } Google Create or update request:
\"ProviderDetails\": { \"authorize_scopes\": \"email profile openid\", \"client_id\":
\"1example23456789.apps.googleusercontent.com\", \"client_secret\":
\"provider-app-client-secret\" } Describe response: \"ProviderDetails\": {
\"attributes_url\": \"https://people.googleapis.com/v1/people/me?personFields=\",
\"attributes_url_add_attributes\": \"true\", \"authorize_scopes\": \"email profile
openid\", \"authorize_url\": \"https://accounts.google.com/o/oauth2/v2/auth\",
\"client_id\": \"1example23456789.apps.googleusercontent.com\", \"client_secret\":
\"provider-app-client-secret\", \"oidc_issuer\": \"https://accounts.google.com\",
\"token_request_method\": \"POST\", \"token_url\":
\"https://www.googleapis.com/oauth2/v4/token\" } SignInWithApple Create or update
request: \"ProviderDetails\": { \"authorize_scopes\": \"email name\", \"client_id\":
\"com.example.cognito\", \"private_key\": \"1EXAMPLE\", \"key_id\": \"2EXAMPLE\",
\"team_id\": \"3EXAMPLE\" } Describe response: \"ProviderDetails\": {
\"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"email name\",
\"authorize_url\": \"https://appleid.apple.com/auth/authorize\", \"client_id\":
\"com.example.cognito\", \"key_id\": \"1EXAMPLE\", \"oidc_issuer\":
\"https://appleid.apple.com\", \"team_id\": \"2EXAMPLE\", \"token_request_method\":
\"POST\", \"token_url\": \"https://appleid.apple.com/auth/token\" } Facebook Create or
update request: \"ProviderDetails\": { \"api_version\": \"v17.0\", \"authorize_scopes\":
\"public_profile, email\", \"client_id\": \"1example23456789\", \"client_secret\":
\"provider-app-client-secret\" } Describe response: \"ProviderDetails\": {
\"api_version\": \"v17.0\", \"attributes_url\":
\"https://graph.facebook.com/v17.0/me?fields=\", \"attributes_url_add_attributes\":
\"true\", \"authorize_scopes\": \"public_profile, email\", \"authorize_url\":
\"https://www.facebook.com/v17.0/dialog/oauth\", \"client_id\": \"1example23456789\",
\"client_secret\": \"provider-app-client-secret\", \"token_request_method\": \"GET\",
\"token_url\": \"https://graph.facebook.com/v17.0/oauth/access_token\" }
- `provider_name`: The IdP name.
- `provider_type`: The IdP type.
- `user_pool_id`: The user pool ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeMapping"`: A mapping of IdP attributes to standard and custom user pool
attributes.
- `"IdpIdentifiers"`: A list of IdP identifiers.
"""
function create_identity_provider(
ProviderDetails,
ProviderName,
ProviderType,
UserPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"CreateIdentityProvider",
Dict{String,Any}(
"ProviderDetails" => ProviderDetails,
"ProviderName" => ProviderName,
"ProviderType" => ProviderType,
"UserPoolId" => UserPoolId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_identity_provider(
ProviderDetails,
ProviderName,
ProviderType,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"CreateIdentityProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProviderDetails" => ProviderDetails,
"ProviderName" => ProviderName,
"ProviderType" => ProviderType,
"UserPoolId" => UserPoolId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resource_server(identifier, name, user_pool_id)
create_resource_server(identifier, name, user_pool_id, params::Dict{String,<:Any})
Creates a new OAuth2.0 resource server and defines custom scopes within it. Amazon Cognito
evaluates Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you must use IAM credentials to authorize requests, and you must grant
yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web
Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `identifier`: A unique resource server identifier for the resource server. The identifier
can be an API friendly name like solar-system-data. You can also set an API URL like
https://solar-system-data-api.example.com as your identifier. Amazon Cognito represents
scopes in the access token in the format resource-server-identifier/scope. Longer
scope-identifier strings increase the size of your access tokens.
- `name`: A friendly name for the resource server.
- `user_pool_id`: The user pool ID for the user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Scopes"`: A list of scopes. Each scope is a key-value map with the keys name and
description.
"""
function create_resource_server(
Identifier, Name, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"CreateResourceServer",
Dict{String,Any}(
"Identifier" => Identifier, "Name" => Name, "UserPoolId" => UserPoolId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_server(
Identifier,
Name,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"CreateResourceServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Identifier" => Identifier, "Name" => Name, "UserPoolId" => UserPoolId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_import_job(cloud_watch_logs_role_arn, job_name, user_pool_id)
create_user_import_job(cloud_watch_logs_role_arn, job_name, user_pool_id, params::Dict{String,<:Any})
Creates a user import job. Amazon Cognito evaluates Identity and Access Management (IAM)
policies in requests for this API operation. For this operation, you must use IAM
credentials to authorize requests, and you must grant yourself the corresponding IAM
permission in a policy. Learn more Signing Amazon Web Services API Requests Using
the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `cloud_watch_logs_role_arn`: The role ARN for the Amazon CloudWatch Logs Logging role for
the user import job.
- `job_name`: The job name for the user import job.
- `user_pool_id`: The user pool ID for the user pool that the users are being imported into.
"""
function create_user_import_job(
CloudWatchLogsRoleArn,
JobName,
UserPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"CreateUserImportJob",
Dict{String,Any}(
"CloudWatchLogsRoleArn" => CloudWatchLogsRoleArn,
"JobName" => JobName,
"UserPoolId" => UserPoolId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_import_job(
CloudWatchLogsRoleArn,
JobName,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"CreateUserImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CloudWatchLogsRoleArn" => CloudWatchLogsRoleArn,
"JobName" => JobName,
"UserPoolId" => UserPoolId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_pool(pool_name)
create_user_pool(pool_name, params::Dict{String,<:Any})
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
require you to register an origination phone number before you can send SMS messages to US
phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone
number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically.
Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up,
activate their accounts, or sign in. If you have never used SMS text messages with Amazon
Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place
your account in the SMS sandbox. In sandbox mode , you can send messages only to verified
phone numbers. After you test your app while in the sandbox environment, you can move out
of the sandbox and into production. For more information, see SMS message settings for
Amazon Cognito user pools in the Amazon Cognito Developer Guide. Creates a new Amazon
Cognito user pool and sets the password policy for the pool. If you don't provide a value
for an attribute, Amazon Cognito sets it to its default value. Amazon Cognito evaluates
Identity and Access Management (IAM) policies in requests for this API operation. For this
operation, you must use IAM credentials to authorize requests, and you must grant yourself
the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services
API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `pool_name`: A string used to name the user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountRecoverySetting"`: The available verified method a user can use to recover their
password when they call ForgotPassword. You can use this setting to define a preferred
method when a user has more than one method available. With this setting, SMS doesn't
qualify for a valid password recovery mechanism if the user also has SMS multi-factor
authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the
legacy behavior to determine the recovery method where SMS is preferred through email.
- `"AdminCreateUserConfig"`: The configuration for AdminCreateUser requests.
- `"AliasAttributes"`: Attributes supported as an alias for this user pool. Possible
values: phone_number, email, or preferred_username.
- `"AutoVerifiedAttributes"`: The attributes to be auto-verified. Possible values: email,
phone_number.
- `"DeletionProtection"`: When active, DeletionProtection prevents accidental deletion of
your user pool. Before you can delete a user pool that you have protected against deletion,
you must deactivate this feature. When you try to delete a protected user pool in a
DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To
delete a protected user pool, send a new DeleteUserPool request after you deactivate
deletion protection in an UpdateUserPool API request.
- `"DeviceConfiguration"`: The device-remembering configuration for a user pool. A null
value indicates that you have deactivated device remembering in your user pool. When you
provide a value for any DeviceConfiguration field, you activate the Amazon Cognito
device-remembering feature.
- `"EmailConfiguration"`: The email configuration of your user pool. The email
configuration type sets your preferred sending method, Amazon Web Services Region, and
sender for messages from your user pool.
- `"EmailVerificationMessage"`: This parameter is no longer used. See
VerificationMessageTemplateType.
- `"EmailVerificationSubject"`: This parameter is no longer used. See
VerificationMessageTemplateType.
- `"LambdaConfig"`: The Lambda trigger configuration information for the new user pool. In
a push model, event sources (such as Amazon S3 and custom applications) need permission to
invoke a function. So you must make an extra call to add permission for these event sources
to invoke your Lambda function. For more information on using the Lambda API to add
permission, see AddPermission . For adding permission using the CLI, see add-permission .
- `"MfaConfiguration"`: Specifies MFA configuration details.
- `"Policies"`: The policies associated with the new user pool.
- `"Schema"`: An array of schema attributes for the new user pool. These attributes can be
standard or custom attributes.
- `"SmsAuthenticationMessage"`: A string representing the SMS authentication message.
- `"SmsConfiguration"`: The SMS configuration with the settings that your Amazon Cognito
user pool must use to send an SMS message from your Amazon Web Services account through
Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web
Services Region that you want, the Amazon Cognito user pool uses an Identity and Access
Management (IAM) role in your Amazon Web Services account.
- `"SmsVerificationMessage"`: This parameter is no longer used. See
VerificationMessageTemplateType.
- `"UserAttributeUpdateSettings"`: The settings for updates to user attributes. These
settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool
setting that tells Amazon Cognito how to handle changes to the value of your users' email
address and phone number attributes. For more information, see Verifying updates to email
addresses and phone numbers.
- `"UserPoolAddOns"`: User pool add-ons. Contains settings for activation of advanced
security features. To log user security information but take no action, set to AUDIT. To
configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
- `"UserPoolTags"`: The tag keys and values to assign to the user pool. A tag is a label
that you can use to categorize and manage user pools in different ways, such as by purpose,
owner, environment, or other criteria.
- `"UsernameAttributes"`: Specifies whether a user can use an email address or phone number
as a username when they sign up.
- `"UsernameConfiguration"`: Case sensitivity on the username input for the selected
sign-in option. When case sensitivity is set to False (case insensitive), users can sign in
with any combination of capital and lowercase letters. For example, username, USERNAME, or
UserName, or for email, [email protected] or [email protected]. For most use cases, set
case sensitivity to False (case insensitive) as a best practice. When usernames and email
addresses are case insensitive, Amazon Cognito treats any variation in case as the same
user, and prevents a case variation from being assigned to the same attribute for a
different user. This configuration is immutable after you set it. For more information, see
UsernameConfigurationType.
- `"VerificationMessageTemplate"`: The template for the verification message that the user
sees when the app requests permission to access the user's information.
"""
function create_user_pool(PoolName; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"CreateUserPool",
Dict{String,Any}("PoolName" => PoolName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_pool(
PoolName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"CreateUserPool",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PoolName" => PoolName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_pool_client(client_name, user_pool_id)
create_user_pool_client(client_name, user_pool_id, params::Dict{String,<:Any})
Creates the user pool client. When you create a new user pool client, token revocation is
automatically activated. For more information about revoking tokens, see RevokeToken. If
you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this
API operation. For this operation, you must use IAM credentials to authorize requests, and
you must grant yourself the corresponding IAM permission in a policy. Learn more
Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and
user pool endpoints
# Arguments
- `client_name`: The client name for the user pool client you would like to create.
- `user_pool_id`: The user pool ID for the user pool where you want to create a user pool
client.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessTokenValidity"`: The access token time limit. After this limit expires, your user
can't use their access token. To specify the time unit for AccessTokenValidity as seconds,
minutes, hours, or days, set a TokenValidityUnits value in your API request. For example,
when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can
authorize access with their access token for 10 hours. The default time unit for
AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens
are valid for one hour.
- `"AllowedOAuthFlows"`: The OAuth grant types that you want your app client to generate.
To create an app client that generates client credentials grants, you must add
client_credentials as the only allowed OAuth flow. code Use a code grant flow, which
provides an authorization code as the response. This code can be exchanged for access
tokens with the /oauth2/token endpoint. implicit Issue the access token (and, optionally,
ID token, based on scopes) directly to your user. client_credentials Issue the access
token from the /oauth2/token endpoint directly to a non-person user using a combination of
the client ID and client secret.
- `"AllowedOAuthFlowsUserPoolClient"`: Set to true to use OAuth 2.0 features in your user
pool app client. AllowedOAuthFlowsUserPoolClient must be true before you can configure the
following features in your app client. CallBackURLs: Callback URLs. LogoutURLs:
Sign-out redirect URLs. AllowedOAuthScopes: OAuth 2.0 scopes. AllowedOAuthFlows:
Support for authorization code, implicit, and client credentials OAuth 2.0 grants. To use
OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient
API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with
the CLI or SDKs, it defaults to false.
- `"AllowedOAuthScopes"`: The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and profile. Possible values provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
- `"AnalyticsConfiguration"`: The user pool analytics configuration for collecting metrics
and sending them to your Amazon Pinpoint campaign. In Amazon Web Services Regions where
Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint
projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is
available, user pools support sending events to Amazon Pinpoint projects within that same
Region.
- `"AuthSessionValidity"`: Amazon Cognito creates a session token for each API request in
an authentication flow. AuthSessionValidity is the duration, in minutes, of that session
token. Your user pool native user must respond to each authentication challenge before the
session expires.
- `"CallbackURLs"`: A list of allowed redirect (callback) URLs for the IdPs. A redirect URI
must: Be an absolute URI. Be registered with the authorization server. Not include a
fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS
over HTTP except for http://localhost for testing purposes only. App callback URLs such as
myapp://example are also supported.
- `"DefaultRedirectURI"`: The default redirect URI. In app clients with one assigned IdP,
replaces redirect_uri in authentication requests. Must be in the CallbackURLs list. A
redirect URI must: Be an absolute URI. Be registered with the authorization server.
Not include a fragment component. For more information, see Default redirect URI. Amazon
Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App
callback URLs such as myapp://example are also supported.
- `"EnablePropagateAdditionalUserContextData"`: Activates the propagation of additional
user context data. For more information about propagation of user context data, see Adding
advanced security to a user pool. If you don’t include this parameter, you can't send
device fingerprint information, including source IP address, to Amazon Cognito advanced
security. You can only activate EnablePropagateAdditionalUserContextData in an app client
that has a client secret.
- `"EnableTokenRevocation"`: Activates or deactivates token revocation. For more
information about revoking tokens, see RevokeToken. If you don't include this parameter,
token revocation is automatically activated for the new user pool client.
- `"ExplicitAuthFlows"`: The authentication flows that you want your user pool client to
support. For each app client in your user pool, you can sign in your users with any
combination of one or more flows, including with a user name and Secure Remote Password
(SRP), a user name and password, or a custom authentication process that you define with
Lambda functions. If you don't specify a value for ExplicitAuthFlows, your user client
supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH. Valid
values include: ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password
authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH
setting. With this authentication flow, your app passes a user name and password to Amazon
Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to
securely transmit the password. ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication. ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In
this flow, Amazon Cognito receives the password in the request instead of using the SRP
protocol to verify passwords. ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. In some environments, you
will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You
can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as
values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.
- `"GenerateSecret"`: Boolean to specify whether you want to generate a secret for the user
pool client being created.
- `"IdTokenValidity"`: The ID token time limit. After this limit expires, your user can't
use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes,
hours, or days, set a TokenValidityUnits value in your API request. For example, when you
set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their
session with their ID token for 10 hours. The default time unit for IdTokenValidity in an
API request is hours. Valid range is displayed below in seconds. If you don't specify
otherwise in the configuration of your app client, your ID tokens are valid for one hour.
- `"LogoutURLs"`: A list of allowed logout URLs for the IdPs.
- `"PreventUserExistenceErrors"`: Errors and responses that you want Amazon Cognito APIs to
return during authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the user doesn't exist,
authentication returns an error indicating either the username or password was incorrect.
Account confirmation and password recovery return a response indicating a code was sent to
a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool. Valid values include: ENABLED -
This prevents user existence-related errors. LEGACY - This represents the early behavior
of Amazon Cognito where user existence related errors aren't prevented.
- `"ReadAttributes"`: The list of user attributes that you want your app client to have
read-only access to. After your user authenticates in your app, their access token
authorizes them to read their own attribute value for any attribute in this list. An
example of this kind of activity is when your user selects a link to view their profile
information. Your app makes a GetUser API request to retrieve and display your user's
profile data. When you don't specify the ReadAttributes for your app client, your app can
read the values of email_verified, phone_number_verified, and the Standard attributes of
your user pool. When your user pool has read access to these default attributes,
ReadAttributes doesn't return any information. Amazon Cognito only populates ReadAttributes
in the API response if you have specified your own custom set of read attributes.
- `"RefreshTokenValidity"`: The refresh token time limit. After this limit expires, your
user can't use their refresh token. To specify the time unit for RefreshTokenValidity as
seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For
example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user
can refresh their session and retrieve new access and ID tokens for 10 days. The default
time unit for RefreshTokenValidity in an API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default
value of 30 days. Valid range is displayed below in seconds. If you don't specify otherwise
in the configuration of your app client, your refresh tokens are valid for 30 days.
- `"SupportedIdentityProviders"`: A list of provider names for the identity providers
(IdPs) that are supported on this client. The following are supported: COGNITO, Facebook,
Google, SignInWithApple, and LoginWithAmazon. You can also specify the names that you
configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP.
- `"TokenValidityUnits"`: The units in which the validity times are represented. The
default unit for RefreshToken is days, and default for ID and access tokens are hours.
- `"WriteAttributes"`: The list of user attributes that you want your app client to have
write access to. After your user authenticates in your app, their access token authorizes
them to set or modify their own attribute value for any attribute in this list. An example
of this kind of activity is when you present your user with a form to update their profile
information and they change their last name. Your app then makes an UpdateUserAttributes
API request and sets family_name to the new value. When you don't specify the
WriteAttributes for your app client, your app can write the values of the Standard
attributes of your user pool. When your user pool has write access to these default
attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates
WriteAttributes in the API response if you have specified your own custom set of write
attributes. If your app client allows users to sign in through an IdP, this array must
include all attributes that you have mapped to IdP attributes. Amazon Cognito updates
mapped attributes when users sign in to your application through an IdP. If your app client
does not have write access to a mapped attribute, Amazon Cognito throws an error when it
tries to update the attribute. For more information, see Specifying IdP Attribute Mappings
for Your user pool.
"""
function create_user_pool_client(
ClientName, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"CreateUserPoolClient",
Dict{String,Any}("ClientName" => ClientName, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_pool_client(
ClientName,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"CreateUserPoolClient",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientName" => ClientName, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_pool_domain(domain, user_pool_id)
create_user_pool_domain(domain, user_pool_id, params::Dict{String,<:Any})
Creates a new domain for a user pool. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `domain`: The domain string. For custom domains, this is the fully-qualified domain name,
such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such
as auth.
- `user_pool_id`: The user pool ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomDomainConfig"`: The configuration for a custom domain that hosts the sign-up and
sign-in webpages for your application. Provide this parameter only if you want to use a
custom domain for your user pool. Otherwise, you can exclude this parameter and use the
Amazon Cognito hosted domain instead. For more information about the hosted domain and
custom domains, see Configuring a User Pool Domain.
"""
function create_user_pool_domain(
Domain, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"CreateUserPoolDomain",
Dict{String,Any}("Domain" => Domain, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_pool_domain(
Domain,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"CreateUserPoolDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Domain" => Domain, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group(group_name, user_pool_id)
delete_group(group_name, user_pool_id, params::Dict{String,<:Any})
Deletes a group. Calling this action requires developer credentials.
# Arguments
- `group_name`: The name of the group.
- `user_pool_id`: The user pool ID for the user pool.
"""
function delete_group(
GroupName, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DeleteGroup",
Dict{String,Any}("GroupName" => GroupName, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group(
GroupName,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DeleteGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_identity_provider(provider_name, user_pool_id)
delete_identity_provider(provider_name, user_pool_id, params::Dict{String,<:Any})
Deletes an IdP for a user pool.
# Arguments
- `provider_name`: The IdP name.
- `user_pool_id`: The user pool ID.
"""
function delete_identity_provider(
ProviderName, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DeleteIdentityProvider",
Dict{String,Any}("ProviderName" => ProviderName, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_identity_provider(
ProviderName,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DeleteIdentityProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProviderName" => ProviderName, "UserPoolId" => UserPoolId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_server(identifier, user_pool_id)
delete_resource_server(identifier, user_pool_id, params::Dict{String,<:Any})
Deletes a resource server.
# Arguments
- `identifier`: The identifier for the resource server.
- `user_pool_id`: The user pool ID for the user pool that hosts the resource server.
"""
function delete_resource_server(
Identifier, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DeleteResourceServer",
Dict{String,Any}("Identifier" => Identifier, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_server(
Identifier,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DeleteResourceServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Identifier" => Identifier, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(access_token)
delete_user(access_token, params::Dict{String,<:Any})
Allows a user to delete their own user profile. Authorize this action with a signed-in
user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon
Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this
API operation. For this operation, you can't use IAM credentials to authorize requests, and
you can't grant IAM permissions in policies. For more information about authorization
models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool
endpoints.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user whose user
profile you want to delete.
"""
function delete_user(AccessToken; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"DeleteUser",
Dict{String,Any}("AccessToken" => AccessToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
AccessToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DeleteUser",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccessToken" => AccessToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_attributes(access_token, user_attribute_names)
delete_user_attributes(access_token, user_attribute_names, params::Dict{String,<:Any})
Deletes the attributes for a user. Authorize this action with a signed-in user's access
token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't
evaluate Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you can't use IAM credentials to authorize requests, and you can't
grant IAM permissions in policies. For more information about authorization models in
Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user whose
attributes you want to delete.
- `user_attribute_names`: An array of strings representing the user attribute names you
want to delete. For custom attributes, you must prependattach the custom: prefix to the
front of the attribute name.
"""
function delete_user_attributes(
AccessToken, UserAttributeNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DeleteUserAttributes",
Dict{String,Any}(
"AccessToken" => AccessToken, "UserAttributeNames" => UserAttributeNames
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_attributes(
AccessToken,
UserAttributeNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DeleteUserAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessToken" => AccessToken, "UserAttributeNames" => UserAttributeNames
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_pool(user_pool_id)
delete_user_pool(user_pool_id, params::Dict{String,<:Any})
Deletes the specified Amazon Cognito user pool.
# Arguments
- `user_pool_id`: The user pool ID for the user pool you want to delete.
"""
function delete_user_pool(UserPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"DeleteUserPool",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_pool(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DeleteUserPool",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_pool_client(client_id, user_pool_id)
delete_user_pool_client(client_id, user_pool_id, params::Dict{String,<:Any})
Allows the developer to delete the user pool client.
# Arguments
- `client_id`: The app client ID of the app associated with the user pool.
- `user_pool_id`: The user pool ID for the user pool where you want to delete the client.
"""
function delete_user_pool_client(
ClientId, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DeleteUserPoolClient",
Dict{String,Any}("ClientId" => ClientId, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_pool_client(
ClientId,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DeleteUserPoolClient",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientId" => ClientId, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_pool_domain(domain, user_pool_id)
delete_user_pool_domain(domain, user_pool_id, params::Dict{String,<:Any})
Deletes a domain for a user pool.
# Arguments
- `domain`: The domain string. For custom domains, this is the fully-qualified domain name,
such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such
as auth.
- `user_pool_id`: The user pool ID.
"""
function delete_user_pool_domain(
Domain, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DeleteUserPoolDomain",
Dict{String,Any}("Domain" => Domain, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_pool_domain(
Domain,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DeleteUserPoolDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Domain" => Domain, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_identity_provider(provider_name, user_pool_id)
describe_identity_provider(provider_name, user_pool_id, params::Dict{String,<:Any})
Gets information about a specific IdP.
# Arguments
- `provider_name`: The IdP name.
- `user_pool_id`: The user pool ID.
"""
function describe_identity_provider(
ProviderName, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DescribeIdentityProvider",
Dict{String,Any}("ProviderName" => ProviderName, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_identity_provider(
ProviderName,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DescribeIdentityProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProviderName" => ProviderName, "UserPoolId" => UserPoolId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resource_server(identifier, user_pool_id)
describe_resource_server(identifier, user_pool_id, params::Dict{String,<:Any})
Describes a resource server.
# Arguments
- `identifier`: A unique resource server identifier for the resource server. The identifier
can be an API friendly name like solar-system-data. You can also set an API URL like
https://solar-system-data-api.example.com as your identifier. Amazon Cognito represents
scopes in the access token in the format resource-server-identifier/scope. Longer
scope-identifier strings increase the size of your access tokens.
- `user_pool_id`: The user pool ID for the user pool that hosts the resource server.
"""
function describe_resource_server(
Identifier, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DescribeResourceServer",
Dict{String,Any}("Identifier" => Identifier, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_resource_server(
Identifier,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DescribeResourceServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Identifier" => Identifier, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_risk_configuration(user_pool_id)
describe_risk_configuration(user_pool_id, params::Dict{String,<:Any})
Describes the risk configuration.
# Arguments
- `user_pool_id`: The user pool ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientId"`: The app client ID.
"""
function describe_risk_configuration(
UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DescribeRiskConfiguration",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_risk_configuration(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DescribeRiskConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user_import_job(job_id, user_pool_id)
describe_user_import_job(job_id, user_pool_id, params::Dict{String,<:Any})
Describes the user import job.
# Arguments
- `job_id`: The job ID for the user import job.
- `user_pool_id`: The user pool ID for the user pool that the users are being imported into.
"""
function describe_user_import_job(
JobId, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DescribeUserImportJob",
Dict{String,Any}("JobId" => JobId, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user_import_job(
JobId,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DescribeUserImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("JobId" => JobId, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user_pool(user_pool_id)
describe_user_pool(user_pool_id, params::Dict{String,<:Any})
Returns the configuration information and metadata of the specified user pool. Amazon
Cognito evaluates Identity and Access Management (IAM) policies in requests for this API
operation. For this operation, you must use IAM credentials to authorize requests, and you
must grant yourself the corresponding IAM permission in a policy. Learn more Signing
Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool
endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool you want to describe.
"""
function describe_user_pool(UserPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"DescribeUserPool",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user_pool(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DescribeUserPool",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user_pool_client(client_id, user_pool_id)
describe_user_pool_client(client_id, user_pool_id, params::Dict{String,<:Any})
Client method for returning the configuration information and metadata of the specified
user pool app client. Amazon Cognito evaluates Identity and Access Management (IAM)
policies in requests for this API operation. For this operation, you must use IAM
credentials to authorize requests, and you must grant yourself the corresponding IAM
permission in a policy. Learn more Signing Amazon Web Services API Requests Using
the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `client_id`: The app client ID of the app associated with the user pool.
- `user_pool_id`: The user pool ID for the user pool you want to describe.
"""
function describe_user_pool_client(
ClientId, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DescribeUserPoolClient",
Dict{String,Any}("ClientId" => ClientId, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user_pool_client(
ClientId,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"DescribeUserPoolClient",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientId" => ClientId, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user_pool_domain(domain)
describe_user_pool_domain(domain, params::Dict{String,<:Any})
Gets information about a domain.
# Arguments
- `domain`: The domain string. For custom domains, this is the fully-qualified domain name,
such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such
as auth.
"""
function describe_user_pool_domain(
Domain; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DescribeUserPoolDomain",
Dict{String,Any}("Domain" => Domain);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user_pool_domain(
Domain, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"DescribeUserPoolDomain",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Domain" => Domain), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
forget_device(device_key)
forget_device(device_key, params::Dict{String,<:Any})
Forgets the specified device. For more information about device authentication, see Working
with user devices in your user pool. Authorize this action with a signed-in user's access
token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't
evaluate Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you can't use IAM credentials to authorize requests, and you can't
grant IAM permissions in policies. For more information about authorization models in
Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
# Arguments
- `device_key`: The device key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessToken"`: A valid access token that Amazon Cognito issued to the user whose
registered device you want to forget.
"""
function forget_device(DeviceKey; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"ForgetDevice",
Dict{String,Any}("DeviceKey" => DeviceKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function forget_device(
DeviceKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ForgetDevice",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DeviceKey" => DeviceKey), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
forgot_password(client_id, username)
forgot_password(client_id, username, params::Dict{String,<:Any})
Calling this API causes a message to be sent to the end user with a confirmation code that
is required to change the user's password. For the Username parameter, you can use the
username or user alias. The method used to send the confirmation code is sent according to
the specified AccountRecoverySetting. For more information, see Recovering User Accounts in
the Amazon Cognito Developer Guide. To use the confirmation code for resetting the
password, call ConfirmForgotPassword. If neither a verified phone number nor a verified
email exists, this API returns InvalidParameterException. If your app client has a client
secret and you don't provide a SECRET_HASH parameter, this API returns
NotAuthorizedException. To use this API operation, your user pool must have self-service
account recovery configured. Use AdminSetUserPassword if you manage passwords as an
administrator. Amazon Cognito doesn't evaluate Identity and Access Management (IAM)
policies in requests for this API operation. For this operation, you can't use IAM
credentials to authorize requests, and you can't grant IAM permissions in policies. For
more information about authorization models in Amazon Cognito, see Using the Amazon Cognito
user pools API and user pool endpoints. This action might generate an SMS text message.
Starting June 1, 2021, US telecom carriers require you to register an origination phone
number before you can send SMS messages to US phone numbers. If you use SMS text messages
in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito
uses the registered number automatically. Otherwise, Amazon Cognito users who must receive
SMS messages might not be able to sign up, activate their accounts, or sign in. If you have
never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon
Simple Notification Service might place your account in the SMS sandbox. In sandbox mode ,
you can send messages only to verified phone numbers. After you test your app while in the
sandbox environment, you can move out of the sandbox and into production. For more
information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito
Developer Guide.
# Arguments
- `client_id`: The ID of the client associated with the user pool.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyticsMetadata"`: The Amazon Pinpoint analytics metadata that contributes to your
metrics for ForgotPassword calls.
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito
invokes any functions that are assigned to the following triggers: pre sign-up, custom
message, and user migration. When Amazon Cognito invokes any of these functions, it passes
a JSON payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to the ClientMetadata
parameter in your ForgotPassword request. In your function code in Lambda, you can process
the clientMetadata value to enhance your workflow for your specific needs. For more
information, see Customizing user pool Workflows with Lambda Triggers in the Amazon
Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon
Cognito won't do the following: Store the ClientMetadata value. This data is available
only to Lambda triggers that are assigned to a user pool to support custom workflows. If
your user pool configuration doesn't include triggers, the ClientMetadata parameter serves
no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't
use Amazon Cognito to provide sensitive information.
- `"SecretHash"`: A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the message.
- `"UserContextData"`: Contextual data about your user session, such as the device
fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk
of an authentication event based on the context that your app generates and passes to
Amazon Cognito when it makes API requests.
"""
function forgot_password(
ClientId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"ForgotPassword",
Dict{String,Any}("ClientId" => ClientId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function forgot_password(
ClientId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ForgotPassword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientId" => ClientId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_csvheader(user_pool_id)
get_csvheader(user_pool_id, params::Dict{String,<:Any})
Gets the header information for the comma-separated value (CSV) file to be used as input
for the user import job.
# Arguments
- `user_pool_id`: The user pool ID for the user pool that the users are to be imported into.
"""
function get_csvheader(UserPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"GetCSVHeader",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_csvheader(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GetCSVHeader",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device(device_key)
get_device(device_key, params::Dict{String,<:Any})
Gets the device. For more information about device authentication, see Working with user
devices in your user pool. Authorize this action with a signed-in user's access token. It
must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate
Identity and Access Management (IAM) policies in requests for this API operation. For this
operation, you can't use IAM credentials to authorize requests, and you can't grant IAM
permissions in policies. For more information about authorization models in Amazon Cognito,
see Using the Amazon Cognito user pools API and user pool endpoints.
# Arguments
- `device_key`: The device key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessToken"`: A valid access token that Amazon Cognito issued to the user whose device
information you want to request.
"""
function get_device(DeviceKey; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"GetDevice",
Dict{String,Any}("DeviceKey" => DeviceKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device(
DeviceKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GetDevice",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DeviceKey" => DeviceKey), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group(group_name, user_pool_id)
get_group(group_name, user_pool_id, params::Dict{String,<:Any})
Gets a group. Calling this action requires developer credentials.
# Arguments
- `group_name`: The name of the group.
- `user_pool_id`: The user pool ID for the user pool.
"""
function get_group(GroupName, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"GetGroup",
Dict{String,Any}("GroupName" => GroupName, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group(
GroupName,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_identity_provider_by_identifier(idp_identifier, user_pool_id)
get_identity_provider_by_identifier(idp_identifier, user_pool_id, params::Dict{String,<:Any})
Gets the specified IdP.
# Arguments
- `idp_identifier`: The IdP identifier.
- `user_pool_id`: The user pool ID.
"""
function get_identity_provider_by_identifier(
IdpIdentifier, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"GetIdentityProviderByIdentifier",
Dict{String,Any}("IdpIdentifier" => IdpIdentifier, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_identity_provider_by_identifier(
IdpIdentifier,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GetIdentityProviderByIdentifier",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdpIdentifier" => IdpIdentifier, "UserPoolId" => UserPoolId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_log_delivery_configuration(user_pool_id)
get_log_delivery_configuration(user_pool_id, params::Dict{String,<:Any})
Gets the detailed activity logging configuration for a user pool.
# Arguments
- `user_pool_id`: The ID of the user pool where you want to view detailed activity logging
configuration.
"""
function get_log_delivery_configuration(
UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"GetLogDeliveryConfiguration",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_log_delivery_configuration(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GetLogDeliveryConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_signing_certificate(user_pool_id)
get_signing_certificate(user_pool_id, params::Dict{String,<:Any})
This method takes a user pool ID, and returns the signing certificate. The issued
certificate is valid for 10 years from the date of issue. Amazon Cognito issues and assigns
a new signing certificate annually. This process returns a new value in the response to
GetSigningCertificate, but doesn't invalidate the original certificate.
# Arguments
- `user_pool_id`: The user pool ID.
"""
function get_signing_certificate(
UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"GetSigningCertificate",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_signing_certificate(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GetSigningCertificate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_uicustomization(user_pool_id)
get_uicustomization(user_pool_id, params::Dict{String,<:Any})
Gets the user interface (UI) Customization information for a particular app client's app
UI, if any such information exists for the client. If nothing is set for the particular
client, but there is an existing pool level customization (the app clientId is ALL), then
that information is returned. If nothing is present, then an empty shape is returned.
# Arguments
- `user_pool_id`: The user pool ID for the user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientId"`: The client ID for the client app.
"""
function get_uicustomization(UserPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"GetUICustomization",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_uicustomization(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GetUICustomization",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user(access_token)
get_user(access_token, params::Dict{String,<:Any})
Gets the user attributes and metadata for a user. Authorize this action with a signed-in
user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon
Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this
API operation. For this operation, you can't use IAM credentials to authorize requests, and
you can't grant IAM permissions in policies. For more information about authorization
models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool
endpoints.
# Arguments
- `access_token`: A non-expired access token for the user whose information you want to
query.
"""
function get_user(AccessToken; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"GetUser",
Dict{String,Any}("AccessToken" => AccessToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_user(
AccessToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GetUser",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccessToken" => AccessToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user_attribute_verification_code(access_token, attribute_name)
get_user_attribute_verification_code(access_token, attribute_name, params::Dict{String,<:Any})
Generates a user attribute verification code for the specified attribute name. Sends a
message to a user with a code that they must return in a VerifyUserAttribute request.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you can't
use IAM credentials to authorize requests, and you can't grant IAM permissions in policies.
For more information about authorization models in Amazon Cognito, see Using the Amazon
Cognito user pools API and user pool endpoints. This action might generate an SMS text
message. Starting June 1, 2021, US telecom carriers require you to register an origination
phone number before you can send SMS messages to US phone numbers. If you use SMS text
messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon
Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
receive SMS messages might not be able to sign up, activate their accounts, or sign in. If
you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox
mode , you can send messages only to verified phone numbers. After you test your app while
in the sandbox environment, you can move out of the sandbox and into production. For more
information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito
Developer Guide.
# Arguments
- `access_token`: A non-expired access token for the user whose attribute verification code
you want to generate.
- `attribute_name`: The attribute name returned by the server response to get the user
attribute verification code.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the GetUserAttributeVerificationCode API
action, Amazon Cognito invokes the function that is assigned to the custom message trigger.
When Amazon Cognito invokes this function, it passes a JSON payload, which the function
receives as input. This payload contains a clientMetadata attribute, which provides the
data that you assigned to the ClientMetadata parameter in your
GetUserAttributeVerificationCode request. In your function code in Lambda, you can process
the clientMetadata value to enhance your workflow for your specific needs. For more
information, see Customizing user pool Workflows with Lambda Triggers in the Amazon
Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon
Cognito won't do the following: Store the ClientMetadata value. This data is available
only to Lambda triggers that are assigned to a user pool to support custom workflows. If
your user pool configuration doesn't include triggers, the ClientMetadata parameter serves
no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't
use Amazon Cognito to provide sensitive information.
"""
function get_user_attribute_verification_code(
AccessToken, AttributeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"GetUserAttributeVerificationCode",
Dict{String,Any}("AccessToken" => AccessToken, "AttributeName" => AttributeName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_user_attribute_verification_code(
AccessToken,
AttributeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GetUserAttributeVerificationCode",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessToken" => AccessToken, "AttributeName" => AttributeName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user_pool_mfa_config(user_pool_id)
get_user_pool_mfa_config(user_pool_id, params::Dict{String,<:Any})
Gets the user pool multi-factor authentication (MFA) configuration.
# Arguments
- `user_pool_id`: The user pool ID.
"""
function get_user_pool_mfa_config(
UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"GetUserPoolMfaConfig",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_user_pool_mfa_config(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GetUserPoolMfaConfig",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
global_sign_out(access_token)
global_sign_out(access_token, params::Dict{String,<:Any})
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.
Call this operation when your user signs out of your app. This results in the following
behavior. Amazon Cognito no longer accepts token-authorized user operations that you
authorize with a signed-out user's access tokens. For more information, see Using the
Amazon Cognito user pools API and user pool endpoints. Amazon Cognito returns an Access
Token has been revoked error when your app attempts to authorize a user pools API request
with a revoked access token that contains the scope aws.cognito.signin.user.admin. Amazon
Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity
pool with ServerSideTokenCheck enabled for its user pool IdP configuration in
CognitoIdentityProvider. Amazon Cognito no longer accepts a signed-out user's refresh
tokens in refresh requests. Other requests might be valid until your user's token
expires. Authorize this action with a signed-in user's access token. It must include the
scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you can't
use IAM credentials to authorize requests, and you can't grant IAM permissions in policies.
For more information about authorization models in Amazon Cognito, see Using the Amazon
Cognito user pools API and user pool endpoints.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user who you want
to sign out.
"""
function global_sign_out(AccessToken; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"GlobalSignOut",
Dict{String,Any}("AccessToken" => AccessToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function global_sign_out(
AccessToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"GlobalSignOut",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccessToken" => AccessToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
initiate_auth(auth_flow, client_id)
initiate_auth(auth_flow, client_id, params::Dict{String,<:Any})
Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user
with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in
through a third party. Amazon Cognito doesn't evaluate Identity and Access Management
(IAM) policies in requests for this API operation. For this operation, you can't use IAM
credentials to authorize requests, and you can't grant IAM permissions in policies. For
more information about authorization models in Amazon Cognito, see Using the Amazon Cognito
user pools API and user pool endpoints. This action might generate an SMS text message.
Starting June 1, 2021, US telecom carriers require you to register an origination phone
number before you can send SMS messages to US phone numbers. If you use SMS text messages
in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito
uses the registered number automatically. Otherwise, Amazon Cognito users who must receive
SMS messages might not be able to sign up, activate their accounts, or sign in. If you have
never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon
Simple Notification Service might place your account in the SMS sandbox. In sandbox mode ,
you can send messages only to verified phone numbers. After you test your app while in the
sandbox environment, you can move out of the sandbox and into production. For more
information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito
Developer Guide.
# Arguments
- `auth_flow`: The authentication flow for this call to run. The API action will depend on
this value. For example: REFRESH_TOKEN_AUTH takes in a valid refresh token and returns
new tokens. USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to
be used for next challenge execution. USER_PASSWORD_AUTH takes in USERNAME and PASSWORD
and returns the next challenge or tokens. Valid values include: USER_SRP_AUTH:
Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and
ID token by supplying a valid refresh token. CUSTOM_AUTH: Custom authentication flow.
USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed
directly. If a user migration Lambda trigger is set, this flow will invoke the user
migration Lambda if it doesn't find the user name in the user pool. ADMIN_NO_SRP_AUTH
isn't a valid value.
- `client_id`: The app client ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyticsMetadata"`: The Amazon Pinpoint analytics metadata that contributes to your
metrics for InitiateAuth calls.
- `"AuthParameters"`: The authentication parameters. These are inputs corresponding to the
AuthFlow that you're invoking. The required values depend on the value of AuthFlow: For
USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app
client is configured with a client secret), DEVICE_KEY. For USER_PASSWORD_AUTH: USERNAME
(required), PASSWORD (required), SECRET_HASH (required if the app client is configured with
a client secret), DEVICE_KEY. For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN
(required), SECRET_HASH (required if the app client is configured with a client secret),
DEVICE_KEY. For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is
configured with client secret), DEVICE_KEY. To start the authentication flow with password
verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value). For more
information about SECRET_HASH, see Computing secret hash values. For information about
DEVICE_KEY, see Working with user devices in your user pool.
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for
certain custom workflows that this action triggers. You create custom workflows by
assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action,
Amazon Cognito invokes the Lambda functions that are specified for various triggers. The
ClientMetadata value is passed as input to the functions for only the following triggers:
Pre signup Pre authentication User migration When Amazon Cognito invokes the
functions for these triggers, it passes a JSON payload, which the function receives as
input. This payload contains a validationData attribute, which provides the data that you
assigned to the ClientMetadata parameter in your InitiateAuth request. In your function
code in Lambda, you can process the validationData value to enhance your workflow for your
specific needs. When you use the InitiateAuth API action, Amazon Cognito also invokes the
functions for the following triggers, but it doesn't provide the ClientMetadata value as
input: Post authentication Custom message Pre token generation Create auth
challenge Define auth challenge For more information, see Customizing user pool
Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the
ClientMetadata parameter, remember that Amazon Cognito won't do the following: Store the
ClientMetadata value. This data is available only to Lambda triggers that are assigned to a
user pool to support custom workflows. If your user pool configuration doesn't include
triggers, the ClientMetadata parameter serves no purpose. Validate the ClientMetadata
value. Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive
information.
- `"UserContextData"`: Contextual data about your user session, such as the device
fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk
of an authentication event based on the context that your app generates and passes to
Amazon Cognito when it makes API requests.
"""
function initiate_auth(
AuthFlow, ClientId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"InitiateAuth",
Dict{String,Any}("AuthFlow" => AuthFlow, "ClientId" => ClientId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function initiate_auth(
AuthFlow,
ClientId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"InitiateAuth",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AuthFlow" => AuthFlow, "ClientId" => ClientId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_devices(access_token)
list_devices(access_token, params::Dict{String,<:Any})
Lists the sign-in devices that Amazon Cognito has registered to the current user. For more
information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you can't
use IAM credentials to authorize requests, and you can't grant IAM permissions in policies.
For more information about authorization models in Amazon Cognito, see Using the Amazon
Cognito user pools API and user pool endpoints.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user whose list of
devices you want to view.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The limit of the device request.
- `"PaginationToken"`: This API operation returns a limited number of results. The
pagination token is an identifier that you can present in an additional API request with
the same parameters. When you include the pagination token, Amazon Cognito returns the next
set of items after the current list. Subsequent requests return a new pagination token. By
use of this token, you can paginate through the full list of items.
"""
function list_devices(AccessToken; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"ListDevices",
Dict{String,Any}("AccessToken" => AccessToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_devices(
AccessToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ListDevices",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccessToken" => AccessToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_groups(user_pool_id)
list_groups(user_pool_id, params::Dict{String,<:Any})
Lists the groups associated with a user pool. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The limit of the request to list groups.
- `"NextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_groups(UserPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"ListGroups",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_groups(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ListGroups",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_identity_providers(user_pool_id)
list_identity_providers(user_pool_id, params::Dict{String,<:Any})
Lists information about all IdPs for a user pool. Amazon Cognito evaluates Identity and
Access Management (IAM) policies in requests for this API operation. For this operation,
you must use IAM credentials to authorize requests, and you must grant yourself the
corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API
Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of IdPs to return.
- `"NextToken"`: A pagination token.
"""
function list_identity_providers(
UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"ListIdentityProviders",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_identity_providers(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ListIdentityProviders",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_servers(user_pool_id)
list_resource_servers(user_pool_id, params::Dict{String,<:Any})
Lists the resource servers for a user pool. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of resource servers to return.
- `"NextToken"`: A pagination token.
"""
function list_resource_servers(
UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"ListResourceServers",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resource_servers(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ListResourceServers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), 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 that are assigned to an Amazon Cognito user pool. A tag is a label that you
can apply to user pools to categorize and manage them in different ways, such as by
purpose, owner, environment, or other criteria. You can use this action up to 10 times per
second, per account.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the user pool that the tags are
assigned to.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"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 cognito_identity_provider(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_user_import_jobs(max_results, user_pool_id)
list_user_import_jobs(max_results, user_pool_id, params::Dict{String,<:Any})
Lists user import jobs for a user pool. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `max_results`: The maximum number of import jobs you want the request to return.
- `user_pool_id`: The user pool ID for the user pool that the users are being imported into.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PaginationToken"`: This API operation returns a limited number of results. The
pagination token is an identifier that you can present in an additional API request with
the same parameters. When you include the pagination token, Amazon Cognito returns the next
set of items after the current list. Subsequent requests return a new pagination token. By
use of this token, you can paginate through the full list of items.
"""
function list_user_import_jobs(
MaxResults, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"ListUserImportJobs",
Dict{String,Any}("MaxResults" => MaxResults, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_user_import_jobs(
MaxResults,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ListUserImportJobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MaxResults" => MaxResults, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_user_pool_clients(user_pool_id)
list_user_pool_clients(user_pool_id, params::Dict{String,<:Any})
Lists the clients that have been created for the specified user pool. Amazon Cognito
evaluates Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you must use IAM credentials to authorize requests, and you must grant
yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web
Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool where you want to list user pool
clients.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results you want the request to return when listing
the user pool clients.
- `"NextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_user_pool_clients(
UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"ListUserPoolClients",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_user_pool_clients(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ListUserPoolClients",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_user_pools(max_results)
list_user_pools(max_results, params::Dict{String,<:Any})
Lists the user pools associated with an Amazon Web Services account. Amazon Cognito
evaluates Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you must use IAM credentials to authorize requests, and you must grant
yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web
Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `max_results`: The maximum number of results you want the request to return when listing
the user pools.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_user_pools(MaxResults; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"ListUserPools",
Dict{String,Any}("MaxResults" => MaxResults);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_user_pools(
MaxResults,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ListUserPools",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MaxResults" => MaxResults), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users(user_pool_id)
list_users(user_pool_id, params::Dict{String,<:Any})
Lists users and their basic details in a user pool. Amazon Cognito evaluates Identity and
Access Management (IAM) policies in requests for this API operation. For this operation,
you must use IAM credentials to authorize requests, and you must grant yourself the
corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API
Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool on which the search should be
performed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributesToGet"`: A JSON array of user attribute names, for example given_name, that
you want Amazon Cognito to include in the response for each user. When you don't provide an
AttributesToGet parameter, Amazon Cognito returns all attributes for each user. Use
AttributesToGet with required attributes in your user pool, or in conjunction with Filter.
Amazon Cognito returns an error if not all users in the results have set a value for the
attribute you request. Attributes that you can't filter on, including custom attributes,
must have a value set in every user profile before an AttributesToGet parameter returns
results.
- `"Filter"`: A filter string of the form \"AttributeName Filter-Type \"AttributeValue\"\".
Quotation marks within the filter string must be escaped using the backslash () character.
For example, \"family_name = \"Reddy\"\". AttributeName: The name of the attribute to
search for. You can only search for one attribute at a time. Filter-Type: For an exact
match, use =, for example, \"given_name = \"Jon\"\". For a prefix (\"starts with\") match,
use ^=, for example, \"given_name ^= \"Jon\"\". AttributeValue: The attribute value
that must be matched for each user. If the filter string is empty, ListUsers returns all
users in the user pool. You can only search for the following standard attributes:
username (case-sensitive) email phone_number name given_name family_name
preferred_username cognito:user_status (called Status in the Console)
(case-insensitive) status (called Enabled in the Console) (case-sensitive) sub
Custom attributes aren't searchable. You can also list users with a client-side filter.
The server-side filter matches no more than one attribute. For an advanced search, use a
client-side filter with the --query parameter of the list-users action in the CLI. When you
use a client-side filter, ListUsers returns a paginated list of zero or more users. You can
receive multiple pages in a row with zero results. Repeat the query with each pagination
token that is returned until you receive a null pagination token value, and then review the
combined result. For more information about server-side and client-side filtering, see
FilteringCLI output in the Command Line Interface User Guide. For more information, see
Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the
Amazon Cognito Developer Guide.
- `"Limit"`: Maximum number of users to be returned.
- `"PaginationToken"`: This API operation returns a limited number of results. The
pagination token is an identifier that you can present in an additional API request with
the same parameters. When you include the pagination token, Amazon Cognito returns the next
set of items after the current list. Subsequent requests return a new pagination token. By
use of this token, you can paginate through the full list of items.
"""
function list_users(UserPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"ListUsers",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_users(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ListUsers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users_in_group(group_name, user_pool_id)
list_users_in_group(group_name, user_pool_id, params::Dict{String,<:Any})
Lists the users in the specified group. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `group_name`: The name of the group.
- `user_pool_id`: The user pool ID for the user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of users that you want to retrieve before pagination.
- `"NextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_users_in_group(
GroupName, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"ListUsersInGroup",
Dict{String,Any}("GroupName" => GroupName, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_users_in_group(
GroupName,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ListUsersInGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resend_confirmation_code(client_id, username)
resend_confirmation_code(client_id, username, params::Dict{String,<:Any})
Resends the confirmation (for confirmation of registration) to a specific user in the user
pool. Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in
requests for this API operation. For this operation, you can't use IAM credentials to
authorize requests, and you can't grant IAM permissions in policies. For more information
about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API
and user pool endpoints. This action might generate an SMS text message. Starting June 1,
2021, US telecom carriers require you to register an origination phone number before you
can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito,
you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered
number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might
not be able to sign up, activate their accounts, or sign in. If you have never used SMS
text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple
Notification Service might place your account in the SMS sandbox. In sandbox mode , you
can send messages only to verified phone numbers. After you test your app while in the
sandbox environment, you can move out of the sandbox and into production. For more
information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito
Developer Guide.
# Arguments
- `client_id`: The ID of the client associated with the user pool.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyticsMetadata"`: The Amazon Pinpoint analytics metadata that contributes to your
metrics for ResendConfirmationCode calls.
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon
Cognito invokes the function that is assigned to the custom message trigger. When Amazon
Cognito invokes this function, it passes a JSON payload, which the function receives as
input. This payload contains a clientMetadata attribute, which provides the data that you
assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your
function code in Lambda, you can process the clientMetadata value to enhance your workflow
for your specific needs. For more information, see Customizing user pool Workflows with
Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata
parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata
value. This data is available only to Lambda triggers that are assigned to a user pool to
support custom workflows. If your user pool configuration doesn't include triggers, the
ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt
the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
- `"SecretHash"`: A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the message.
- `"UserContextData"`: Contextual data about your user session, such as the device
fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk
of an authentication event based on the context that your app generates and passes to
Amazon Cognito when it makes API requests.
"""
function resend_confirmation_code(
ClientId, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"ResendConfirmationCode",
Dict{String,Any}("ClientId" => ClientId, "Username" => Username);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resend_confirmation_code(
ClientId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"ResendConfirmationCode",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientId" => ClientId, "Username" => Username),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
respond_to_auth_challenge(challenge_name, client_id)
respond_to_auth_challenge(challenge_name, client_id, params::Dict{String,<:Any})
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for
device authentication that bypasses MFA, or for a custom authentication challenge. A
RespondToAuthChallenge API request provides the answer to that challenge, like a code or a
secure remote password (SRP). The parameters of a response to an authentication challenge
vary with the type of challenge. For more information about custom authentication
challenges, see Custom authentication challenge Lambda triggers. Amazon Cognito doesn't
evaluate Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you can't use IAM credentials to authorize requests, and you can't
grant IAM permissions in policies. For more information about authorization models in
Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints. This
action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
require you to register an origination phone number before you can send SMS messages to US
phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone
number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically.
Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up,
activate their accounts, or sign in. If you have never used SMS text messages with Amazon
Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place
your account in the SMS sandbox. In sandbox mode , you can send messages only to verified
phone numbers. After you test your app while in the sandbox environment, you can move out
of the sandbox and into production. For more information, see SMS message settings for
Amazon Cognito user pools in the Amazon Cognito Developer Guide.
# Arguments
- `challenge_name`: The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH isn't a valid value.
- `client_id`: The app client ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyticsMetadata"`: The Amazon Pinpoint analytics metadata that contributes to your
metrics for RespondToAuthChallenge calls.
- `"ChallengeResponses"`: The responses to the challenge that you received in the previous
request. Each challenge has its own required response parameters. The following examples
are partial JSON request bodies that highlight challenge-response parameters. You must
provide a SECRET_HASH parameter in all challenge responses to an app client that has a
client secret. SMS_MFA \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\":
{\"SMS_MFA_CODE\": \"[SMS_code]\", \"USERNAME\": \"[username]\"} PASSWORD_VERIFIER
\"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":
{\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\":
\"[secret_block]\", \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"} Add
\"DEVICE_KEY\" when you sign in with a remembered device. CUSTOM_CHALLENGE
\"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\": {\"USERNAME\":
\"[username]\", \"ANSWER\": \"[challenge_answer]\"} Add \"DEVICE_KEY\" when you sign in
with a remembered device. NEW_PASSWORD_REQUIRED \"ChallengeName\":
\"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\": {\"NEW_PASSWORD\": \"[new_password]\",
\"USERNAME\": \"[username]\"} To set any required attributes that InitiateAuth returned in
an requiredAttributes parameter, add \"userAttributes.[attribute_name]\":
\"[attribute_value]\". This parameter can also set values for writable attributes that
aren't required by your user pool. In a NEW_PASSWORD_REQUIRED challenge response, you
can't modify a required attribute that already has a value. In RespondToAuthChallenge, set
a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then
use the UpdateUserAttributes API operation to modify the value of any additional
attributes. SOFTWARE_TOKEN_MFA \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\",
\"ChallengeResponses\": {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":
[authenticator_code]} DEVICE_SRP_AUTH \"ChallengeName\": \"DEVICE_SRP_AUTH\",
\"ChallengeResponses\": {\"USERNAME\": \"[username]\", \"DEVICE_KEY\": \"[device_key]\",
\"SRP_A\": \"[srp_a]\"} DEVICE_PASSWORD_VERIFIER \"ChallengeName\":
\"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\": {\"DEVICE_KEY\": \"[device_key]\",
\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\":
\"[secret_block]\", \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"} MFA_SETUP
\"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\": \"[username]\"},
\"SESSION\": \"[Session ID from VerifySoftwareToken]\" SELECT_MFA_TYPE
\"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":
\"[username]\", \"ANSWER\": \"[SMS_MFA or SOFTWARE_TOKEN_MFA]\"} For more information
about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see
Working with user devices in your user pool.
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon
Cognito invokes any functions that are assigned to the following triggers: post
authentication, pre token generation, define auth challenge, create auth challenge, and
verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON
payload, which the function receives as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in
your RespondToAuthChallenge request. In your function code in Lambda, you can process the
clientMetadata value to enhance your workflow for your specific needs. For more
information, see Customizing user pool Workflows with Lambda Triggers in the Amazon
Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon
Cognito won't do the following: Store the ClientMetadata value. This data is available
only to Lambda triggers that are assigned to a user pool to support custom workflows. If
your user pool configuration doesn't include triggers, the ClientMetadata parameter serves
no purpose. Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't
use Amazon Cognito to provide sensitive information.
- `"Session"`: The session that should be passed both ways in challenge-response calls to
the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller
must pass another challenge, they return a session with other challenge parameters. This
session should be passed as it is to the next RespondToAuthChallenge API call.
- `"UserContextData"`: Contextual data about your user session, such as the device
fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk
of an authentication event based on the context that your app generates and passes to
Amazon Cognito when it makes API requests.
"""
function respond_to_auth_challenge(
ChallengeName, ClientId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"RespondToAuthChallenge",
Dict{String,Any}("ChallengeName" => ChallengeName, "ClientId" => ClientId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function respond_to_auth_challenge(
ChallengeName,
ClientId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"RespondToAuthChallenge",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChallengeName" => ChallengeName, "ClientId" => ClientId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_token(client_id, token)
revoke_token(client_id, token, params::Dict{String,<:Any})
Revokes all of the access tokens generated by, and at the same time as, the specified
refresh token. After a token is revoked, you can't use the revoked token to access Amazon
Cognito user APIs, or to authorize access to your resource server. Amazon Cognito doesn't
evaluate Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you can't use IAM credentials to authorize requests, and you can't
grant IAM permissions in policies. For more information about authorization models in
Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
# Arguments
- `client_id`: The client ID for the token that you want to revoke.
- `token`: The refresh token that you want to revoke.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientSecret"`: The secret for the client ID. This is required only if the client ID
has a secret.
"""
function revoke_token(ClientId, Token; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"RevokeToken",
Dict{String,Any}("ClientId" => ClientId, "Token" => Token);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_token(
ClientId,
Token,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"RevokeToken",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientId" => ClientId, "Token" => Token), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_log_delivery_configuration(log_configurations, user_pool_id)
set_log_delivery_configuration(log_configurations, user_pool_id, params::Dict{String,<:Any})
Sets up or modifies the detailed activity logging configuration of a user pool.
# Arguments
- `log_configurations`: A collection of all of the detailed activity logging configurations
for a user pool.
- `user_pool_id`: The ID of the user pool where you want to configure detailed activity
logging .
"""
function set_log_delivery_configuration(
LogConfigurations, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"SetLogDeliveryConfiguration",
Dict{String,Any}(
"LogConfigurations" => LogConfigurations, "UserPoolId" => UserPoolId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_log_delivery_configuration(
LogConfigurations,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"SetLogDeliveryConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LogConfigurations" => LogConfigurations, "UserPoolId" => UserPoolId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_risk_configuration(user_pool_id)
set_risk_configuration(user_pool_id, params::Dict{String,<:Any})
Configures actions on detected risks. To delete the risk configuration for UserPoolId or
ClientId, pass null values for all four configuration types. To activate Amazon Cognito
advanced security features, update the user pool to include the UserPoolAddOns
keyAdvancedSecurityMode.
# Arguments
- `user_pool_id`: The user pool ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountTakeoverRiskConfiguration"`: The account takeover risk configuration.
- `"ClientId"`: The app client ID. If ClientId is null, then the risk configuration is
mapped to userPoolId. When the client ID is null, the same risk configuration is applied to
all the clients in the userPool. Otherwise, ClientId is mapped to the client. When the
client ID isn't null, the user pool configuration is overridden and the risk configuration
for the client is used instead.
- `"CompromisedCredentialsRiskConfiguration"`: The compromised credentials risk
configuration.
- `"RiskExceptionConfiguration"`: The configuration to override the risk decision.
"""
function set_risk_configuration(
UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"SetRiskConfiguration",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_risk_configuration(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"SetRiskConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_uicustomization(user_pool_id)
set_uicustomization(user_pool_id, params::Dict{String,<:Any})
Sets the user interface (UI) customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific
clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the
default configuration is used for every client that has no previously set UI customization.
If you specify UI customization settings for a particular client, it will no longer return
to the ALL configuration. To use this API, your user pool must have a domain associated
with it. Otherwise, there is no place to host the app's pages, and the service will throw
an error.
# Arguments
- `user_pool_id`: The user pool ID for the user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CSS"`: The CSS values in the UI customization.
- `"ClientId"`: The client ID for the client app.
- `"ImageFile"`: The uploaded logo image for the UI customization.
"""
function set_uicustomization(UserPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"SetUICustomization",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_uicustomization(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"SetUICustomization",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_user_mfapreference(access_token)
set_user_mfapreference(access_token, params::Dict{String,<:Any})
Set the user's multi-factor authentication (MFA) method preference, including which MFA
factors are activated and if any are preferred. Only one factor can be set as preferred.
The preferred MFA factor will be used to authenticate a user if multiple factors are
activated. If multiple options are activated and no preference is set, a challenge to
choose an MFA option will be returned during sign-in. If an MFA type is activated for a
user, the user will be prompted for MFA during all sign-in attempts unless device tracking
is turned on and the device has been trusted. If you want MFA to be applied selectively
based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on
Adaptive Authentication for the user pool. Authorize this action with a signed-in user's
access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito
doesn't evaluate Identity and Access Management (IAM) policies in requests for this API
operation. For this operation, you can't use IAM credentials to authorize requests, and you
can't grant IAM permissions in policies. For more information about authorization models in
Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user whose MFA
preference you want to set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SMSMfaSettings"`: The SMS text message multi-factor authentication (MFA) settings.
- `"SoftwareTokenMfaSettings"`: The time-based one-time password (TOTP) software token MFA
settings.
"""
function set_user_mfapreference(
AccessToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"SetUserMFAPreference",
Dict{String,Any}("AccessToken" => AccessToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_user_mfapreference(
AccessToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"SetUserMFAPreference",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccessToken" => AccessToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_user_pool_mfa_config(user_pool_id)
set_user_pool_mfa_config(user_pool_id, params::Dict{String,<:Any})
Sets the user pool multi-factor authentication (MFA) configuration. This action might
generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to
register an origination phone number before you can send SMS messages to US phone numbers.
If you use SMS text messages in Amazon Cognito, you must register a phone number with
Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon
Cognito users who must receive SMS messages might not be able to sign up, activate their
accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any
other Amazon Web Service, Amazon Simple Notification Service might place your account in
the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers.
After you test your app while in the sandbox environment, you can move out of the sandbox
and into production. For more information, see SMS message settings for Amazon Cognito
user pools in the Amazon Cognito Developer Guide.
# Arguments
- `user_pool_id`: The user pool ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MfaConfiguration"`: The MFA configuration. If you set the MfaConfiguration value to
‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding
Multi-Factor Authentication (MFA) to a user pool. Valid values include: OFF MFA won't be
used for any users. ON MFA is required for all users to sign in. OPTIONAL MFA will be
required only for individual users who have an MFA factor activated.
- `"SmsMfaConfiguration"`: The SMS text message MFA configuration.
- `"SoftwareTokenMfaConfiguration"`: The software token MFA configuration.
"""
function set_user_pool_mfa_config(
UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"SetUserPoolMfaConfig",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_user_pool_mfa_config(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"SetUserPoolMfaConfig",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_user_settings(access_token, mfaoptions)
set_user_settings(access_token, mfaoptions, params::Dict{String,<:Any})
This action is no longer supported. You can use it to configure only SMS MFA. You can't
use it to configure time-based one-time password (TOTP) software token MFA. To configure
either type of MFA, use SetUserMFAPreference instead. Authorize this action with a
signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests
for this API operation. For this operation, you can't use IAM credentials to authorize
requests, and you can't grant IAM permissions in policies. For more information about
authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and
user pool endpoints.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user whose user
settings you want to configure.
- `mfaoptions`: You can use this parameter only to set an SMS configuration that uses SMS
for delivery.
"""
function set_user_settings(
AccessToken, MFAOptions; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"SetUserSettings",
Dict{String,Any}("AccessToken" => AccessToken, "MFAOptions" => MFAOptions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_user_settings(
AccessToken,
MFAOptions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"SetUserSettings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccessToken" => AccessToken, "MFAOptions" => MFAOptions),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
sign_up(client_id, password, username)
sign_up(client_id, password, username, params::Dict{String,<:Any})
Registers the user in the specified user pool and creates a user name, password, and user
attributes. Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies
in requests for this API operation. For this operation, you can't use IAM credentials to
authorize requests, and you can't grant IAM permissions in policies. For more information
about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API
and user pool endpoints. This action might generate an SMS text message. Starting June 1,
2021, US telecom carriers require you to register an origination phone number before you
can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito,
you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered
number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might
not be able to sign up, activate their accounts, or sign in. If you have never used SMS
text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple
Notification Service might place your account in the SMS sandbox. In sandbox mode , you
can send messages only to verified phone numbers. After you test your app while in the
sandbox environment, you can move out of the sandbox and into production. For more
information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito
Developer Guide.
# Arguments
- `client_id`: The ID of the client associated with the user pool.
- `password`: The password of the user you want to register.
- `username`: The username of the user that you want to sign up. The value of this
parameter is typically a username, but can be any alias attribute in your user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalyticsMetadata"`: The Amazon Pinpoint analytics metadata that contributes to your
metrics for SignUp calls.
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers. You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes
any functions that are assigned to the following triggers: pre sign-up, custom message, and
post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON
payload, which the function receives as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in
your SignUp request. In your function code in Lambda, you can process the clientMetadata
value to enhance your workflow for your specific needs. For more information, see
Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the
following: Store the ClientMetadata value. This data is available only to Lambda triggers
that are assigned to a user pool to support custom workflows. If your user pool
configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value. Encrypt the ClientMetadata value. Don't use Amazon
Cognito to provide sensitive information.
- `"SecretHash"`: A keyed-hash message authentication code (HMAC) calculated using the
secret key of a user pool client and username plus the client ID in the message.
- `"UserAttributes"`: An array of name-value pairs representing user attributes. For custom
attributes, you must prepend the custom: prefix to the attribute name.
- `"UserContextData"`: Contextual data about your user session, such as the device
fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk
of an authentication event based on the context that your app generates and passes to
Amazon Cognito when it makes API requests.
- `"ValidationData"`: Temporary user attributes that contribute to the outcomes of your pre
sign-up Lambda trigger. This set of key-value pairs are for custom validation of
information that you collect from your users but don't need to retain. Your Lambda function
can analyze this additional data and act on it. Your function might perform external API
operations like logging user attributes and validation data to Amazon CloudWatch Logs.
Validation data might also affect the response that your function returns to Amazon
Cognito, like automatically confirming the user if they sign up from within your network.
For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
"""
function sign_up(
ClientId, Password, Username; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"SignUp",
Dict{String,Any}(
"ClientId" => ClientId, "Password" => Password, "Username" => Username
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function sign_up(
ClientId,
Password,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"SignUp",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientId" => ClientId, "Password" => Password, "Username" => Username
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_user_import_job(job_id, user_pool_id)
start_user_import_job(job_id, user_pool_id, params::Dict{String,<:Any})
Starts the user import.
# Arguments
- `job_id`: The job ID for the user import job.
- `user_pool_id`: The user pool ID for the user pool that the users are being imported into.
"""
function start_user_import_job(
JobId, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"StartUserImportJob",
Dict{String,Any}("JobId" => JobId, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_user_import_job(
JobId,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"StartUserImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("JobId" => JobId, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_user_import_job(job_id, user_pool_id)
stop_user_import_job(job_id, user_pool_id, params::Dict{String,<:Any})
Stops the user import job.
# Arguments
- `job_id`: The job ID for the user import job.
- `user_pool_id`: The user pool ID for the user pool that the users are being imported into.
"""
function stop_user_import_job(
JobId, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"StopUserImportJob",
Dict{String,Any}("JobId" => JobId, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_user_import_job(
JobId,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"StopUserImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("JobId" => JobId, "UserPoolId" => UserPoolId),
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 a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to
categorize and manage user pools in different ways, such as by purpose, owner, environment,
or other criteria. Each tag consists of a key and value, both of which you define. A key is
a general category for more specific values. For example, if you have two versions of a
user pool, one for testing and another for production, you might assign an Environment tag
key to both user pools. The value of this key might be Test for one user pool, and
Production for the other. Tags are useful for cost tracking and access control. You can
activate your tags so that they appear on the Billing and Cost Management console, where
you can track the costs associated with your user pools. In an Identity and Access
Management policy, you can constrain permissions for user pools based on specific tags or
tag values. You can use this action up to 5 times per second, per account. A user pool can
have as many as 50 tags.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the user pool to assign the tags to.
- `tags`: The tags to assign to the user pool.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"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 cognito_identity_provider(
"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 an Amazon Cognito user pool. You can use this action up to
5 times per second, per account.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the user pool that the tags are
assigned to.
- `tag_keys`: The keys of the tags to remove from the user pool.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"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 cognito_identity_provider(
"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_auth_event_feedback(event_id, feedback_token, feedback_value, user_pool_id, username)
update_auth_event_feedback(event_id, feedback_token, feedback_value, user_pool_id, username, params::Dict{String,<:Any})
Provides the feedback for an authentication event, whether it was from a valid user or not.
This feedback is used for improving the risk evaluation decision for the user pool as part
of Amazon Cognito advanced security. Amazon Cognito doesn't evaluate Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you can't
use IAM credentials to authorize requests, and you can't grant IAM permissions in policies.
For more information about authorization models in Amazon Cognito, see Using the Amazon
Cognito user pools API and user pool endpoints.
# Arguments
- `event_id`: The event ID.
- `feedback_token`: The feedback token.
- `feedback_value`: The authentication event feedback value. When you provide a
FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where
Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of
invalid, you tell Amazon Cognito that you don't trust a user session, or you don't believe
that Amazon Cognito evaluated a high-enough risk level.
- `user_pool_id`: The user pool ID.
- `username`: The username of the user that you want to query or modify. The value of this
parameter is typically your user's username, but it can be any of their alias attributes.
If username isn't an alias attribute in your user pool, this value must be the sub of a
local user or the username of a user from a third-party IdP.
"""
function update_auth_event_feedback(
EventId,
FeedbackToken,
FeedbackValue,
UserPoolId,
Username;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateAuthEventFeedback",
Dict{String,Any}(
"EventId" => EventId,
"FeedbackToken" => FeedbackToken,
"FeedbackValue" => FeedbackValue,
"UserPoolId" => UserPoolId,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_auth_event_feedback(
EventId,
FeedbackToken,
FeedbackValue,
UserPoolId,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateAuthEventFeedback",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EventId" => EventId,
"FeedbackToken" => FeedbackToken,
"FeedbackValue" => FeedbackValue,
"UserPoolId" => UserPoolId,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_device_status(access_token, device_key)
update_device_status(access_token, device_key, params::Dict{String,<:Any})
Updates the device status. For more information about device authentication, see Working
with user devices in your user pool. Authorize this action with a signed-in user's access
token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't
evaluate Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you can't use IAM credentials to authorize requests, and you can't
grant IAM permissions in policies. For more information about authorization models in
Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user whose device
status you want to update.
- `device_key`: The device key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeviceRememberedStatus"`: The status of whether a device is remembered.
"""
function update_device_status(
AccessToken, DeviceKey; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"UpdateDeviceStatus",
Dict{String,Any}("AccessToken" => AccessToken, "DeviceKey" => DeviceKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_device_status(
AccessToken,
DeviceKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateDeviceStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccessToken" => AccessToken, "DeviceKey" => DeviceKey),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_group(group_name, user_pool_id)
update_group(group_name, user_pool_id, params::Dict{String,<:Any})
Updates the specified group with the specified attributes. Amazon Cognito evaluates
Identity and Access Management (IAM) policies in requests for this API operation. For this
operation, you must use IAM credentials to authorize requests, and you must grant yourself
the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services
API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `group_name`: The name of the group.
- `user_pool_id`: The user pool ID for the user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A string containing the new description of the group.
- `"Precedence"`: The new precedence value for the group. For more information about this
parameter, see CreateGroup.
- `"RoleArn"`: The new role Amazon Resource Name (ARN) for the group. This is used for
setting the cognito:roles and cognito:preferred_role claims in the token.
"""
function update_group(
GroupName, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"UpdateGroup",
Dict{String,Any}("GroupName" => GroupName, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_group(
GroupName,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_identity_provider(provider_name, user_pool_id)
update_identity_provider(provider_name, user_pool_id, params::Dict{String,<:Any})
Updates IdP information for a user pool. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `provider_name`: The IdP name.
- `user_pool_id`: The user pool ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeMapping"`: The IdP attribute mapping to be changed.
- `"IdpIdentifiers"`: A list of IdP identifiers.
- `"ProviderDetails"`: The scopes, URLs, and identifiers for your external identity
provider. The following examples describe the provider detail keys for each IdP type. These
values and their schema are subject to change. Social IdP authorize_scopes values must
match the values listed here. OpenID Connect (OIDC) Amazon Cognito accepts the following
elements when it can't discover endpoint URLs from oidc_issuer: attributes_url,
authorize_url, jwks_uri, token_url. Create or update request: \"ProviderDetails\": {
\"attributes_request_method\": \"GET\", \"attributes_url\":
\"https://auth.example.com/userInfo\", \"authorize_scopes\": \"openid profile email\",
\"authorize_url\": \"https://auth.example.com/authorize\", \"client_id\":
\"1example23456789\", \"client_secret\": \"provider-app-client-secret\", \"jwks_uri\":
\"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":
\"https://auth.example.com\", \"token_url\": \"https://example.com/token\" } Describe
response: \"ProviderDetails\": { \"attributes_request_method\": \"GET\",
\"attributes_url\": \"https://auth.example.com/userInfo\",
\"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"openid profile
email\", \"authorize_url\": \"https://auth.example.com/authorize\", \"client_id\":
\"1example23456789\", \"client_secret\": \"provider-app-client-secret\", \"jwks_uri\":
\"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":
\"https://auth.example.com\", \"token_url\": \"https://example.com/token\" } SAML Create
or update request with Metadata URL: \"ProviderDetails\": { \"IDPInit\": \"true\",
\"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"MetadataURL\":
\"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\": \"rsa-sha256\"
} Create or update request with Metadata file: \"ProviderDetails\": { \"IDPInit\":
\"true\", \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"MetadataFile\":
\"[metadata XML]\", \"RequestSigningAlgorithm\": \"rsa-sha256\" } The value of
MetadataFile must be the plaintext metadata document with all quote (\") characters escaped
by backslashes. Describe response: \"ProviderDetails\": { \"IDPInit\": \"true\",
\"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\",
\"ActiveEncryptionCertificate\": \"[certificate]\", \"MetadataURL\":
\"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\":
\"rsa-sha256\", \"SLORedirectBindingURI\": \"https://auth.example.com/slo/saml\",
\"SSORedirectBindingURI\": \"https://auth.example.com/sso/saml\" } LoginWithAmazon
Create or update request: \"ProviderDetails\": { \"authorize_scopes\": \"profile
postal_code\", \"client_id\": \"amzn1.application-oa2-client.1example23456789\",
\"client_secret\": \"provider-app-client-secret\" Describe response: \"ProviderDetails\":
{ \"attributes_url\": \"https://api.amazon.com/user/profile\",
\"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"profile
postal_code\", \"authorize_url\": \"https://www.amazon.com/ap/oa\", \"client_id\":
\"amzn1.application-oa2-client.1example23456789\", \"client_secret\":
\"provider-app-client-secret\", \"token_request_method\": \"POST\", \"token_url\":
\"https://api.amazon.com/auth/o2/token\" } Google Create or update request:
\"ProviderDetails\": { \"authorize_scopes\": \"email profile openid\", \"client_id\":
\"1example23456789.apps.googleusercontent.com\", \"client_secret\":
\"provider-app-client-secret\" } Describe response: \"ProviderDetails\": {
\"attributes_url\": \"https://people.googleapis.com/v1/people/me?personFields=\",
\"attributes_url_add_attributes\": \"true\", \"authorize_scopes\": \"email profile
openid\", \"authorize_url\": \"https://accounts.google.com/o/oauth2/v2/auth\",
\"client_id\": \"1example23456789.apps.googleusercontent.com\", \"client_secret\":
\"provider-app-client-secret\", \"oidc_issuer\": \"https://accounts.google.com\",
\"token_request_method\": \"POST\", \"token_url\":
\"https://www.googleapis.com/oauth2/v4/token\" } SignInWithApple Create or update
request: \"ProviderDetails\": { \"authorize_scopes\": \"email name\", \"client_id\":
\"com.example.cognito\", \"private_key\": \"1EXAMPLE\", \"key_id\": \"2EXAMPLE\",
\"team_id\": \"3EXAMPLE\" } Describe response: \"ProviderDetails\": {
\"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"email name\",
\"authorize_url\": \"https://appleid.apple.com/auth/authorize\", \"client_id\":
\"com.example.cognito\", \"key_id\": \"1EXAMPLE\", \"oidc_issuer\":
\"https://appleid.apple.com\", \"team_id\": \"2EXAMPLE\", \"token_request_method\":
\"POST\", \"token_url\": \"https://appleid.apple.com/auth/token\" } Facebook Create or
update request: \"ProviderDetails\": { \"api_version\": \"v17.0\", \"authorize_scopes\":
\"public_profile, email\", \"client_id\": \"1example23456789\", \"client_secret\":
\"provider-app-client-secret\" } Describe response: \"ProviderDetails\": {
\"api_version\": \"v17.0\", \"attributes_url\":
\"https://graph.facebook.com/v17.0/me?fields=\", \"attributes_url_add_attributes\":
\"true\", \"authorize_scopes\": \"public_profile, email\", \"authorize_url\":
\"https://www.facebook.com/v17.0/dialog/oauth\", \"client_id\": \"1example23456789\",
\"client_secret\": \"provider-app-client-secret\", \"token_request_method\": \"GET\",
\"token_url\": \"https://graph.facebook.com/v17.0/oauth/access_token\" }
"""
function update_identity_provider(
ProviderName, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"UpdateIdentityProvider",
Dict{String,Any}("ProviderName" => ProviderName, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_identity_provider(
ProviderName,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateIdentityProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ProviderName" => ProviderName, "UserPoolId" => UserPoolId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_server(identifier, name, user_pool_id)
update_resource_server(identifier, name, user_pool_id, params::Dict{String,<:Any})
Updates the name and scopes of resource server. All other fields are read-only. If you
don't provide a value for an attribute, it is set to the default value. Amazon Cognito
evaluates Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you must use IAM credentials to authorize requests, and you must grant
yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web
Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `identifier`: A unique resource server identifier for the resource server. The identifier
can be an API friendly name like solar-system-data. You can also set an API URL like
https://solar-system-data-api.example.com as your identifier. Amazon Cognito represents
scopes in the access token in the format resource-server-identifier/scope. Longer
scope-identifier strings increase the size of your access tokens.
- `name`: The name of the resource server.
- `user_pool_id`: The user pool ID for the user pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Scopes"`: The scope values to be set for the resource server.
"""
function update_resource_server(
Identifier, Name, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"UpdateResourceServer",
Dict{String,Any}(
"Identifier" => Identifier, "Name" => Name, "UserPoolId" => UserPoolId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_server(
Identifier,
Name,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateResourceServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Identifier" => Identifier, "Name" => Name, "UserPoolId" => UserPoolId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_attributes(access_token, user_attributes)
update_user_attributes(access_token, user_attributes, params::Dict{String,<:Any})
With this operation, your users can update one or more of their attributes with their own
credentials. You authorize this API request with the user's access token. To delete an
attribute from your user, submit the attribute in your API request with a blank value.
Custom attribute values in this request must include the custom: prefix. Authorize this
action with a signed-in user's access token. It must include the scope
aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you can't
use IAM credentials to authorize requests, and you can't grant IAM permissions in policies.
For more information about authorization models in Amazon Cognito, see Using the Amazon
Cognito user pools API and user pool endpoints. This action might generate an SMS text
message. Starting June 1, 2021, US telecom carriers require you to register an origination
phone number before you can send SMS messages to US phone numbers. If you use SMS text
messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon
Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must
receive SMS messages might not be able to sign up, activate their accounts, or sign in. If
you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,
Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox
mode , you can send messages only to verified phone numbers. After you test your app while
in the sandbox environment, you can move out of the sandbox and into production. For more
information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito
Developer Guide.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user whose user
attributes you want to update.
- `user_attributes`: An array of name-value pairs representing user attributes. For custom
attributes, you must prepend the custom: prefix to the attribute name. If you have set an
attribute to require verification before Amazon Cognito updates its value, this request
doesn’t immediately update the value of that attribute. After your user receives and
responds to a verification message to verify the new value, Amazon Cognito updates the
attribute value. Your user can sign in and receive messages with the original attribute
value until they verify the new value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientMetadata"`: A map of custom key-value pairs that you can provide as input for any
custom workflows that this action initiates. You create custom workflows by assigning
Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action,
Amazon Cognito invokes the function that is assigned to the custom message trigger. When
Amazon Cognito invokes this function, it passes a JSON payload, which the function receives
as input. This payload contains a clientMetadata attribute, which provides the data that
you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your
function code in Lambda, you can process the clientMetadata value to enhance your workflow
for your specific needs. For more information, see Customizing user pool Workflows with
Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata
parameter, remember that Amazon Cognito won't do the following: Store the ClientMetadata
value. This data is available only to Lambda triggers that are assigned to a user pool to
support custom workflows. If your user pool configuration doesn't include triggers, the
ClientMetadata parameter serves no purpose. Validate the ClientMetadata value. Encrypt
the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
"""
function update_user_attributes(
AccessToken, UserAttributes; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"UpdateUserAttributes",
Dict{String,Any}("AccessToken" => AccessToken, "UserAttributes" => UserAttributes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_attributes(
AccessToken,
UserAttributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateUserAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessToken" => AccessToken, "UserAttributes" => UserAttributes
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_pool(user_pool_id)
update_user_pool(user_pool_id, params::Dict{String,<:Any})
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers
require you to register an origination phone number before you can send SMS messages to US
phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone
number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically.
Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up,
activate their accounts, or sign in. If you have never used SMS text messages with Amazon
Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place
your account in the SMS sandbox. In sandbox mode , you can send messages only to verified
phone numbers. After you test your app while in the sandbox environment, you can move out
of the sandbox and into production. For more information, see SMS message settings for
Amazon Cognito user pools in the Amazon Cognito Developer Guide. Updates the specified
user pool with the specified attributes. You can get a list of the current user pool
settings using DescribeUserPool. If you don't provide a value for an attribute, Amazon
Cognito sets it to its default value. Amazon Cognito evaluates Identity and Access
Management (IAM) policies in requests for this API operation. For this operation, you must
use IAM credentials to authorize requests, and you must grant yourself the corresponding
IAM permission in a policy. Learn more Signing Amazon Web Services API Requests
Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `user_pool_id`: The user pool ID for the user pool you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountRecoverySetting"`: The available verified method a user can use to recover their
password when they call ForgotPassword. You can use this setting to define a preferred
method when a user has more than one method available. With this setting, SMS doesn't
qualify for a valid password recovery mechanism if the user also has SMS multi-factor
authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the
legacy behavior to determine the recovery method where SMS is preferred through email.
- `"AdminCreateUserConfig"`: The configuration for AdminCreateUser requests.
- `"AutoVerifiedAttributes"`: The attributes that are automatically verified when Amazon
Cognito requests to update user pools.
- `"DeletionProtection"`: When active, DeletionProtection prevents accidental deletion of
your user pool. Before you can delete a user pool that you have protected against deletion,
you must deactivate this feature. When you try to delete a protected user pool in a
DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To
delete a protected user pool, send a new DeleteUserPool request after you deactivate
deletion protection in an UpdateUserPool API request.
- `"DeviceConfiguration"`: The device-remembering configuration for a user pool. A null
value indicates that you have deactivated device remembering in your user pool. When you
provide a value for any DeviceConfiguration field, you activate the Amazon Cognito
device-remembering feature.
- `"EmailConfiguration"`: The email configuration of your user pool. The email
configuration type sets your preferred sending method, Amazon Web Services Region, and
sender for email invitation and verification messages from your user pool.
- `"EmailVerificationMessage"`: This parameter is no longer used. See
VerificationMessageTemplateType.
- `"EmailVerificationSubject"`: This parameter is no longer used. See
VerificationMessageTemplateType.
- `"LambdaConfig"`: The Lambda configuration information from the request to update the
user pool.
- `"MfaConfiguration"`: Possible values include: OFF - MFA tokens aren't required and
can't be specified during user registration. ON - MFA tokens are required for all user
registrations. You can only specify ON when you're initially creating a user pool. You can
use the SetUserPoolMfaConfig API operation to turn MFA \"ON\" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.
- `"Policies"`: A container with the policies you want to update in a user pool.
- `"SmsAuthenticationMessage"`: The contents of the SMS authentication message.
- `"SmsConfiguration"`: The SMS configuration with the settings that your Amazon Cognito
user pool must use to send an SMS message from your Amazon Web Services account through
Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web
Services Region that you want, the Amazon Cognito user pool uses an Identity and Access
Management (IAM) role in your Amazon Web Services account.
- `"SmsVerificationMessage"`: This parameter is no longer used. See
VerificationMessageTemplateType.
- `"UserAttributeUpdateSettings"`: The settings for updates to user attributes. These
settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool
setting that tells Amazon Cognito how to handle changes to the value of your users' email
address and phone number attributes. For more information, see Verifying updates to email
addresses and phone numbers.
- `"UserPoolAddOns"`: User pool add-ons. Contains settings for activation of advanced
security features. To log user security information but take no action, set to AUDIT. To
configure automatic security responses to risky traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool.
- `"UserPoolTags"`: The tag keys and values to assign to the user pool. A tag is a label
that you can use to categorize and manage user pools in different ways, such as by purpose,
owner, environment, or other criteria.
- `"VerificationMessageTemplate"`: The template for verification messages.
"""
function update_user_pool(UserPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"UpdateUserPool",
Dict{String,Any}("UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_pool(
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateUserPool",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserPoolId" => UserPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_pool_client(client_id, user_pool_id)
update_user_pool_client(client_id, user_pool_id, params::Dict{String,<:Any})
Updates the specified user pool app client with the specified attributes. You can get a
list of the current user pool app client settings using DescribeUserPoolClient. If you
don't provide a value for an attribute, Amazon Cognito sets it to its default value. You
can also use this operation to enable token revocation for user pool clients. For more
information about revoking tokens, see RevokeToken. Amazon Cognito evaluates Identity and
Access Management (IAM) policies in requests for this API operation. For this operation,
you must use IAM credentials to authorize requests, and you must grant yourself the
corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API
Requests Using the Amazon Cognito user pools API and user pool endpoints
# Arguments
- `client_id`: The ID of the client associated with the user pool.
- `user_pool_id`: The user pool ID for the user pool where you want to update the user pool
client.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessTokenValidity"`: The access token time limit. After this limit expires, your user
can't use their access token. To specify the time unit for AccessTokenValidity as seconds,
minutes, hours, or days, set a TokenValidityUnits value in your API request. For example,
when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can
authorize access with their access token for 10 hours. The default time unit for
AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens
are valid for one hour.
- `"AllowedOAuthFlows"`: The allowed OAuth flows. code Use a code grant flow, which
provides an authorization code as the response. This code can be exchanged for access
tokens with the /oauth2/token endpoint. implicit Issue the access token (and, optionally,
ID token, based on scopes) directly to your user. client_credentials Issue the access
token from the /oauth2/token endpoint directly to a non-person user using a combination of
the client ID and client secret.
- `"AllowedOAuthFlowsUserPoolClient"`: Set to true to use OAuth 2.0 features in your user
pool app client. AllowedOAuthFlowsUserPoolClient must be true before you can configure the
following features in your app client. CallBackURLs: Callback URLs. LogoutURLs:
Sign-out redirect URLs. AllowedOAuthScopes: OAuth 2.0 scopes. AllowedOAuthFlows:
Support for authorization code, implicit, and client credentials OAuth 2.0 grants. To use
OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient
API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with
the CLI or SDKs, it defaults to false.
- `"AllowedOAuthScopes"`: The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and profile. Possible values provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
- `"AnalyticsConfiguration"`: The Amazon Pinpoint analytics configuration necessary to
collect metrics for this user pool. In Amazon Web Services Regions where Amazon Pinpoint
isn't available, user pools only support sending events to Amazon Pinpoint projects in
us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events
to Amazon Pinpoint projects within that same Region.
- `"AuthSessionValidity"`: Amazon Cognito creates a session token for each API request in
an authentication flow. AuthSessionValidity is the duration, in minutes, of that session
token. Your user pool native user must respond to each authentication challenge before the
session expires.
- `"CallbackURLs"`: A list of allowed redirect (callback) URLs for the IdPs. A redirect URI
must: Be an absolute URI. Be registered with the authorization server. Not include a
fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS
over HTTP except for http://localhost for testing purposes only. App callback URLs such as
myapp://example are also supported.
- `"ClientName"`: The client name from the update user pool client request.
- `"DefaultRedirectURI"`: The default redirect URI. Must be in the CallbackURLs list. A
redirect URI must: Be an absolute URI. Be registered with the authorization server.
Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito
requires HTTPS over HTTP except for http://localhost for testing purposes only. App
callback URLs such as myapp://example are also supported.
- `"EnablePropagateAdditionalUserContextData"`: Activates the propagation of additional
user context data. For more information about propagation of user context data, see Adding
advanced security to a user pool. If you don’t include this parameter, you can't send
device fingerprint information, including source IP address, to Amazon Cognito advanced
security. You can only activate EnablePropagateAdditionalUserContextData in an app client
that has a client secret.
- `"EnableTokenRevocation"`: Activates or deactivates token revocation. For more
information about revoking tokens, see RevokeToken.
- `"ExplicitAuthFlows"`: The authentication flows that you want your user pool client to
support. For each app client in your user pool, you can sign in your users with any
combination of one or more flows, including with a user name and Secure Remote Password
(SRP), a user name and password, or a custom authentication process that you define with
Lambda functions. If you don't specify a value for ExplicitAuthFlows, your user client
supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH. Valid
values include: ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password
authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH
setting. With this authentication flow, your app passes a user name and password to Amazon
Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to
securely transmit the password. ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication. ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In
this flow, Amazon Cognito receives the password in the request instead of using the SRP
protocol to verify passwords. ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens. In some environments, you
will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You
can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as
values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.
- `"IdTokenValidity"`: The ID token time limit. After this limit expires, your user can't
use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes,
hours, or days, set a TokenValidityUnits value in your API request. For example, when you
set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their
session with their ID token for 10 hours. The default time unit for IdTokenValidity in an
API request is hours. Valid range is displayed below in seconds. If you don't specify
otherwise in the configuration of your app client, your ID tokens are valid for one hour.
- `"LogoutURLs"`: A list of allowed logout URLs for the IdPs.
- `"PreventUserExistenceErrors"`: Errors and responses that you want Amazon Cognito APIs to
return during authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the user doesn't exist,
authentication returns an error indicating either the username or password was incorrect.
Account confirmation and password recovery return a response indicating a code was sent to
a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool. Valid values include: ENABLED -
This prevents user existence-related errors. LEGACY - This represents the early behavior
of Amazon Cognito where user existence related errors aren't prevented.
- `"ReadAttributes"`: The list of user attributes that you want your app client to have
read-only access to. After your user authenticates in your app, their access token
authorizes them to read their own attribute value for any attribute in this list. An
example of this kind of activity is when your user selects a link to view their profile
information. Your app makes a GetUser API request to retrieve and display your user's
profile data. When you don't specify the ReadAttributes for your app client, your app can
read the values of email_verified, phone_number_verified, and the Standard attributes of
your user pool. When your user pool has read access to these default attributes,
ReadAttributes doesn't return any information. Amazon Cognito only populates ReadAttributes
in the API response if you have specified your own custom set of read attributes.
- `"RefreshTokenValidity"`: The refresh token time limit. After this limit expires, your
user can't use their refresh token. To specify the time unit for RefreshTokenValidity as
seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request. For
example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user
can refresh their session and retrieve new access and ID tokens for 10 days. The default
time unit for RefreshTokenValidity in an API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default
value of 30 days. Valid range is displayed below in seconds. If you don't specify otherwise
in the configuration of your app client, your refresh tokens are valid for 30 days.
- `"SupportedIdentityProviders"`: A list of provider names for the IdPs that this client
supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple,
LoginWithAmazon, and the names of your own SAML and OIDC providers.
- `"TokenValidityUnits"`: The time units you use when you set the duration of ID, access,
and refresh tokens. The default unit for RefreshToken is days, and the default for ID and
access tokens is hours.
- `"WriteAttributes"`: The list of user attributes that you want your app client to have
write access to. After your user authenticates in your app, their access token authorizes
them to set or modify their own attribute value for any attribute in this list. An example
of this kind of activity is when you present your user with a form to update their profile
information and they change their last name. Your app then makes an UpdateUserAttributes
API request and sets family_name to the new value. When you don't specify the
WriteAttributes for your app client, your app can write the values of the Standard
attributes of your user pool. When your user pool has write access to these default
attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates
WriteAttributes in the API response if you have specified your own custom set of write
attributes. If your app client allows users to sign in through an IdP, this array must
include all attributes that you have mapped to IdP attributes. Amazon Cognito updates
mapped attributes when users sign in to your application through an IdP. If your app client
does not have write access to a mapped attribute, Amazon Cognito throws an error when it
tries to update the attribute. For more information, see Specifying IdP Attribute Mappings
for Your user pool.
"""
function update_user_pool_client(
ClientId, UserPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"UpdateUserPoolClient",
Dict{String,Any}("ClientId" => ClientId, "UserPoolId" => UserPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_pool_client(
ClientId,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateUserPoolClient",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientId" => ClientId, "UserPoolId" => UserPoolId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_pool_domain(custom_domain_config, domain, user_pool_id)
update_user_pool_domain(custom_domain_config, domain, user_pool_id, params::Dict{String,<:Any})
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user
pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new
certificate to Amazon Cognito. You can't use it to change the domain for a user pool. A
custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and
sign-in pages for your application. When you set up a custom domain, you provide a
certificate that you manage with Certificate Manager (ACM). When necessary, you can use
this operation to change the certificate that you applied to your custom domain. Usually,
this is unnecessary following routine certificate renewal with ACM. When you renew your
existing certificate in ACM, the ARN for your certificate remains the same, and your custom
domain uses the new certificate automatically. However, if you replace your existing
certificate with a new one, ACM gives the new certificate a new ARN. To apply the new
certificate to your custom domain, you must provide this ARN to Amazon Cognito. When you
add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web
Services Region. After you submit your request, Amazon Cognito requires up to 1 hour to
distribute your new certificate to your custom domain. For more information about adding a
custom domain to your user pool, see Using Your Own Domain for the Hosted UI. Amazon
Cognito evaluates Identity and Access Management (IAM) policies in requests for this API
operation. For this operation, you must use IAM credentials to authorize requests, and you
must grant yourself the corresponding IAM permission in a policy. Learn more Signing
Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool
endpoints
# Arguments
- `custom_domain_config`: The configuration for a custom domain that hosts the sign-up and
sign-in pages for your application. Use this object to specify an SSL certificate that is
managed by ACM.
- `domain`: The domain name for the custom domain that hosts the sign-up and sign-in pages
for your application. One example might be auth.example.com. This string can include only
lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last
character. Use periods to separate subdomain names.
- `user_pool_id`: The ID of the user pool that is associated with the custom domain whose
certificate you're updating.
"""
function update_user_pool_domain(
CustomDomainConfig,
Domain,
UserPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateUserPoolDomain",
Dict{String,Any}(
"CustomDomainConfig" => CustomDomainConfig,
"Domain" => Domain,
"UserPoolId" => UserPoolId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_pool_domain(
CustomDomainConfig,
Domain,
UserPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"UpdateUserPoolDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CustomDomainConfig" => CustomDomainConfig,
"Domain" => Domain,
"UserPoolId" => UserPoolId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_software_token(user_code)
verify_software_token(user_code, params::Dict{String,<:Any})
Use this API to register a user's entered time-based one-time password (TOTP) code and mark
the user's software token MFA status as \"verified\" if successful. The request takes an
access token or a session string, but not both. Amazon Cognito doesn't evaluate Identity
and Access Management (IAM) policies in requests for this API operation. For this
operation, you can't use IAM credentials to authorize requests, and you can't grant IAM
permissions in policies. For more information about authorization models in Amazon Cognito,
see Using the Amazon Cognito user pools API and user pool endpoints.
# Arguments
- `user_code`: The one- time password computed using the secret code returned by
AssociateSoftwareToken.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessToken"`: A valid access token that Amazon Cognito issued to the user whose
software token you want to verify.
- `"FriendlyDeviceName"`: The friendly device name.
- `"Session"`: The session that should be passed both ways in challenge-response calls to
the service.
"""
function verify_software_token(UserCode; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_identity_provider(
"VerifySoftwareToken",
Dict{String,Any}("UserCode" => UserCode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_software_token(
UserCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"VerifySoftwareToken",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserCode" => UserCode), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_user_attribute(access_token, attribute_name, code)
verify_user_attribute(access_token, attribute_name, code, params::Dict{String,<:Any})
Verifies the specified user attributes in the user pool. If your user pool requires
verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates
the affected attribute to its pending value. For more information, see
UserAttributeUpdateSettingsType. Authorize this action with a signed-in user's access
token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't
evaluate Identity and Access Management (IAM) policies in requests for this API operation.
For this operation, you can't use IAM credentials to authorize requests, and you can't
grant IAM permissions in policies. For more information about authorization models in
Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
# Arguments
- `access_token`: A valid access token that Amazon Cognito issued to the user whose user
attributes you want to verify.
- `attribute_name`: The attribute name in the request to verify user attributes.
- `code`: The verification code in the request to verify user attributes.
"""
function verify_user_attribute(
AccessToken, AttributeName, Code; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_identity_provider(
"VerifyUserAttribute",
Dict{String,Any}(
"AccessToken" => AccessToken, "AttributeName" => AttributeName, "Code" => Code
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_user_attribute(
AccessToken,
AttributeName,
Code,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_identity_provider(
"VerifyUserAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessToken" => AccessToken,
"AttributeName" => AttributeName,
"Code" => Code,
),
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 | 27189 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: cognito_sync
using AWS.Compat
using AWS.UUIDs
"""
bulk_publish(identity_pool_id)
bulk_publish(identity_pool_id, params::Dict{String,<:Any})
Initiates a bulk publish of all existing datasets for an Identity Pool to the configured
stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is
an asynchronous request, customers can see the status of the request via the
GetBulkPublishDetails operation.This API can only be called with developer credentials. You
cannot call this API with the temporary user credentials provided by Cognito Identity.
# Arguments
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
"""
function bulk_publish(IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/bulkpublish";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function bulk_publish(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/bulkpublish",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset(dataset_name, identity_id, identity_pool_id)
delete_dataset(dataset_name, identity_id, identity_pool_id, params::Dict{String,<:Any})
Deletes the specific dataset. The dataset will be deleted permanently, and the action can't
be undone. Datasets that this dataset was merged with will no longer report the merge. Any
subsequent operation on this dataset will result in a ResourceNotFoundException. This API
can be called with temporary user credentials provided by Cognito Identity or with
developer credentials.
# Arguments
- `dataset_name`: A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
- `identity_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
"""
function delete_dataset(
DatasetName,
IdentityId,
IdentityPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"DELETE",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dataset(
DatasetName,
IdentityId,
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"DELETE",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset(dataset_name, identity_id, identity_pool_id)
describe_dataset(dataset_name, identity_id, identity_pool_id, params::Dict{String,<:Any})
Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each
identity has access only to its own data. Thus, the credentials used to make this API call
need to have access to the identity data. This API can be called with temporary user
credentials provided by Cognito Identity or with developer credentials. You should use
Cognito Identity credentials to make this API call.
# Arguments
- `dataset_name`: A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
- `identity_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
"""
function describe_dataset(
DatasetName,
IdentityId,
IdentityPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dataset(
DatasetName,
IdentityId,
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_identity_pool_usage(identity_pool_id)
describe_identity_pool_usage(identity_pool_id, params::Dict{String,<:Any})
Gets usage details (for example, data storage) about a particular identity pool. This API
can only be called with developer credentials. You cannot call this API with the temporary
user credentials provided by Cognito Identity.
# Arguments
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
"""
function describe_identity_pool_usage(
IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_identity_pool_usage(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_identity_usage(identity_id, identity_pool_id)
describe_identity_usage(identity_id, identity_pool_id, params::Dict{String,<:Any})
Gets usage information for an identity, including number of datasets and data usage. This
API can be called with temporary user credentials provided by Cognito Identity or with
developer credentials.
# Arguments
- `identity_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
"""
function describe_identity_usage(
IdentityId, IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_identity_usage(
IdentityId,
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bulk_publish_details(identity_pool_id)
get_bulk_publish_details(identity_pool_id, params::Dict{String,<:Any})
Get the status of the last BulkPublish operation for an identity pool.This API can only be
called with developer credentials. You cannot call this API with the temporary user
credentials provided by Cognito Identity.
# Arguments
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
"""
function get_bulk_publish_details(
IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/getBulkPublishDetails";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bulk_publish_details(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/getBulkPublishDetails",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cognito_events(identity_pool_id)
get_cognito_events(identity_pool_id, params::Dict{String,<:Any})
Gets the events and the corresponding Lambda functions associated with an identity
pool.This API can only be called with developer credentials. You cannot call this API with
the temporary user credentials provided by Cognito Identity.
# Arguments
- `identity_pool_id`: The Cognito Identity Pool ID for the request
"""
function get_cognito_events(
IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/events";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cognito_events(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/events",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_identity_pool_configuration(identity_pool_id)
get_identity_pool_configuration(identity_pool_id, params::Dict{String,<:Any})
Gets the configuration settings of an identity pool.This API can only be called with
developer credentials. You cannot call this API with the temporary user credentials
provided by Cognito Identity.
# Arguments
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID
of the pool for which to return a configuration.
"""
function get_identity_pool_configuration(
IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_identity_pool_configuration(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_datasets(identity_id, identity_pool_id)
list_datasets(identity_id, identity_pool_id, params::Dict{String,<:Any})
Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to
its own data. Thus, the credentials used to make this API call need to have access to the
identity data. ListDatasets can be called with temporary user credentials provided by
Cognito Identity or with developer credentials. You should use the Cognito Identity
credentials to make this API call.
# Arguments
- `identity_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned.
- `"nextToken"`: A pagination token for obtaining the next page of results.
"""
function list_datasets(
IdentityId, IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_datasets(
IdentityId,
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_identity_pool_usage()
list_identity_pool_usage(params::Dict{String,<:Any})
Gets a list of identity pools registered with Cognito. ListIdentityPoolUsage can only be
called with developer credentials. You cannot make this API call with the temporary user
credentials provided by Cognito Identity.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned.
- `"nextToken"`: A pagination token for obtaining the next page of results.
"""
function list_identity_pool_usage(; aws_config::AbstractAWSConfig=global_aws_config())
return cognito_sync(
"GET", "/identitypools"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_identity_pool_usage(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_sync(
"GET",
"/identitypools",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_records(dataset_name, identity_id, identity_pool_id)
list_records(dataset_name, identity_id, identity_pool_id, params::Dict{String,<:Any})
Gets paginated records, optionally changed after a particular sync count for a dataset and
identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus,
the credentials used to make this API call need to have access to the identity data.
ListRecords can be called with temporary user credentials provided by Cognito Identity or
with developer credentials. You should use Cognito Identity credentials to make this API
call.
# Arguments
- `dataset_name`: A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
- `identity_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"lastSyncCount"`: The last server sync count for this record.
- `"maxResults"`: The maximum number of results to be returned.
- `"nextToken"`: A pagination token for obtaining the next page of results.
- `"syncSessionToken"`: A token containing a session ID, identity ID, and expiration.
"""
function list_records(
DatasetName,
IdentityId,
IdentityPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)/records";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_records(
DatasetName,
IdentityId,
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"GET",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)/records",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_device(identity_id, identity_pool_id, platform, token)
register_device(identity_id, identity_pool_id, platform, token, params::Dict{String,<:Any})
Registers a device to receive push sync notifications.This API can only be called with
temporary credentials provided by Cognito Identity. You cannot call this API with developer
credentials.
# Arguments
- `identity_id`: The unique ID for this identity.
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of
the pool that the identity belongs to.
- `platform`: The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
- `token`: The push token.
"""
function register_device(
IdentityId,
IdentityPoolId,
Platform,
Token;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/identity/$(IdentityId)/device",
Dict{String,Any}("Platform" => Platform, "Token" => Token);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_device(
IdentityId,
IdentityPoolId,
Platform,
Token,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/identity/$(IdentityId)/device",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Platform" => Platform, "Token" => Token), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_cognito_events(events, identity_pool_id)
set_cognito_events(events, identity_pool_id, params::Dict{String,<:Any})
Sets the AWS Lambda function for a given event type for an identity pool. This request only
updates the key/value pair specified. Other key/values pairs are not updated. To remove a
key value pair, pass a empty value for the particular key.This API can only be called with
developer credentials. You cannot call this API with the temporary user credentials
provided by Cognito Identity.
# Arguments
- `events`: The events to configure
- `identity_pool_id`: The Cognito Identity Pool to use when configuring Cognito Events
"""
function set_cognito_events(
Events, IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/events",
Dict{String,Any}("Events" => Events);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_cognito_events(
Events,
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/events",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Events" => Events), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_identity_pool_configuration(identity_pool_id)
set_identity_pool_configuration(identity_pool_id, params::Dict{String,<:Any})
Sets the necessary configuration for push sync.This API can only be called with developer
credentials. You cannot call this API with the temporary user credentials provided by
Cognito Identity.
# Arguments
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID
of the pool to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CognitoStreams"`: Options to apply to this identity pool for Amazon Cognito streams.
- `"PushSync"`: Options to apply to this identity pool for push synchronization.
"""
function set_identity_pool_configuration(
IdentityPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_identity_pool_configuration(
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
subscribe_to_dataset(dataset_name, device_id, identity_id, identity_pool_id)
subscribe_to_dataset(dataset_name, device_id, identity_id, identity_pool_id, params::Dict{String,<:Any})
Subscribes to receive notifications when a dataset is modified by another device.This API
can only be called with temporary credentials provided by Cognito Identity. You cannot call
this API with developer credentials.
# Arguments
- `dataset_name`: The name of the dataset to subcribe to.
- `device_id`: The unique ID generated for this device by Cognito.
- `identity_id`: Unique ID for this identity.
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the
pool to which the identity belongs.
"""
function subscribe_to_dataset(
DatasetName,
DeviceId,
IdentityId,
IdentityPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)/subscriptions/$(DeviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function subscribe_to_dataset(
DatasetName,
DeviceId,
IdentityId,
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)/subscriptions/$(DeviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unsubscribe_from_dataset(dataset_name, device_id, identity_id, identity_pool_id)
unsubscribe_from_dataset(dataset_name, device_id, identity_id, identity_pool_id, params::Dict{String,<:Any})
Unsubscribes from receiving notifications when a dataset is modified by another device.This
API can only be called with temporary credentials provided by Cognito Identity. You cannot
call this API with developer credentials.
# Arguments
- `dataset_name`: The name of the dataset from which to unsubcribe.
- `device_id`: The unique ID generated for this device by Cognito.
- `identity_id`: Unique ID for this identity.
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the
pool to which this identity belongs.
"""
function unsubscribe_from_dataset(
DatasetName,
DeviceId,
IdentityId,
IdentityPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"DELETE",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)/subscriptions/$(DeviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unsubscribe_from_dataset(
DatasetName,
DeviceId,
IdentityId,
IdentityPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"DELETE",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)/subscriptions/$(DeviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_records(dataset_name, identity_id, identity_pool_id, sync_session_token)
update_records(dataset_name, identity_id, identity_pool_id, sync_session_token, params::Dict{String,<:Any})
Posts updates to records and adds and deletes records for a dataset and user. The sync
count in the record patch is your last known sync count for that record. The server will
reject an UpdateRecords request with a ResourceConflictException if you try to patch a
record with a new value but a stale sync count.For example, if the sync count on the server
is 5 for a key called highScore and you try and submit a new highScore with sync count of
4, the request will be rejected. To obtain the current sync count for a record, call
ListRecords. On a successful update of the record, the response returns the new sync count
for that record. You should present that sync count the next time you try to update that
same record. When the record does not exist, specify the sync count as 0. This API can be
called with temporary user credentials provided by Cognito Identity or with developer
credentials.
# Arguments
- `dataset_name`: A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
- `identity_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
- `identity_pool_id`: A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation
is unique within a region.
- `sync_session_token`: The SyncSessionToken returned by a previous call to ListRecords for
this dataset and identity.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeviceId"`: The unique ID generated for this device by Cognito.
- `"RecordPatches"`: A list of patch operations.
- `"x-amz-Client-Context"`: Intended to supply a device ID that will populate the
lastModifiedBy field referenced in other methods. The ClientContext field is not yet
implemented.
"""
function update_records(
DatasetName,
IdentityId,
IdentityPoolId,
SyncSessionToken;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)",
Dict{String,Any}("SyncSessionToken" => SyncSessionToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_records(
DatasetName,
IdentityId,
IdentityPoolId,
SyncSessionToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cognito_sync(
"POST",
"/identitypools/$(IdentityPoolId)/identities/$(IdentityId)/datasets/$(DatasetName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SyncSessionToken" => SyncSessionToken), 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 | 146339 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: comprehend
using AWS.Compat
using AWS.UUIDs
"""
batch_detect_dominant_language(text_list)
batch_detect_dominant_language(text_list, params::Dict{String,<:Any})
Determines the dominant language of the input text for a batch of documents. For a list of
languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
# Arguments
- `text_list`: A list containing the UTF-8 encoded text of the input documents. The list
can contain a maximum of 25 documents. Each document should contain at least 20 characters.
The maximum size of each document is 5 KB.
"""
function batch_detect_dominant_language(
TextList; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"BatchDetectDominantLanguage",
Dict{String,Any}("TextList" => TextList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_detect_dominant_language(
TextList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"BatchDetectDominantLanguage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TextList" => TextList), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_detect_entities(language_code, text_list)
batch_detect_entities(language_code, text_list, params::Dict{String,<:Any})
Inspects the text of a batch of documents for named entities and returns information about
them. For more information about named entities, see Entities in the Comprehend Developer
Guide.
# Arguments
- `language_code`: The language of the input documents. You can specify any of the primary
languages supported by Amazon Comprehend. All documents must be in the same language.
- `text_list`: A list containing the UTF-8 encoded text of the input documents. The list
can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
"""
function batch_detect_entities(
LanguageCode, TextList; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"BatchDetectEntities",
Dict{String,Any}("LanguageCode" => LanguageCode, "TextList" => TextList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_detect_entities(
LanguageCode,
TextList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"BatchDetectEntities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "TextList" => TextList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_detect_key_phrases(language_code, text_list)
batch_detect_key_phrases(language_code, text_list, params::Dict{String,<:Any})
Detects the key noun phrases found in a batch of documents.
# Arguments
- `language_code`: The language of the input documents. You can specify any of the primary
languages supported by Amazon Comprehend. All documents must be in the same language.
- `text_list`: A list containing the UTF-8 encoded text of the input documents. The list
can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
"""
function batch_detect_key_phrases(
LanguageCode, TextList; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"BatchDetectKeyPhrases",
Dict{String,Any}("LanguageCode" => LanguageCode, "TextList" => TextList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_detect_key_phrases(
LanguageCode,
TextList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"BatchDetectKeyPhrases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "TextList" => TextList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_detect_sentiment(language_code, text_list)
batch_detect_sentiment(language_code, text_list, params::Dict{String,<:Any})
Inspects a batch of documents and returns an inference of the prevailing sentiment,
POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
# Arguments
- `language_code`: The language of the input documents. You can specify any of the primary
languages supported by Amazon Comprehend. All documents must be in the same language.
- `text_list`: A list containing the UTF-8 encoded text of the input documents. The list
can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
"""
function batch_detect_sentiment(
LanguageCode, TextList; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"BatchDetectSentiment",
Dict{String,Any}("LanguageCode" => LanguageCode, "TextList" => TextList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_detect_sentiment(
LanguageCode,
TextList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"BatchDetectSentiment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "TextList" => TextList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_detect_syntax(language_code, text_list)
batch_detect_syntax(language_code, text_list, params::Dict{String,<:Any})
Inspects the text of a batch of documents for the syntax and part of speech of the words in
the document and returns information about them. For more information, see Syntax in the
Comprehend Developer Guide.
# Arguments
- `language_code`: The language of the input documents. You can specify any of the
following languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"),
Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents
must be in the same language.
- `text_list`: A list containing the UTF-8 encoded text of the input documents. The list
can contain a maximum of 25 documents. The maximum size for each document is 5 KB.
"""
function batch_detect_syntax(
LanguageCode, TextList; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"BatchDetectSyntax",
Dict{String,Any}("LanguageCode" => LanguageCode, "TextList" => TextList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_detect_syntax(
LanguageCode,
TextList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"BatchDetectSyntax",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "TextList" => TextList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_detect_targeted_sentiment(language_code, text_list)
batch_detect_targeted_sentiment(language_code, text_list, params::Dict{String,<:Any})
Inspects a batch of documents and returns a sentiment analysis for each entity identified
in the documents. For more information about targeted sentiment, see Targeted sentiment in
the Amazon Comprehend Developer Guide.
# Arguments
- `language_code`: The language of the input documents. Currently, English is the only
supported language.
- `text_list`: A list containing the UTF-8 encoded text of the input documents. The list
can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
"""
function batch_detect_targeted_sentiment(
LanguageCode, TextList; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"BatchDetectTargetedSentiment",
Dict{String,Any}("LanguageCode" => LanguageCode, "TextList" => TextList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_detect_targeted_sentiment(
LanguageCode,
TextList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"BatchDetectTargetedSentiment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "TextList" => TextList),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
classify_document(endpoint_arn)
classify_document(endpoint_arn, params::Dict{String,<:Any})
Creates a classification request to analyze a single document in real-time.
ClassifyDocument supports the following model types: Custom classifier - a custom model
that you have created and trained. For input, you can provide plain text, a single-page
document (PDF, Word, or image), or Amazon Textract API output. For more information, see
Custom classification in the Amazon Comprehend Developer Guide. Prompt safety classifier
- Amazon Comprehend provides a pre-trained model for classifying input prompts for
generative AI applications. For input, you provide English plain text input. For prompt
safety classification, the response includes only the Classes field. For more information
about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend
Developer Guide. If the system detects errors while processing a page in the input
document, the API response includes an Errors field that describes the errors. If the
system detects a document-level error in your input document, the API returns an
InvalidRequestException error response. For details about this exception, see Errors in
semi-structured documents in the Comprehend Developer Guide.
# Arguments
- `endpoint_arn`: The Amazon Resource Number (ARN) of the endpoint. For prompt safety
classification, Amazon Comprehend provides the endpoint ARN. For more information about
prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend
Developer Guide For custom classification, you create an endpoint for your custom model.
For more information, see Using Amazon Comprehend endpoints.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Bytes"`: Use the Bytes parameter to input a text, PDF, Word or image file. When you
classify a document using a custom model, you can also use the Bytes parameter to input an
Amazon Textract DetectDocumentText or AnalyzeDocument output file. To classify a document
using the prompt safety classifier, use the Text parameter for input. Provide the input
document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services
SDK to classify documents, the SDK may encode the document file bytes for you. The maximum
length of this field depends on the input document type. For details, see Inputs for
real-time custom analysis in the Comprehend Developer Guide. If you use the Bytes
parameter, do not use the Text parameter.
- `"DocumentReaderConfig"`: Provides configuration parameters to override the default
actions for extracting text from PDF documents and image files.
- `"Text"`: The document text to be analyzed. If you enter text using this parameter, do
not use the Bytes parameter.
"""
function classify_document(EndpointArn; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ClassifyDocument",
Dict{String,Any}("EndpointArn" => EndpointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function classify_document(
EndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"ClassifyDocument",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointArn" => EndpointArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
contains_pii_entities(language_code, text)
contains_pii_entities(language_code, text, params::Dict{String,<:Any})
Analyzes input text for the presence of personally identifiable information (PII) and
returns the labels of identified PII entity types such as name, address, bank account
number, or phone number.
# Arguments
- `language_code`: The language of the input documents.
- `text`: A UTF-8 text string. The maximum string size is 100 KB.
"""
function contains_pii_entities(
LanguageCode, Text; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ContainsPiiEntities",
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function contains_pii_entities(
LanguageCode,
Text,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"ContainsPiiEntities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset(dataset_name, flywheel_arn, input_data_config)
create_dataset(dataset_name, flywheel_arn, input_data_config, params::Dict{String,<:Any})
Creates a dataset to upload training or test data for a model associated with a flywheel.
For more information about datasets, see Flywheel overview in the Amazon Comprehend
Developer Guide.
# Arguments
- `dataset_name`: Name of the dataset.
- `flywheel_arn`: The Amazon Resource Number (ARN) of the flywheel of the flywheel to
receive the data.
- `input_data_config`: Information about the input data configuration. The type of input
data varies based on the format of the input and whether the data is for a classifier model
or an entity recognition model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
- `"DatasetType"`: The dataset type. You can specify that the data in a dataset is for
training the model or for testing the model.
- `"Description"`: Description of the dataset.
- `"Tags"`: Tags for the dataset.
"""
function create_dataset(
DatasetName,
FlywheelArn,
InputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"CreateDataset",
Dict{String,Any}(
"DatasetName" => DatasetName,
"FlywheelArn" => FlywheelArn,
"InputDataConfig" => InputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset(
DatasetName,
FlywheelArn,
InputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"CreateDataset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatasetName" => DatasetName,
"FlywheelArn" => FlywheelArn,
"InputDataConfig" => InputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_document_classifier(data_access_role_arn, document_classifier_name, input_data_config, language_code)
create_document_classifier(data_access_role_arn, document_classifier_name, input_data_config, language_code, params::Dict{String,<:Any})
Creates a new document classifier that you can use to categorize documents. To create a
classifier, you provide a set of training documents that are labeled with the categories
that you want to use. For more information, see Training classifier models in the
Comprehend Developer Guide.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data.
- `document_classifier_name`: The name of the document classifier.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `language_code`: The language of the input documents. You can specify any of the
languages supported by Amazon Comprehend. All documents must be in the same language.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
- `"Mode"`: Indicates the mode in which the classifier will be trained. The classifier can
be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode
identifies a single class label for each document and multi-label mode identifies one or
more class labels for each document. Multiple labels for an individual document are
separated by a delimiter. The default delimiter between labels is a pipe (|).
- `"ModelKmsKeyId"`: ID for the KMS key that Amazon Comprehend uses to encrypt trained
custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID:
\"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"ModelPolicy"`: The resource-based policy to attach to your custom document classifier
model. You can use this policy to allow another Amazon Web Services account to import your
custom model. Provide your policy as a JSON body that you enter as a UTF-8 encoded string
without line breaks. To provide valid JSON, enclose the attribute names and values in
double quotes. If the JSON body is also enclosed in double quotes, then you must escape the
double quotes that are inside the policy: \"{\"attribute\": \"value\", \"attribute\":
[\"value\"]}\" To avoid escaping quotes, you can use single quotes to enclose the policy
and double quotes to enclose the JSON names and values: '{\"attribute\": \"value\",
\"attribute\": [\"value\"]}'
- `"OutputDataConfig"`: Specifies the location for the output files from a custom
classifier job. This parameter is required for a request that creates a native document
model.
- `"Tags"`: Tags to associate with the document classifier. A tag is a key-value pair that
adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with
\"Sales\" as the key might be added to a resource to indicate its use by the sales
department.
- `"VersionName"`: The version name given to the newly created classifier. Version names
can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores
(_) are allowed. The version name must be unique among all models with the same classifier
name in the Amazon Web Services account/Amazon Web Services Region.
- `"VolumeKmsKeyId"`: ID for the Amazon Web Services Key Management Service (KMS) key that
Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
following formats: KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon
Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"VpcConfig"`: Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your custom classifier. For more
information, see Amazon VPC.
"""
function create_document_classifier(
DataAccessRoleArn,
DocumentClassifierName,
InputDataConfig,
LanguageCode;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"CreateDocumentClassifier",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"DocumentClassifierName" => DocumentClassifierName,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_document_classifier(
DataAccessRoleArn,
DocumentClassifierName,
InputDataConfig,
LanguageCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"CreateDocumentClassifier",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"DocumentClassifierName" => DocumentClassifierName,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_endpoint(desired_inference_units, endpoint_name)
create_endpoint(desired_inference_units, endpoint_name, params::Dict{String,<:Any})
Creates a model-specific endpoint for synchronous inference for a previously trained custom
model For information about endpoints, see Managing endpoints.
# Arguments
- `desired_inference_units`: The desired number of inference units to be used by the model
using this endpoint. Each inference unit represents of a throughput of 100 characters per
second.
- `endpoint_name`: This is the descriptive suffix that becomes part of the EndpointArn used
for all subsequent requests to this resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: An idempotency token provided by the customer. If this token
matches a previous endpoint creation request, Amazon Comprehend will not return a
ResourceInUseException.
- `"DataAccessRoleArn"`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to trained custom models encrypted with a customer managed key
(ModelKmsKeyId).
- `"FlywheelArn"`: The Amazon Resource Number (ARN) of the flywheel to which the endpoint
will be attached.
- `"ModelArn"`: The Amazon Resource Number (ARN) of the model to which the endpoint will be
attached.
- `"Tags"`: Tags to associate with the endpoint. A tag is a key-value pair that adds
metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an
endpoint to indicate its use by the sales department.
"""
function create_endpoint(
DesiredInferenceUnits, EndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"CreateEndpoint",
Dict{String,Any}(
"DesiredInferenceUnits" => DesiredInferenceUnits,
"EndpointName" => EndpointName,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_endpoint(
DesiredInferenceUnits,
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"CreateEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DesiredInferenceUnits" => DesiredInferenceUnits,
"EndpointName" => EndpointName,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_entity_recognizer(data_access_role_arn, input_data_config, language_code, recognizer_name)
create_entity_recognizer(data_access_role_arn, input_data_config, language_code, recognizer_name, params::Dict{String,<:Any})
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer
request is submitted, you can check job status using the DescribeEntityRecognizer API.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data.
- `input_data_config`: Specifies the format and location of the input data. The S3 bucket
containing the input data must be located in the same Region as the entity recognizer being
created.
- `language_code`: You can specify any of the following languages: English (\"en\"),
Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese
(\"pt\"). If you plan to use this entity recognizer with PDF, Word, or image input files,
you must specify English as the language. All training documents must be in the same
language.
- `recognizer_name`: The name given to the newly created recognizer. Recognizer names can
be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_)
are allowed. The name must be unique in the account/Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
- `"ModelKmsKeyId"`: ID for the KMS key that Amazon Comprehend uses to encrypt trained
custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID:
\"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"ModelPolicy"`: The JSON resource-based policy to attach to your custom entity
recognizer model. You can use this policy to allow another Amazon Web Services account to
import your custom model. Provide your JSON as a UTF-8 encoded string without line breaks.
To provide valid JSON for your policy, enclose the attribute names and values in double
quotes. If the JSON body is also enclosed in double quotes, then you must escape the double
quotes that are inside the policy: \"{\"attribute\": \"value\", \"attribute\":
[\"value\"]}\" To avoid escaping quotes, you can use single quotes to enclose the policy
and double quotes to enclose the JSON names and values: '{\"attribute\": \"value\",
\"attribute\": [\"value\"]}'
- `"Tags"`: Tags to associate with the entity recognizer. A tag is a key-value pair that
adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with
\"Sales\" as the key might be added to a resource to indicate its use by the sales
department.
- `"VersionName"`: The version name given to the newly created recognizer. Version names
can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores
(_) are allowed. The version name must be unique among all models with the same recognizer
name in the account/Region.
- `"VolumeKmsKeyId"`: ID for the Amazon Web Services Key Management Service (KMS) key that
Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
following formats: KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon
Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"VpcConfig"`: Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your custom entity recognizer. For more
information, see Amazon VPC.
"""
function create_entity_recognizer(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
RecognizerName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"CreateEntityRecognizer",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"RecognizerName" => RecognizerName,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_entity_recognizer(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
RecognizerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"CreateEntityRecognizer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"RecognizerName" => RecognizerName,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_flywheel(data_access_role_arn, data_lake_s3_uri, flywheel_name)
create_flywheel(data_access_role_arn, data_lake_s3_uri, flywheel_name, params::Dict{String,<:Any})
A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a
model for custom classification or custom entity recognition. You can create a flywheel to
start with an existing trained model, or Comprehend can create and train a new model. When
you create the flywheel, Comprehend creates a data lake in your account. The data lake
holds the training data and test data for all versions of the model. To use a flywheel with
an existing trained model, you specify the active model version. Comprehend copies the
model's training data and test data into the flywheel's data lake. To use the flywheel with
a new model, you need to provide a dataset for training data (and optional test data) when
you create the flywheel. For more information about flywheels, see Flywheel overview in
the Amazon Comprehend Developer Guide.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend the permissions required to access the flywheel data in the data lake.
- `data_lake_s3_uri`: Enter the S3 location for the data lake. You can specify a new S3
bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this
location.
- `flywheel_name`: Name for the flywheel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActiveModelArn"`: To associate an existing model with the flywheel, specify the Amazon
Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you
specify an ActiveModelArn.
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
- `"DataSecurityConfig"`: Data security configurations.
- `"ModelType"`: The model type. You need to set ModelType if you are creating a flywheel
for a new model.
- `"Tags"`: The tags to associate with this flywheel.
- `"TaskConfig"`: Configuration about the model associated with the flywheel. You need to
set TaskConfig if you are creating a flywheel for a new model.
"""
function create_flywheel(
DataAccessRoleArn,
DataLakeS3Uri,
FlywheelName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"CreateFlywheel",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"DataLakeS3Uri" => DataLakeS3Uri,
"FlywheelName" => FlywheelName,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_flywheel(
DataAccessRoleArn,
DataLakeS3Uri,
FlywheelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"CreateFlywheel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"DataLakeS3Uri" => DataLakeS3Uri,
"FlywheelName" => FlywheelName,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_document_classifier(document_classifier_arn)
delete_document_classifier(document_classifier_arn, params::Dict{String,<:Any})
Deletes a previously created document classifier Only those classifiers that are in
terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using
the model, a ResourceInUseException will be returned. This is an asynchronous action that
puts the classifier into a DELETING state, and it is then removed by a background job. Once
removed, the classifier disappears from your account and is no longer available for use.
# Arguments
- `document_classifier_arn`: The Amazon Resource Name (ARN) that identifies the document
classifier.
"""
function delete_document_classifier(
DocumentClassifierArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DeleteDocumentClassifier",
Dict{String,Any}("DocumentClassifierArn" => DocumentClassifierArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_document_classifier(
DocumentClassifierArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DeleteDocumentClassifier",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DocumentClassifierArn" => DocumentClassifierArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_endpoint(endpoint_arn)
delete_endpoint(endpoint_arn, params::Dict{String,<:Any})
Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must
be deleted in order for the model to be deleted. For information about endpoints, see
Managing endpoints.
# Arguments
- `endpoint_arn`: The Amazon Resource Number (ARN) of the endpoint being deleted.
"""
function delete_endpoint(EndpointArn; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"DeleteEndpoint",
Dict{String,Any}("EndpointArn" => EndpointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_endpoint(
EndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DeleteEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointArn" => EndpointArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_entity_recognizer(entity_recognizer_arn)
delete_entity_recognizer(entity_recognizer_arn, params::Dict{String,<:Any})
Deletes an entity recognizer. Only those recognizers that are in terminated states
(IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a
ResourceInUseException will be returned. This is an asynchronous action that puts the
recognizer into a DELETING state, and it is then removed by a background job. Once removed,
the recognizer disappears from your account and is no longer available for use.
# Arguments
- `entity_recognizer_arn`: The Amazon Resource Name (ARN) that identifies the entity
recognizer.
"""
function delete_entity_recognizer(
EntityRecognizerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DeleteEntityRecognizer",
Dict{String,Any}("EntityRecognizerArn" => EntityRecognizerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_entity_recognizer(
EntityRecognizerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DeleteEntityRecognizer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EntityRecognizerArn" => EntityRecognizerArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_flywheel(flywheel_arn)
delete_flywheel(flywheel_arn, params::Dict{String,<:Any})
Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the
data lake or the model associated with the flywheel. For more information about flywheels,
see Flywheel overview in the Amazon Comprehend Developer Guide.
# Arguments
- `flywheel_arn`: The Amazon Resource Number (ARN) of the flywheel to delete.
"""
function delete_flywheel(FlywheelArn; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"DeleteFlywheel",
Dict{String,Any}("FlywheelArn" => FlywheelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_flywheel(
FlywheelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DeleteFlywheel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FlywheelArn" => FlywheelArn), 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 that is attached to a custom model.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the custom model version that has the
policy to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyRevisionId"`: The revision ID of the policy to delete.
"""
function delete_resource_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"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 comprehend(
"DeleteResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset(dataset_arn)
describe_dataset(dataset_arn, params::Dict{String,<:Any})
Returns information about the dataset that you specify. For more information about
datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
# Arguments
- `dataset_arn`: The ARN of the dataset.
"""
function describe_dataset(DatasetArn; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"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 comprehend(
"DescribeDataset",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatasetArn" => DatasetArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_document_classification_job(job_id)
describe_document_classification_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with a document classification job. Use this operation to
get the status of a classification job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend generated for the job. The
StartDocumentClassificationJob operation returns this identifier in its response.
"""
function describe_document_classification_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeDocumentClassificationJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_document_classification_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeDocumentClassificationJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_document_classifier(document_classifier_arn)
describe_document_classifier(document_classifier_arn, params::Dict{String,<:Any})
Gets the properties associated with a document classifier.
# Arguments
- `document_classifier_arn`: The Amazon Resource Name (ARN) that identifies the document
classifier. The CreateDocumentClassifier operation returns this identifier in its response.
"""
function describe_document_classifier(
DocumentClassifierArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeDocumentClassifier",
Dict{String,Any}("DocumentClassifierArn" => DocumentClassifierArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_document_classifier(
DocumentClassifierArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DescribeDocumentClassifier",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DocumentClassifierArn" => DocumentClassifierArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dominant_language_detection_job(job_id)
describe_dominant_language_detection_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with a dominant language detection job. Use this operation
to get the status of a detection job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend generated for the job. The
StartDominantLanguageDetectionJob operation returns this identifier in its response.
"""
function describe_dominant_language_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeDominantLanguageDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_dominant_language_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeDominantLanguageDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoint(endpoint_arn)
describe_endpoint(endpoint_arn, params::Dict{String,<:Any})
Gets the properties associated with a specific endpoint. Use this operation to get the
status of an endpoint. For information about endpoints, see Managing endpoints.
# Arguments
- `endpoint_arn`: The Amazon Resource Number (ARN) of the endpoint being described.
"""
function describe_endpoint(EndpointArn; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"DescribeEndpoint",
Dict{String,Any}("EndpointArn" => EndpointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_endpoint(
EndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DescribeEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointArn" => EndpointArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_entities_detection_job(job_id)
describe_entities_detection_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with an entities detection job. Use this operation to get
the status of a detection job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend generated for the job. The
StartEntitiesDetectionJob operation returns this identifier in its response.
"""
function describe_entities_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeEntitiesDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_entities_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeEntitiesDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_entity_recognizer(entity_recognizer_arn)
describe_entity_recognizer(entity_recognizer_arn, params::Dict{String,<:Any})
Provides details about an entity recognizer including status, S3 buckets containing
training data, recognizer metadata, metrics, and so on.
# Arguments
- `entity_recognizer_arn`: The Amazon Resource Name (ARN) that identifies the entity
recognizer.
"""
function describe_entity_recognizer(
EntityRecognizerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeEntityRecognizer",
Dict{String,Any}("EntityRecognizerArn" => EntityRecognizerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_entity_recognizer(
EntityRecognizerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DescribeEntityRecognizer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EntityRecognizerArn" => EntityRecognizerArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events_detection_job(job_id)
describe_events_detection_job(job_id, params::Dict{String,<:Any})
Gets the status and details of an events detection job.
# Arguments
- `job_id`: The identifier of the events detection job.
"""
function describe_events_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeEventsDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_events_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeEventsDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_flywheel(flywheel_arn)
describe_flywheel(flywheel_arn, params::Dict{String,<:Any})
Provides configuration information about the flywheel. For more information about
flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
# Arguments
- `flywheel_arn`: The Amazon Resource Number (ARN) of the flywheel.
"""
function describe_flywheel(FlywheelArn; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"DescribeFlywheel",
Dict{String,Any}("FlywheelArn" => FlywheelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_flywheel(
FlywheelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DescribeFlywheel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FlywheelArn" => FlywheelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_flywheel_iteration(flywheel_arn, flywheel_iteration_id)
describe_flywheel_iteration(flywheel_arn, flywheel_iteration_id, params::Dict{String,<:Any})
Retrieve the configuration properties of a flywheel iteration. For more information about
flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
# Arguments
- `flywheel_arn`:
- `flywheel_iteration_id`:
"""
function describe_flywheel_iteration(
FlywheelArn, FlywheelIterationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeFlywheelIteration",
Dict{String,Any}(
"FlywheelArn" => FlywheelArn, "FlywheelIterationId" => FlywheelIterationId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_flywheel_iteration(
FlywheelArn,
FlywheelIterationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DescribeFlywheelIteration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FlywheelArn" => FlywheelArn,
"FlywheelIterationId" => FlywheelIterationId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_key_phrases_detection_job(job_id)
describe_key_phrases_detection_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with a key phrases detection job. Use this operation to get
the status of a detection job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend generated for the job. The
StartKeyPhrasesDetectionJob operation returns this identifier in its response.
"""
function describe_key_phrases_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeKeyPhrasesDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_key_phrases_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeKeyPhrasesDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pii_entities_detection_job(job_id)
describe_pii_entities_detection_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with a PII entities detection job. For example, you can use
this operation to get the job status.
# Arguments
- `job_id`: The identifier that Amazon Comprehend generated for the job. The operation
returns this identifier in its response.
"""
function describe_pii_entities_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribePiiEntitiesDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_pii_entities_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribePiiEntitiesDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), 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 details of a resource-based policy that is attached to a custom model, including
the JSON body of the policy.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the custom model version that has the
resource policy.
"""
function describe_resource_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"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 comprehend(
"DescribeResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_sentiment_detection_job(job_id)
describe_sentiment_detection_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with a sentiment detection job. Use this operation to get
the status of a detection job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend generated for the job. The operation
returns this identifier in its response.
"""
function describe_sentiment_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeSentimentDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_sentiment_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeSentimentDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_targeted_sentiment_detection_job(job_id)
describe_targeted_sentiment_detection_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with a targeted sentiment detection job. Use this operation
to get the status of the job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend generated for the job. The
StartTargetedSentimentDetectionJob operation returns this identifier in its response.
"""
function describe_targeted_sentiment_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeTargetedSentimentDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_targeted_sentiment_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeTargetedSentimentDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_topics_detection_job(job_id)
describe_topics_detection_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with a topic detection job. Use this operation to get the
status of a detection job.
# Arguments
- `job_id`: The identifier assigned by the user to the detection job.
"""
function describe_topics_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeTopicsDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_topics_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DescribeTopicsDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_dominant_language(text)
detect_dominant_language(text, params::Dict{String,<:Any})
Determines the dominant language of the input text. For a list of languages that Amazon
Comprehend can detect, see Amazon Comprehend Supported Languages.
# Arguments
- `text`: A UTF-8 text string. The string must contain at least 20 characters. The maximum
string size is 100 KB.
"""
function detect_dominant_language(Text; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"DetectDominantLanguage",
Dict{String,Any}("Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_dominant_language(
Text, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DetectDominantLanguage",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_entities()
detect_entities(params::Dict{String,<:Any})
Detects named entities in input text when you use the pre-trained model. Detects custom
entities if you have a custom entity recognition model. When detecting named entities
using the pre-trained model, use plain text as the input. For more information about named
entities, see Entities in the Comprehend Developer Guide. When you use a custom entity
recognition model, you can input plain text or you can upload a single-page input document
(text, PDF, Word, or image). If the system detects errors while processing a page in the
input document, the API response includes an entry in Errors for each error. If the system
detects a document-level error in your input document, the API returns an
InvalidRequestException error response. For details about this exception, see Errors in
semi-structured documents in the Comprehend Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Bytes"`: This field applies only when you use a custom entity recognition model that
was trained with PDF annotations. For other cases, enter your text input in the Text field.
Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file
in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the
response is identical). You can also use the Bytes parameter to input an Amazon Textract
DetectDocumentText or AnalyzeDocument output file. Provide the input document as a sequence
of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities,
the SDK may encode the document file bytes for you. The maximum length of this field
depends on the input document type. For details, see Inputs for real-time custom analysis
in the Comprehend Developer Guide. If you use the Bytes parameter, do not use the Text
parameter.
- `"DocumentReaderConfig"`: Provides configuration parameters to override the default
actions for extracting text from PDF documents and image files.
- `"EndpointArn"`: The Amazon Resource Name of an endpoint that is associated with a custom
entity recognition model. Provide an endpoint if you want to detect entities by using your
own custom model instead of the default model that is used by Amazon Comprehend. If you
specify an endpoint, Amazon Comprehend uses the language of your custom model, and it
ignores any language code that you provide in your request. For information about
endpoints, see Managing endpoints.
- `"LanguageCode"`: The language of the input documents. You can specify any of the primary
languages supported by Amazon Comprehend. If your request includes the endpoint for a
custom entity recognition model, Amazon Comprehend uses the language of your custom model,
and it ignores any language code that you specify here. All input documents must be in the
same language.
- `"Text"`: A UTF-8 text string. The maximum string size is 100 KB. If you enter text using
this parameter, do not use the Bytes parameter.
"""
function detect_entities(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"DetectEntities"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function detect_entities(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DetectEntities", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
detect_key_phrases(language_code, text)
detect_key_phrases(language_code, text, params::Dict{String,<:Any})
Detects the key noun phrases found in the text.
# Arguments
- `language_code`: The language of the input documents. You can specify any of the primary
languages supported by Amazon Comprehend. All documents must be in the same language.
- `text`: A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded
characters.
"""
function detect_key_phrases(
LanguageCode, Text; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DetectKeyPhrases",
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_key_phrases(
LanguageCode,
Text,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DetectKeyPhrases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_pii_entities(language_code, text)
detect_pii_entities(language_code, text, params::Dict{String,<:Any})
Inspects the input text for entities that contain personally identifiable information (PII)
and returns information about them.
# Arguments
- `language_code`: The language of the input text. Enter the language code for English (en)
or Spanish (es).
- `text`: A UTF-8 text string. The maximum string size is 100 KB.
"""
function detect_pii_entities(
LanguageCode, Text; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DetectPiiEntities",
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_pii_entities(
LanguageCode,
Text,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DetectPiiEntities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_sentiment(language_code, text)
detect_sentiment(language_code, text, params::Dict{String,<:Any})
Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL,
MIXED, or NEGATIVE).
# Arguments
- `language_code`: The language of the input documents. You can specify any of the primary
languages supported by Amazon Comprehend. All documents must be in the same language.
- `text`: A UTF-8 text string. The maximum string size is 5 KB.
"""
function detect_sentiment(
LanguageCode, Text; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DetectSentiment",
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_sentiment(
LanguageCode,
Text,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DetectSentiment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_syntax(language_code, text)
detect_syntax(language_code, text, params::Dict{String,<:Any})
Inspects text for syntax and the part of speech of words in the document. For more
information, see Syntax in the Comprehend Developer Guide.
# Arguments
- `language_code`: The language code of the input documents. You can specify any of the
following languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"),
Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\").
- `text`: A UTF-8 string. The maximum string size is 5 KB.
"""
function detect_syntax(
LanguageCode, Text; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DetectSyntax",
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_syntax(
LanguageCode,
Text,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DetectSyntax",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_targeted_sentiment(language_code, text)
detect_targeted_sentiment(language_code, text, params::Dict{String,<:Any})
Inspects the input text and returns a sentiment analysis for each entity identified in the
text. For more information about targeted sentiment, see Targeted sentiment in the Amazon
Comprehend Developer Guide.
# Arguments
- `language_code`: The language of the input documents. Currently, English is the only
supported language.
- `text`: A UTF-8 text string. The maximum string length is 5 KB.
"""
function detect_targeted_sentiment(
LanguageCode, Text; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DetectTargetedSentiment",
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_targeted_sentiment(
LanguageCode,
Text,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DetectTargetedSentiment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LanguageCode" => LanguageCode, "Text" => Text),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_toxic_content(language_code, text_segments)
detect_toxic_content(language_code, text_segments, params::Dict{String,<:Any})
Performs toxicity analysis on the list of text strings that you provide as input. The API
response contains a results list that matches the size of the input list. For more
information about toxicity detection, see Toxicity detection in the Amazon Comprehend
Developer Guide.
# Arguments
- `language_code`: The language of the input text. Currently, English is the only supported
language.
- `text_segments`: A list of up to 10 text strings. Each string has a maximum size of 1 KB,
and the maximum size of the list is 10 KB.
"""
function detect_toxic_content(
LanguageCode, TextSegments; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"DetectToxicContent",
Dict{String,Any}("LanguageCode" => LanguageCode, "TextSegments" => TextSegments);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_toxic_content(
LanguageCode,
TextSegments,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"DetectToxicContent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LanguageCode" => LanguageCode, "TextSegments" => TextSegments
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_model(source_model_arn)
import_model(source_model_arn, params::Dict{String,<:Any})
Creates a new custom model that replicates a source custom model that you import. The
source model can be in your Amazon Web Services account or another one. If the source model
is in another Amazon Web Services account, then it must have a resource-based policy that
authorizes you to import it. The source model must be in the same Amazon Web Services
Region that you're using when you import. You can't import a model that's in a different
Region.
# Arguments
- `source_model_arn`: The Amazon Resource Name (ARN) of the custom model to import.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataAccessRoleArn"`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the
custom model.
- `"ModelKmsKeyId"`: ID for the KMS key that Amazon Comprehend uses to encrypt trained
custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID:
\"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"ModelName"`: The name to assign to the custom model that is created in Amazon
Comprehend by this import.
- `"Tags"`: Tags to associate with the custom model that is created by this import. A tag
is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For
example, a tag with \"Sales\" as the key might be added to a resource to indicate its use
by the sales department.
- `"VersionName"`: The version name given to the custom model that is created by this
import. Version names can have a maximum of 256 characters. Alphanumeric characters,
hyphens (-) and underscores (_) are allowed. The version name must be unique among all
models with the same classifier name in the account/Region.
"""
function import_model(SourceModelArn; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ImportModel",
Dict{String,Any}("SourceModelArn" => SourceModelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_model(
SourceModelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"ImportModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SourceModelArn" => SourceModelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_datasets()
list_datasets(params::Dict{String,<:Any})
List the datasets that you have configured in this Region. For more information about
datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the datasets to be returned in the response.
- `"FlywheelArn"`: The Amazon Resource Number (ARN) of the flywheel.
- `"MaxResults"`: Maximum number of results to return in a response. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_datasets(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ListDatasets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_datasets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListDatasets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_document_classification_jobs()
list_document_classification_jobs(params::Dict{String,<:Any})
Gets a list of the documentation classification jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs on their names,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_document_classification_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListDocumentClassificationJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_document_classification_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListDocumentClassificationJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_document_classifier_summaries()
list_document_classifier_summaries(params::Dict{String,<:Any})
Gets a list of summaries of the document classifiers that you have created
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return on each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_document_classifier_summaries(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListDocumentClassifierSummaries";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_document_classifier_summaries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListDocumentClassifierSummaries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_document_classifiers()
list_document_classifiers(params::Dict{String,<:Any})
Gets a list of the document classifiers that you have created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs on their name,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_document_classifiers(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ListDocumentClassifiers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_document_classifiers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListDocumentClassifiers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dominant_language_detection_jobs()
list_dominant_language_detection_jobs(params::Dict{String,<:Any})
Gets a list of the dominant language detection jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters that jobs that are returned. You can filter jobs on their name,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_dominant_language_detection_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListDominantLanguageDetectionJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dominant_language_detection_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListDominantLanguageDetectionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_endpoints()
list_endpoints(params::Dict{String,<:Any})
Gets a list of all existing endpoints that you've created. For information about endpoints,
see Managing endpoints.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the endpoints that are returned. You can filter endpoints on their
name, model, status, or the date and time that they were created. You can only set one
filter at a time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ListEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListEndpoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_entities_detection_jobs()
list_entities_detection_jobs(params::Dict{String,<:Any})
Gets a list of the entity detection jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs on their name,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_entities_detection_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ListEntitiesDetectionJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_entities_detection_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListEntitiesDetectionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_entity_recognizer_summaries()
list_entity_recognizer_summaries(params::Dict{String,<:Any})
Gets a list of summaries for the entity recognizers that you have created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to return on each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_entity_recognizer_summaries(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListEntityRecognizerSummaries";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_entity_recognizer_summaries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListEntityRecognizerSummaries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_entity_recognizers()
list_entity_recognizers(params::Dict{String,<:Any})
Gets a list of the properties of all entity recognizers that you created, including
recognizers currently in training. Allows you to filter the list of recognizers based on
criteria such as status and submission time. This call returns up to 500 entity recognizers
in the list, with a default number of 100 recognizers in the list. The results of this list
are not in any particular order. Please get the list and sort locally if needed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the list of entities returned. You can filter on Status,
SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.
- `"MaxResults"`: The maximum number of results to return on each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_entity_recognizers(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ListEntityRecognizers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_entity_recognizers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListEntityRecognizers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_events_detection_jobs()
list_events_detection_jobs(params::Dict{String,<:Any})
Gets a list of the events detection jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs on their name,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_events_detection_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ListEventsDetectionJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_events_detection_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListEventsDetectionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_flywheel_iteration_history(flywheel_arn)
list_flywheel_iteration_history(flywheel_arn, params::Dict{String,<:Any})
Information about the history of a flywheel iteration. For more information about
flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
# Arguments
- `flywheel_arn`: The ARN of the flywheel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filter the flywheel iteration history based on creation time.
- `"MaxResults"`: Maximum number of iteration history results to return
- `"NextToken"`: Next token
"""
function list_flywheel_iteration_history(
FlywheelArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListFlywheelIterationHistory",
Dict{String,Any}("FlywheelArn" => FlywheelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_flywheel_iteration_history(
FlywheelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"ListFlywheelIterationHistory",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FlywheelArn" => FlywheelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_flywheels()
list_flywheels(params::Dict{String,<:Any})
Gets a list of the flywheels that you have created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the flywheels that are returned. You can filter flywheels on their
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: Maximum number of results to return in a response. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_flywheels(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ListFlywheels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_flywheels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListFlywheels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_key_phrases_detection_jobs()
list_key_phrases_detection_jobs(params::Dict{String,<:Any})
Get a list of key phrase detection jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs on their name,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_key_phrases_detection_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListKeyPhrasesDetectionJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_key_phrases_detection_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListKeyPhrasesDetectionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pii_entities_detection_jobs()
list_pii_entities_detection_jobs(params::Dict{String,<:Any})
Gets a list of the PII entity detection jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs on their name,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_pii_entities_detection_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListPiiEntitiesDetectionJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pii_entities_detection_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListPiiEntitiesDetectionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sentiment_detection_jobs()
list_sentiment_detection_jobs(params::Dict{String,<:Any})
Gets a list of sentiment detection jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs on their name,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_sentiment_detection_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ListSentimentDetectionJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_sentiment_detection_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListSentimentDetectionJobs",
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 given Amazon Comprehend resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the given Amazon Comprehend resource
you are querying.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"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 comprehend(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_targeted_sentiment_detection_jobs()
list_targeted_sentiment_detection_jobs(params::Dict{String,<:Any})
Gets a list of targeted sentiment detection jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs on their name,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_targeted_sentiment_detection_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListTargetedSentimentDetectionJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_targeted_sentiment_detection_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListTargetedSentimentDetectionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_topics_detection_jobs()
list_topics_detection_jobs(params::Dict{String,<:Any})
Gets a list of the topic detection jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. Jobs can be filtered on their name,
status, or the date and time that they were submitted. You can set only one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_topics_detection_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"ListTopicsDetectionJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_topics_detection_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"ListTopicsDetectionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(resource_arn, resource_policy)
put_resource_policy(resource_arn, resource_policy, params::Dict{String,<:Any})
Attaches a resource-based policy to a custom model. You can use this policy to authorize an
entity in another Amazon Web Services account to import the custom model, which replicates
it in Amazon Comprehend in their account.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the custom model to attach the policy
to.
- `resource_policy`: The JSON resource-based policy to attach to your custom model. Provide
your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your
policy, enclose the attribute names and values in double quotes. If the JSON body is also
enclosed in double quotes, then you must escape the double quotes that are inside the
policy: \"{\"attribute\": \"value\", \"attribute\": [\"value\"]}\" To avoid escaping
quotes, you can use single quotes to enclose the policy and double quotes to enclose the
JSON names and values: '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyRevisionId"`: The revision ID that Amazon Comprehend assigned to the policy that
you are updating. If you are creating a new policy that has no prior version, don't use
this parameter. Amazon Comprehend creates the revision ID for you.
"""
function put_resource_policy(
ResourceArn, ResourcePolicy; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"PutResourcePolicy",
Dict{String,Any}("ResourceArn" => ResourceArn, "ResourcePolicy" => ResourcePolicy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
ResourceArn,
ResourcePolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceArn" => ResourceArn, "ResourcePolicy" => ResourcePolicy
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_document_classification_job(data_access_role_arn, input_data_config, output_data_config)
start_document_classification_job(data_access_role_arn, input_data_config, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous document classification job using a custom classification model. Use
the DescribeDocumentClassificationJob operation to track the progress of the job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `output_data_config`: Specifies where to send the output files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you do not set the client
request token, Amazon Comprehend generates one.
- `"DocumentClassifierArn"`: The Amazon Resource Name (ARN) of the document classifier to
use to process the job.
- `"FlywheelArn"`: The Amazon Resource Number (ARN) of the flywheel associated with the
model to use.
- `"JobName"`: The identifier of the job.
- `"Tags"`: Tags to associate with the document classification job. A tag is a key-value
pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with
\"Sales\" as the key might be added to a resource to indicate its use by the sales
department.
- `"VolumeKmsKeyId"`: ID for the Amazon Web Services Key Management Service (KMS) key that
Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
following formats: KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon
Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"VpcConfig"`: Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your document classification job. For more
information, see Amazon VPC.
"""
function start_document_classification_job(
DataAccessRoleArn,
InputDataConfig,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartDocumentClassificationJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_document_classification_job(
DataAccessRoleArn,
InputDataConfig,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartDocumentClassificationJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_dominant_language_detection_job(data_access_role_arn, input_data_config, output_data_config)
start_dominant_language_detection_job(data_access_role_arn, input_data_config, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous dominant language detection job for a collection of documents. Use
the operation to track the status of a job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data. For more information, see Role-based permissions.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `output_data_config`: Specifies where to send the output files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you do not set the client
request token, Amazon Comprehend generates one.
- `"JobName"`: An identifier for the job.
- `"Tags"`: Tags to associate with the dominant language detection job. A tag is a
key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a
tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales
department.
- `"VolumeKmsKeyId"`: ID for the Amazon Web Services Key Management Service (KMS) key that
Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
following formats: KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon
Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"VpcConfig"`: Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your dominant language detection job. For
more information, see Amazon VPC.
"""
function start_dominant_language_detection_job(
DataAccessRoleArn,
InputDataConfig,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartDominantLanguageDetectionJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_dominant_language_detection_job(
DataAccessRoleArn,
InputDataConfig,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartDominantLanguageDetectionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_entities_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_entities_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous entity detection job for a collection of documents. Use the
operation to track the status of a job. This API can be used for either standard entity
detection or custom entity recognition. In order to be used for custom entity recognition,
the optional EntityRecognizerArn must be used in order to provide access to the recognizer
being used to detect the custom entity.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data. For more information, see Role-based permissions.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `language_code`: The language of the input documents. All documents must be in the same
language. You can specify any of the languages supported by Amazon Comprehend. If custom
entities recognition is used, this parameter is ignored and the language used for training
the model is used instead.
- `output_data_config`: Specifies where to send the output files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
- `"EntityRecognizerArn"`: The Amazon Resource Name (ARN) that identifies the specific
entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is
only used for a custom entity recognition job.
- `"FlywheelArn"`: The Amazon Resource Number (ARN) of the flywheel associated with the
model to use.
- `"JobName"`: The identifier of the job.
- `"Tags"`: Tags to associate with the entities detection job. A tag is a key-value pair
that adds metadata to a resource used by Amazon Comprehend. For example, a tag with
\"Sales\" as the key might be added to a resource to indicate its use by the sales
department.
- `"VolumeKmsKeyId"`: ID for the Amazon Web Services Key Management Service (KMS) key that
Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
following formats: KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon
Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"VpcConfig"`: Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your entity detection job. For more
information, see Amazon VPC.
"""
function start_entities_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartEntitiesDetectionJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_entities_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartEntitiesDetectionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_events_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, target_event_types)
start_events_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, target_event_types, params::Dict{String,<:Any})
Starts an asynchronous event detection job for a collection of documents.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `language_code`: The language code of the input documents.
- `output_data_config`: Specifies where to send the output files.
- `target_event_types`: The types of events to detect in the input documents.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: An unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
- `"JobName"`: The identifier of the events detection job.
- `"Tags"`: Tags to associate with the events detection job. A tag is a key-value pair that
adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as
the key might be added to a resource to indicate its use by the sales department.
"""
function start_events_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
TargetEventTypes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartEventsDetectionJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"TargetEventTypes" => TargetEventTypes,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_events_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
TargetEventTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartEventsDetectionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"TargetEventTypes" => TargetEventTypes,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_flywheel_iteration(flywheel_arn)
start_flywheel_iteration(flywheel_arn, params::Dict{String,<:Any})
Start the flywheel iteration.This operation uses any new datasets to train a new model
version. For more information about flywheels, see Flywheel overview in the Amazon
Comprehend Developer Guide.
# Arguments
- `flywheel_arn`: The ARN of the flywheel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
"""
function start_flywheel_iteration(
FlywheelArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StartFlywheelIteration",
Dict{String,Any}("FlywheelArn" => FlywheelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_flywheel_iteration(
FlywheelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartFlywheelIteration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FlywheelArn" => FlywheelArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_key_phrases_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_key_phrases_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous key phrase detection job for a collection of documents. Use the
operation to track the status of a job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data. For more information, see Role-based permissions.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `language_code`: The language of the input documents. You can specify any of the primary
languages supported by Amazon Comprehend. All documents must be in the same language.
- `output_data_config`: Specifies where to send the output files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
- `"JobName"`: The identifier of the job.
- `"Tags"`: Tags to associate with the key phrases detection job. A tag is a key-value pair
that adds metadata to a resource used by Amazon Comprehend. For example, a tag with
\"Sales\" as the key might be added to a resource to indicate its use by the sales
department.
- `"VolumeKmsKeyId"`: ID for the Amazon Web Services Key Management Service (KMS) key that
Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
following formats: KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon
Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"VpcConfig"`: Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your key phrases detection job. For more
information, see Amazon VPC.
"""
function start_key_phrases_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartKeyPhrasesDetectionJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_key_phrases_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartKeyPhrasesDetectionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_pii_entities_detection_job(data_access_role_arn, input_data_config, language_code, mode, output_data_config)
start_pii_entities_detection_job(data_access_role_arn, input_data_config, language_code, mode, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous PII entity detection job for a collection of documents.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data.
- `input_data_config`: The input properties for a PII entities detection job.
- `language_code`: The language of the input documents. Enter the language code for English
(en) or Spanish (es).
- `mode`: Specifies whether the output provides the locations (offsets) of PII entities or
a file in which PII entities are redacted.
- `output_data_config`: Provides configuration parameters for the output of PII entity
detection jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
- `"JobName"`: The identifier of the job.
- `"RedactionConfig"`: Provides configuration parameters for PII entity redaction. This
parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you
must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
- `"Tags"`: Tags to associate with the PII entities detection job. A tag is a key-value
pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with
\"Sales\" as the key might be added to a resource to indicate its use by the sales
department.
"""
function start_pii_entities_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
Mode,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartPiiEntitiesDetectionJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"Mode" => Mode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_pii_entities_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
Mode,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartPiiEntitiesDetectionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"Mode" => Mode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_sentiment_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_sentiment_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous sentiment detection job for a collection of documents. Use the
operation to track the status of a job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data. For more information, see Role-based permissions.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `language_code`: The language of the input documents. You can specify any of the primary
languages supported by Amazon Comprehend. All documents must be in the same language.
- `output_data_config`: Specifies where to send the output files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
- `"JobName"`: The identifier of the job.
- `"Tags"`: Tags to associate with the sentiment detection job. A tag is a key-value pair
that adds metadata to a resource used by Amazon Comprehend. For example, a tag with
\"Sales\" as the key might be added to a resource to indicate its use by the sales
department.
- `"VolumeKmsKeyId"`: ID for the Amazon Web Services Key Management Service (KMS) key that
Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
following formats: KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon
Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"VpcConfig"`: Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your sentiment detection job. For more
information, see Amazon VPC.
"""
function start_sentiment_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartSentimentDetectionJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_sentiment_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartSentimentDetectionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_targeted_sentiment_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_targeted_sentiment_detection_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use
the DescribeTargetedSentimentDetectionJob operation to track the status of a job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data. For more information, see Role-based permissions.
- `input_data_config`:
- `language_code`: The language of the input documents. Currently, English is the only
supported language.
- `output_data_config`: Specifies where to send the output files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
- `"JobName"`: The identifier of the job.
- `"Tags"`: Tags to associate with the targeted sentiment detection job. A tag is a
key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a
tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales
department.
- `"VolumeKmsKeyId"`: ID for the KMS key that Amazon Comprehend uses to encrypt data on the
storage volume attached to the ML compute instance(s) that process the analysis job. The
VolumeKmsKeyId can be either of the following formats: KMS Key ID:
\"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"VpcConfig"`:
"""
function start_targeted_sentiment_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartTargetedSentimentDetectionJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_targeted_sentiment_detection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartTargetedSentimentDetectionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_topics_detection_job(data_access_role_arn, input_data_config, output_data_config)
start_topics_detection_job(data_access_role_arn, input_data_config, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to
track the status of a job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend read access to your input data. For more information, see Role-based permissions.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `output_data_config`: Specifies where to send the output files. The output is a
compressed archive with two files, topic-terms.csv that lists the terms associated with
each topic, and doc-topics.csv that lists the documents associated with each topic
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you do not set the client
request token, Amazon Comprehend generates one.
- `"JobName"`: The identifier of the job.
- `"NumberOfTopics"`: The number of topics to detect.
- `"Tags"`: Tags to associate with the topics detection job. A tag is a key-value pair that
adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as
the key might be added to a resource to indicate its use by the sales department.
- `"VolumeKmsKeyId"`: ID for the Amazon Web Services Key Management Service (KMS) key that
Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
following formats: KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\" Amazon
Resource Name (ARN) of a KMS Key:
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
- `"VpcConfig"`: Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your topic detection job. For more
information, see Amazon VPC.
"""
function start_topics_detection_job(
DataAccessRoleArn,
InputDataConfig,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartTopicsDetectionJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_topics_detection_job(
DataAccessRoleArn,
InputDataConfig,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StartTopicsDetectionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_dominant_language_detection_job(job_id)
stop_dominant_language_detection_job(job_id, params::Dict{String,<:Any})
Stops a dominant language detection job in progress. If the job state is IN_PROGRESS the
job is marked for termination and put into the STOP_REQUESTED state. If the job completes
before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped
and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you
call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal
Request Exception. When a job is stopped, any documents already processed are written to
the output location.
# Arguments
- `job_id`: The identifier of the dominant language detection job to stop.
"""
function stop_dominant_language_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopDominantLanguageDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_dominant_language_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopDominantLanguageDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_entities_detection_job(job_id)
stop_entities_detection_job(job_id, params::Dict{String,<:Any})
Stops an entities detection job in progress. If the job state is IN_PROGRESS the job is
marked for termination and put into the STOP_REQUESTED state. If the job completes before
it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put
into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request
Exception. When a job is stopped, any documents already processed are written to the
output location.
# Arguments
- `job_id`: The identifier of the entities detection job to stop.
"""
function stop_entities_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopEntitiesDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_entities_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopEntitiesDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_events_detection_job(job_id)
stop_events_detection_job(job_id, params::Dict{String,<:Any})
Stops an events detection job in progress.
# Arguments
- `job_id`: The identifier of the events detection job to stop.
"""
function stop_events_detection_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"StopEventsDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_events_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopEventsDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_key_phrases_detection_job(job_id)
stop_key_phrases_detection_job(job_id, params::Dict{String,<:Any})
Stops a key phrases detection job in progress. If the job state is IN_PROGRESS the job is
marked for termination and put into the STOP_REQUESTED state. If the job completes before
it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put
into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the
StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request
Exception. When a job is stopped, any documents already processed are written to the
output location.
# Arguments
- `job_id`: The identifier of the key phrases detection job to stop.
"""
function stop_key_phrases_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopKeyPhrasesDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_key_phrases_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopKeyPhrasesDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_pii_entities_detection_job(job_id)
stop_pii_entities_detection_job(job_id, params::Dict{String,<:Any})
Stops a PII entities detection job in progress.
# Arguments
- `job_id`: The identifier of the PII entities detection job to stop.
"""
function stop_pii_entities_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopPiiEntitiesDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_pii_entities_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopPiiEntitiesDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_sentiment_detection_job(job_id)
stop_sentiment_detection_job(job_id, params::Dict{String,<:Any})
Stops a sentiment detection job in progress. If the job state is IN_PROGRESS, the job is
marked for termination and put into the STOP_REQUESTED state. If the job completes before
it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and
put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call
the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal
Request Exception. When a job is stopped, any documents already processed are written to
the output location.
# Arguments
- `job_id`: The identifier of the sentiment detection job to stop.
"""
function stop_sentiment_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopSentimentDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_sentiment_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopSentimentDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_targeted_sentiment_detection_job(job_id)
stop_targeted_sentiment_detection_job(job_id, params::Dict{String,<:Any})
Stops a targeted sentiment detection job in progress. If the job state is IN_PROGRESS, the
job is marked for termination and put into the STOP_REQUESTED state. If the job completes
before it can be stopped, it is put into the COMPLETED state; otherwise the job is be
stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when
you call the StopDominantLanguageDetectionJob operation, the operation returns a 400
Internal Request Exception. When a job is stopped, any documents already processed are
written to the output location.
# Arguments
- `job_id`: The identifier of the targeted sentiment detection job to stop.
"""
function stop_targeted_sentiment_detection_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopTargetedSentimentDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_targeted_sentiment_detection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopTargetedSentimentDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_training_document_classifier(document_classifier_arn)
stop_training_document_classifier(document_classifier_arn, params::Dict{String,<:Any})
Stops a document classifier training job while in progress. If the training job state is
TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the
training job completes before it can be stopped, it is put into the TRAINED; otherwise the
training job is stopped and put into the STOPPED state and the service sends back an HTTP
200 response with an empty HTTP body.
# Arguments
- `document_classifier_arn`: The Amazon Resource Name (ARN) that identifies the document
classifier currently being trained.
"""
function stop_training_document_classifier(
DocumentClassifierArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopTrainingDocumentClassifier",
Dict{String,Any}("DocumentClassifierArn" => DocumentClassifierArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_training_document_classifier(
DocumentClassifierArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StopTrainingDocumentClassifier",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DocumentClassifierArn" => DocumentClassifierArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_training_entity_recognizer(entity_recognizer_arn)
stop_training_entity_recognizer(entity_recognizer_arn, params::Dict{String,<:Any})
Stops an entity recognizer training job while in progress. If the training job state is
TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the
training job completes before it can be stopped, it is put into the TRAINED; otherwise the
training job is stopped and putted into the STOPPED state and the service sends back an
HTTP 200 response with an empty HTTP body.
# Arguments
- `entity_recognizer_arn`: The Amazon Resource Name (ARN) that identifies the entity
recognizer currently being trained.
"""
function stop_training_entity_recognizer(
EntityRecognizerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"StopTrainingEntityRecognizer",
Dict{String,Any}("EntityRecognizerArn" => EntityRecognizerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_training_entity_recognizer(
EntityRecognizerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"StopTrainingEntityRecognizer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EntityRecognizerArn" => EntityRecognizerArn),
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 specific tag with an Amazon Comprehend resource. A tag is a key-value pair
that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with
\"Sales\" as the key might be added to a resource to indicate its use by the sales
department.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to
which you want to associate the tags.
- `tags`: Tags being associated with a specific Amazon Comprehend resource. There can be a
maximum of 50 tags (both existing and pending) associated with a specific resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"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 comprehend(
"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 associated with an Amazon Comprehend resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the given Amazon Comprehend resource
from which you want to remove the tags.
- `tag_keys`: The initial part of a key-value pair that forms a tag being removed from a
given resource. For example, a tag with \"Sales\" as the key might be added to a resource
to indicate its use by the sales department. Keys must be unique and cannot be duplicated
for a particular resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehend(
"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 comprehend(
"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_endpoint(endpoint_arn)
update_endpoint(endpoint_arn, params::Dict{String,<:Any})
Updates information about the specified endpoint. For information about endpoints, see
Managing endpoints.
# Arguments
- `endpoint_arn`: The Amazon Resource Number (ARN) of the endpoint being updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DesiredDataAccessRoleArn"`: Data access role ARN to use in case the new model is
encrypted with a customer CMK.
- `"DesiredInferenceUnits"`: The desired number of inference units to be used by the model
using this endpoint. Each inference unit represents of a throughput of 100 characters per
second.
- `"DesiredModelArn"`: The ARN of the new model to use when updating an existing endpoint.
- `"FlywheelArn"`: The Amazon Resource Number (ARN) of the flywheel
"""
function update_endpoint(EndpointArn; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"UpdateEndpoint",
Dict{String,Any}("EndpointArn" => EndpointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_endpoint(
EndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"UpdateEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointArn" => EndpointArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_flywheel(flywheel_arn)
update_flywheel(flywheel_arn, params::Dict{String,<:Any})
Update the configuration information for an existing flywheel.
# Arguments
- `flywheel_arn`: The Amazon Resource Number (ARN) of the flywheel to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActiveModelArn"`: The Amazon Resource Number (ARN) of the active model version.
- `"DataAccessRoleArn"`: The Amazon Resource Name (ARN) of the IAM role that grants Amazon
Comprehend permission to access the flywheel data.
- `"DataSecurityConfig"`: Flywheel data security configuration.
"""
function update_flywheel(FlywheelArn; aws_config::AbstractAWSConfig=global_aws_config())
return comprehend(
"UpdateFlywheel",
Dict{String,Any}("FlywheelArn" => FlywheelArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_flywheel(
FlywheelArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehend(
"UpdateFlywheel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FlywheelArn" => FlywheelArn), 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 | 36343 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: comprehendmedical
using AWS.Compat
using AWS.UUIDs
"""
describe_entities_detection_v2_job(job_id)
describe_entities_detection_v2_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with a medical entities detection job. Use this operation to
get the status of a detection job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend Medical generated for the job. The
StartEntitiesDetectionV2Job operation returns this identifier in its response.
"""
function describe_entities_detection_v2_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DescribeEntitiesDetectionV2Job",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_entities_detection_v2_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DescribeEntitiesDetectionV2Job",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_icd10_cminference_job(job_id)
describe_icd10_cminference_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with an InferICD10CM job. Use this operation to get the
status of an inference job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend Medical generated for the job. The
StartICD10CMInferenceJob operation returns this identifier in its response.
"""
function describe_icd10_cminference_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DescribeICD10CMInferenceJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_icd10_cminference_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DescribeICD10CMInferenceJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_phidetection_job(job_id)
describe_phidetection_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with a protected health information (PHI) detection job. Use
this operation to get the status of a detection job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend Medical generated for the job. The
StartPHIDetectionJob operation returns this identifier in its response.
"""
function describe_phidetection_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"DescribePHIDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_phidetection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DescribePHIDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_rx_norm_inference_job(job_id)
describe_rx_norm_inference_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with an InferRxNorm job. Use this operation to get the
status of an inference job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend Medical generated for the job. The
StartRxNormInferenceJob operation returns this identifier in its response.
"""
function describe_rx_norm_inference_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DescribeRxNormInferenceJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_rx_norm_inference_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DescribeRxNormInferenceJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snomedctinference_job(job_id)
describe_snomedctinference_job(job_id, params::Dict{String,<:Any})
Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the
status of an inference job.
# Arguments
- `job_id`: The identifier that Amazon Comprehend Medical generated for the job. The
StartSNOMEDCTInferenceJob operation returns this identifier in its response.
"""
function describe_snomedctinference_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DescribeSNOMEDCTInferenceJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_snomedctinference_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DescribeSNOMEDCTInferenceJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_entities(text)
detect_entities(text, params::Dict{String,<:Any})
The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation
instead. Inspects the clinical text for a variety of medical entities and returns specific
information about them such as entity category, location, and confidence score on that
information.
# Arguments
- `text`: A UTF-8 text string containing the clinical content being examined for entities.
"""
function detect_entities(Text; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"DetectEntities",
Dict{String,Any}("Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_entities(
Text, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DetectEntities",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_entities_v2(text)
detect_entities_v2(text, params::Dict{String,<:Any})
Inspects the clinical text for a variety of medical entities and returns specific
information about them such as entity category, location, and confidence score on that
information. Amazon Comprehend Medical only detects medical entities in English language
texts. The DetectEntitiesV2 operation replaces the DetectEntities operation. This new
action uses a different model for determining the entities in your medical text and changes
the way that some entities are returned in the output. You should use the DetectEntitiesV2
operation in all new applications. The DetectEntitiesV2 operation returns the Acuity and
Direction entities as attributes instead of types.
# Arguments
- `text`: A UTF-8 string containing the clinical content being examined for entities.
"""
function detect_entities_v2(Text; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"DetectEntitiesV2",
Dict{String,Any}("Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_entities_v2(
Text, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DetectEntitiesV2",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_phi(text)
detect_phi(text, params::Dict{String,<:Any})
Inspects the clinical text for protected health information (PHI) entities and returns the
entity category, location, and confidence score for each entity. Amazon Comprehend Medical
only detects entities in English language texts.
# Arguments
- `text`: A UTF-8 text string containing the clinical content being examined for PHI
entities.
"""
function detect_phi(Text; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"DetectPHI",
Dict{String,Any}("Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_phi(
Text, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"DetectPHI",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
infer_icd10_cm(text)
infer_icd10_cm(text, params::Dict{String,<:Any})
InferICD10CM detects medical conditions as entities listed in a patient record and links
those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the
Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in
English language texts.
# Arguments
- `text`: The input text used for analysis.
"""
function infer_icd10_cm(Text; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"InferICD10CM",
Dict{String,Any}("Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function infer_icd10_cm(
Text, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"InferICD10CM",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
infer_rx_norm(text)
infer_rx_norm(text, params::Dict{String,<:Any})
InferRxNorm detects medications as entities listed in a patient record and links to the
normalized concept identifiers in the RxNorm database from the National Library of
Medicine. Amazon Comprehend Medical only detects medical entities in English language
texts.
# Arguments
- `text`: The input text used for analysis.
"""
function infer_rx_norm(Text; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"InferRxNorm",
Dict{String,Any}("Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function infer_rx_norm(
Text, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"InferRxNorm",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
infer_snomedct(text)
infer_snomedct(text, params::Dict{String,<:Any})
InferSNOMEDCT detects possible medical concepts as entities and links them to codes from
the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology
# Arguments
- `text`: The input text to be analyzed using InferSNOMEDCT.
"""
function infer_snomedct(Text; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"InferSNOMEDCT",
Dict{String,Any}("Text" => Text);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function infer_snomedct(
Text, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"InferSNOMEDCT",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Text" => Text), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_entities_detection_v2_jobs()
list_entities_detection_v2_jobs(params::Dict{String,<:Any})
Gets a list of medical entity detection jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs based on their names,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_entities_detection_v2_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"ListEntitiesDetectionV2Jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_entities_detection_v2_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"ListEntitiesDetectionV2Jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_icd10_cminference_jobs()
list_icd10_cminference_jobs(params::Dict{String,<:Any})
Gets a list of InferICD10CM jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs based on their names,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_icd10_cminference_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"ListICD10CMInferenceJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_icd10_cminference_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"ListICD10CMInferenceJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_phidetection_jobs()
list_phidetection_jobs(params::Dict{String,<:Any})
Gets a list of protected health information (PHI) detection jobs you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs based on their names,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: The maximum number of results to return in each page. The default is 100.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_phidetection_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"ListPHIDetectionJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_phidetection_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"ListPHIDetectionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rx_norm_inference_jobs()
list_rx_norm_inference_jobs(params::Dict{String,<:Any})
Gets a list of InferRxNorm jobs that you have submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the jobs that are returned. You can filter jobs based on their names,
status, or the date and time that they were submitted. You can only set one filter at a
time.
- `"MaxResults"`: Identifies the next page of results to return.
- `"NextToken"`: Identifies the next page of results to return.
"""
function list_rx_norm_inference_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"ListRxNormInferenceJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rx_norm_inference_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"ListRxNormInferenceJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_snomedctinference_jobs()
list_snomedctinference_jobs(params::Dict{String,<:Any})
Gets a list of InferSNOMEDCT jobs a user has submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`:
- `"MaxResults"`: The maximum number of results to return in each page. The default is
100.
- `"NextToken"`: Identifies the next page of InferSNOMEDCT results to return.
"""
function list_snomedctinference_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"ListSNOMEDCTInferenceJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_snomedctinference_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"ListSNOMEDCTInferenceJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_entities_detection_v2_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_entities_detection_v2_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous medical entity detection job for a collection of documents. Use the
DescribeEntitiesDetectionV2Job operation to track the status of a job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the AWS Identity and Access
Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.
For more information, see Role-Based Permissions Required for Asynchronous Operations.
- `input_data_config`: The input configuration that specifies the format and location of
the input data for the job.
- `language_code`: The language of the input documents. All documents must be in the same
language. Amazon Comprehend Medical processes files in US English (en).
- `output_data_config`: The output configuration that specifies where to send the output
files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend Medical generates one for you.
- `"JobName"`: The identifier of the job.
- `"KMSKey"`: An AWS Key Management Service key to encrypt your output files. If you do not
specify a key, the files are written in plain text.
"""
function start_entities_detection_v2_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehendmedical(
"StartEntitiesDetectionV2Job",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_entities_detection_v2_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehendmedical(
"StartEntitiesDetectionV2Job",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_icd10_cminference_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_icd10_cminference_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM
ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the AWS Identity and Access
Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.
For more information, see Role-Based Permissions Required for Asynchronous Operations.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `language_code`: The language of the input documents. All documents must be in the same
language.
- `output_data_config`: Specifies where to send the output files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend Medical generates one.
- `"JobName"`: The identifier of the job.
- `"KMSKey"`: An AWS Key Management Service key to encrypt your output files. If you do not
specify a key, the files are written in plain text.
"""
function start_icd10_cminference_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehendmedical(
"StartICD10CMInferenceJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_icd10_cminference_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehendmedical(
"StartICD10CMInferenceJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_phidetection_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_phidetection_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous job to detect protected health information (PHI). Use the
DescribePHIDetectionJob operation to track the status of a job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the AWS Identity and Access
Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.
For more information, see Role-Based Permissions Required for Asynchronous Operations.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `language_code`: The language of the input documents. All documents must be in the same
language.
- `output_data_config`: Specifies where to send the output files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend Medical generates one.
- `"JobName"`: The identifier of the job.
- `"KMSKey"`: An AWS Key Management Service key to encrypt your output files. If you do not
specify a key, the files are written in plain text.
"""
function start_phidetection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehendmedical(
"StartPHIDetectionJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_phidetection_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehendmedical(
"StartPHIDetectionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_rx_norm_inference_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_rx_norm_inference_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous job to detect medication entities and link them to the RxNorm
ontology. Use the DescribeRxNormInferenceJob operation to track the status of a job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the AWS Identity and Access
Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.
For more information, see Role-Based Permissions Required for Asynchronous Operations.
- `input_data_config`: Specifies the format and location of the input data for the job.
- `language_code`: The language of the input documents. All documents must be in the same
language.
- `output_data_config`: Specifies where to send the output files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend Medical generates one.
- `"JobName"`: The identifier of the job.
- `"KMSKey"`: An AWS Key Management Service key to encrypt your output files. If you do not
specify a key, the files are written in plain text.
"""
function start_rx_norm_inference_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehendmedical(
"StartRxNormInferenceJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_rx_norm_inference_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehendmedical(
"StartRxNormInferenceJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_snomedctinference_job(data_access_role_arn, input_data_config, language_code, output_data_config)
start_snomedctinference_job(data_access_role_arn, input_data_config, language_code, output_data_config, params::Dict{String,<:Any})
Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT
ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.
# Arguments
- `data_access_role_arn`: The Amazon Resource Name (ARN) of the AWS Identity and Access
Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.
- `input_data_config`:
- `language_code`: The language of the input documents. All documents must be in the same
language.
- `output_data_config`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend Medical generates one.
- `"JobName"`: The user generated name the asynchronous InferSNOMEDCT job.
- `"KMSKey"`: An AWS Key Management Service key used to encrypt your output files. If you
do not specify a key, the files are written in plain text.
"""
function start_snomedctinference_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehendmedical(
"StartSNOMEDCTInferenceJob",
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_snomedctinference_job(
DataAccessRoleArn,
InputDataConfig,
LanguageCode,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return comprehendmedical(
"StartSNOMEDCTInferenceJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataAccessRoleArn" => DataAccessRoleArn,
"InputDataConfig" => InputDataConfig,
"LanguageCode" => LanguageCode,
"OutputDataConfig" => OutputDataConfig,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_entities_detection_v2_job(job_id)
stop_entities_detection_v2_job(job_id, params::Dict{String,<:Any})
Stops a medical entities detection job in progress.
# Arguments
- `job_id`: The identifier of the medical entities job to stop.
"""
function stop_entities_detection_v2_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"StopEntitiesDetectionV2Job",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_entities_detection_v2_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"StopEntitiesDetectionV2Job",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_icd10_cminference_job(job_id)
stop_icd10_cminference_job(job_id, params::Dict{String,<:Any})
Stops an InferICD10CM inference job in progress.
# Arguments
- `job_id`: The identifier of the job.
"""
function stop_icd10_cminference_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"StopICD10CMInferenceJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_icd10_cminference_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"StopICD10CMInferenceJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_phidetection_job(job_id)
stop_phidetection_job(job_id, params::Dict{String,<:Any})
Stops a protected health information (PHI) detection job in progress.
# Arguments
- `job_id`: The identifier of the PHI detection job to stop.
"""
function stop_phidetection_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return comprehendmedical(
"StopPHIDetectionJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_phidetection_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"StopPHIDetectionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_rx_norm_inference_job(job_id)
stop_rx_norm_inference_job(job_id, params::Dict{String,<:Any})
Stops an InferRxNorm inference job in progress.
# Arguments
- `job_id`: The identifier of the job.
"""
function stop_rx_norm_inference_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"StopRxNormInferenceJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_rx_norm_inference_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"StopRxNormInferenceJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_snomedctinference_job(job_id)
stop_snomedctinference_job(job_id, params::Dict{String,<:Any})
Stops an InferSNOMEDCT inference job in progress.
# Arguments
- `job_id`: The job id of the asynchronous InferSNOMEDCT job to be stopped.
"""
function stop_snomedctinference_job(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"StopSNOMEDCTInferenceJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_snomedctinference_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return comprehendmedical(
"StopSNOMEDCTInferenceJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), 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 | 67924 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: compute_optimizer
using AWS.Compat
using AWS.UUIDs
"""
delete_recommendation_preferences(recommendation_preference_names, resource_type)
delete_recommendation_preferences(recommendation_preference_names, resource_type, params::Dict{String,<:Any})
Deletes a recommendation preference, such as enhanced infrastructure metrics. For more
information, see Activating enhanced infrastructure metrics in the Compute Optimizer User
Guide.
# Arguments
- `recommendation_preference_names`: The name of the recommendation preference to delete.
- `resource_type`: The target resource type of the recommendation preference to delete. The
Ec2Instance option encompasses standalone instances and instances that are part of Auto
Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an
Auto Scaling group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"scope"`: An object that describes the scope of the recommendation preference to delete.
You can delete recommendation preferences that are created at the organization level (for
management accounts of an organization only), account level, and resource level. For more
information, see Activating enhanced infrastructure metrics in the Compute Optimizer User
Guide.
"""
function delete_recommendation_preferences(
recommendationPreferenceNames,
resourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"DeleteRecommendationPreferences",
Dict{String,Any}(
"recommendationPreferenceNames" => recommendationPreferenceNames,
"resourceType" => resourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_recommendation_preferences(
recommendationPreferenceNames,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"DeleteRecommendationPreferences",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"recommendationPreferenceNames" => recommendationPreferenceNames,
"resourceType" => resourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_recommendation_export_jobs()
describe_recommendation_export_jobs(params::Dict{String,<:Any})
Describes recommendation export jobs created in the last seven days. Use the
ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to
request an export of your recommendations. Then use the DescribeRecommendationExportJobs
action to view your export jobs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: An array of objects to specify a filter that returns a more specific list of
export jobs.
- `"jobIds"`: The identification numbers of the export jobs to return. An export job ID is
returned when you create an export using the ExportAutoScalingGroupRecommendations or
ExportEC2InstanceRecommendations actions. All export jobs created in the last seven days
are returned if this parameter is omitted.
- `"maxResults"`: The maximum number of export jobs to return with a single request. To
retrieve the remaining results, make another request with the returned nextToken value.
- `"nextToken"`: The token to advance to the next page of export jobs.
"""
function describe_recommendation_export_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"DescribeRecommendationExportJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_recommendation_export_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"DescribeRecommendationExportJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_auto_scaling_group_recommendations(s3_destination_config)
export_auto_scaling_group_recommendations(s3_destination_config, params::Dict{String,<:Any})
Exports optimization recommendations for Auto Scaling groups. Recommendations are exported
in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation
(JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that
you specify. For more information, see Exporting Recommendations in the Compute Optimizer
User Guide. You can have only one Auto Scaling group export job in progress per Amazon Web
Services Region.
# Arguments
- `s3_destination_config`: An object to specify the destination Amazon Simple Storage
Service (Amazon S3) bucket name and key prefix for the export job. You must create the
destination Amazon S3 bucket for your recommendations export before you create the export
job. Compute Optimizer does not create the S3 bucket for you. After you create the S3
bucket, ensure that it has the required permissions policy to allow Compute Optimizer to
write the export file to it. If you plan to specify an object prefix when you create the
export job, you must include the object prefix in the policy that you add to the S3 bucket.
For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute
Optimizer User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The IDs of the Amazon Web Services accounts for which to export Auto
Scaling group recommendations. If your account is the management account of an
organization, use this parameter to specify the member account for which you want to export
recommendations. This parameter cannot be specified together with the include member
accounts parameter. The parameters are mutually exclusive. Recommendations for member
accounts are not included in the export if this parameter, or the include member accounts
parameter, is omitted. You can specify multiple account IDs per request.
- `"fieldsToExport"`: The recommendations data to include in the export file. For more
information about the fields that can be exported, see Exported files in the Compute
Optimizer User Guide.
- `"fileFormat"`: The format of the export file. The only export file format currently
supported is Csv.
- `"filters"`: An array of objects to specify a filter that exports a more specific set of
Auto Scaling group recommendations.
- `"includeMemberAccounts"`: Indicates whether to include recommendations for resources in
all member accounts of the organization if your account is the management account of an
organization. The member accounts must also be opted in to Compute Optimizer, and trusted
access for Compute Optimizer must be enabled in the organization account. For more
information, see Compute Optimizer and Amazon Web Services Organizations trusted access in
the Compute Optimizer User Guide. Recommendations for member accounts of the organization
are not included in the export file if this parameter is omitted. This parameter cannot be
specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or
the account IDs parameter, is omitted.
- `"recommendationPreferences"`: An object to specify the preferences for the Auto Scaling
group recommendations to export.
"""
function export_auto_scaling_group_recommendations(
s3DestinationConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"ExportAutoScalingGroupRecommendations",
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_auto_scaling_group_recommendations(
s3DestinationConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"ExportAutoScalingGroupRecommendations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_ebsvolume_recommendations(s3_destination_config)
export_ebsvolume_recommendations(s3_destination_config, params::Dict{String,<:Any})
Exports optimization recommendations for Amazon EBS volumes. Recommendations are exported
in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation
(JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that
you specify. For more information, see Exporting Recommendations in the Compute Optimizer
User Guide. You can have only one Amazon EBS volume export job in progress per Amazon Web
Services Region.
# Arguments
- `s3_destination_config`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The IDs of the Amazon Web Services accounts for which to export Amazon
EBS volume recommendations. If your account is the management account of an organization,
use this parameter to specify the member account for which you want to export
recommendations. This parameter cannot be specified together with the include member
accounts parameter. The parameters are mutually exclusive. Recommendations for member
accounts are not included in the export if this parameter, or the include member accounts
parameter, is omitted. You can specify multiple account IDs per request.
- `"fieldsToExport"`: The recommendations data to include in the export file. For more
information about the fields that can be exported, see Exported files in the Compute
Optimizer User Guide.
- `"fileFormat"`: The format of the export file. The only export file format currently
supported is Csv.
- `"filters"`: An array of objects to specify a filter that exports a more specific set of
Amazon EBS volume recommendations.
- `"includeMemberAccounts"`: Indicates whether to include recommendations for resources in
all member accounts of the organization if your account is the management account of an
organization. The member accounts must also be opted in to Compute Optimizer, and trusted
access for Compute Optimizer must be enabled in the organization account. For more
information, see Compute Optimizer and Amazon Web Services Organizations trusted access in
the Compute Optimizer User Guide. Recommendations for member accounts of the organization
are not included in the export file if this parameter is omitted. This parameter cannot be
specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or
the account IDs parameter, is omitted.
"""
function export_ebsvolume_recommendations(
s3DestinationConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"ExportEBSVolumeRecommendations",
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_ebsvolume_recommendations(
s3DestinationConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"ExportEBSVolumeRecommendations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_ec2_instance_recommendations(s3_destination_config)
export_ec2_instance_recommendations(s3_destination_config, params::Dict{String,<:Any})
Exports optimization recommendations for Amazon EC2 instances. Recommendations are exported
in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation
(JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that
you specify. For more information, see Exporting Recommendations in the Compute Optimizer
User Guide. You can have only one Amazon EC2 instance export job in progress per Amazon Web
Services Region.
# Arguments
- `s3_destination_config`: An object to specify the destination Amazon Simple Storage
Service (Amazon S3) bucket name and key prefix for the export job. You must create the
destination Amazon S3 bucket for your recommendations export before you create the export
job. Compute Optimizer does not create the S3 bucket for you. After you create the S3
bucket, ensure that it has the required permissions policy to allow Compute Optimizer to
write the export file to it. If you plan to specify an object prefix when you create the
export job, you must include the object prefix in the policy that you add to the S3 bucket.
For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute
Optimizer User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The IDs of the Amazon Web Services accounts for which to export instance
recommendations. If your account is the management account of an organization, use this
parameter to specify the member account for which you want to export recommendations. This
parameter cannot be specified together with the include member accounts parameter. The
parameters are mutually exclusive. Recommendations for member accounts are not included in
the export if this parameter, or the include member accounts parameter, is omitted. You can
specify multiple account IDs per request.
- `"fieldsToExport"`: The recommendations data to include in the export file. For more
information about the fields that can be exported, see Exported files in the Compute
Optimizer User Guide.
- `"fileFormat"`: The format of the export file. The only export file format currently
supported is Csv.
- `"filters"`: An array of objects to specify a filter that exports a more specific set of
instance recommendations.
- `"includeMemberAccounts"`: Indicates whether to include recommendations for resources in
all member accounts of the organization if your account is the management account of an
organization. The member accounts must also be opted in to Compute Optimizer, and trusted
access for Compute Optimizer must be enabled in the organization account. For more
information, see Compute Optimizer and Amazon Web Services Organizations trusted access in
the Compute Optimizer User Guide. Recommendations for member accounts of the organization
are not included in the export file if this parameter is omitted. Recommendations for
member accounts are not included in the export if this parameter, or the account IDs
parameter, is omitted.
- `"recommendationPreferences"`: An object to specify the preferences for the Amazon EC2
instance recommendations to export.
"""
function export_ec2_instance_recommendations(
s3DestinationConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"ExportEC2InstanceRecommendations",
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_ec2_instance_recommendations(
s3DestinationConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"ExportEC2InstanceRecommendations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_ecsservice_recommendations(s3_destination_config)
export_ecsservice_recommendations(s3_destination_config, params::Dict{String,<:Any})
Exports optimization recommendations for Amazon ECS services on Fargate. Recommendations
are exported in a CSV file, and its metadata in a JSON file, to an existing Amazon Simple
Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting
Recommendations in the Compute Optimizer User Guide. You can only have one Amazon ECS
service export job in progress per Amazon Web Services Region.
# Arguments
- `s3_destination_config`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The Amazon Web Services account IDs for the export Amazon ECS service
recommendations. If your account is the management account or the delegated administrator
of an organization, use this parameter to specify the member account you want to export
recommendations to. This parameter can't be specified together with the include member
accounts parameter. The parameters are mutually exclusive. If this parameter or the include
member accounts parameter is omitted, the recommendations for member accounts aren't
included in the export. You can specify multiple account IDs per request.
- `"fieldsToExport"`: The recommendations data to include in the export file. For more
information about the fields that can be exported, see Exported files in the Compute
Optimizer User Guide.
- `"fileFormat"`: The format of the export file. The CSV file is the only export file
format currently supported.
- `"filters"`: An array of objects to specify a filter that exports a more specific set of
Amazon ECS service recommendations.
- `"includeMemberAccounts"`: If your account is the management account or the delegated
administrator of an organization, this parameter indicates whether to include
recommendations for resources in all member accounts of the organization. The member
accounts must also be opted in to Compute Optimizer, and trusted access for Compute
Optimizer must be enabled in the organization account. For more information, see Compute
Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer
User Guide. If this parameter is omitted, recommendations for member accounts of the
organization aren't included in the export file. If this parameter or the account ID
parameter is omitted, recommendations for member accounts aren't included in the export.
"""
function export_ecsservice_recommendations(
s3DestinationConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"ExportECSServiceRecommendations",
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_ecsservice_recommendations(
s3DestinationConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"ExportECSServiceRecommendations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_lambda_function_recommendations(s3_destination_config)
export_lambda_function_recommendations(s3_destination_config, params::Dict{String,<:Any})
Exports optimization recommendations for Lambda functions. Recommendations are exported in
a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation
(JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that
you specify. For more information, see Exporting Recommendations in the Compute Optimizer
User Guide. You can have only one Lambda function export job in progress per Amazon Web
Services Region.
# Arguments
- `s3_destination_config`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The IDs of the Amazon Web Services accounts for which to export Lambda
function recommendations. If your account is the management account of an organization, use
this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The
parameters are mutually exclusive. Recommendations for member accounts are not included in
the export if this parameter, or the include member accounts parameter, is omitted. You can
specify multiple account IDs per request.
- `"fieldsToExport"`: The recommendations data to include in the export file. For more
information about the fields that can be exported, see Exported files in the Compute
Optimizer User Guide.
- `"fileFormat"`: The format of the export file. The only export file format currently
supported is Csv.
- `"filters"`: An array of objects to specify a filter that exports a more specific set of
Lambda function recommendations.
- `"includeMemberAccounts"`: Indicates whether to include recommendations for resources in
all member accounts of the organization if your account is the management account of an
organization. The member accounts must also be opted in to Compute Optimizer, and trusted
access for Compute Optimizer must be enabled in the organization account. For more
information, see Compute Optimizer and Amazon Web Services Organizations trusted access in
the Compute Optimizer User Guide. Recommendations for member accounts of the organization
are not included in the export file if this parameter is omitted. This parameter cannot be
specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or
the account IDs parameter, is omitted.
"""
function export_lambda_function_recommendations(
s3DestinationConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"ExportLambdaFunctionRecommendations",
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_lambda_function_recommendations(
s3DestinationConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"ExportLambdaFunctionRecommendations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_license_recommendations(s3_destination_config)
export_license_recommendations(s3_destination_config, params::Dict{String,<:Any})
Export optimization recommendations for your licenses. Recommendations are exported in a
comma-separated values (CSV) file, and its metadata in a JavaScript Object Notation (JSON)
file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For
more information, see Exporting Recommendations in the Compute Optimizer User Guide. You
can have only one license export job in progress per Amazon Web Services Region.
# Arguments
- `s3_destination_config`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The IDs of the Amazon Web Services accounts for which to export license
recommendations. If your account is the management account of an organization, use this
parameter to specify the member account for which you want to export recommendations. This
parameter can't be specified together with the include member accounts parameter. The
parameters are mutually exclusive. If this parameter is omitted, recommendations for member
accounts aren't included in the export. You can specify multiple account IDs per request.
- `"fieldsToExport"`: The recommendations data to include in the export file. For more
information about the fields that can be exported, see Exported files in the Compute
Optimizer User Guide.
- `"fileFormat"`: The format of the export file. A CSV file is the only export format
currently supported.
- `"filters"`: An array of objects to specify a filter that exports a more specific set of
license recommendations.
- `"includeMemberAccounts"`: Indicates whether to include recommendations for resources in
all member accounts of the organization if your account is the management account of an
organization. The member accounts must also be opted in to Compute Optimizer, and trusted
access for Compute Optimizer must be enabled in the organization account. For more
information, see Compute Optimizer and Amazon Web Services Organizations trusted access in
the Compute Optimizer User Guide. If this parameter is omitted, recommendations for member
accounts of the organization aren't included in the export file . This parameter cannot be
specified together with the account IDs parameter. The parameters are mutually exclusive.
"""
function export_license_recommendations(
s3DestinationConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"ExportLicenseRecommendations",
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_license_recommendations(
s3DestinationConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"ExportLicenseRecommendations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_rdsdatabase_recommendations(s3_destination_config)
export_rdsdatabase_recommendations(s3_destination_config, params::Dict{String,<:Any})
Export optimization recommendations for your Amazon Relational Database Service (Amazon
RDS). Recommendations are exported in a comma-separated values (CSV) file, and its
metadata in a JavaScript Object Notation (JSON) file, to an existing Amazon Simple Storage
Service (Amazon S3) bucket that you specify. For more information, see Exporting
Recommendations in the Compute Optimizer User Guide. You can have only one Amazon RDS
export job in progress per Amazon Web Services Region.
# Arguments
- `s3_destination_config`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The Amazon Web Services account IDs for the export Amazon RDS
recommendations. If your account is the management account or the delegated administrator
of an organization, use this parameter to specify the member account you want to export
recommendations to. This parameter can't be specified together with the include member
accounts parameter. The parameters are mutually exclusive. If this parameter or the include
member accounts parameter is omitted, the recommendations for member accounts aren't
included in the export. You can specify multiple account IDs per request.
- `"fieldsToExport"`: The recommendations data to include in the export file. For more
information about the fields that can be exported, see Exported files in the Compute
Optimizer User Guide.
- `"fileFormat"`: The format of the export file. The CSV file is the only export file
format currently supported.
- `"filters"`: An array of objects to specify a filter that exports a more specific set of
Amazon RDS recommendations.
- `"includeMemberAccounts"`: If your account is the management account or the delegated
administrator of an organization, this parameter indicates whether to include
recommendations for resources in all member accounts of the organization. The member
accounts must also be opted in to Compute Optimizer, and trusted access for Compute
Optimizer must be enabled in the organization account. For more information, see Compute
Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer
User Guide. If this parameter is omitted, recommendations for member accounts of the
organization aren't included in the export file. If this parameter or the account ID
parameter is omitted, recommendations for member accounts aren't included in the export.
- `"recommendationPreferences"`:
"""
function export_rdsdatabase_recommendations(
s3DestinationConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"ExportRDSDatabaseRecommendations",
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_rdsdatabase_recommendations(
s3DestinationConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"ExportRDSDatabaseRecommendations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("s3DestinationConfig" => s3DestinationConfig),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_auto_scaling_group_recommendations()
get_auto_scaling_group_recommendations(params::Dict{String,<:Any})
Returns Auto Scaling group recommendations. Compute Optimizer generates recommendations for
Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more
information, see the Supported resources and requirements in the Compute Optimizer User
Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The ID of the Amazon Web Services account for which to return Auto
Scaling group recommendations. If your account is the management account of an
organization, use this parameter to specify the member account for which you want to return
Auto Scaling group recommendations. Only one account ID can be specified per request.
- `"autoScalingGroupArns"`: The Amazon Resource Name (ARN) of the Auto Scaling groups for
which to return recommendations.
- `"filters"`: An array of objects to specify a filter that returns a more specific list of
Auto Scaling group recommendations.
- `"maxResults"`: The maximum number of Auto Scaling group recommendations to return with a
single request. To retrieve the remaining results, make another request with the returned
nextToken value.
- `"nextToken"`: The token to advance to the next page of Auto Scaling group
recommendations.
- `"recommendationPreferences"`: An object to specify the preferences for the Auto Scaling
group recommendations to return in the response.
"""
function get_auto_scaling_group_recommendations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetAutoScalingGroupRecommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_auto_scaling_group_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetAutoScalingGroupRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ebsvolume_recommendations()
get_ebsvolume_recommendations(params::Dict{String,<:Any})
Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations. Compute Optimizer
generates recommendations for Amazon EBS volumes that meet a specific set of requirements.
For more information, see the Supported resources and requirements in the Compute Optimizer
User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The ID of the Amazon Web Services account for which to return volume
recommendations. If your account is the management account of an organization, use this
parameter to specify the member account for which you want to return volume
recommendations. Only one account ID can be specified per request.
- `"filters"`: An array of objects to specify a filter that returns a more specific list of
volume recommendations.
- `"maxResults"`: The maximum number of volume recommendations to return with a single
request. To retrieve the remaining results, make another request with the returned
nextToken value.
- `"nextToken"`: The token to advance to the next page of volume recommendations.
- `"volumeArns"`: The Amazon Resource Name (ARN) of the volumes for which to return
recommendations.
"""
function get_ebsvolume_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return compute_optimizer(
"GetEBSVolumeRecommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ebsvolume_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetEBSVolumeRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ec2_instance_recommendations()
get_ec2_instance_recommendations(params::Dict{String,<:Any})
Returns Amazon EC2 instance recommendations. Compute Optimizer generates recommendations
for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of
requirements. For more information, see the Supported resources and requirements in the
Compute Optimizer User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The ID of the Amazon Web Services account for which to return instance
recommendations. If your account is the management account of an organization, use this
parameter to specify the member account for which you want to return instance
recommendations. Only one account ID can be specified per request.
- `"filters"`: An array of objects to specify a filter that returns a more specific list of
instance recommendations.
- `"instanceArns"`: The Amazon Resource Name (ARN) of the instances for which to return
recommendations.
- `"maxResults"`: The maximum number of instance recommendations to return with a single
request. To retrieve the remaining results, make another request with the returned
nextToken value.
- `"nextToken"`: The token to advance to the next page of instance recommendations.
- `"recommendationPreferences"`: An object to specify the preferences for the Amazon EC2
instance recommendations to return in the response.
"""
function get_ec2_instance_recommendations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetEC2InstanceRecommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ec2_instance_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetEC2InstanceRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ec2_recommendation_projected_metrics(end_time, instance_arn, period, start_time, stat)
get_ec2_recommendation_projected_metrics(end_time, instance_arn, period, start_time, stat, params::Dict{String,<:Any})
Returns the projected utilization metrics of Amazon EC2 instance recommendations. The Cpu
and Memory metrics are the only projected utilization metrics returned when you run this
action. Additionally, the Memory metric is returned only for resources that have the
unified CloudWatch agent installed on them. For more information, see Enabling Memory
Utilization with the CloudWatch Agent.
# Arguments
- `end_time`: The timestamp of the last projected metrics data point to return.
- `instance_arn`: The Amazon Resource Name (ARN) of the instances for which to return
recommendation projected metrics.
- `period`: The granularity, in seconds, of the projected metrics data points.
- `start_time`: The timestamp of the first projected metrics data point to return.
- `stat`: The statistic of the projected metrics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"recommendationPreferences"`: An object to specify the preferences for the Amazon EC2
recommendation projected metrics to return in the response.
"""
function get_ec2_recommendation_projected_metrics(
endTime,
instanceArn,
period,
startTime,
stat;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"GetEC2RecommendationProjectedMetrics",
Dict{String,Any}(
"endTime" => endTime,
"instanceArn" => instanceArn,
"period" => period,
"startTime" => startTime,
"stat" => stat,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ec2_recommendation_projected_metrics(
endTime,
instanceArn,
period,
startTime,
stat,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"GetEC2RecommendationProjectedMetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"instanceArn" => instanceArn,
"period" => period,
"startTime" => startTime,
"stat" => stat,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ecsservice_recommendation_projected_metrics(end_time, period, service_arn, start_time, stat)
get_ecsservice_recommendation_projected_metrics(end_time, period, service_arn, start_time, stat, params::Dict{String,<:Any})
Returns the projected metrics of Amazon ECS service recommendations.
# Arguments
- `end_time`: The timestamp of the last projected metrics data point to return.
- `period`: The granularity, in seconds, of the projected metrics data points.
- `service_arn`: The ARN that identifies the Amazon ECS service. The following is the
format of the ARN: arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
- `start_time`: The timestamp of the first projected metrics data point to return.
- `stat`: The statistic of the projected metrics.
"""
function get_ecsservice_recommendation_projected_metrics(
endTime,
period,
serviceArn,
startTime,
stat;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"GetECSServiceRecommendationProjectedMetrics",
Dict{String,Any}(
"endTime" => endTime,
"period" => period,
"serviceArn" => serviceArn,
"startTime" => startTime,
"stat" => stat,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ecsservice_recommendation_projected_metrics(
endTime,
period,
serviceArn,
startTime,
stat,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"GetECSServiceRecommendationProjectedMetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"period" => period,
"serviceArn" => serviceArn,
"startTime" => startTime,
"stat" => stat,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ecsservice_recommendations()
get_ecsservice_recommendations(params::Dict{String,<:Any})
Returns Amazon ECS service recommendations. Compute Optimizer generates recommendations
for Amazon ECS services on Fargate that meet a specific set of requirements. For more
information, see the Supported resources and requirements in the Compute Optimizer User
Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: Return the Amazon ECS service recommendations to the specified Amazon
Web Services account IDs. If your account is the management account or the delegated
administrator of an organization, use this parameter to return the Amazon ECS service
recommendations to specific member accounts. You can only specify one account ID per
request.
- `"filters"`: An array of objects to specify a filter that returns a more specific list
of Amazon ECS service recommendations.
- `"maxResults"`: The maximum number of Amazon ECS service recommendations to return with
a single request. To retrieve the remaining results, make another request with the
returned nextToken value.
- `"nextToken"`: The token to advance to the next page of Amazon ECS service
recommendations.
- `"serviceArns"`: The ARN that identifies the Amazon ECS service. The following is the
format of the ARN: arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
"""
function get_ecsservice_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return compute_optimizer(
"GetECSServiceRecommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ecsservice_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetECSServiceRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_effective_recommendation_preferences(resource_arn)
get_effective_recommendation_preferences(resource_arn, params::Dict{String,<:Any})
Returns the recommendation preferences that are in effect for a given resource, such as
enhanced infrastructure metrics. Considers all applicable preferences that you might have
set at the resource, account, and organization level. When you create a recommendation
preference, you can set its status to Active or Inactive. Use this action to view the
recommendation preferences that are in effect, or Active.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which to confirm
effective recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are
currently supported.
"""
function get_effective_recommendation_preferences(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetEffectiveRecommendationPreferences",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_effective_recommendation_preferences(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"GetEffectiveRecommendationPreferences",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_enrollment_status()
get_enrollment_status(params::Dict{String,<:Any})
Returns the enrollment (opt in) status of an account to the Compute Optimizer service. If
the account is the management account of an organization, this action also confirms the
enrollment status of member accounts of the organization. Use the
GetEnrollmentStatusesForOrganization action to get detailed information about the
enrollment status of member accounts of an organization.
"""
function get_enrollment_status(; aws_config::AbstractAWSConfig=global_aws_config())
return compute_optimizer(
"GetEnrollmentStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_enrollment_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetEnrollmentStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_enrollment_statuses_for_organization()
get_enrollment_statuses_for_organization(params::Dict{String,<:Any})
Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts,
if your account is an organization management account. To get the enrollment status of
standalone accounts, use the GetEnrollmentStatus action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: An array of objects to specify a filter that returns a more specific list of
account enrollment statuses.
- `"maxResults"`: The maximum number of account enrollment statuses to return with a single
request. You can specify up to 100 statuses to return with each request. To retrieve the
remaining results, make another request with the returned nextToken value.
- `"nextToken"`: The token to advance to the next page of account enrollment statuses.
"""
function get_enrollment_statuses_for_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetEnrollmentStatusesForOrganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_enrollment_statuses_for_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetEnrollmentStatusesForOrganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lambda_function_recommendations()
get_lambda_function_recommendations(params::Dict{String,<:Any})
Returns Lambda function recommendations. Compute Optimizer generates recommendations for
functions that meet a specific set of requirements. For more information, see the Supported
resources and requirements in the Compute Optimizer User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The ID of the Amazon Web Services account for which to return function
recommendations. If your account is the management account of an organization, use this
parameter to specify the member account for which you want to return function
recommendations. Only one account ID can be specified per request.
- `"filters"`: An array of objects to specify a filter that returns a more specific list of
function recommendations.
- `"functionArns"`: The Amazon Resource Name (ARN) of the functions for which to return
recommendations. You can specify a qualified or unqualified ARN. If you specify an
unqualified ARN without a function version suffix, Compute Optimizer will return
recommendations for the latest (LATEST) version of the function. If you specify a qualified
ARN with a version suffix, Compute Optimizer will return recommendations for the specified
function version. For more information about using function versions, see Using versions in
the Lambda Developer Guide.
- `"maxResults"`: The maximum number of function recommendations to return with a single
request. To retrieve the remaining results, make another request with the returned
nextToken value.
- `"nextToken"`: The token to advance to the next page of function recommendations.
"""
function get_lambda_function_recommendations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetLambdaFunctionRecommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lambda_function_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetLambdaFunctionRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_license_recommendations()
get_license_recommendations(params::Dict{String,<:Any})
Returns license recommendations for Amazon EC2 instances that run on a specific license.
Compute Optimizer generates recommendations for licenses that meet a specific set of
requirements. For more information, see the Supported resources and requirements in the
Compute Optimizer User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The ID of the Amazon Web Services account for which to return license
recommendations. If your account is the management account of an organization, use this
parameter to specify the member account for which you want to return license
recommendations. Only one account ID can be specified per request.
- `"filters"`: An array of objects to specify a filter that returns a more specific list
of license recommendations.
- `"maxResults"`: The maximum number of license recommendations to return with a single
request. To retrieve the remaining results, make another request with the returned
nextToken value.
- `"nextToken"`: The token to advance to the next page of license recommendations.
- `"resourceArns"`: The ARN that identifies the Amazon EC2 instance. The following is
the format of the ARN: arn:aws:ec2:region:aws_account_id:instance/instance-id
"""
function get_license_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return compute_optimizer(
"GetLicenseRecommendations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_license_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetLicenseRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rdsdatabase_recommendation_projected_metrics(end_time, period, resource_arn, start_time, stat)
get_rdsdatabase_recommendation_projected_metrics(end_time, period, resource_arn, start_time, stat, params::Dict{String,<:Any})
Returns the projected metrics of Amazon RDS recommendations.
# Arguments
- `end_time`: The timestamp of the last projected metrics data point to return.
- `period`: The granularity, in seconds, of the projected metrics data points.
- `resource_arn`: The ARN that identifies the Amazon RDS. The following is the format of
the ARN: arn:aws:rds:{region}:{accountId}:db:{resourceName}
- `start_time`: The timestamp of the first projected metrics data point to return.
- `stat`: The statistic of the projected metrics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"recommendationPreferences"`:
"""
function get_rdsdatabase_recommendation_projected_metrics(
endTime,
period,
resourceArn,
startTime,
stat;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"GetRDSDatabaseRecommendationProjectedMetrics",
Dict{String,Any}(
"endTime" => endTime,
"period" => period,
"resourceArn" => resourceArn,
"startTime" => startTime,
"stat" => stat,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rdsdatabase_recommendation_projected_metrics(
endTime,
period,
resourceArn,
startTime,
stat,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"GetRDSDatabaseRecommendationProjectedMetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"period" => period,
"resourceArn" => resourceArn,
"startTime" => startTime,
"stat" => stat,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rdsdatabase_recommendations()
get_rdsdatabase_recommendations(params::Dict{String,<:Any})
Returns Amazon RDS recommendations. Compute Optimizer generates recommendations for
Amazon RDS that meet a specific set of requirements. For more information, see the
Supported resources and requirements in the Compute Optimizer User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: Return the Amazon RDS recommendations to the specified Amazon Web
Services account IDs. If your account is the management account or the delegated
administrator of an organization, use this parameter to return the Amazon RDS
recommendations to specific member accounts. You can only specify one account ID per
request.
- `"filters"`: An array of objects to specify a filter that returns a more specific list
of Amazon RDS recommendations.
- `"maxResults"`: The maximum number of Amazon RDS recommendations to return with a single
request. To retrieve the remaining results, make another request with the returned
nextToken value.
- `"nextToken"`: The token to advance to the next page of Amazon RDS recommendations.
- `"recommendationPreferences"`:
- `"resourceArns"`: The ARN that identifies the Amazon RDS. The following is the format
of the ARN: arn:aws:rds:{region}:{accountId}:db:{resourceName} The following is the
format of a DB Cluster ARN: arn:aws:rds:{region}:{accountId}:cluster:{resourceName}
"""
function get_rdsdatabase_recommendations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetRDSDatabaseRecommendations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rdsdatabase_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetRDSDatabaseRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recommendation_preferences(resource_type)
get_recommendation_preferences(resource_type, params::Dict{String,<:Any})
Returns existing recommendation preferences, such as enhanced infrastructure metrics. Use
the scope parameter to specify which preferences to return. You can specify to return
preferences for an organization, a specific account ID, or a specific EC2 instance or Auto
Scaling group Amazon Resource Name (ARN). For more information, see Activating enhanced
infrastructure metrics in the Compute Optimizer User Guide.
# Arguments
- `resource_type`: The target resource type of the recommendation preference for which to
return preferences. The Ec2Instance option encompasses standalone instances and instances
that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only
instances that are part of an Auto Scaling group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of recommendation preferences to return with a single
request. To retrieve the remaining results, make another request with the returned
nextToken value.
- `"nextToken"`: The token to advance to the next page of recommendation preferences.
- `"scope"`: An object that describes the scope of the recommendation preference to return.
You can return recommendation preferences that are created at the organization level (for
management accounts of an organization only), account level, and resource level. For more
information, see Activating enhanced infrastructure metrics in the Compute Optimizer User
Guide.
"""
function get_recommendation_preferences(
resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetRecommendationPreferences",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recommendation_preferences(
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"GetRecommendationPreferences",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recommendation_summaries()
get_recommendation_summaries(params::Dict{String,<:Any})
Returns the optimization findings for an account. It returns the number of: Amazon EC2
instances in an account that are Underprovisioned, Overprovisioned, or Optimized. Auto
Scaling groups in an account that are NotOptimized, or Optimized. Amazon EBS volumes in
an account that are NotOptimized, or Optimized. Lambda functions in an account that are
NotOptimized, or Optimized. Amazon ECS services in an account that are Underprovisioned,
Overprovisioned, or Optimized.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The ID of the Amazon Web Services account for which to return
recommendation summaries. If your account is the management account of an organization, use
this parameter to specify the member account for which you want to return recommendation
summaries. Only one account ID can be specified per request.
- `"maxResults"`: The maximum number of recommendation summaries to return with a single
request. To retrieve the remaining results, make another request with the returned
nextToken value.
- `"nextToken"`: The token to advance to the next page of recommendation summaries.
"""
function get_recommendation_summaries(; aws_config::AbstractAWSConfig=global_aws_config())
return compute_optimizer(
"GetRecommendationSummaries"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_recommendation_summaries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"GetRecommendationSummaries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_recommendation_preferences(resource_type)
put_recommendation_preferences(resource_type, params::Dict{String,<:Any})
Creates a new recommendation preference or updates an existing recommendation preference,
such as enhanced infrastructure metrics. For more information, see Activating enhanced
infrastructure metrics in the Compute Optimizer User Guide.
# Arguments
- `resource_type`: The target resource type of the recommendation preference to create. The
Ec2Instance option encompasses standalone instances and instances that are part of Auto
Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an
Auto Scaling group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enhancedInfrastructureMetrics"`: The status of the enhanced infrastructure metrics
recommendation preference to create or update. Specify the Active status to activate the
preference, or specify Inactive to deactivate the preference. For more information, see
Enhanced infrastructure metrics in the Compute Optimizer User Guide.
- `"externalMetricsPreference"`: The provider of the external metrics recommendation
preference to create or update. Specify a valid provider in the source field to activate
the preference. To delete this preference, see the DeleteRecommendationPreferences action.
This preference can only be set for the Ec2Instance resource type. For more information,
see External metrics ingestion in the Compute Optimizer User Guide.
- `"inferredWorkloadTypes"`: The status of the inferred workload types recommendation
preference to create or update. The inferred workload type feature is active by default.
To deactivate it, create a recommendation preference. Specify the Inactive status to
deactivate the feature, or specify Active to activate it. For more information, see
Inferred workload types in the Compute Optimizer User Guide.
- `"lookBackPeriod"`: The preference to control the number of days the utilization metrics
of the Amazon Web Services resource are analyzed. When this preference isn't specified, we
use the default value DAYS_14. You can only set this preference for the Amazon EC2
instance and Auto Scaling group resource types.
- `"preferredResources"`: The preference to control which resource type values are
considered when generating rightsizing recommendations. You can specify this preference as
a combination of include and exclude lists. You must specify either an includeList or
excludeList. If the preference is an empty set of resource type values, an error occurs.
You can only set this preference for the Amazon EC2 instance and Auto Scaling group
resource types.
- `"savingsEstimationMode"`: The status of the savings estimation mode preference to
create or update. Specify the AfterDiscounts status to activate the preference, or specify
BeforeDiscounts to deactivate the preference. Only the account manager or delegated
administrator of your organization can activate this preference. For more information, see
Savings estimation mode in the Compute Optimizer User Guide.
- `"scope"`: An object that describes the scope of the recommendation preference to create.
You can create recommendation preferences at the organization level (for management
accounts of an organization only), account level, and resource level. For more information,
see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide. You
cannot create recommendation preferences for Auto Scaling groups at the organization and
account levels. You can create recommendation preferences for Auto Scaling groups only at
the resource level by specifying a scope name of ResourceArn and a scope value of the Auto
Scaling group Amazon Resource Name (ARN). This will configure the preference for all
instances that are part of the specified Auto Scaling group. You also cannot create
recommendation preferences at the resource level for instances that are part of an Auto
Scaling group. You can create recommendation preferences at the resource level only for
standalone instances.
- `"utilizationPreferences"`: The preference to control the resource’s CPU utilization
threshold, CPU utilization headroom, and memory utilization headroom. When this preference
isn't specified, we use the following default values. CPU utilization: P99_5 for
threshold PERCENT_20 for headroom Memory utilization: PERCENT_20 for headroom
You can only set CPU and memory utilization preferences for the Amazon EC2 instance
resource type. The threshold setting isn’t available for memory utilization.
"""
function put_recommendation_preferences(
resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"PutRecommendationPreferences",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_recommendation_preferences(
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return compute_optimizer(
"PutRecommendationPreferences",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_enrollment_status(status)
update_enrollment_status(status, params::Dict{String,<:Any})
Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer
service. If the account is a management account of an organization, this action can also be
used to enroll member accounts of the organization. You must have the appropriate
permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out.
For more information, see Controlling access with Amazon Web Services Identity and Access
Management in the Compute Optimizer User Guide. When you opt in, Compute Optimizer
automatically creates a service-linked role in your account to access its data. For more
information, see Using Service-Linked Roles for Compute Optimizer in the Compute Optimizer
User Guide.
# Arguments
- `status`: The new enrollment status of the account. The following status options are
available: Active - Opts in your account to the Compute Optimizer service. Compute
Optimizer begins analyzing the configuration and utilization metrics of your Amazon Web
Services resources after you opt in. For more information, see Metrics analyzed by Compute
Optimizer in the Compute Optimizer User Guide. Inactive - Opts out your account from the
Compute Optimizer service. Your account's recommendations and related metrics data will be
deleted from Compute Optimizer after you opt out. The Pending and Failed options cannot
be used to update the enrollment status of an account. They are returned in the response of
a request to update the enrollment status of an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeMemberAccounts"`: Indicates whether to enroll member accounts of the
organization if the account is the management account of an organization.
"""
function update_enrollment_status(status; aws_config::AbstractAWSConfig=global_aws_config())
return compute_optimizer(
"UpdateEnrollmentStatus",
Dict{String,Any}("status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_enrollment_status(
status, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return compute_optimizer(
"UpdateEnrollmentStatus",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("status" => status), 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 | 174617 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: config_service
using AWS.Compat
using AWS.UUIDs
"""
batch_get_aggregate_resource_config(configuration_aggregator_name, resource_identifiers)
batch_get_aggregate_resource_config(configuration_aggregator_name, resource_identifiers, params::Dict{String,<:Any})
Returns the current configuration items for resources that are present in your Config
aggregator. The operation also returns a list of resources that are not processed in the
current request. If there are no unprocessed resources, the operation returns an empty
unprocessedResourceIdentifiers list. The API does not return results for deleted
resources. The API does not return tags and relationships.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
- `resource_identifiers`: A list of aggregate ResourceIdentifiers objects.
"""
function batch_get_aggregate_resource_config(
ConfigurationAggregatorName,
ResourceIdentifiers;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"BatchGetAggregateResourceConfig",
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName,
"ResourceIdentifiers" => ResourceIdentifiers,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_aggregate_resource_config(
ConfigurationAggregatorName,
ResourceIdentifiers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"BatchGetAggregateResourceConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName,
"ResourceIdentifiers" => ResourceIdentifiers,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_resource_config(resource_keys)
batch_get_resource_config(resource_keys, params::Dict{String,<:Any})
Returns the BaseConfigurationItem for one or more requested resources. The operation also
returns a list of resources that are not processed in the current request. If there are no
unprocessed resources, the operation returns an empty unprocessedResourceKeys list. The
API does not return results for deleted resources. The API does not return any tags for
the requested resources. This information is filtered out of the supplementaryConfiguration
section of the API response.
# Arguments
- `resource_keys`: A list of resource keys to be processed with the current request. Each
element in the list consists of the resource type and resource ID.
"""
function batch_get_resource_config(
resourceKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"BatchGetResourceConfig",
Dict{String,Any}("resourceKeys" => resourceKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_resource_config(
resourceKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"BatchGetResourceConfig",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceKeys" => resourceKeys), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_aggregation_authorization(authorized_account_id, authorized_aws_region)
delete_aggregation_authorization(authorized_account_id, authorized_aws_region, params::Dict{String,<:Any})
Deletes the authorization granted to the specified configuration aggregator account in a
specified region.
# Arguments
- `authorized_account_id`: The 12-digit account ID of the account authorized to aggregate
data.
- `authorized_aws_region`: The region authorized to collect aggregated data.
"""
function delete_aggregation_authorization(
AuthorizedAccountId,
AuthorizedAwsRegion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteAggregationAuthorization",
Dict{String,Any}(
"AuthorizedAccountId" => AuthorizedAccountId,
"AuthorizedAwsRegion" => AuthorizedAwsRegion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_aggregation_authorization(
AuthorizedAccountId,
AuthorizedAwsRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteAggregationAuthorization",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthorizedAccountId" => AuthorizedAccountId,
"AuthorizedAwsRegion" => AuthorizedAwsRegion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_config_rule(config_rule_name)
delete_config_rule(config_rule_name, params::Dict{String,<:Any})
Deletes the specified Config rule and all of its evaluation results. Config sets the state
of a rule to DELETING until the deletion is complete. You cannot update a rule while it is
in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you
will receive a ResourceInUseException. You can check the state of a rule by using the
DescribeConfigRules request.
# Arguments
- `config_rule_name`: The name of the Config rule that you want to delete.
"""
function delete_config_rule(
ConfigRuleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteConfigRule",
Dict{String,Any}("ConfigRuleName" => ConfigRuleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_config_rule(
ConfigRuleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteConfigRule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConfigRuleName" => ConfigRuleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_aggregator(configuration_aggregator_name)
delete_configuration_aggregator(configuration_aggregator_name, params::Dict{String,<:Any})
Deletes the specified configuration aggregator and the aggregated data associated with the
aggregator.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
"""
function delete_configuration_aggregator(
ConfigurationAggregatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteConfigurationAggregator",
Dict{String,Any}("ConfigurationAggregatorName" => ConfigurationAggregatorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_aggregator(
ConfigurationAggregatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteConfigurationAggregator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_recorder(configuration_recorder_name)
delete_configuration_recorder(configuration_recorder_name, params::Dict{String,<:Any})
Deletes the configuration recorder. After the configuration recorder is deleted, Config
will not record resource configuration changes until you create a new configuration
recorder. This action does not delete the configuration information that was previously
recorded. You will be able to access the previously recorded information by using the
GetResourceConfigHistory action, but you will not be able to access this information in the
Config console until you create a new configuration recorder.
# Arguments
- `configuration_recorder_name`: The name of the configuration recorder to be deleted. You
can retrieve the name of your configuration recorder by using the
DescribeConfigurationRecorders action.
"""
function delete_configuration_recorder(
ConfigurationRecorderName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteConfigurationRecorder",
Dict{String,Any}("ConfigurationRecorderName" => ConfigurationRecorderName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_recorder(
ConfigurationRecorderName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteConfigurationRecorder",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationRecorderName" => ConfigurationRecorderName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_conformance_pack(conformance_pack_name)
delete_conformance_pack(conformance_pack_name, params::Dict{String,<:Any})
Deletes the specified conformance pack and all the Config rules, remediation actions, and
all evaluation results within that conformance pack. Config sets the conformance pack to
DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack
while it is in this state.
# Arguments
- `conformance_pack_name`: Name of the conformance pack you want to delete.
"""
function delete_conformance_pack(
ConformancePackName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteConformancePack",
Dict{String,Any}("ConformancePackName" => ConformancePackName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_conformance_pack(
ConformancePackName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteConformancePack",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConformancePackName" => ConformancePackName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_delivery_channel(delivery_channel_name)
delete_delivery_channel(delivery_channel_name, params::Dict{String,<:Any})
Deletes the delivery channel. Before you can delete the delivery channel, you must stop the
configuration recorder by using the StopConfigurationRecorder action.
# Arguments
- `delivery_channel_name`: The name of the delivery channel to delete.
"""
function delete_delivery_channel(
DeliveryChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteDeliveryChannel",
Dict{String,Any}("DeliveryChannelName" => DeliveryChannelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_delivery_channel(
DeliveryChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteDeliveryChannel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DeliveryChannelName" => DeliveryChannelName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_evaluation_results(config_rule_name)
delete_evaluation_results(config_rule_name, params::Dict{String,<:Any})
Deletes the evaluation results for the specified Config rule. You can specify one Config
rule per request. After you delete the evaluation results, you can call the
StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources
against the rule.
# Arguments
- `config_rule_name`: The name of the Config rule for which you want to delete the
evaluation results.
"""
function delete_evaluation_results(
ConfigRuleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteEvaluationResults",
Dict{String,Any}("ConfigRuleName" => ConfigRuleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_evaluation_results(
ConfigRuleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteEvaluationResults",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConfigRuleName" => ConfigRuleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_organization_config_rule(organization_config_rule_name)
delete_organization_config_rule(organization_config_rule_name, params::Dict{String,<:Any})
Deletes the specified organization Config rule and all of its evaluation results from all
member accounts in that organization. Only a management account and a delegated
administrator account can delete an organization Config rule. When calling this API with a
delegated administrator, you must ensure Organizations ListDelegatedAdministrator
permissions are added. Config sets the state of a rule to DELETE_IN_PROGRESS until the
deletion is complete. You cannot update a rule while it is in this state.
# Arguments
- `organization_config_rule_name`: The name of organization Config rule that you want to
delete.
"""
function delete_organization_config_rule(
OrganizationConfigRuleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteOrganizationConfigRule",
Dict{String,Any}("OrganizationConfigRuleName" => OrganizationConfigRuleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_organization_config_rule(
OrganizationConfigRuleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteOrganizationConfigRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OrganizationConfigRuleName" => OrganizationConfigRuleName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_organization_conformance_pack(organization_conformance_pack_name)
delete_organization_conformance_pack(organization_conformance_pack_name, params::Dict{String,<:Any})
Deletes the specified organization conformance pack and all of the Config rules and
remediation actions from all member accounts in that organization. Only a management
account or a delegated administrator account can delete an organization conformance pack.
When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator permissions are added. Config sets the state of a conformance
pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance
pack while it is in this state.
# Arguments
- `organization_conformance_pack_name`: The name of organization conformance pack that you
want to delete.
"""
function delete_organization_conformance_pack(
OrganizationConformancePackName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteOrganizationConformancePack",
Dict{String,Any}(
"OrganizationConformancePackName" => OrganizationConformancePackName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_organization_conformance_pack(
OrganizationConformancePackName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteOrganizationConformancePack",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OrganizationConformancePackName" => OrganizationConformancePackName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_pending_aggregation_request(requester_account_id, requester_aws_region)
delete_pending_aggregation_request(requester_account_id, requester_aws_region, params::Dict{String,<:Any})
Deletes pending authorization requests for a specified aggregator account in a specified
region.
# Arguments
- `requester_account_id`: The 12-digit account ID of the account requesting to aggregate
data.
- `requester_aws_region`: The region requesting to aggregate data.
"""
function delete_pending_aggregation_request(
RequesterAccountId,
RequesterAwsRegion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeletePendingAggregationRequest",
Dict{String,Any}(
"RequesterAccountId" => RequesterAccountId,
"RequesterAwsRegion" => RequesterAwsRegion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_pending_aggregation_request(
RequesterAccountId,
RequesterAwsRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeletePendingAggregationRequest",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RequesterAccountId" => RequesterAccountId,
"RequesterAwsRegion" => RequesterAwsRegion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_remediation_configuration(config_rule_name)
delete_remediation_configuration(config_rule_name, params::Dict{String,<:Any})
Deletes the remediation configuration.
# Arguments
- `config_rule_name`: The name of the Config rule for which you want to delete remediation
configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceType"`: The type of a resource.
"""
function delete_remediation_configuration(
ConfigRuleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteRemediationConfiguration",
Dict{String,Any}("ConfigRuleName" => ConfigRuleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_remediation_configuration(
ConfigRuleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteRemediationConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConfigRuleName" => ConfigRuleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_remediation_exceptions(config_rule_name, resource_keys)
delete_remediation_exceptions(config_rule_name, resource_keys, params::Dict{String,<:Any})
Deletes one or more remediation exceptions mentioned in the resource keys. Config
generates a remediation exception when a problem occurs executing a remediation action to a
specific resource. Remediation exceptions blocks auto-remediation until the exception is
cleared.
# Arguments
- `config_rule_name`: The name of the Config rule for which you want to delete remediation
exception configuration.
- `resource_keys`: An exception list of resource exception keys to be processed with the
current request. Config adds exception for each resource key. For example, Config adds 3
exceptions for 3 resource keys.
"""
function delete_remediation_exceptions(
ConfigRuleName, ResourceKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteRemediationExceptions",
Dict{String,Any}(
"ConfigRuleName" => ConfigRuleName, "ResourceKeys" => ResourceKeys
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_remediation_exceptions(
ConfigRuleName,
ResourceKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteRemediationExceptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigRuleName" => ConfigRuleName, "ResourceKeys" => ResourceKeys
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_config(resource_id, resource_type)
delete_resource_config(resource_id, resource_type, params::Dict{String,<:Any})
Records the configuration state for a custom resource that has been deleted. This API
records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the
ConfigurationItems recorded for this resource in your Config History.
# Arguments
- `resource_id`: Unique identifier of the resource.
- `resource_type`: The type of the resource.
"""
function delete_resource_config(
ResourceId, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteResourceConfig",
Dict{String,Any}("ResourceId" => ResourceId, "ResourceType" => ResourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_config(
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteResourceConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceId" => ResourceId, "ResourceType" => ResourceType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_retention_configuration(retention_configuration_name)
delete_retention_configuration(retention_configuration_name, params::Dict{String,<:Any})
Deletes the retention configuration.
# Arguments
- `retention_configuration_name`: The name of the retention configuration to delete.
"""
function delete_retention_configuration(
RetentionConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeleteRetentionConfiguration",
Dict{String,Any}("RetentionConfigurationName" => RetentionConfigurationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_retention_configuration(
RetentionConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteRetentionConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RetentionConfigurationName" => RetentionConfigurationName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_stored_query(query_name)
delete_stored_query(query_name, params::Dict{String,<:Any})
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web
Services Region.
# Arguments
- `query_name`: The name of the query that you want to delete.
"""
function delete_stored_query(QueryName; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"DeleteStoredQuery",
Dict{String,Any}("QueryName" => QueryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_stored_query(
QueryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeleteStoredQuery",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueryName" => QueryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deliver_config_snapshot(delivery_channel_name)
deliver_config_snapshot(delivery_channel_name, params::Dict{String,<:Any})
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified
delivery channel. After the delivery has started, Config sends the following notifications
using an Amazon SNS topic that you have specified. Notification of the start of the
delivery. Notification of the completion of the delivery, if the delivery was
successfully completed. Notification of delivery failure, if the delivery failed.
# Arguments
- `delivery_channel_name`: The name of the delivery channel through which the snapshot is
delivered.
"""
function deliver_config_snapshot(
deliveryChannelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DeliverConfigSnapshot",
Dict{String,Any}("deliveryChannelName" => deliveryChannelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deliver_config_snapshot(
deliveryChannelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DeliverConfigSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("deliveryChannelName" => deliveryChannelName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_aggregate_compliance_by_config_rules(configuration_aggregator_name)
describe_aggregate_compliance_by_config_rules(configuration_aggregator_name, params::Dict{String,<:Any})
Returns a list of compliant and noncompliant rules with the number of resources for
compliant and noncompliant rules. Does not display rules that do not have compliance
results. The results can return an empty result page, but if you have a nextToken, the
results are displayed on the next page.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters the results by ConfigRuleComplianceFilters object.
- `"Limit"`: The maximum number of evaluation results returned on each page. The default is
maximum. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function describe_aggregate_compliance_by_config_rules(
ConfigurationAggregatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeAggregateComplianceByConfigRules",
Dict{String,Any}("ConfigurationAggregatorName" => ConfigurationAggregatorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_aggregate_compliance_by_config_rules(
ConfigurationAggregatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DescribeAggregateComplianceByConfigRules",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_aggregate_compliance_by_conformance_packs(configuration_aggregator_name)
describe_aggregate_compliance_by_conformance_packs(configuration_aggregator_name, params::Dict{String,<:Any})
Returns a list of the conformance packs and their associated compliance status with the
count of compliant and noncompliant Config rules within each conformance pack. Also returns
the total rule count which includes compliant rules, noncompliant rules, and rules that
cannot be evaluated due to insufficient data. The results can return an empty result page,
but if you have a nextToken, the results are displayed on the next page.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters the result by AggregateConformancePackComplianceFilters object.
- `"Limit"`: The maximum number of conformance packs compliance details returned on each
page. The default is maximum. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function describe_aggregate_compliance_by_conformance_packs(
ConfigurationAggregatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeAggregateComplianceByConformancePacks",
Dict{String,Any}("ConfigurationAggregatorName" => ConfigurationAggregatorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_aggregate_compliance_by_conformance_packs(
ConfigurationAggregatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DescribeAggregateComplianceByConformancePacks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_aggregation_authorizations()
describe_aggregation_authorizations(params::Dict{String,<:Any})
Returns a list of authorizations granted to various aggregator accounts and regions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of AggregationAuthorizations returned on each page. The
default is maximum. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function describe_aggregation_authorizations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeAggregationAuthorizations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_aggregation_authorizations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeAggregationAuthorizations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_compliance_by_config_rule()
describe_compliance_by_config_rule(params::Dict{String,<:Any})
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this
action returns the number of Amazon Web Services resources that do not comply with the
rule. A rule is compliant if all of the evaluated resources comply with it. It is
noncompliant if any of these resources do not comply. If Config has no current evaluation
results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the
following conditions: Config has never invoked an evaluation for the rule. To check
whether it has, use the DescribeConfigRuleEvaluationStatus action to get the
LastSuccessfulInvocationTime and LastFailedInvocationTime. The rule's Lambda function is
failing to send evaluation results to Config. Verify that the role you assigned to your
configuration recorder includes the config:PutEvaluations permission. If the rule is a
custom rule, verify that the Lambda execution role includes the config:PutEvaluations
permission. The rule's Lambda function has returned NOT_APPLICABLE for all evaluation
results. This can occur if the resources were deleted or removed from the rule's scope.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComplianceTypes"`: Filters the results by compliance.
- `"ConfigRuleNames"`: Specify one or more Config rule names to filter the results by rule.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function describe_compliance_by_config_rule(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeComplianceByConfigRule";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_compliance_by_config_rule(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeComplianceByConfigRule",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_compliance_by_resource()
describe_compliance_by_resource(params::Dict{String,<:Any})
Indicates whether the specified Amazon Web Services resources are compliant. If a resource
is noncompliant, this action returns the number of Config rules that the resource does not
comply with. A resource is compliant if it complies with all the Config rules that evaluate
it. It is noncompliant if it does not comply with one or more of these rules. If Config has
no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result
might indicate one of the following conditions about the rules that evaluate the resource:
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and
LastFailedInvocationTime. The rule's Lambda function is failing to send evaluation
results to Config. Verify that the role that you assigned to your configuration recorder
includes the config:PutEvaluations permission. If the rule is a custom rule, verify that
the Lambda execution role includes the config:PutEvaluations permission. The rule's
Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if
the resources were deleted or removed from the rule's scope.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComplianceTypes"`: Filters the results by compliance.
- `"Limit"`: The maximum number of evaluation results returned on each page. The default is
10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"ResourceId"`: The ID of the Amazon Web Services resource for which you want compliance
information. You can specify only one resource ID. If you specify a resource ID, you must
also specify a type for ResourceType.
- `"ResourceType"`: The types of Amazon Web Services resources for which you want
compliance information (for example, AWS::EC2::Instance). For this action, you can specify
that the resource type is an Amazon Web Services account by specifying AWS::::Account.
"""
function describe_compliance_by_resource(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeComplianceByResource";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_compliance_by_resource(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeComplianceByResource",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_config_rule_evaluation_status()
describe_config_rule_evaluation_status(params::Dict{String,<:Any})
Returns status information for each of your Config managed rules. The status includes
information such as the last time Config invoked the rule, the last time Config failed to
invoke the rule, and the related error for the last failure.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigRuleNames"`: The name of the Config managed rules for which you want status
information. If you do not specify any names, Config returns status information for all
Config managed rules that you use.
- `"Limit"`: The number of rule evaluation results that you want returned. This parameter
is required if the rule limit for your account is more than the default of 1000 rules. For
information about requesting a rule limit increase, see Config Limits in the Amazon Web
Services General Reference Guide.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function describe_config_rule_evaluation_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConfigRuleEvaluationStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_config_rule_evaluation_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConfigRuleEvaluationStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_config_rules()
describe_config_rules(params::Dict{String,<:Any})
Returns details about your Config rules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigRuleNames"`: The names of the Config rules for which you want details. If you do
not specify any names, Config returns details for all your rules.
- `"Filters"`: Returns a list of Detective or Proactive Config rules. By default, this API
returns an unfiltered list. For more information on Detective or Proactive Config rules,
see Evaluation Mode in the Config Developer Guide.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function describe_config_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"DescribeConfigRules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_config_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConfigRules",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration_aggregator_sources_status(configuration_aggregator_name)
describe_configuration_aggregator_sources_status(configuration_aggregator_name, params::Dict{String,<:Any})
Returns status information for sources within an aggregator. The status includes
information about the last time Config verified authorization between the source account
and an aggregator account. In case of a failure, the status contains the related error code
or message.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of AggregatorSourceStatus returned on each page. The
default is maximum. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"UpdateStatus"`: Filters the status type. Valid value FAILED indicates errors while
moving data. Valid value SUCCEEDED indicates the data was successfully moved. Valid
value OUTDATED indicates the data is not the most recent.
"""
function describe_configuration_aggregator_sources_status(
ConfigurationAggregatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConfigurationAggregatorSourcesStatus",
Dict{String,Any}("ConfigurationAggregatorName" => ConfigurationAggregatorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration_aggregator_sources_status(
ConfigurationAggregatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DescribeConfigurationAggregatorSourcesStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration_aggregators()
describe_configuration_aggregators(params::Dict{String,<:Any})
Returns the details of one or more configuration aggregators. If the configuration
aggregator is not specified, this action returns the details for all the configuration
aggregators associated with the account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationAggregatorNames"`: The name of the configuration aggregators.
- `"Limit"`: The maximum number of configuration aggregators returned on each page. The
default is maximum. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function describe_configuration_aggregators(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConfigurationAggregators";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration_aggregators(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConfigurationAggregators",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration_recorder_status()
describe_configuration_recorder_status(params::Dict{String,<:Any})
Returns the current status of the specified configuration recorder as well as the status of
the last recording event for the recorder. If a configuration recorder is not specified,
this action returns the status of all configuration recorders associated with the account.
>You can specify only one configuration recorder for each Amazon Web Services Region for
each account. For a detailed status of recording events over time, add your Config events
to Amazon CloudWatch metrics and use CloudWatch metrics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationRecorderNames"`: The name(s) of the configuration recorder. If the name is
not specified, the action returns the current status of all the configuration recorders
associated with the account.
"""
function describe_configuration_recorder_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConfigurationRecorderStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration_recorder_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConfigurationRecorderStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration_recorders()
describe_configuration_recorders(params::Dict{String,<:Any})
Returns the details for the specified configuration recorders. If the configuration
recorder is not specified, this action returns the details for all configuration recorders
associated with the account. You can specify only one configuration recorder for each
Amazon Web Services Region for each account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigurationRecorderNames"`: A list of configuration recorder names.
"""
function describe_configuration_recorders(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConfigurationRecorders";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration_recorders(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConfigurationRecorders",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_conformance_pack_compliance(conformance_pack_name)
describe_conformance_pack_compliance(conformance_pack_name, params::Dict{String,<:Any})
Returns compliance details for each rule in that conformance pack. You must provide exact
rule names.
# Arguments
- `conformance_pack_name`: Name of the conformance pack.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A ConformancePackComplianceFilters object.
- `"Limit"`: The maximum number of Config rules within a conformance pack are returned on
each page.
- `"NextToken"`: The nextToken string returned in a previous request that you use to
request the next page of results in a paginated response.
"""
function describe_conformance_pack_compliance(
ConformancePackName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConformancePackCompliance",
Dict{String,Any}("ConformancePackName" => ConformancePackName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_conformance_pack_compliance(
ConformancePackName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DescribeConformancePackCompliance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConformancePackName" => ConformancePackName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_conformance_pack_status()
describe_conformance_pack_status(params::Dict{String,<:Any})
Provides one or more conformance packs deployment status. If there are no conformance
packs then you will see an empty result.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConformancePackNames"`: Comma-separated list of conformance pack names.
- `"Limit"`: The maximum number of conformance packs status returned on each page.
- `"NextToken"`: The nextToken string returned in a previous request that you use to
request the next page of results in a paginated response.
"""
function describe_conformance_pack_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConformancePackStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_conformance_pack_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConformancePackStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_conformance_packs()
describe_conformance_packs(params::Dict{String,<:Any})
Returns a list of one or more conformance packs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConformancePackNames"`: Comma-separated list of conformance pack names for which you
want details. If you do not specify any names, Config returns details for all your
conformance packs.
- `"Limit"`: The maximum number of conformance packs returned on each page.
- `"NextToken"`: The nextToken string returned in a previous request that you use to
request the next page of results in a paginated response.
"""
function describe_conformance_packs(; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"DescribeConformancePacks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_conformance_packs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeConformancePacks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_delivery_channel_status()
describe_delivery_channel_status(params::Dict{String,<:Any})
Returns the current status of the specified delivery channel. If a delivery channel is not
specified, this action returns the current status of all delivery channels associated with
the account. Currently, you can specify only one delivery channel per region in your
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeliveryChannelNames"`: A list of delivery channel names.
"""
function describe_delivery_channel_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeDeliveryChannelStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_delivery_channel_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeDeliveryChannelStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_delivery_channels()
describe_delivery_channels(params::Dict{String,<:Any})
Returns details about the specified delivery channel. If a delivery channel is not
specified, this action returns the details of all delivery channels associated with the
account. Currently, you can specify only one delivery channel per region in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeliveryChannelNames"`: A list of delivery channel names.
"""
function describe_delivery_channels(; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"DescribeDeliveryChannels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_delivery_channels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeDeliveryChannels",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_config_rule_statuses()
describe_organization_config_rule_statuses(params::Dict{String,<:Any})
Provides organization Config rule deployment status for an organization. The status is not
considered successful until organization Config rule is successfully deployed in all the
member accounts with an exception of excluded accounts. When you specify the limit and the
next token, you receive a paginated response. Limit and next token are not applicable if
you specify organization Config rule names. It is only applicable, when you request all the
organization Config rules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of OrganizationConfigRuleStatuses returned on each page. If
you do no specify a number, Config uses the default. The default is 100.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"OrganizationConfigRuleNames"`: The names of organization Config rules for which you
want status details. If you do not specify any names, Config returns details for all your
organization Config rules.
"""
function describe_organization_config_rule_statuses(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeOrganizationConfigRuleStatuses";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_config_rule_statuses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeOrganizationConfigRuleStatuses",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_config_rules()
describe_organization_config_rules(params::Dict{String,<:Any})
Returns a list of organization Config rules. When you specify the limit and the next
token, you receive a paginated response. Limit and next token are not applicable if you
specify organization Config rule names. It is only applicable, when you request all the
organization Config rules. For accounts within an organization If you deploy an
organizational rule or conformance pack in an organization administrator account, and then
establish a delegated administrator and deploy an organizational rule or conformance pack
in the delegated administrator account, you won't be able to see the organizational rule or
conformance pack in the organization administrator account from the delegated administrator
account or see the organizational rule or conformance pack in the delegated administrator
account from organization administrator account. The DescribeOrganizationConfigRules and
DescribeOrganizationConformancePacks APIs can only see and interact with the
organization-related resource that were deployed from within the account calling those
APIs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of organization Config rules returned on each page. If you
do no specify a number, Config uses the default. The default is 100.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"OrganizationConfigRuleNames"`: The names of organization Config rules for which you
want details. If you do not specify any names, Config returns details for all your
organization Config rules.
"""
function describe_organization_config_rules(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeOrganizationConfigRules";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_config_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeOrganizationConfigRules",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_conformance_pack_statuses()
describe_organization_conformance_pack_statuses(params::Dict{String,<:Any})
Provides organization conformance pack deployment status for an organization. The status
is not considered successful until organization conformance pack is successfully deployed
in all the member accounts with an exception of excluded accounts. When you specify the
limit and the next token, you receive a paginated response. Limit and next token are not
applicable if you specify organization conformance pack names. They are only applicable,
when you request all the organization conformance packs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of OrganizationConformancePackStatuses returned on each
page. If you do no specify a number, Config uses the default. The default is 100.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"OrganizationConformancePackNames"`: The names of organization conformance packs for
which you want status details. If you do not specify any names, Config returns details for
all your organization conformance packs.
"""
function describe_organization_conformance_pack_statuses(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeOrganizationConformancePackStatuses";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_conformance_pack_statuses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeOrganizationConformancePackStatuses",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_conformance_packs()
describe_organization_conformance_packs(params::Dict{String,<:Any})
Returns a list of organization conformance packs. When you specify the limit and the next
token, you receive a paginated response. Limit and next token are not applicable if you
specify organization conformance packs names. They are only applicable, when you request
all the organization conformance packs. For accounts within an organization If you
deploy an organizational rule or conformance pack in an organization administrator account,
and then establish a delegated administrator and deploy an organizational rule or
conformance pack in the delegated administrator account, you won't be able to see the
organizational rule or conformance pack in the organization administrator account from the
delegated administrator account or see the organizational rule or conformance pack in the
delegated administrator account from organization administrator account. The
DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see
and interact with the organization-related resource that were deployed from within the
account calling those APIs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of organization config packs returned on each page. If you
do no specify a number, Config uses the default. The default is 100.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"OrganizationConformancePackNames"`: The name that you assign to an organization
conformance pack.
"""
function describe_organization_conformance_packs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeOrganizationConformancePacks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_conformance_packs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeOrganizationConformancePacks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pending_aggregation_requests()
describe_pending_aggregation_requests(params::Dict{String,<:Any})
Returns a list of all pending aggregation requests.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of evaluation results returned on each page. The default is
maximum. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function describe_pending_aggregation_requests(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribePendingAggregationRequests";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_pending_aggregation_requests(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribePendingAggregationRequests",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_remediation_configurations(config_rule_names)
describe_remediation_configurations(config_rule_names, params::Dict{String,<:Any})
Returns the details of one or more remediation configurations.
# Arguments
- `config_rule_names`: A list of Config rule names of remediation configurations for which
you want details.
"""
function describe_remediation_configurations(
ConfigRuleNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeRemediationConfigurations",
Dict{String,Any}("ConfigRuleNames" => ConfigRuleNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_remediation_configurations(
ConfigRuleNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DescribeRemediationConfigurations",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ConfigRuleNames" => ConfigRuleNames), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_remediation_exceptions(config_rule_name)
describe_remediation_exceptions(config_rule_name, params::Dict{String,<:Any})
Returns the details of one or more remediation exceptions. A detailed view of a remediation
exception for a set of resources that includes an explanation of an exception and the time
when the exception will be deleted. When you specify the limit and the next token, you
receive a paginated response. Config generates a remediation exception when a problem
occurs executing a remediation action to a specific resource. Remediation exceptions blocks
auto-remediation until the exception is cleared. When you specify the limit and the next
token, you receive a paginated response. Limit and next token are not applicable if you
request resources in batch. It is only applicable, when you request all resources.
# Arguments
- `config_rule_name`: The name of the Config rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of RemediationExceptionResourceKey returned on each page.
The default is 25. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned in a previous request that you use to
request the next page of results in a paginated response.
- `"ResourceKeys"`: An exception list of resource exception keys to be processed with the
current request. Config adds exception for each resource key. For example, Config adds 3
exceptions for 3 resource keys.
"""
function describe_remediation_exceptions(
ConfigRuleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeRemediationExceptions",
Dict{String,Any}("ConfigRuleName" => ConfigRuleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_remediation_exceptions(
ConfigRuleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DescribeRemediationExceptions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConfigRuleName" => ConfigRuleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_remediation_execution_status(config_rule_name)
describe_remediation_execution_status(config_rule_name, params::Dict{String,<:Any})
Provides a detailed view of a Remediation Execution for a set of resources including state,
timestamps for when steps for the remediation execution occur, and any error messages for
steps that have failed. When you specify the limit and the next token, you receive a
paginated response.
# Arguments
- `config_rule_name`: A list of Config rule names.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of RemediationExecutionStatuses returned on each page. The
default is maximum. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"ResourceKeys"`: A list of resource keys to be processed with the current request. Each
element in the list consists of the resource type and resource ID.
"""
function describe_remediation_execution_status(
ConfigRuleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeRemediationExecutionStatus",
Dict{String,Any}("ConfigRuleName" => ConfigRuleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_remediation_execution_status(
ConfigRuleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"DescribeRemediationExecutionStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConfigRuleName" => ConfigRuleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_retention_configurations()
describe_retention_configurations(params::Dict{String,<:Any})
Returns the details of one or more retention configurations. If the retention configuration
name is not specified, this action returns the details for all the retention configurations
for that account. Currently, Config supports only one retention configuration per region
in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"RetentionConfigurationNames"`: A list of names of retention configurations for which
you want details. If you do not specify a name, Config returns details for all the
retention configurations for that account. Currently, Config supports only one retention
configuration per region in your account.
"""
function describe_retention_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeRetentionConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_retention_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"DescribeRetentionConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_aggregate_compliance_details_by_config_rule(account_id, aws_region, config_rule_name, configuration_aggregator_name)
get_aggregate_compliance_details_by_config_rule(account_id, aws_region, config_rule_name, configuration_aggregator_name, params::Dict{String,<:Any})
Returns the evaluation results for the specified Config rule for a specific resource in a
rule. The results indicate which Amazon Web Services resources were evaluated by the rule,
when each resource was last evaluated, and whether each resource complies with the rule.
The results can return an empty result page. But if you have a nextToken, the results are
displayed on the next page.
# Arguments
- `account_id`: The 12-digit account ID of the source account.
- `aws_region`: The source region from where the data is aggregated.
- `config_rule_name`: The name of the Config rule for which you want compliance information.
- `configuration_aggregator_name`: The name of the configuration aggregator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComplianceType"`: The resource compliance status. For the
GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the
COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and
INSUFFICIENT_DATA values.
- `"Limit"`: The maximum number of evaluation results returned on each page. The default is
50. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function get_aggregate_compliance_details_by_config_rule(
AccountId,
AwsRegion,
ConfigRuleName,
ConfigurationAggregatorName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetAggregateComplianceDetailsByConfigRule",
Dict{String,Any}(
"AccountId" => AccountId,
"AwsRegion" => AwsRegion,
"ConfigRuleName" => ConfigRuleName,
"ConfigurationAggregatorName" => ConfigurationAggregatorName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_aggregate_compliance_details_by_config_rule(
AccountId,
AwsRegion,
ConfigRuleName,
ConfigurationAggregatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetAggregateComplianceDetailsByConfigRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountId" => AccountId,
"AwsRegion" => AwsRegion,
"ConfigRuleName" => ConfigRuleName,
"ConfigurationAggregatorName" => ConfigurationAggregatorName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_aggregate_config_rule_compliance_summary(configuration_aggregator_name)
get_aggregate_config_rule_compliance_summary(configuration_aggregator_name, params::Dict{String,<:Any})
Returns the number of compliant and noncompliant rules for one or more accounts and regions
in an aggregator. The results can return an empty result page, but if you have a
nextToken, the results are displayed on the next page.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters the results based on the ConfigRuleComplianceSummaryFilters object.
- `"GroupByKey"`: Groups the result based on ACCOUNT_ID or AWS_REGION.
- `"Limit"`: The maximum number of evaluation results returned on each page. The default is
1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the
default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function get_aggregate_config_rule_compliance_summary(
ConfigurationAggregatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetAggregateConfigRuleComplianceSummary",
Dict{String,Any}("ConfigurationAggregatorName" => ConfigurationAggregatorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_aggregate_config_rule_compliance_summary(
ConfigurationAggregatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetAggregateConfigRuleComplianceSummary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_aggregate_conformance_pack_compliance_summary(configuration_aggregator_name)
get_aggregate_conformance_pack_compliance_summary(configuration_aggregator_name, params::Dict{String,<:Any})
Returns the count of compliant and noncompliant conformance packs across all Amazon Web
Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on
Amazon Web Services account ID or Amazon Web Services Region. The results can return an
empty result page, but if you have a nextToken, the results are displayed on the next page.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters the results based on the
AggregateConformancePackComplianceSummaryFilters object.
- `"GroupByKey"`: Groups the result based on Amazon Web Services account ID or Amazon Web
Services Region.
- `"Limit"`: The maximum number of results returned on each page. The default is maximum.
If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function get_aggregate_conformance_pack_compliance_summary(
ConfigurationAggregatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetAggregateConformancePackComplianceSummary",
Dict{String,Any}("ConfigurationAggregatorName" => ConfigurationAggregatorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_aggregate_conformance_pack_compliance_summary(
ConfigurationAggregatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetAggregateConformancePackComplianceSummary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_aggregate_discovered_resource_counts(configuration_aggregator_name)
get_aggregate_discovered_resource_counts(configuration_aggregator_name, params::Dict{String,<:Any})
Returns the resource counts across accounts and regions that are present in your Config
aggregator. You can request the resource counts by providing filters and GroupByKey. For
example, if the input contains accountID 12345678910 and region us-east-1 in filters, the
API returns the count of resources in account ID 12345678910 and region us-east-1. If the
input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source
accounts that are present in your aggregator.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters the results based on the ResourceCountFilters object.
- `"GroupByKey"`: The key to group the resource counts.
- `"Limit"`: The maximum number of GroupedResourceCount objects returned on each page. The
default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config
uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function get_aggregate_discovered_resource_counts(
ConfigurationAggregatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetAggregateDiscoveredResourceCounts",
Dict{String,Any}("ConfigurationAggregatorName" => ConfigurationAggregatorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_aggregate_discovered_resource_counts(
ConfigurationAggregatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetAggregateDiscoveredResourceCounts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_aggregate_resource_config(configuration_aggregator_name, resource_identifier)
get_aggregate_resource_config(configuration_aggregator_name, resource_identifier, params::Dict{String,<:Any})
Returns configuration item that is aggregated for your specific resource in a specific
source account and region.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
- `resource_identifier`: An object that identifies aggregate resource.
"""
function get_aggregate_resource_config(
ConfigurationAggregatorName,
ResourceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetAggregateResourceConfig",
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName,
"ResourceIdentifier" => ResourceIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_aggregate_resource_config(
ConfigurationAggregatorName,
ResourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetAggregateResourceConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName,
"ResourceIdentifier" => ResourceIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compliance_details_by_config_rule(config_rule_name)
get_compliance_details_by_config_rule(config_rule_name, params::Dict{String,<:Any})
Returns the evaluation results for the specified Config rule. The results indicate which
Amazon Web Services resources were evaluated by the rule, when each resource was last
evaluated, and whether each resource complies with the rule.
# Arguments
- `config_rule_name`: The name of the Config rule for which you want compliance information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComplianceTypes"`: Filters the results by compliance. INSUFFICIENT_DATA is a valid
ComplianceType that is returned when an Config rule cannot be evaluated. However,
INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.
- `"Limit"`: The maximum number of evaluation results returned on each page. The default is
10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function get_compliance_details_by_config_rule(
ConfigRuleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetComplianceDetailsByConfigRule",
Dict{String,Any}("ConfigRuleName" => ConfigRuleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_compliance_details_by_config_rule(
ConfigRuleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetComplianceDetailsByConfigRule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConfigRuleName" => ConfigRuleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compliance_details_by_resource()
get_compliance_details_by_resource(params::Dict{String,<:Any})
Returns the evaluation results for the specified Amazon Web Services resource. The results
indicate which Config rules were used to evaluate the resource, when each rule was last
invoked, and whether the resource complies with each rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComplianceTypes"`: Filters the results by compliance. INSUFFICIENT_DATA is a valid
ComplianceType that is returned when an Config rule cannot be evaluated. However,
INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"ResourceEvaluationId"`: The unique ID of Amazon Web Services resource execution for
which you want to retrieve evaluation results. You need to only provide either a
ResourceEvaluationID or a ResourceID and ResourceType.
- `"ResourceId"`: The ID of the Amazon Web Services resource for which you want compliance
information.
- `"ResourceType"`: The type of the Amazon Web Services resource for which you want
compliance information.
"""
function get_compliance_details_by_resource(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetComplianceDetailsByResource";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_compliance_details_by_resource(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetComplianceDetailsByResource",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compliance_summary_by_config_rule()
get_compliance_summary_by_config_rule(params::Dict{String,<:Any})
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of
25 for each.
"""
function get_compliance_summary_by_config_rule(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetComplianceSummaryByConfigRule";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_compliance_summary_by_config_rule(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetComplianceSummaryByConfigRule",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compliance_summary_by_resource_type()
get_compliance_summary_by_resource_type(params::Dict{String,<:Any})
Returns the number of resources that are compliant and the number that are noncompliant.
You can specify one or more resource types to get these numbers for each resource type. The
maximum number returned is 100.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceTypes"`: Specify one or more resource types to get the number of resources that
are compliant and the number that are noncompliant for each resource type. For this
request, you can specify an Amazon Web Services resource type such as AWS::EC2::Instance.
You can specify that the resource type is an Amazon Web Services account by specifying
AWS::::Account.
"""
function get_compliance_summary_by_resource_type(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetComplianceSummaryByResourceType";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_compliance_summary_by_resource_type(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetComplianceSummaryByResourceType",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_conformance_pack_compliance_details(conformance_pack_name)
get_conformance_pack_compliance_details(conformance_pack_name, params::Dict{String,<:Any})
Returns compliance details of a conformance pack for all Amazon Web Services resources that
are monitered by conformance pack.
# Arguments
- `conformance_pack_name`: Name of the conformance pack.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A ConformancePackEvaluationFilters object.
- `"Limit"`: The maximum number of evaluation results returned on each page. If you do no
specify a number, Config uses the default. The default is 100.
- `"NextToken"`: The nextToken string returned in a previous request that you use to
request the next page of results in a paginated response.
"""
function get_conformance_pack_compliance_details(
ConformancePackName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetConformancePackComplianceDetails",
Dict{String,Any}("ConformancePackName" => ConformancePackName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_conformance_pack_compliance_details(
ConformancePackName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetConformancePackComplianceDetails",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConformancePackName" => ConformancePackName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_conformance_pack_compliance_summary(conformance_pack_names)
get_conformance_pack_compliance_summary(conformance_pack_names, params::Dict{String,<:Any})
Returns compliance details for the conformance pack based on the cumulative compliance
results of all the rules in that conformance pack.
# Arguments
- `conformance_pack_names`: Names of conformance packs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of conformance packs returned on each page.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function get_conformance_pack_compliance_summary(
ConformancePackNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetConformancePackComplianceSummary",
Dict{String,Any}("ConformancePackNames" => ConformancePackNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_conformance_pack_compliance_summary(
ConformancePackNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetConformancePackComplianceSummary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConformancePackNames" => ConformancePackNames),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_custom_rule_policy()
get_custom_rule_policy(params::Dict{String,<:Any})
Returns the policy definition containing the logic for your Config Custom Policy rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigRuleName"`: The name of your Config Custom Policy rule.
"""
function get_custom_rule_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"GetCustomRulePolicy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_custom_rule_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetCustomRulePolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_discovered_resource_counts()
get_discovered_resource_counts(params::Dict{String,<:Any})
Returns the resource types, the number of each resource type, and the total number of
resources that Config is recording in this region for your Amazon Web Services account.
Example Config is recording three resource types in the US East (Ohio) Region for your
account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets. You make a call to the
GetDiscoveredResourceCounts action and specify that you want all resource types. Config
returns the following: The resource types (EC2 instances, IAM users, and S3 buckets).
The number of each resource type (25, 20, and 15). The total number of all resources
(60). The response is paginated. By default, Config lists 100 ResourceCount objects on
each page. You can customize this number with the limit parameter. The response includes a
nextToken string. To get the next page of results, run the request again and specify the
string for the nextToken parameter. If you make a call to the GetDiscoveredResourceCounts
action, you might not immediately receive resource counts in the following situations:
You are a new Config customer. You just enabled resource recording. It might take a few
minutes for Config to record and count your resources. Wait a few minutes and then retry
the GetDiscoveredResourceCounts action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`: The maximum number of ResourceCount objects returned on each page. The default
is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the
default.
- `"nextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"resourceTypes"`: The comma-separated list that specifies the resource types that you
want Config to return (for example, \"AWS::EC2::Instance\", \"AWS::IAM::User\"). If a value
for resourceTypes is not specified, Config returns all resource types that Config is
recording in the region for your account. If the configuration recorder is turned off,
Config returns an empty list of ResourceCount objects. If the configuration recorder is not
recording a specific resource type (for example, S3 buckets), that resource type is not
returned in the list of ResourceCount objects.
"""
function get_discovered_resource_counts(; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"GetDiscoveredResourceCounts";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_discovered_resource_counts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetDiscoveredResourceCounts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_organization_config_rule_detailed_status(organization_config_rule_name)
get_organization_config_rule_detailed_status(organization_config_rule_name, params::Dict{String,<:Any})
Returns detailed status for each member account within an organization for a given
organization Config rule.
# Arguments
- `organization_config_rule_name`: The name of your organization Config rule for which you
want status details for member accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A StatusDetailFilters object.
- `"Limit"`: The maximum number of OrganizationConfigRuleDetailedStatus returned on each
page. If you do not specify a number, Config uses the default. The default is 100.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function get_organization_config_rule_detailed_status(
OrganizationConfigRuleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetOrganizationConfigRuleDetailedStatus",
Dict{String,Any}("OrganizationConfigRuleName" => OrganizationConfigRuleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_organization_config_rule_detailed_status(
OrganizationConfigRuleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetOrganizationConfigRuleDetailedStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OrganizationConfigRuleName" => OrganizationConfigRuleName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_organization_conformance_pack_detailed_status(organization_conformance_pack_name)
get_organization_conformance_pack_detailed_status(organization_conformance_pack_name, params::Dict{String,<:Any})
Returns detailed status for each member account within an organization for a given
organization conformance pack.
# Arguments
- `organization_conformance_pack_name`: The name of organization conformance pack for which
you want status details for member accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An OrganizationResourceDetailedStatusFilters object.
- `"Limit"`: The maximum number of OrganizationConformancePackDetailedStatuses returned on
each page. If you do not specify a number, Config uses the default. The default is 100.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function get_organization_conformance_pack_detailed_status(
OrganizationConformancePackName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetOrganizationConformancePackDetailedStatus",
Dict{String,Any}(
"OrganizationConformancePackName" => OrganizationConformancePackName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_organization_conformance_pack_detailed_status(
OrganizationConformancePackName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetOrganizationConformancePackDetailedStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OrganizationConformancePackName" => OrganizationConformancePackName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_organization_custom_rule_policy(organization_config_rule_name)
get_organization_custom_rule_policy(organization_config_rule_name, params::Dict{String,<:Any})
Returns the policy definition containing the logic for your organization Config Custom
Policy rule.
# Arguments
- `organization_config_rule_name`: The name of your organization Config Custom Policy rule.
"""
function get_organization_custom_rule_policy(
OrganizationConfigRuleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetOrganizationCustomRulePolicy",
Dict{String,Any}("OrganizationConfigRuleName" => OrganizationConfigRuleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_organization_custom_rule_policy(
OrganizationConfigRuleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetOrganizationCustomRulePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OrganizationConfigRuleName" => OrganizationConfigRuleName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_config_history(resource_id, resource_type)
get_resource_config_history(resource_id, resource_type, params::Dict{String,<:Any})
For accurate reporting on the compliance status, you must record the
AWS::Config::ResourceCompliance resource type. For more information, see Selecting Which
Resources Config Records. Returns a list of ConfigurationItems for the specified resource.
The list contains details about each state of the resource during the specified time
interval. If you specified a retention period to retain your ConfigurationItems between a
minimum of 30 days and a maximum of 7 years (2557 days), Config returns the
ConfigurationItems for the specified retention period. The response is paginated. By
default, Config returns a limit of 10 configuration items per page. You can customize this
number with the limit parameter. The response includes a nextToken string. To get the next
page of results, run the request again and specify the string for the nextToken parameter.
Each call to the API is limited to span a duration of seven days. It is likely that the
number of records returned is smaller than the specified limit. In such cases, you can make
another call, using the nextToken.
# Arguments
- `resource_id`: The ID of the resource (for example., sg-xxxxxx).
- `resource_type`: The resource type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"chronologicalOrder"`: The chronological order for configuration items listed. By
default, the results are listed in reverse chronological order.
- `"earlierTime"`: The chronologically earliest time in the time range for which the
history requested. If not specified, the action returns paginated results that contain
configuration items that start when the first configuration item was recorded.
- `"laterTime"`: The chronologically latest time in the time range for which the history
requested. If not specified, current time is taken.
- `"limit"`: The maximum number of configuration items returned on each page. The default
is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the
default.
- `"nextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function get_resource_config_history(
resourceId, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetResourceConfigHistory",
Dict{String,Any}("resourceId" => resourceId, "resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_config_history(
resourceId,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetResourceConfigHistory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceId" => resourceId, "resourceType" => resourceType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_evaluation_summary(resource_evaluation_id)
get_resource_evaluation_summary(resource_evaluation_id, params::Dict{String,<:Any})
Returns a summary of resource evaluation for the specified resource evaluation ID from the
proactive rules that were run. The results indicate which evaluation context was used to
evaluate the rules, which resource details were evaluated, the evaluation mode that was
run, and whether the resource details comply with the configuration of the proactive rules.
To see additional information about the evaluation result, such as which rule flagged a
resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. For more
information, see the Examples section.
# Arguments
- `resource_evaluation_id`: The unique ResourceEvaluationId of Amazon Web Services resource
execution for which you want to retrieve the evaluation summary.
"""
function get_resource_evaluation_summary(
ResourceEvaluationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"GetResourceEvaluationSummary",
Dict{String,Any}("ResourceEvaluationId" => ResourceEvaluationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_evaluation_summary(
ResourceEvaluationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetResourceEvaluationSummary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceEvaluationId" => ResourceEvaluationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_stored_query(query_name)
get_stored_query(query_name, params::Dict{String,<:Any})
Returns the details of a specific stored query.
# Arguments
- `query_name`: The name of the query.
"""
function get_stored_query(QueryName; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"GetStoredQuery",
Dict{String,Any}("QueryName" => QueryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_stored_query(
QueryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"GetStoredQuery",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueryName" => QueryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_aggregate_discovered_resources(configuration_aggregator_name, resource_type)
list_aggregate_discovered_resources(configuration_aggregator_name, resource_type, params::Dict{String,<:Any})
Accepts a resource type and returns a list of resource identifiers that are aggregated for
a specific resource type across accounts and regions. A resource identifier includes the
resource type, ID, (if available) the custom resource name, source account, and source
region. You can narrow the results to include only resources that have specific resource
IDs, or a resource name, or source account ID, or source region. For example, if the input
consists of accountID 12345678910 and the region is us-east-1 for resource type
AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID
12345678910 and region us-east-1.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
- `resource_type`: The type of resources that you want Config to list in the response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters the results based on the ResourceFilters object.
- `"Limit"`: The maximum number of resource identifiers returned on each page. You cannot
specify a number greater than 100. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function list_aggregate_discovered_resources(
ConfigurationAggregatorName,
ResourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"ListAggregateDiscoveredResources",
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName,
"ResourceType" => ResourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_aggregate_discovered_resources(
ConfigurationAggregatorName,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"ListAggregateDiscoveredResources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName,
"ResourceType" => ResourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_conformance_pack_compliance_scores()
list_conformance_pack_compliance_scores(params::Dict{String,<:Any})
Returns a list of conformance pack compliance scores. A compliance score is the percentage
of the number of compliant rule-resource combinations in a conformance pack compared to the
number of total possible rule-resource combinations in the conformance pack. This metric
provides you with a high-level view of the compliance state of your conformance packs. You
can use it to identify, investigate, and understand the level of compliance in your
conformance packs. Conformance packs with no evaluation results will have a compliance
score of INSUFFICIENT_DATA.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters the results based on the ConformancePackComplianceScoresFilters.
- `"Limit"`: The maximum number of conformance pack compliance scores returned on each page.
- `"NextToken"`: The nextToken string in a prior request that you can use to get the
paginated response for the next set of conformance pack compliance scores.
- `"SortBy"`: Sorts your conformance pack compliance scores in either ascending or
descending order, depending on SortOrder. By default, conformance pack compliance scores
are sorted in alphabetical order by name of the conformance pack. Enter SCORE, to sort
conformance pack compliance scores by the numerical value of the compliance score.
- `"SortOrder"`: Determines the order in which conformance pack compliance scores are
sorted. Either in ascending or descending order. By default, conformance pack compliance
scores are sorted in alphabetical order by name of the conformance pack. Conformance pack
compliance scores are sorted in reverse alphabetical order if you enter DESCENDING. You can
sort conformance pack compliance scores by the numerical value of the compliance score by
entering SCORE in the SortBy action. When compliance scores are sorted by SCORE,
conformance packs with a compliance score of INSUFFICIENT_DATA will be last when sorting by
ascending order and first when sorting by descending order.
"""
function list_conformance_pack_compliance_scores(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"ListConformancePackComplianceScores";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_conformance_pack_compliance_scores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"ListConformancePackComplianceScores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_discovered_resources(resource_type)
list_discovered_resources(resource_type, params::Dict{String,<:Any})
Accepts a resource type and returns a list of resource identifiers for the resources of
that type. A resource identifier includes the resource type, ID, and (if available) the
custom resource name. The results consist of resources that Config has discovered,
including those that Config is not currently recording. You can narrow the results to
include only resources that have specific resource IDs or a resource name. You can specify
either resource IDs or a resource name, but not both, in the same request. The response is
paginated. By default, Config lists 100 resource identifiers on each page. You can
customize this number with the limit parameter. The response includes a nextToken string.
To get the next page of results, run the request again and specify the string for the
nextToken parameter.
# Arguments
- `resource_type`: The type of resources that you want Config to list in the response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeDeletedResources"`: Specifies whether Config includes deleted resources in the
results. By default, deleted resources are not included.
- `"limit"`: The maximum number of resource identifiers returned on each page. The default
is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the
default.
- `"nextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
- `"resourceIds"`: The IDs of only those resources that you want Config to list in the
response. If you do not specify this parameter, Config lists all resources of the specified
type that it has discovered. You can list a minimum of 1 resourceID and a maximum of 20
resourceIds.
- `"resourceName"`: The custom name of only those resources that you want Config to list in
the response. If you do not specify this parameter, Config lists all resources of the
specified type that it has discovered.
"""
function list_discovered_resources(
resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"ListDiscoveredResources",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_discovered_resources(
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"ListDiscoveredResources",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_evaluations()
list_resource_evaluations(params::Dict{String,<:Any})
Returns a list of proactive resource evaluations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Returns a ResourceEvaluationFilters object.
- `"Limit"`: The maximum number of evaluations returned on each page. The default is 10.
You cannot specify a number greater than 100. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function list_resource_evaluations(; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"ListResourceEvaluations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_resource_evaluations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"ListResourceEvaluations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_stored_queries()
list_stored_queries(params::Dict{String,<:Any})
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web
Services Region. The default is 100.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned with a single call.
- `"NextToken"`: The nextToken string returned in a previous request that you use to
request the next page of results in a paginated response.
"""
function list_stored_queries(; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"ListStoredQueries"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_stored_queries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"ListStoredQueries", 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 for Config resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator
and AggregatorAuthorization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of tags returned on each page. The limit maximum is 50. You
cannot specify a number greater than 50. If you specify 0, Config uses the default.
- `"NextToken"`: The nextToken string returned on a previous page that you use to get the
next page of results in a paginated response.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"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 config_service(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_aggregation_authorization(authorized_account_id, authorized_aws_region)
put_aggregation_authorization(authorized_account_id, authorized_aws_region, params::Dict{String,<:Any})
Authorizes the aggregator account and region to collect data from the source account and
region. PutAggregationAuthorization is an idempotent API. Subsequent requests won’t
create a duplicate resource if one was already created. If a following request has
different tags values, Config will ignore these differences and treat it as an idempotent
request of the previous. In this case, tags will not be updated, even if they are
different.
# Arguments
- `authorized_account_id`: The 12-digit account ID of the account authorized to aggregate
data.
- `authorized_aws_region`: The region authorized to collect aggregated data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: An array of tag object.
"""
function put_aggregation_authorization(
AuthorizedAccountId,
AuthorizedAwsRegion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutAggregationAuthorization",
Dict{String,Any}(
"AuthorizedAccountId" => AuthorizedAccountId,
"AuthorizedAwsRegion" => AuthorizedAwsRegion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_aggregation_authorization(
AuthorizedAccountId,
AuthorizedAwsRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutAggregationAuthorization",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthorizedAccountId" => AuthorizedAccountId,
"AuthorizedAwsRegion" => AuthorizedAwsRegion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_config_rule(config_rule)
put_config_rule(config_rule, params::Dict{String,<:Any})
Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply
with your desired configurations. For information on how many Config rules you can have per
account, see Service Limits in the Config Developer Guide. There are two types of rules:
Config Managed Rules and Config Custom Rules. You can use PutConfigRule to create both
Config Managed Rules and Config Custom Rules. Config Managed Rules are predefined,
customizable rules created by Config. For a list of managed rules, see List of Config
Managed Rules. If you are adding an Config managed rule, you must specify the rule's
identifier for the SourceIdentifier key. Config Custom Rules are rules that you create from
scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda
Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language.
Config custom rules created with Lambda are called Config Custom Lambda Rules and Config
custom rules created with Guard are called Config Custom Policy Rules. If you are adding a
new Config Custom Lambda rule, you first need to create an Lambda function that the rule
invokes to evaluate your resources. When you use PutConfigRule to add a Custom Lambda rule
to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the
function. You specify the ARN in the SourceIdentifier key. This key is part of the Source
object, which is part of the ConfigRule object. For any new Config rule that you add,
specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or
the ConfigRuleId. These values are generated by Config for new rules. If you are updating a
rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId,
or ConfigRuleArn in the ConfigRule data type that you use in this request. For more
information about developing and using Config rules, see Evaluating Resources with Config
Rules in the Config Developer Guide. PutConfigRule is an idempotent API. Subsequent
requests won’t create a duplicate resource if one was already created. If a following
request has different tags values, Config will ignore these differences and treat it as an
idempotent request of the previous. In this case, tags will not be updated, even if they
are different.
# Arguments
- `config_rule`: The rule that you want to add to your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: An array of tag object.
"""
function put_config_rule(ConfigRule; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"PutConfigRule",
Dict{String,Any}("ConfigRule" => ConfigRule);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_config_rule(
ConfigRule,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutConfigRule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConfigRule" => ConfigRule), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_aggregator(configuration_aggregator_name)
put_configuration_aggregator(configuration_aggregator_name, params::Dict{String,<:Any})
Creates and updates the configuration aggregator with the selected source accounts and
regions. The source account can be individual account(s) or an organization. accountIds
that are passed will be replaced with existing accounts. If you want to add additional
accounts into the aggregator, call DescribeConfigurationAggregators to get the previous
accounts and then append new ones. Config should be enabled in source accounts and regions
you want to aggregate. If your source type is an organization, you must be signed in to the
management account or a registered delegated administrator and all the features must be
enabled in your organization. If the caller is a management account, Config calls
EnableAwsServiceAccess API to enable integration between Config and Organizations. If the
caller is a registered delegated administrator, Config calls ListDelegatedAdministrators
API to verify whether the caller is a valid delegated administrator. To register a
delegated administrator, see Register a Delegated Administrator in the Config developer
guide. PutConfigurationAggregator is an idempotent API. Subsequent requests won’t
create a duplicate resource if one was already created. If a following request has
different tags values, Config will ignore these differences and treat it as an idempotent
request of the previous. In this case, tags will not be updated, even if they are
different.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountAggregationSources"`: A list of AccountAggregationSource object.
- `"OrganizationAggregationSource"`: An OrganizationAggregationSource object.
- `"Tags"`: An array of tag object.
"""
function put_configuration_aggregator(
ConfigurationAggregatorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"PutConfigurationAggregator",
Dict{String,Any}("ConfigurationAggregatorName" => ConfigurationAggregatorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_aggregator(
ConfigurationAggregatorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutConfigurationAggregator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_configuration_recorder(configuration_recorder)
put_configuration_recorder(configuration_recorder, params::Dict{String,<:Any})
Creates a new configuration recorder to record configuration changes for specified resource
types. You can also use this action to change the roleARN or the recordingGroup of an
existing recorder. For more information, see Managing the Configuration Recorder in the
Config Developer Guide. You can specify only one configuration recorder for each Amazon
Web Services Region for each account. If the configuration recorder does not have the
recordingGroup field specified, the default is to record all supported resource types.
# Arguments
- `configuration_recorder`: An object for the configuration recorder to record
configuration changes for specified resource types.
"""
function put_configuration_recorder(
ConfigurationRecorder; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"PutConfigurationRecorder",
Dict{String,Any}("ConfigurationRecorder" => ConfigurationRecorder);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_configuration_recorder(
ConfigurationRecorder,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutConfigurationRecorder",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationRecorder" => ConfigurationRecorder),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_conformance_pack(conformance_pack_name)
put_conformance_pack(conformance_pack_name, params::Dict{String,<:Any})
Creates or updates a conformance pack. A conformance pack is a collection of Config rules
that can be easily deployed in an account and a region and across an organization. For
information on how many conformance packs you can have per account, see Service Limits in
the Config Developer Guide. This API creates a service-linked role
AWSServiceRoleForConfigConforms in your account. The service-linked role is created only
when the role does not exist in your account. You must specify only one of the follow
parameters: TemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails.
# Arguments
- `conformance_pack_name`: The unique name of the conformance pack you want to deploy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConformancePackInputParameters"`: A list of ConformancePackInputParameter objects.
- `"DeliveryS3Bucket"`: The name of the Amazon S3 bucket where Config stores conformance
pack templates. This field is optional.
- `"DeliveryS3KeyPrefix"`: The prefix for the Amazon S3 bucket. This field is optional.
- `"TemplateBody"`: A string containing the full conformance pack template body. The
structure containing the template body has a minimum length of 1 byte and a maximum length
of 51,200 bytes. You can use a YAML template with two resource types: Config rule
(AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).
- `"TemplateS3Uri"`: The location of the file containing the template body
(s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300
KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.
You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful
deployment, the template object must not be in an archived storage class if this parameter
is passed.
- `"TemplateSSMDocumentDetails"`: An object of type TemplateSSMDocumentDetails, which
contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems
Manager document (SSM document) and the version of the SSM document that is used to create
a conformance pack.
"""
function put_conformance_pack(
ConformancePackName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"PutConformancePack",
Dict{String,Any}("ConformancePackName" => ConformancePackName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_conformance_pack(
ConformancePackName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutConformancePack",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConformancePackName" => ConformancePackName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_delivery_channel(delivery_channel)
put_delivery_channel(delivery_channel, params::Dict{String,<:Any})
Creates a delivery channel object to deliver configuration information and other compliance
information to an Amazon S3 bucket and Amazon SNS topic. For more information, see
Notifications that Config Sends to an Amazon SNS topic. Before you can create a delivery
channel, you must create a configuration recorder. You can use this action to change the
Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the
Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values
for the S3 bucket and the SNS topic. If you specify a different value for either the S3
bucket or the SNS topic, this action will keep the existing value for the parameter that is
not changed. You can have only one delivery channel per region in your account.
# Arguments
- `delivery_channel`: The configuration delivery channel object that delivers the
configuration information to an Amazon S3 bucket and to an Amazon SNS topic.
"""
function put_delivery_channel(
DeliveryChannel; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"PutDeliveryChannel",
Dict{String,Any}("DeliveryChannel" => DeliveryChannel);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_delivery_channel(
DeliveryChannel,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutDeliveryChannel",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeliveryChannel" => DeliveryChannel), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_evaluations(result_token)
put_evaluations(result_token, params::Dict{String,<:Any})
Used by an Lambda function to deliver evaluation results to Config. This action is required
in every Lambda function that is invoked by an Config rule.
# Arguments
- `result_token`: An encrypted token that associates an evaluation with an Config rule.
Identifies the rule and the event that triggered the evaluation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Evaluations"`: The assessments that the Lambda function performs. Each evaluation
identifies an Amazon Web Services resource and indicates whether it complies with the
Config rule that invokes the Lambda function.
- `"TestMode"`: Use this parameter to specify a test run for PutEvaluations. You can verify
whether your Lambda function will deliver evaluation results to Config. No updates occur to
your existing evaluations, and evaluation results are not sent to Config. When TestMode is
true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the
value cannot be null.
"""
function put_evaluations(ResultToken; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"PutEvaluations",
Dict{String,Any}("ResultToken" => ResultToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_evaluations(
ResultToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutEvaluations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResultToken" => ResultToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_external_evaluation(config_rule_name, external_evaluation)
put_external_evaluation(config_rule_name, external_evaluation, params::Dict{String,<:Any})
Add or updates the evaluations for process checks. This API checks if the rule is a process
check when the name of the Config rule is provided.
# Arguments
- `config_rule_name`: The name of the Config rule.
- `external_evaluation`: An ExternalEvaluation object that provides details about
compliance.
"""
function put_external_evaluation(
ConfigRuleName, ExternalEvaluation; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"PutExternalEvaluation",
Dict{String,Any}(
"ConfigRuleName" => ConfigRuleName, "ExternalEvaluation" => ExternalEvaluation
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_external_evaluation(
ConfigRuleName,
ExternalEvaluation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutExternalEvaluation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigRuleName" => ConfigRuleName,
"ExternalEvaluation" => ExternalEvaluation,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_organization_config_rule(organization_config_rule_name)
put_organization_config_rule(organization_config_rule_name, params::Dict{String,<:Any})
Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web
Services resources comply with your desired configurations. For information on how many
organization Config rules you can have per account, see Service Limits in the Config
Developer Guide. Only a management account and a delegated administrator can create or
update an organization Config rule. When calling this API with a delegated administrator,
you must ensure Organizations ListDelegatedAdministrator permissions are added. An
organization can have up to 3 delegated administrators. This API enables organization
service access through the EnableAWSServiceAccess action and creates a service-linked role
AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator
account of your organization. The service-linked role is created only when the role does
not exist in the caller account. Config verifies the existence of role with GetRole action.
To use this API with delegated administrator, register a delegated administrator by calling
Amazon Web Services Organization register-delegated-administrator for
config-multiaccountsetup.amazonaws.com. There are two types of rules: Config Managed Rules
and Config Custom Rules. You can use PutOrganizationConfigRule to create both Config
Managed Rules and Config Custom Rules. Config Managed Rules are predefined, customizable
rules created by Config. For a list of managed rules, see List of Config Managed Rules. If
you are adding an Config managed rule, you must specify the rule's identifier for the
RuleIdentifier key. Config Custom Rules are rules that you create from scratch. There are
two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and
with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules
created with Lambda are called Config Custom Lambda Rules and Config custom rules created
with Guard are called Config Custom Policy Rules. If you are adding a new Config Custom
Lambda rule, you first need to create an Lambda function in the management account or a
delegated administrator that the rule invokes to evaluate your resources. You also need to
create an IAM role in the managed account that can be assumed by the Lambda function. When
you use PutOrganizationConfigRule to add a Custom Lambda rule to Config, you must specify
the Amazon Resource Name (ARN) that Lambda assigns to the function. Prerequisite: Ensure
you call EnableAllFeatures API to enable all features in an organization. Make sure to
specify one of either OrganizationCustomPolicyRuleMetadata for Custom Policy rules,
OrganizationCustomRuleMetadata for Custom Lambda rules, or OrganizationManagedRuleMetadata
for managed rules.
# Arguments
- `organization_config_rule_name`: The name that you assign to an organization Config rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExcludedAccounts"`: A comma-separated list of accounts that you want to exclude from an
organization Config rule.
- `"OrganizationCustomPolicyRuleMetadata"`: An OrganizationCustomPolicyRuleMetadata object.
This object specifies metadata for your organization's Config Custom Policy rule. The
metadata includes the runtime system in use, which accounts have debug logging enabled, and
other custom rule metadata, such as resource type, resource ID of Amazon Web Services
resource, and organization trigger types that initiate Config to evaluate Amazon Web
Services resources against a rule.
- `"OrganizationCustomRuleMetadata"`: An OrganizationCustomRuleMetadata object. This object
specifies organization custom rule metadata such as resource type, resource ID of Amazon
Web Services resource, Lambda function ARN, and organization trigger types that trigger
Config to evaluate your Amazon Web Services resources against a rule. It also provides the
frequency with which you want Config to run evaluations for the rule if the trigger type is
periodic.
- `"OrganizationManagedRuleMetadata"`: An OrganizationManagedRuleMetadata object. This
object specifies organization managed rule metadata such as resource type and ID of Amazon
Web Services resource along with the rule identifier. It also provides the frequency with
which you want Config to run evaluations for the rule if the trigger type is periodic.
"""
function put_organization_config_rule(
OrganizationConfigRuleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"PutOrganizationConfigRule",
Dict{String,Any}("OrganizationConfigRuleName" => OrganizationConfigRuleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_organization_config_rule(
OrganizationConfigRuleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutOrganizationConfigRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OrganizationConfigRuleName" => OrganizationConfigRuleName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_organization_conformance_pack(organization_conformance_pack_name)
put_organization_conformance_pack(organization_conformance_pack_name, params::Dict{String,<:Any})
Deploys conformance packs across member accounts in an Amazon Web Services Organization.
For information on how many organization conformance packs and how many Config rules you
can have per account, see Service Limits in the Config Developer Guide. Only a management
account and a delegated administrator can call this API. When calling this API with a
delegated administrator, you must ensure Organizations ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated administrators. This API
enables organization service access for config-multiaccountsetup.amazonaws.com through the
EnableAWSServiceAccess action and creates a service-linked role
AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator
account of your organization. The service-linked role is created only when the role does
not exist in the caller account. To use this API with delegated administrator, register a
delegated administrator by calling Amazon Web Services Organization register-delegate-admin
for config-multiaccountsetup.amazonaws.com. Prerequisite: Ensure you call
EnableAllFeatures API to enable all features in an organization. You must specify either
the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config
uses the TemplateS3Uri parameter and ignores the TemplateBody parameter. Config sets the
state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the
conformance pack is created or updated. You cannot update a conformance pack while it is in
this state.
# Arguments
- `organization_conformance_pack_name`: Name of the organization conformance pack you want
to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConformancePackInputParameters"`: A list of ConformancePackInputParameter objects.
- `"DeliveryS3Bucket"`: The name of the Amazon S3 bucket where Config stores conformance
pack templates. This field is optional. If used, it must be prefixed with
awsconfigconforms.
- `"DeliveryS3KeyPrefix"`: The prefix for the Amazon S3 bucket. This field is optional.
- `"ExcludedAccounts"`: A list of Amazon Web Services accounts to be excluded from an
organization conformance pack while deploying a conformance pack.
- `"TemplateBody"`: A string containing full conformance pack template body. Structure
containing the template body with a minimum length of 1 byte and a maximum length of 51,200
bytes.
- `"TemplateS3Uri"`: Location of file containing the template body. The uri must point to
the conformance pack template (max size: 300 KB). You must have access to read Amazon S3
bucket. In addition, in order to ensure a successful deployment, the template object must
not be in an archived storage class if this parameter is passed.
"""
function put_organization_conformance_pack(
OrganizationConformancePackName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"PutOrganizationConformancePack",
Dict{String,Any}(
"OrganizationConformancePackName" => OrganizationConformancePackName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_organization_conformance_pack(
OrganizationConformancePackName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutOrganizationConformancePack",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OrganizationConformancePackName" => OrganizationConformancePackName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_remediation_configurations(remediation_configurations)
put_remediation_configurations(remediation_configurations, params::Dict{String,<:Any})
Adds or updates the remediation configuration with a specific Config rule with the selected
target or action. The API creates the RemediationConfiguration object for the Config rule.
The Config rule must already exist for you to add a remediation configuration. The target
(SSM document) must exist and have permissions to use the target. Be aware of backward
incompatible changes If you make backward incompatible changes to the SSM document, you
must call this again to ensure the remediations can run. This API does not support adding
remediation configurations for service-linked Config Rules such as Organization Config
rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services
Security Hub. Required fields For manual remediation configuration, you need to provide
a value for automationAssumeRole or use a value in the assumeRolefield to remediate your
resources. The SSM automation document can use either as long as it maps to a valid
parameter. However, for automatic remediation configuration, the only valid assumeRole
field value is AutomationAssumeRole and you need to provide a value for
AutomationAssumeRole to remediate your resources. Auto remediation can be initiated even
for compliant resources If you enable auto remediation for a specific Config rule using
the PutRemediationConfigurations API or the Config console, it initiates the remediation
process for all non-compliant resources for that specific rule. The auto remediation
process relies on the compliance data snapshot which is captured on a periodic basis. Any
non-compliant resource that is updated between the snapshot schedule will continue to be
remediated based on the last known compliance data snapshot. This means that in some cases
auto remediation can be initiated even for compliant resources, since the bootstrap
processor uses a database that can have stale evaluation results based on the last known
compliance data snapshot.
# Arguments
- `remediation_configurations`: A list of remediation configuration objects.
"""
function put_remediation_configurations(
RemediationConfigurations; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"PutRemediationConfigurations",
Dict{String,Any}("RemediationConfigurations" => RemediationConfigurations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_remediation_configurations(
RemediationConfigurations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutRemediationConfigurations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RemediationConfigurations" => RemediationConfigurations),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_remediation_exceptions(config_rule_name, resource_keys)
put_remediation_exceptions(config_rule_name, resource_keys, params::Dict{String,<:Any})
A remediation exception is when a specified resource is no longer considered for
auto-remediation. This API adds a new exception or updates an existing exception for a
specified resource with a specified Config rule. Exceptions block auto remediation
Config generates a remediation exception when a problem occurs running a remediation action
for a specified resource. Remediation exceptions blocks auto-remediation until the
exception is cleared. Manual remediation is recommended when placing an exception When
placing an exception on an Amazon Web Services resource, it is recommended that remediation
is set as manual remediation until the given Config rule for the specified resource
evaluates the resource as NON_COMPLIANT. Once the resource has been evaluated as
NON_COMPLIANT, you can add remediation exceptions and change the remediation type back from
Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation
before a NON_COMPLIANT evaluation result can delete resources before the exception is
applied. Exceptions can only be performed on non-compliant resources Placing an
exception can only be performed on resources that are NON_COMPLIANT. If you use this API
for COMPLIANT resources or resources that are NOT_APPLICABLE, a remediation exception will
not be generated. For more information on the conditions that initiate the possible Config
evaluation results, see Concepts | Config Rules in the Config Developer Guide. Auto
remediation can be initiated even for compliant resources If you enable auto remediation
for a specific Config rule using the PutRemediationConfigurations API or the Config
console, it initiates the remediation process for all non-compliant resources for that
specific rule. The auto remediation process relies on the compliance data snapshot which is
captured on a periodic basis. Any non-compliant resource that is updated between the
snapshot schedule will continue to be remediated based on the last known compliance data
snapshot. This means that in some cases auto remediation can be initiated even for
compliant resources, since the bootstrap processor uses a database that can have stale
evaluation results based on the last known compliance data snapshot.
# Arguments
- `config_rule_name`: The name of the Config rule for which you want to create remediation
exception.
- `resource_keys`: An exception list of resource exception keys to be processed with the
current request. Config adds exception for each resource key. For example, Config adds 3
exceptions for 3 resource keys.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExpirationTime"`: The exception is automatically deleted after the expiration date.
- `"Message"`: The message contains an explanation of the exception.
"""
function put_remediation_exceptions(
ConfigRuleName, ResourceKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"PutRemediationExceptions",
Dict{String,Any}(
"ConfigRuleName" => ConfigRuleName, "ResourceKeys" => ResourceKeys
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_remediation_exceptions(
ConfigRuleName,
ResourceKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutRemediationExceptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigRuleName" => ConfigRuleName, "ResourceKeys" => ResourceKeys
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_config(configuration, resource_id, resource_type, schema_version_id)
put_resource_config(configuration, resource_id, resource_type, schema_version_id, params::Dict{String,<:Any})
Records the configuration state for the resource provided in the request. The configuration
state of a resource is represented in Config as Configuration Items. Once this API records
the configuration item, you can retrieve the list of configuration items for the custom
resource type using existing Config APIs. The custom resource type must be registered
with CloudFormation. This API accepts the configuration item registered with
CloudFormation. When you call this API, Config only stores configuration state of the
resource provided in the request. This API does not change or remediate the configuration
of the resource. Write-only schema properites are not recorded as part of the published
configuration item.
# Arguments
- `configuration`: The configuration object of the resource in valid JSON format. It must
match the schema registered with CloudFormation. The configuration JSON must not exceed 64
KB.
- `resource_id`: Unique identifier of the resource.
- `resource_type`: The type of the resource. The custom resource type must be registered
with CloudFormation. You cannot use the organization names “amzn”, “amazon”,
“alexa”, “custom” with custom resource types. It is the first part of the
ResourceType up to the first ::.
- `schema_version_id`: Version of the schema registered for the ResourceType in
CloudFormation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceName"`: Name of the resource.
- `"Tags"`: Tags associated with the resource. This field is not to be confused with the
Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for
PutResourceConfig are tags that you supply for the configuration items of your custom
resources.
"""
function put_resource_config(
Configuration,
ResourceId,
ResourceType,
SchemaVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutResourceConfig",
Dict{String,Any}(
"Configuration" => Configuration,
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
"SchemaVersionId" => SchemaVersionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_config(
Configuration,
ResourceId,
ResourceType,
SchemaVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutResourceConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Configuration" => Configuration,
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
"SchemaVersionId" => SchemaVersionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_retention_configuration(retention_period_in_days)
put_retention_configuration(retention_period_in_days, params::Dict{String,<:Any})
Creates and updates the retention configuration with details about retention period (number
of days) that Config stores your historical information. The API creates the
RetentionConfiguration object and names the object as default. When you have a
RetentionConfiguration object named default, calling the API modifies the default object.
Currently, Config supports only one retention configuration per region in your account.
# Arguments
- `retention_period_in_days`: Number of days Config stores your historical information.
Currently, only applicable to the configuration item history.
"""
function put_retention_configuration(
RetentionPeriodInDays; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"PutRetentionConfiguration",
Dict{String,Any}("RetentionPeriodInDays" => RetentionPeriodInDays);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_retention_configuration(
RetentionPeriodInDays,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutRetentionConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RetentionPeriodInDays" => RetentionPeriodInDays),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_stored_query(stored_query)
put_stored_query(stored_query, params::Dict{String,<:Any})
Saves a new query or updates an existing saved query. The QueryName must be unique for a
single Amazon Web Services account and a single Amazon Web Services Region. You can create
upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services
Region. PutStoredQuery is an idempotent API. Subsequent requests won’t create a
duplicate resource if one was already created. If a following request has different tags
values, Config will ignore these differences and treat it as an idempotent request of the
previous. In this case, tags will not be updated, even if they are different.
# Arguments
- `stored_query`: A list of StoredQuery objects. The mandatory fields are QueryName and
Expression. When you are creating a query, you must provide a query name and an
expression. When you are updating a query, you must provide a query name but updating the
description is optional.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of Tags object.
"""
function put_stored_query(StoredQuery; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"PutStoredQuery",
Dict{String,Any}("StoredQuery" => StoredQuery);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_stored_query(
StoredQuery,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"PutStoredQuery",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StoredQuery" => StoredQuery), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
select_aggregate_resource_config(configuration_aggregator_name, expression)
select_aggregate_resource_config(configuration_aggregator_name, expression, params::Dict{String,<:Any})
Accepts a structured query language (SQL) SELECT command and an aggregator to query
configuration state of Amazon Web Services resources across multiple accounts and regions,
performs the corresponding search, and returns resource configurations matching the
properties. For more information about query components, see the Query Components section
in the Config Developer Guide. If you run an aggregation query (i.e., using GROUP BY or
using aggregate functions such as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE
resourceType = 'AWS::IAM::Role' GROUP BY resourceId) and do not specify the MaxResults or
the Limit query parameters, the default page size is set to 500. If you run a
non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT * WHERE
resourceType = 'AWS::IAM::Role') and do not specify the MaxResults or the Limit query
parameters, the default page size is set to 25.
# Arguments
- `configuration_aggregator_name`: The name of the configuration aggregator.
- `expression`: The SQL query SELECT command.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of query results returned on each page.
- `"MaxResults"`: The maximum number of query results returned on each page. Config also
allows the Limit request parameter.
- `"NextToken"`: The nextToken string returned in a previous request that you use to
request the next page of results in a paginated response.
"""
function select_aggregate_resource_config(
ConfigurationAggregatorName,
Expression;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"SelectAggregateResourceConfig",
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName,
"Expression" => Expression,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function select_aggregate_resource_config(
ConfigurationAggregatorName,
Expression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"SelectAggregateResourceConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationAggregatorName" => ConfigurationAggregatorName,
"Expression" => Expression,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
select_resource_config(expression)
select_resource_config(expression, params::Dict{String,<:Any})
Accepts a structured query language (SQL) SELECT command, performs the corresponding
search, and returns resource configurations matching the properties. For more information
about query components, see the Query Components section in the Config Developer Guide.
# Arguments
- `expression`: The SQL query SELECT command.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of query results returned on each page.
- `"NextToken"`: The nextToken string returned in a previous request that you use to
request the next page of results in a paginated response.
"""
function select_resource_config(
Expression; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"SelectResourceConfig",
Dict{String,Any}("Expression" => Expression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function select_resource_config(
Expression,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"SelectResourceConfig",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Expression" => Expression), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_config_rules_evaluation()
start_config_rules_evaluation(params::Dict{String,<:Any})
Runs an on-demand evaluation for the specified Config rules against the last known
configuration state of the resources. Use StartConfigRulesEvaluation when you want to test
that a rule you updated is working as expected. StartConfigRulesEvaluation does not
re-record the latest configuration state for your resources. It re-runs an evaluation
against the last known state of your resources. You can specify up to 25 Config rules per
request. An existing StartConfigRulesEvaluation call for the specified rules must complete
before you can call the API again. If you chose to have Config stream to an Amazon SNS
topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation
starts. You don't need to call the StartConfigRulesEvaluation API to run an evaluation for
a new rule. When you create a rule, Config evaluates your resources against the rule
automatically. The StartConfigRulesEvaluation API is useful if you want to run on-demand
evaluations, such as the following example: You have a custom rule that evaluates your
IAM resources every 24 hours. You update your Lambda function to add additional
conditions to your rule. Instead of waiting for the next periodic evaluation, you call
the StartConfigRulesEvaluation API. Config invokes your Lambda function and evaluates
your IAM resources. Your custom rule will still run periodic evaluations every 24 hours.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfigRuleNames"`: The list of names of Config rules that you want to run evaluations
for.
"""
function start_config_rules_evaluation(; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"StartConfigRulesEvaluation"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function start_config_rules_evaluation(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"StartConfigRulesEvaluation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_configuration_recorder(configuration_recorder_name)
start_configuration_recorder(configuration_recorder_name, params::Dict{String,<:Any})
Starts recording configurations of the Amazon Web Services resources you have selected to
record in your Amazon Web Services account. You must have created at least one delivery
channel to successfully start the configuration recorder.
# Arguments
- `configuration_recorder_name`: The name of the recorder object that records each
configuration change made to the resources.
"""
function start_configuration_recorder(
ConfigurationRecorderName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"StartConfigurationRecorder",
Dict{String,Any}("ConfigurationRecorderName" => ConfigurationRecorderName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_configuration_recorder(
ConfigurationRecorderName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"StartConfigurationRecorder",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationRecorderName" => ConfigurationRecorderName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_remediation_execution(config_rule_name, resource_keys)
start_remediation_execution(config_rule_name, resource_keys, params::Dict{String,<:Any})
Runs an on-demand remediation for the specified Config rules against the last known
remediation configuration. It runs an execution against the current state of your
resources. Remediation execution is asynchronous. You can specify up to 100 resource keys
per request. An existing StartRemediationExecution call for the specified resource keys
must complete before you can call the API again.
# Arguments
- `config_rule_name`: The list of names of Config rules that you want to run remediation
execution for.
- `resource_keys`: A list of resource keys to be processed with the current request. Each
element in the list consists of the resource type and resource ID.
"""
function start_remediation_execution(
ConfigRuleName, ResourceKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"StartRemediationExecution",
Dict{String,Any}(
"ConfigRuleName" => ConfigRuleName, "ResourceKeys" => ResourceKeys
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_remediation_execution(
ConfigRuleName,
ResourceKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"StartRemediationExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigRuleName" => ConfigRuleName, "ResourceKeys" => ResourceKeys
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_resource_evaluation(evaluation_mode, resource_details)
start_resource_evaluation(evaluation_mode, resource_details, params::Dict{String,<:Any})
Runs an on-demand evaluation for the specified resource to determine whether the resource
details will comply with configured Config rules. You can also use it for evaluation
purposes. Config recommends using an evaluation context. It runs an execution against the
resource details with all of the Config rules in your account that match with the specified
proactive mode and resource type. Ensure you have the cloudformation:DescribeType role
setup to validate the resource type schema. You can find the Resource type schema in
\"Amazon Web Services public extensions\" within the CloudFormation registry or with the
following CLI commmand: aws cloudformation describe-type --type-name \"AWS::S3::Bucket\"
--type RESOURCE. For more information, see Managing extensions through the CloudFormation
registry and Amazon Web Services resource and property types reference in the
CloudFormation User Guide.
# Arguments
- `evaluation_mode`: The mode of an evaluation. The valid values for this API are DETECTIVE
and PROACTIVE.
- `resource_details`: Returns a ResourceDetails object.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A client token is a unique, case-sensitive string of up to 64 ASCII
characters. To make an idempotent API request using one of these actions, specify a client
token in the request. Avoid reusing the same client token for other API requests. If you
retry a request that completed successfully using the same client token and the same
parameters, the retry succeeds without performing any further actions. If you retry a
successful request using the same client token, but one or more of the parameters are
different, other than the Region or Availability Zone, the retry fails with an
IdempotentParameterMismatch error.
- `"EvaluationContext"`: Returns an EvaluationContext object.
- `"EvaluationTimeout"`: The timeout for an evaluation. The default is 900 seconds. You
cannot specify a number greater than 3600. If you specify 0, Config uses the default.
"""
function start_resource_evaluation(
EvaluationMode, ResourceDetails; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"StartResourceEvaluation",
Dict{String,Any}(
"EvaluationMode" => EvaluationMode, "ResourceDetails" => ResourceDetails
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_resource_evaluation(
EvaluationMode,
ResourceDetails,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"StartResourceEvaluation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EvaluationMode" => EvaluationMode, "ResourceDetails" => ResourceDetails
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_configuration_recorder(configuration_recorder_name)
stop_configuration_recorder(configuration_recorder_name, params::Dict{String,<:Any})
Stops recording configurations of the Amazon Web Services resources you have selected to
record in your Amazon Web Services account.
# Arguments
- `configuration_recorder_name`: The name of the recorder object that records each
configuration change made to the resources.
"""
function stop_configuration_recorder(
ConfigurationRecorderName; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"StopConfigurationRecorder",
Dict{String,Any}("ConfigurationRecorderName" => ConfigurationRecorderName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_configuration_recorder(
ConfigurationRecorderName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return config_service(
"StopConfigurationRecorder",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConfigurationRecorderName" => ConfigurationRecorderName),
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. If
existing tags are specified, however, then their values will be updated. 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 resource for which to
list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator
and AggregatorAuthorization.
- `tags`: An array of tag object.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return config_service(
"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 config_service(
"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 specified tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator
and AggregatorAuthorization.
- `tag_keys`: The keys of the tags to be removed.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return config_service(
"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 config_service(
"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 | 465309 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: connect
using AWS.Compat
using AWS.UUIDs
"""
activate_evaluation_form(evaluation_form_id, evaluation_form_version, instance_id)
activate_evaluation_form(evaluation_form_id, evaluation_form_version, instance_id, params::Dict{String,<:Any})
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation
form is activated, it is available to start new evaluations based on the form.
# Arguments
- `evaluation_form_id`: The unique identifier for the evaluation form.
- `evaluation_form_version`: The version of the evaluation form to activate. If the version
property is not provided, the latest version of the evaluation form is activated.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function activate_evaluation_form(
EvaluationFormId,
EvaluationFormVersion,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)/activate",
Dict{String,Any}("EvaluationFormVersion" => EvaluationFormVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function activate_evaluation_form(
EvaluationFormId,
EvaluationFormVersion,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)/activate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EvaluationFormVersion" => EvaluationFormVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_analytics_data_set(data_set_id, instance_id)
associate_analytics_data_set(data_set_id, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Associates the
specified dataset for a Amazon Connect instance with the target account. You can associate
only one dataset in a single call.
# Arguments
- `data_set_id`: The identifier of the dataset to associate with the target account.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TargetAccountId"`: The identifier of the target account. Use to associate a dataset to
a different account than the one containing the Amazon Connect instance. If not specified,
by default this value is the Amazon Web Services account that has the Amazon Connect
instance.
"""
function associate_analytics_data_set(
DataSetId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/analytics-data/instance/$(InstanceId)/association",
Dict{String,Any}("DataSetId" => DataSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_analytics_data_set(
DataSetId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/analytics-data/instance/$(InstanceId)/association",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DataSetId" => DataSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_approved_origin(instance_id, origin)
associate_approved_origin(instance_id, origin, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Associates an
approved origin to an Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `origin`: The domain to add to your allow list.
"""
function associate_approved_origin(
InstanceId, Origin; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/instance/$(InstanceId)/approved-origin",
Dict{String,Any}("Origin" => Origin);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_approved_origin(
InstanceId,
Origin,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/approved-origin",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Origin" => Origin), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_bot(instance_id)
associate_bot(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Allows the
specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LexBot"`:
- `"LexV2Bot"`: The Amazon Lex V2 bot to associate with the instance.
"""
function associate_bot(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"PUT",
"/instance/$(InstanceId)/bot";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_bot(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/bot",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_default_vocabulary(instance_id, language_code)
associate_default_vocabulary(instance_id, language_code, params::Dict{String,<:Any})
Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the
vocabulary in post-call and real-time analysis sessions for the given language.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `language_code`: The language code of the vocabulary entries. For a list of languages and
their corresponding language codes, see What is Amazon Transcribe?
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"VocabularyId"`: The identifier of the custom vocabulary. If this is empty, the default
is set to none.
"""
function associate_default_vocabulary(
InstanceId, LanguageCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/default-vocabulary/$(InstanceId)/$(LanguageCode)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_default_vocabulary(
InstanceId,
LanguageCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/default-vocabulary/$(InstanceId)/$(LanguageCode)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_flow(flow_id, instance_id, resource_id, resource_type)
associate_flow(flow_id, instance_id, resource_id, resource_type, params::Dict{String,<:Any})
Associates a connect resource to a flow.
# Arguments
- `flow_id`: The identifier of the flow.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `resource_id`: The identifier of the resource.
- `resource_type`: A valid resource type.
"""
function associate_flow(
FlowId,
InstanceId,
ResourceId,
ResourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/flow-associations/$(InstanceId)",
Dict{String,Any}(
"FlowId" => FlowId, "ResourceId" => ResourceId, "ResourceType" => ResourceType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_flow(
FlowId,
InstanceId,
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/flow-associations/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FlowId" => FlowId,
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_instance_storage_config(instance_id, resource_type, storage_config)
associate_instance_storage_config(instance_id, resource_type, storage_config, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Associates a
storage resource type for the first time. You can only associate one type of storage
configuration in a single call. This means, for example, that you can't define an instance
with multiple S3 buckets for storing chat transcripts. This API does not create a resource
that doesn't exist. It only associates it to the instance. Ensure that the resource being
specified in the storage configuration, like an S3 bucket, exists when being used for
association.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `resource_type`: A valid resource type. To enable streaming for real-time analysis of
contacts, use the following types: For chat contacts, use
REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS. For voice contacts, use
REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS. REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is
deprecated, but it is still supported and will apply only to VOICE channel contacts. Use
REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward. If you have
previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no action is
needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
- `storage_config`: A valid storage type.
"""
function associate_instance_storage_config(
InstanceId,
ResourceType,
StorageConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/storage-config",
Dict{String,Any}("ResourceType" => ResourceType, "StorageConfig" => StorageConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_instance_storage_config(
InstanceId,
ResourceType,
StorageConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/storage-config",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceType" => ResourceType, "StorageConfig" => StorageConfig
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_lambda_function(function_arn, instance_id)
associate_lambda_function(function_arn, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Allows the
specified Amazon Connect instance to access the specified Lambda function.
# Arguments
- `function_arn`: The Amazon Resource Name (ARN) for the Lambda function being associated.
Maximum number of characters allowed is 140.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function associate_lambda_function(
FunctionArn, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/instance/$(InstanceId)/lambda-function",
Dict{String,Any}("FunctionArn" => FunctionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_lambda_function(
FunctionArn,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/lambda-function",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FunctionArn" => FunctionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_lex_bot(instance_id, lex_bot)
associate_lex_bot(instance_id, lex_bot, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Allows the
specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only
supports the association of Amazon Lex V1 bots.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `lex_bot`: The Amazon Lex bot to associate with the instance.
"""
function associate_lex_bot(
InstanceId, LexBot; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/instance/$(InstanceId)/lex-bot",
Dict{String,Any}("LexBot" => LexBot);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_lex_bot(
InstanceId,
LexBot,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/lex-bot",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("LexBot" => LexBot), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_phone_number_contact_flow(contact_flow_id, instance_id, phone_number_id)
associate_phone_number_contact_flow(contact_flow_id, instance_id, phone_number_id, params::Dict{String,<:Any})
Associates a flow with a phone number claimed to your Amazon Connect instance. If the
number is claimed to a traffic distribution group, and you are calling this API using an
instance in the Amazon Web Services Region where the traffic distribution group was
created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI
request parameter. However, if the number is claimed to a traffic distribution group and
you are calling this API using an instance in the alternate Amazon Web Services Region
associated with the traffic distribution group, you must provide a full phone number ARN.
If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
# Arguments
- `contact_flow_id`: The identifier of the flow.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `phone_number_id`: A unique identifier for the phone number.
"""
function associate_phone_number_contact_flow(
ContactFlowId,
InstanceId,
PhoneNumberId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/phone-number/$(PhoneNumberId)/contact-flow",
Dict{String,Any}("ContactFlowId" => ContactFlowId, "InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_phone_number_contact_flow(
ContactFlowId,
InstanceId,
PhoneNumberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/phone-number/$(PhoneNumberId)/contact-flow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactFlowId" => ContactFlowId, "InstanceId" => InstanceId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_queue_quick_connects(instance_id, queue_id, quick_connect_ids)
associate_queue_quick_connects(instance_id, queue_id, quick_connect_ids, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Associates a
set of quick connects with a queue.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_id`: The identifier for the queue.
- `quick_connect_ids`: The quick connects to associate with this queue.
"""
function associate_queue_quick_connects(
InstanceId, QueueId, QuickConnectIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/associate-quick-connects",
Dict{String,Any}("QuickConnectIds" => QuickConnectIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_queue_quick_connects(
InstanceId,
QueueId,
QuickConnectIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/associate-quick-connects",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("QuickConnectIds" => QuickConnectIds), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_routing_profile_queues(instance_id, queue_configs, routing_profile_id)
associate_routing_profile_queues(instance_id, queue_configs, routing_profile_id, params::Dict{String,<:Any})
Associates a set of queues with a routing profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_configs`: The queues to associate with this routing profile.
- `routing_profile_id`: The identifier of the routing profile.
"""
function associate_routing_profile_queues(
InstanceId,
QueueConfigs,
RoutingProfileId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/associate-queues",
Dict{String,Any}("QueueConfigs" => QueueConfigs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_routing_profile_queues(
InstanceId,
QueueConfigs,
RoutingProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/associate-queues",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueueConfigs" => QueueConfigs), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_security_key(instance_id, key)
associate_security_key(instance_id, key, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Associates a
security key to the instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `key`: A valid security key in PEM format.
"""
function associate_security_key(
InstanceId, Key; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/instance/$(InstanceId)/security-key",
Dict{String,Any}("Key" => Key);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_security_key(
InstanceId,
Key,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/security-key",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Key" => Key), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_traffic_distribution_group_user(instance_id, traffic_distribution_group_id, user_id)
associate_traffic_distribution_group_user(instance_id, traffic_distribution_group_id, user_id, params::Dict{String,<:Any})
Associates an agent with a traffic distribution group.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `traffic_distribution_group_id`: The identifier of the traffic distribution group. This
can be the ID or the ARN if the API is being called in the Region where the traffic
distribution group was created. The ARN must be provided if the call is from the replicated
Region.
- `user_id`: The identifier of the user account. This can be the ID or the ARN of the user.
"""
function associate_traffic_distribution_group_user(
InstanceId,
TrafficDistributionGroupId,
UserId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/traffic-distribution-group/$(TrafficDistributionGroupId)/user",
Dict{String,Any}("InstanceId" => InstanceId, "UserId" => UserId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_traffic_distribution_group_user(
InstanceId,
TrafficDistributionGroupId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/traffic-distribution-group/$(TrafficDistributionGroupId)/user",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "UserId" => UserId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_user_proficiencies(instance_id, user_id, user_proficiencies)
associate_user_proficiencies(instance_id, user_id, user_proficiencies, params::Dict{String,<:Any})
>Associates a set of proficiencies with a user.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN of the instance).
- `user_id`: The identifier of the user account.
- `user_proficiencies`: The proficiencies to associate with the user.
"""
function associate_user_proficiencies(
InstanceId, UserId, UserProficiencies; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/associate-proficiencies",
Dict{String,Any}("UserProficiencies" => UserProficiencies);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_user_proficiencies(
InstanceId,
UserId,
UserProficiencies,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/associate-proficiencies",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("UserProficiencies" => UserProficiencies), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_associate_analytics_data_set(data_set_ids, instance_id)
batch_associate_analytics_data_set(data_set_ids, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Associates a
list of analytics datasets for a given Amazon Connect instance to a target account. You can
associate multiple datasets in a single call.
# Arguments
- `data_set_ids`: An array of dataset identifiers to associate.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TargetAccountId"`: The identifier of the target account. Use to associate a dataset to
a different account than the one containing the Amazon Connect instance. If not specified,
by default this value is the Amazon Web Services account that has the Amazon Connect
instance.
"""
function batch_associate_analytics_data_set(
DataSetIds, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/analytics-data/instance/$(InstanceId)/associations",
Dict{String,Any}("DataSetIds" => DataSetIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_associate_analytics_data_set(
DataSetIds,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/analytics-data/instance/$(InstanceId)/associations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DataSetIds" => DataSetIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_disassociate_analytics_data_set(data_set_ids, instance_id)
batch_disassociate_analytics_data_set(data_set_ids, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Removes a list
of analytics datasets associated with a given Amazon Connect instance. You can disassociate
multiple datasets in a single call.
# Arguments
- `data_set_ids`: An array of associated dataset identifiers to remove.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TargetAccountId"`: The identifier of the target account. Use to disassociate a dataset
from a different account than the one containing the Amazon Connect instance. If not
specified, by default this value is the Amazon Web Services account that has the Amazon
Connect instance.
"""
function batch_disassociate_analytics_data_set(
DataSetIds, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/analytics-data/instance/$(InstanceId)/associations",
Dict{String,Any}("DataSetIds" => DataSetIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_disassociate_analytics_data_set(
DataSetIds,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/analytics-data/instance/$(InstanceId)/associations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DataSetIds" => DataSetIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_attached_file_metadata(file_ids, instance_id, associated_resource_arn)
batch_get_attached_file_metadata(file_ids, instance_id, associated_resource_arn, params::Dict{String,<:Any})
Allows you to retrieve metadata about multiple attached files on an associated resource.
Each attached file provided in the input list must be associated with the input
AssociatedResourceArn.
# Arguments
- `file_ids`: The unique identifiers of the attached file resource.
- `instance_id`: The unique identifier of the Connect instance.
- `associated_resource_arn`: The resource to which the attached file is (being) uploaded
to. Cases are the only current supported resource. This value must be a valid ARN.
"""
function batch_get_attached_file_metadata(
FileIds,
InstanceId,
associatedResourceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/attached-files/$(InstanceId)",
Dict{String,Any}(
"FileIds" => FileIds, "associatedResourceArn" => associatedResourceArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_attached_file_metadata(
FileIds,
InstanceId,
associatedResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/attached-files/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileIds" => FileIds, "associatedResourceArn" => associatedResourceArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_flow_association(instance_id, resource_ids)
batch_get_flow_association(instance_id, resource_ids, params::Dict{String,<:Any})
Retrieve the flow associations for the given resources.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `resource_ids`: A list of resource identifiers to retrieve flow associations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceType"`: The type of resource association.
"""
function batch_get_flow_association(
InstanceId, ResourceIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/flow-associations-batch/$(InstanceId)",
Dict{String,Any}("ResourceIds" => ResourceIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_flow_association(
InstanceId,
ResourceIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/flow-associations-batch/$(InstanceId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceIds" => ResourceIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_put_contact(contact_data_request_list, instance_id)
batch_put_contact(contact_data_request_list, instance_id, params::Dict{String,<:Any})
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role
in your account and call this API. Allows you to create a batch of contacts in Amazon
Connect. The outbound campaigns capability ingests dial requests via the
PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to
those dial requests. If agents are available, the dial requests are dialed out, which
results in a voice call. The resulting voice call uses the same contactId that was created
by BatchPutContact.
# Arguments
- `contact_data_request_list`: List of individual contact requests.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function batch_put_contact(
ContactDataRequestList, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/contact/batch/$(InstanceId)",
Dict{String,Any}(
"ContactDataRequestList" => ContactDataRequestList,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_contact(
ContactDataRequestList,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact/batch/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactDataRequestList" => ContactDataRequestList,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
claim_phone_number(phone_number)
claim_phone_number(phone_number, params::Dict{String,<:Any})
Claims an available phone number to your Amazon Connect instance or traffic distribution
group. You can call this API only in the same Amazon Web Services Region where the Amazon
Connect instance or traffic distribution group was created. For more information about how
to use this operation, see Claim a phone number in your country and Claim phone numbers to
traffic distribution groups in the Amazon Connect Administrator Guide. You can call the
SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the
DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If
you plan to claim and release numbers frequently, contact us for a service quota exception.
Otherwise, it is possible you will be blocked from claiming and releasing any more numbers
until up to 180 days past the oldest number released has expired. By default you can claim
and release up to 200% of your maximum number of active phone numbers. If you claim and
release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200%
of your phone number service level quota, you will be blocked from claiming any more
numbers until 180 days past the oldest number released has expired. For example, if you
already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any
180 day period you release 99, claim 99, and then release 99, you will have exceeded the
200% limit. At that point you are blocked from claiming any more numbers until you open an
Amazon Web Services support ticket.
# Arguments
- `phone_number`: The phone number you want to claim. Phone numbers are formatted [+]
[country code] [subscriber number including area code].
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent
APIs. Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
- `"InstanceId"`: The identifier of the Amazon Connect instance that phone numbers are
claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
You must enter InstanceId or TargetArn.
- `"PhoneNumberDescription"`: The description of the phone number.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
- `"TargetArn"`: The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
distribution groups that phone number inbound traffic is routed through. You must enter
InstanceId or TargetArn.
"""
function claim_phone_number(PhoneNumber; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"POST",
"/phone-number/claim",
Dict{String,Any}("PhoneNumber" => PhoneNumber, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function claim_phone_number(
PhoneNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/phone-number/claim",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PhoneNumber" => PhoneNumber, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
complete_attached_file_upload(file_id, instance_id, associated_resource_arn)
complete_attached_file_upload(file_id, instance_id, associated_resource_arn, params::Dict{String,<:Any})
Allows you to confirm that the attached file has been uploaded using the pre-signed URL
provided in the StartAttachedFileUpload API.
# Arguments
- `file_id`: The unique identifier of the attached file resource.
- `instance_id`: The unique identifier of the Connect instance.
- `associated_resource_arn`: The resource to which the attached file is (being) uploaded
to. Cases are the only current supported resource. This value must be a valid ARN.
"""
function complete_attached_file_upload(
FileId,
InstanceId,
associatedResourceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/attached-files/$(InstanceId)/$(FileId)",
Dict{String,Any}("associatedResourceArn" => associatedResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function complete_attached_file_upload(
FileId,
InstanceId,
associatedResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/attached-files/$(InstanceId)/$(FileId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("associatedResourceArn" => associatedResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_agent_status(instance_id, name, state)
create_agent_status(instance_id, name, state, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Creates an
agent status for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the status.
- `state`: The state of the status.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the status.
- `"DisplayOrder"`: The display order of the status.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_agent_status(
InstanceId, Name, State; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/agent-status/$(InstanceId)",
Dict{String,Any}("Name" => Name, "State" => State);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_agent_status(
InstanceId,
Name,
State,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/agent-status/$(InstanceId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Name" => Name, "State" => State), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_contact_flow(content, instance_id, name, type)
create_contact_flow(content, instance_id, name, type, params::Dict{String,<:Any})
Creates a flow for the specified Amazon Connect instance. You can also create and update
flows using the Amazon Connect Flow language.
# Arguments
- `content`: The JSON string that represents the content of the flow. For an example, see
Example flow in Amazon Connect Flow language. Length Constraints: Minimum length of 1.
Maximum length of 256000.
- `instance_id`: The identifier of the Amazon Connect instance.
- `name`: The name of the flow.
- `type`: The type of the flow. For descriptions of the available types, see Choose a flow
type in the Amazon Connect Administrator Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the flow.
- `"Status"`: Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status
will initiate validation on the content. the SAVED status does not initiate validation of
the content. SAVED | PUBLISHED.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_contact_flow(
Content, InstanceId, Name, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/contact-flows/$(InstanceId)",
Dict{String,Any}("Content" => Content, "Name" => Name, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_contact_flow(
Content,
InstanceId,
Name,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact-flows/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Content" => Content, "Name" => Name, "Type" => Type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_contact_flow_module(content, instance_id, name)
create_contact_flow_module(content, instance_id, name, params::Dict{String,<:Any})
Creates a flow module for the specified Amazon Connect instance.
# Arguments
- `content`: The JSON string that represents the content of the flow. For an example, see
Example flow in Amazon Connect Flow language.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the flow module.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"Description"`: The description of the flow module.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_contact_flow_module(
Content, InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/contact-flow-modules/$(InstanceId)",
Dict{String,Any}(
"Content" => Content, "Name" => Name, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_contact_flow_module(
Content,
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact-flow-modules/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Content" => Content, "Name" => Name, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_evaluation_form(instance_id, items, title)
create_evaluation_form(instance_id, items, title, params::Dict{String,<:Any})
Creates an evaluation form in the specified Amazon Connect instance. The form can be used
to define questions related to agent performance, and create sections to organize such
questions. Question and section identifiers cannot be duplicated within the same evaluation
form.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `items`: Items that are part of the evaluation form. The total number of sections and
questions must not exceed 100 each. Questions must be contained in a section.
- `title`: A title of the evaluation form.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"Description"`: The description of the evaluation form.
- `"ScoringStrategy"`: A scoring strategy of the evaluation form.
"""
function create_evaluation_form(
InstanceId, Items, Title; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/evaluation-forms/$(InstanceId)",
Dict{String,Any}(
"Items" => Items, "Title" => Title, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_evaluation_form(
InstanceId,
Items,
Title,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/evaluation-forms/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Items" => Items, "Title" => Title, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_hours_of_operation(config, instance_id, name, time_zone)
create_hours_of_operation(config, instance_id, name, time_zone, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Creates hours
of operation.
# Arguments
- `config`: Configuration information for the hours of operation: day, start time, and end
time.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the hours of operation.
- `time_zone`: The time zone of the hours of operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the hours of operation.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_hours_of_operation(
Config, InstanceId, Name, TimeZone; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/hours-of-operations/$(InstanceId)",
Dict{String,Any}("Config" => Config, "Name" => Name, "TimeZone" => TimeZone);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_hours_of_operation(
Config,
InstanceId,
Name,
TimeZone,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/hours-of-operations/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Config" => Config, "Name" => Name, "TimeZone" => TimeZone
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance(identity_management_type, inbound_calls_enabled, outbound_calls_enabled)
create_instance(identity_management_type, inbound_calls_enabled, outbound_calls_enabled, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Initiates an
Amazon Connect instance with all the supported channels enabled. It does not attach any
storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does
not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or
delete in 30 days. If you exceed this limit, you will get an error message indicating there
has been an excessive number of attempts at creating or deleting instances. You must wait
30 days before you can restart creating and deleting instances in your account.
# Arguments
- `identity_management_type`: The type of identity management for your Amazon Connect users.
- `inbound_calls_enabled`: Your contact center handles incoming contacts.
- `outbound_calls_enabled`: Your contact center allows outbound calls.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: The idempotency token.
- `"DirectoryId"`: The identifier for the directory.
- `"InstanceAlias"`: The name for your instance.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_instance(
IdentityManagementType,
InboundCallsEnabled,
OutboundCallsEnabled;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance",
Dict{String,Any}(
"IdentityManagementType" => IdentityManagementType,
"InboundCallsEnabled" => InboundCallsEnabled,
"OutboundCallsEnabled" => OutboundCallsEnabled,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instance(
IdentityManagementType,
InboundCallsEnabled,
OutboundCallsEnabled,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityManagementType" => IdentityManagementType,
"InboundCallsEnabled" => InboundCallsEnabled,
"OutboundCallsEnabled" => OutboundCallsEnabled,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_integration_association(instance_id, integration_arn, integration_type)
create_integration_association(instance_id, integration_arn, integration_type, params::Dict{String,<:Any})
Creates an Amazon Web Services resource association with an Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `integration_arn`: The Amazon Resource Name (ARN) of the integration. When integrating
with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same
account.
- `integration_type`: The type of information to be ingested.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SourceApplicationName"`: The name of the external application. This field is only
required for the EVENT integration type.
- `"SourceApplicationUrl"`: The URL for the external application. This field is only
required for the EVENT integration type.
- `"SourceType"`: The type of the data source. This field is only required for the EVENT
integration type.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_integration_association(
InstanceId,
IntegrationArn,
IntegrationType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/integration-associations",
Dict{String,Any}(
"IntegrationArn" => IntegrationArn, "IntegrationType" => IntegrationType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_integration_association(
InstanceId,
IntegrationArn,
IntegrationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/integration-associations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IntegrationArn" => IntegrationArn, "IntegrationType" => IntegrationType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_participant(contact_id, instance_id, participant_details)
create_participant(contact_id, instance_id, participant_details, params::Dict{String,<:Any})
Adds a new participant into an on-going chat contact. For more information, see Customize
chat flow experiences by integrating custom participants.
# Arguments
- `contact_id`: The identifier of the contact in this instance of Amazon Connect. Only
contacts in the CHAT channel are supported.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `participant_details`: Information identifying the participant. The only Valid value for
ParticipantRole is CUSTOM_BOT. DisplayName is Required.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function create_participant(
ContactId,
InstanceId,
ParticipantDetails;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/create-participant",
Dict{String,Any}(
"ContactId" => ContactId,
"InstanceId" => InstanceId,
"ParticipantDetails" => ParticipantDetails,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_participant(
ContactId,
InstanceId,
ParticipantDetails,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/create-participant",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"InstanceId" => InstanceId,
"ParticipantDetails" => ParticipantDetails,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_persistent_contact_association(initial_contact_id, instance_id, rehydration_type, source_contact_id)
create_persistent_contact_association(initial_contact_id, instance_id, rehydration_type, source_contact_id, params::Dict{String,<:Any})
Enables rehydration of chats for the lifespan of a contact. For more information about chat
rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
# Arguments
- `initial_contact_id`: This is the contactId of the current contact that the
CreatePersistentContactAssociation API is being called from.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `rehydration_type`: The contactId chosen for rehydration depends on the type chosen.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact
of the specified past ended chat session. To use this type, provide the initialContactId of
the past ended chat session in the sourceContactId field. In this type, Amazon Connect
determines what the most recent chat contact on the past ended chat session and uses it to
start a persistent chat. FROM_SEGMENT: Rehydrates a chat from the specified past chat
contact provided in the sourceContactId field. The actual contactId used for rehydration
is provided in the response of this API. To illustrate how to use rehydration type,
consider the following example: A customer starts a chat session. Agent a1 accepts the chat
and a conversation starts between the customer and Agent a1. This first contact creates a
contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact
ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect
flow for a post chat survey that creates another contact ID C3. After the chat survey, the
chat session ends. Later, the customer returns and wants to resume their past chat session.
At this point, the customer can have following use cases: Use Case 1: The customer
wants to continue the past chat session but they want to hide the post chat survey. For
this they will use the following configuration: Configuration SourceContactId =
\"C2\" RehydrationType = \"FROM_SEGMENT\" Expected behavior This starts a
persistent chat session from the specified past ended contact (C2). Transcripts of past
chat sessions C2 and C1 are accessible in the current persistent chat session. Note that
chat segment C3 is dropped from the persistent chat session. Use Case 2: The
customer wants to continue the past chat session and see the transcript of the entire past
engagement, including the post chat survey. For this they will use the following
configuration: Configuration SourceContactId = \"C1\" RehydrationType =
\"ENTIRE_PAST_SESSION\" Expected behavior This starts a persistent chat session
from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2
and C1 are accessible in the current persistent chat session.
- `source_contact_id`: The contactId from which a persistent chat session must be started.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function create_persistent_contact_association(
InitialContactId,
InstanceId,
RehydrationType,
SourceContactId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/persistent-contact-association/$(InstanceId)/$(InitialContactId)",
Dict{String,Any}(
"RehydrationType" => RehydrationType, "SourceContactId" => SourceContactId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_persistent_contact_association(
InitialContactId,
InstanceId,
RehydrationType,
SourceContactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/persistent-contact-association/$(InstanceId)/$(InitialContactId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RehydrationType" => RehydrationType,
"SourceContactId" => SourceContactId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_predefined_attribute(instance_id, name, values)
create_predefined_attribute(instance_id, name, values, params::Dict{String,<:Any})
Creates a new predefined attribute for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the predefined attribute.
- `values`: The values of the predefined attribute.
"""
function create_predefined_attribute(
InstanceId, Name, Values; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/predefined-attributes/$(InstanceId)",
Dict{String,Any}("Name" => Name, "Values" => Values);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_predefined_attribute(
InstanceId,
Name,
Values,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/predefined-attributes/$(InstanceId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Name" => Name, "Values" => Values), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_prompt(instance_id, name, s3_uri)
create_prompt(instance_id, name, s3_uri, params::Dict{String,<:Any})
Creates a prompt. For more information about prompts, such as supported file types and
maximum length, see Create prompts in the Amazon Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the prompt.
- `s3_uri`: The URI for the S3 bucket where the prompt is stored. You can provide S3
pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the prompt.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_prompt(
InstanceId, Name, S3Uri; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/prompts/$(InstanceId)",
Dict{String,Any}("Name" => Name, "S3Uri" => S3Uri);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_prompt(
InstanceId,
Name,
S3Uri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/prompts/$(InstanceId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Name" => Name, "S3Uri" => S3Uri), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_queue(hours_of_operation_id, instance_id, name)
create_queue(hours_of_operation_id, instance_id, name, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Creates a new
queue for the specified Amazon Connect instance. If the phone number is claimed to a
traffic distribution group that was created in the same Region as the Amazon Connect
instance where you are calling this API, then you can use a full phone number ARN or a UUID
for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic
distribution group that is in one Region, and you are calling this API from an instance in
another Amazon Web Services Region that is associated with the traffic distribution group,
you must provide a full phone number ARN. If a UUID is provided in this scenario, you will
receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't
contain instance in the path, for example,
arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is
returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to
allow/deny access to this API for phone number resources claimed to a traffic distribution
group, see Allow or Deny queue API actions for phone numbers in a replica Region.
# Arguments
- `hours_of_operation_id`: The identifier for the hours of operation.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the queue.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the queue.
- `"MaxContacts"`: The maximum number of contacts that can be in the queue before it is
considered full.
- `"OutboundCallerConfig"`: The outbound caller ID name, number, and outbound whisper flow.
- `"QuickConnectIds"`: The quick connects available to agents who are working the queue.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_queue(
HoursOfOperationId, InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/queues/$(InstanceId)",
Dict{String,Any}("HoursOfOperationId" => HoursOfOperationId, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_queue(
HoursOfOperationId,
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/queues/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HoursOfOperationId" => HoursOfOperationId, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_quick_connect(instance_id, name, quick_connect_config)
create_quick_connect(instance_id, name, quick_connect_config, params::Dict{String,<:Any})
Creates a quick connect for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: A unique name of the quick connect.
- `quick_connect_config`: Configuration settings for the quick connect.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the quick connect.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_quick_connect(
InstanceId, Name, QuickConnectConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/quick-connects/$(InstanceId)",
Dict{String,Any}("Name" => Name, "QuickConnectConfig" => QuickConnectConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_quick_connect(
InstanceId,
Name,
QuickConnectConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/quick-connects/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "QuickConnectConfig" => QuickConnectConfig
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_routing_profile(default_outbound_queue_id, description, instance_id, media_concurrencies, name)
create_routing_profile(default_outbound_queue_id, description, instance_id, media_concurrencies, name, params::Dict{String,<:Any})
Creates a new routing profile.
# Arguments
- `default_outbound_queue_id`: The default outbound queue for the routing profile.
- `description`: Description of the routing profile. Must not be more than 250 characters.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `media_concurrencies`: The channels that agents can handle in the Contact Control Panel
(CCP) for this routing profile.
- `name`: The name of the routing profile. Must not be more than 127 characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentAvailabilityTimer"`: Whether agents with this routing profile will have their
routing order calculated based on longest idle time or time since their last inbound
contact.
- `"QueueConfigs"`: The inbound queues associated with the routing profile. If no queue is
added, the agent can make only outbound calls. The limit of 10 array members applies to the
maximum number of RoutingProfileQueueConfig objects that can be passed during a
CreateRoutingProfile API request. It is different from the quota of 50 queues per routing
profile per instance that is listed in Amazon Connect service quotas.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_routing_profile(
DefaultOutboundQueueId,
Description,
InstanceId,
MediaConcurrencies,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/routing-profiles/$(InstanceId)",
Dict{String,Any}(
"DefaultOutboundQueueId" => DefaultOutboundQueueId,
"Description" => Description,
"MediaConcurrencies" => MediaConcurrencies,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_routing_profile(
DefaultOutboundQueueId,
Description,
InstanceId,
MediaConcurrencies,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/routing-profiles/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DefaultOutboundQueueId" => DefaultOutboundQueueId,
"Description" => Description,
"MediaConcurrencies" => MediaConcurrencies,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule(actions, function, instance_id, name, publish_status, trigger_event_source)
create_rule(actions, function, instance_id, name, publish_status, trigger_event_source, params::Dict{String,<:Any})
Creates a rule for the specified Amazon Connect instance. Use the Rules Function language
to code conditions for the rule.
# Arguments
- `actions`: A list of actions to be run when the rule is triggered.
- `function`: The conditions of the rule.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: A unique name for the rule.
- `publish_status`: The publish status of the rule.
- `trigger_event_source`: The event source to trigger the rule.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function create_rule(
Actions,
Function,
InstanceId,
Name,
PublishStatus,
TriggerEventSource;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/rules/$(InstanceId)",
Dict{String,Any}(
"Actions" => Actions,
"Function" => Function,
"Name" => Name,
"PublishStatus" => PublishStatus,
"TriggerEventSource" => TriggerEventSource,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule(
Actions,
Function,
InstanceId,
Name,
PublishStatus,
TriggerEventSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/rules/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Actions" => Actions,
"Function" => Function,
"Name" => Name,
"PublishStatus" => PublishStatus,
"TriggerEventSource" => TriggerEventSource,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_security_profile(instance_id, security_profile_name)
create_security_profile(instance_id, security_profile_name, params::Dict{String,<:Any})
Creates a security profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `security_profile_name`: The name of the security profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowedAccessControlHierarchyGroupId"`: The identifier of the hierarchy group that a
security profile uses to restrict access to resources in Amazon Connect.
- `"AllowedAccessControlTags"`: The list of tags that a security profile uses to restrict
access to resources in Amazon Connect.
- `"Applications"`: A list of third-party applications that the security profile will give
access to.
- `"Description"`: The description of the security profile.
- `"HierarchyRestrictedResources"`: The list of resources that a security profile applies
hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.
- `"Permissions"`: Permissions assigned to the security profile. For a list of valid
permissions, see List of security profile permissions.
- `"TagRestrictedResources"`: The list of resources that a security profile applies tag
restrictions to in Amazon Connect. Following are acceptable ResourceNames: User |
SecurityProfile | Queue | RoutingProfile
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_security_profile(
InstanceId, SecurityProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/security-profiles/$(InstanceId)",
Dict{String,Any}("SecurityProfileName" => SecurityProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_security_profile(
InstanceId,
SecurityProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/security-profiles/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SecurityProfileName" => SecurityProfileName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_task_template(fields, instance_id, name)
create_task_template(fields, instance_id, name, params::Dict{String,<:Any})
Creates a new task template in the specified Amazon Connect instance.
# Arguments
- `fields`: Fields that are part of the template.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the task 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"Constraints"`: Constraints that are applicable to the fields listed.
- `"ContactFlowId"`: The identifier of the flow that runs by default when a task is created
by referencing this template.
- `"Defaults"`: The default values for fields when a task is created by referencing this
template.
- `"Description"`: The description of the task template.
- `"Status"`: Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task
that refers to this template cannot be created.
"""
function create_task_template(
Fields, InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/instance/$(InstanceId)/task/template",
Dict{String,Any}(
"Fields" => Fields, "Name" => Name, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_task_template(
Fields,
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/task/template",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Fields" => Fields, "Name" => Name, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_traffic_distribution_group(instance_id, name)
create_traffic_distribution_group(instance_id, name, params::Dict{String,<:Any})
Creates a traffic distribution group given an Amazon Connect instance that has been
replicated. The SignInConfig distribution is available only on a default
TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data
type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default
TrafficDistributionGroup, an InvalidRequestException is returned. For more information
about creating traffic distribution groups, see Set up traffic distribution groups in the
Amazon Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance that has been replicated.
You can find the instanceId in the ARN of the instance.
- `name`: The name for the traffic distribution group.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"Description"`: A description for the traffic distribution group.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_traffic_distribution_group(
InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/traffic-distribution-group",
Dict{String,Any}(
"InstanceId" => InstanceId, "Name" => Name, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_traffic_distribution_group(
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/traffic-distribution-group",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceId" => InstanceId,
"Name" => Name,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_use_case(instance_id, integration_association_id, use_case_type)
create_use_case(instance_id, integration_association_id, use_case_type, params::Dict{String,<:Any})
Creates a use case for an integration association.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `integration_association_id`: The identifier for the integration association.
- `use_case_type`: The type of use case to associate to the integration association. Each
integration association can have only one of each use case type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_use_case(
InstanceId,
IntegrationAssociationId,
UseCaseType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/integration-associations/$(IntegrationAssociationId)/use-cases",
Dict{String,Any}("UseCaseType" => UseCaseType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_use_case(
InstanceId,
IntegrationAssociationId,
UseCaseType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/instance/$(InstanceId)/integration-associations/$(IntegrationAssociationId)/use-cases",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UseCaseType" => UseCaseType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(instance_id, phone_config, routing_profile_id, security_profile_ids, username)
create_user(instance_id, phone_config, routing_profile_id, security_profile_ids, username, params::Dict{String,<:Any})
Creates a user account for the specified Amazon Connect instance. Certain UserIdentityInfo
parameters are required in some situations. For example, Email is required if you are using
SAML for identity management. FirstName and LastName are required if you are using Amazon
Connect or SAML for identity management. For information about how to create users using
the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `phone_config`: The phone settings for the user.
- `routing_profile_id`: The identifier of the routing profile for the user.
- `security_profile_ids`: The identifier of the security profile for the user.
- `username`: The user name for the account. For instances not using SAML for identity
management, the user name can include up to 20 characters. If you are using SAML for
identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.@]+.
Username can include @ only if used in an email format. For example: Correct: testuser
Correct: [email protected] Incorrect: testuser@example
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DirectoryUserId"`: The identifier of the user account in the directory used for
identity management. If Amazon Connect cannot access the directory, you can specify this
identifier to authenticate users. If you include the identifier, we assume that Amazon
Connect cannot access the directory. Otherwise, the identity information is used to
authenticate users from your directory. This parameter is required if you are using an
existing directory for identity management in Amazon Connect when Amazon Connect cannot
access your directory to authenticate users. If you are using SAML for identity management
and include this parameter, an error is returned.
- `"HierarchyGroupId"`: The identifier of the hierarchy group for the user.
- `"IdentityInfo"`: The information about the identity of the user.
- `"Password"`: The password for the user account. A password is required if you are using
Amazon Connect for identity management. Otherwise, it is an error to include a password.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_user(
InstanceId,
PhoneConfig,
RoutingProfileId,
SecurityProfileIds,
Username;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/users/$(InstanceId)",
Dict{String,Any}(
"PhoneConfig" => PhoneConfig,
"RoutingProfileId" => RoutingProfileId,
"SecurityProfileIds" => SecurityProfileIds,
"Username" => Username,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
InstanceId,
PhoneConfig,
RoutingProfileId,
SecurityProfileIds,
Username,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/users/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PhoneConfig" => PhoneConfig,
"RoutingProfileId" => RoutingProfileId,
"SecurityProfileIds" => SecurityProfileIds,
"Username" => Username,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_hierarchy_group(instance_id, name)
create_user_hierarchy_group(instance_id, name, params::Dict{String,<:Any})
Creates a new user hierarchy group.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the user hierarchy group. Must not be more than 100 characters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ParentGroupId"`: The identifier for the parent hierarchy group. The user hierarchy is
created at level one if the parent group ID is null.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_user_hierarchy_group(
InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/user-hierarchy-groups/$(InstanceId)",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_hierarchy_group(
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/user-hierarchy-groups/$(InstanceId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_view(content, instance_id, name, status)
create_view(content, instance_id, name, status, params::Dict{String,<:Any})
Creates a new view with the possible status of SAVED or PUBLISHED. The views will have a
unique name for each connect instance. It performs basic content validation if the status
is SAVED or full content validation if the status is set to PUBLISHED. An error is returned
if validation fails. It associates either the SAVED qualifier or both of the SAVED and
LATEST qualifiers with the provided view content based on the status. The view is
idempotent if ClientToken is provided.
# Arguments
- `content`: View content containing all content necessary to render a view except for
runtime input data. The total uncompressed content has a maximum file size of 400kB.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
- `name`: The name of the view.
- `status`: Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status
will initiate validation on the content.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique Id for each create view request to avoid duplicate view
creation. For example, the view is idempotent ClientToken is provided.
- `"Description"`: The description of the view.
- `"Tags"`: The tags associated with the view resource (not specific to view version).These
tags can be used to organize, track, or control access for this resource. For example, {
\"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_view(
Content, InstanceId, Name, Status; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/views/$(InstanceId)",
Dict{String,Any}("Content" => Content, "Name" => Name, "Status" => Status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_view(
Content,
InstanceId,
Name,
Status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/views/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Content" => Content, "Name" => Name, "Status" => Status),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_view_version(instance_id, view_id)
create_view_version(instance_id, view_id, params::Dict{String,<:Any})
Publishes a new version of the view identifier. Versions are immutable and monotonically
increasing. It returns the highest version if there is no change in content compared to
that version. An error is displayed if the supplied ViewContentSha256 is different from the
ViewContentSha256 of the LATEST alias.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
- `view_id`: The identifier of the view. Both ViewArn and ViewId can be used.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"VersionDescription"`: The description for the version being published.
- `"ViewContentSha256"`: Indicates the checksum value of the latest published view content.
"""
function create_view_version(
InstanceId, ViewId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/views/$(InstanceId)/$(ViewId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_view_version(
InstanceId,
ViewId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/views/$(InstanceId)/$(ViewId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vocabulary(content, instance_id, language_code, vocabulary_name)
create_vocabulary(content, instance_id, language_code, vocabulary_name, params::Dict{String,<:Any})
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a
custom vocabulary to be your default vocabulary for a given language. Contact Lens for
Amazon Connect uses the default vocabulary in post-call and real-time contact analysis
sessions for that language.
# Arguments
- `content`: The content of the custom vocabulary in plain-text format with a table of
values. Each row in the table represents a word or a phrase, described with Phrase, IPA,
SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit
is 50KB. For more information, see Create a custom vocabulary using a table.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `language_code`: The language code of the vocabulary entries. For a list of languages and
their corresponding language codes, see What is Amazon Transcribe?
- `vocabulary_name`: A unique name of the custom vocabulary.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent
APIs. If a create request is received more than once with same client token, subsequent
requests return the previous response without creating a vocabulary again.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function create_vocabulary(
Content,
InstanceId,
LanguageCode,
VocabularyName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/vocabulary/$(InstanceId)",
Dict{String,Any}(
"Content" => Content,
"LanguageCode" => LanguageCode,
"VocabularyName" => VocabularyName,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vocabulary(
Content,
InstanceId,
LanguageCode,
VocabularyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/vocabulary/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Content" => Content,
"LanguageCode" => LanguageCode,
"VocabularyName" => VocabularyName,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deactivate_evaluation_form(evaluation_form_id, evaluation_form_version, instance_id)
deactivate_evaluation_form(evaluation_form_id, evaluation_form_version, instance_id, params::Dict{String,<:Any})
Deactivates an evaluation form in the specified Amazon Connect instance. After a form is
deactivated, it is no longer available for users to start new evaluations based on the
form.
# Arguments
- `evaluation_form_id`: The unique identifier for the evaluation form.
- `evaluation_form_version`: A version of the evaluation form. If the version property is
not provided, the latest version of the evaluation form is deactivated.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function deactivate_evaluation_form(
EvaluationFormId,
EvaluationFormVersion,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)/deactivate",
Dict{String,Any}("EvaluationFormVersion" => EvaluationFormVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deactivate_evaluation_form(
EvaluationFormId,
EvaluationFormVersion,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)/deactivate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EvaluationFormVersion" => EvaluationFormVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_attached_file(file_id, instance_id, associated_resource_arn)
delete_attached_file(file_id, instance_id, associated_resource_arn, params::Dict{String,<:Any})
Deletes an attached file along with the underlying S3 Object. The attached file is
permanently deleted if S3 bucket versioning is not enabled.
# Arguments
- `file_id`: The unique identifier of the attached file resource.
- `instance_id`: The unique identifier of the Connect instance.
- `associated_resource_arn`: The resource to which the attached file is (being) uploaded
to. Cases are the only current supported resource. This value must be a valid ARN.
"""
function delete_attached_file(
FileId,
InstanceId,
associatedResourceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/attached-files/$(InstanceId)/$(FileId)",
Dict{String,Any}("associatedResourceArn" => associatedResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_attached_file(
FileId,
InstanceId,
associatedResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/attached-files/$(InstanceId)/$(FileId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("associatedResourceArn" => associatedResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_contact_evaluation(evaluation_id, instance_id)
delete_contact_evaluation(evaluation_id, instance_id, params::Dict{String,<:Any})
Deletes a contact evaluation in the specified Amazon Connect instance.
# Arguments
- `evaluation_id`: A unique identifier for the contact evaluation.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function delete_contact_evaluation(
EvaluationId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/contact-evaluations/$(InstanceId)/$(EvaluationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_contact_evaluation(
EvaluationId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/contact-evaluations/$(InstanceId)/$(EvaluationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_contact_flow(contact_flow_id, instance_id)
delete_contact_flow(contact_flow_id, instance_id, params::Dict{String,<:Any})
Deletes a flow for the specified Amazon Connect instance.
# Arguments
- `contact_flow_id`: The identifier of the flow.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function delete_contact_flow(
ContactFlowId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/contact-flows/$(InstanceId)/$(ContactFlowId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_contact_flow(
ContactFlowId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/contact-flows/$(InstanceId)/$(ContactFlowId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_contact_flow_module(contact_flow_module_id, instance_id)
delete_contact_flow_module(contact_flow_module_id, instance_id, params::Dict{String,<:Any})
Deletes the specified flow module.
# Arguments
- `contact_flow_module_id`: The identifier of the flow module.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function delete_contact_flow_module(
ContactFlowModuleId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/contact-flow-modules/$(InstanceId)/$(ContactFlowModuleId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_contact_flow_module(
ContactFlowModuleId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/contact-flow-modules/$(InstanceId)/$(ContactFlowModuleId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_evaluation_form(evaluation_form_id, instance_id)
delete_evaluation_form(evaluation_form_id, instance_id, params::Dict{String,<:Any})
Deletes an evaluation form in the specified Amazon Connect instance. If the version
property is provided, only the specified version of the evaluation form is deleted. If no
version is provided, then the full form (all versions) is deleted.
# Arguments
- `evaluation_form_id`: The unique identifier for the evaluation form.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The unique identifier for the evaluation form.
"""
function delete_evaluation_form(
EvaluationFormId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_evaluation_form(
EvaluationFormId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_hours_of_operation(hours_of_operation_id, instance_id)
delete_hours_of_operation(hours_of_operation_id, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Deletes an
hours of operation.
# Arguments
- `hours_of_operation_id`: The identifier for the hours of operation.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function delete_hours_of_operation(
HoursOfOperationId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/hours-of-operations/$(InstanceId)/$(HoursOfOperationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_hours_of_operation(
HoursOfOperationId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/hours-of-operations/$(InstanceId)/$(HoursOfOperationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance(instance_id)
delete_instance(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Deletes the
Amazon Connect instance. Amazon Connect enforces a limit on the total number of instances
that you can create or delete in 30 days. If you exceed this limit, you will get an error
message indicating there has been an excessive number of attempts at creating or deleting
instances. You must wait 30 days before you can restart creating and deleting instances in
your account.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function delete_instance(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"DELETE",
"/instance/$(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 connect(
"DELETE",
"/instance/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_integration_association(instance_id, integration_association_id)
delete_integration_association(instance_id, integration_association_id, params::Dict{String,<:Any})
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The
association must not have any use cases associated with it.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `integration_association_id`: The identifier for the integration association.
"""
function delete_integration_association(
InstanceId, IntegrationAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/instance/$(InstanceId)/integration-associations/$(IntegrationAssociationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_integration_association(
InstanceId,
IntegrationAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/instance/$(InstanceId)/integration-associations/$(IntegrationAssociationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_predefined_attribute(instance_id, name)
delete_predefined_attribute(instance_id, name, params::Dict{String,<:Any})
Deletes a predefined attribute from the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the predefined attribute.
"""
function delete_predefined_attribute(
InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/predefined-attributes/$(InstanceId)/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_predefined_attribute(
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/predefined-attributes/$(InstanceId)/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_prompt(instance_id, prompt_id)
delete_prompt(instance_id, prompt_id, params::Dict{String,<:Any})
Deletes a prompt.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `prompt_id`: A unique identifier for the prompt.
"""
function delete_prompt(
InstanceId, PromptId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/prompts/$(InstanceId)/$(PromptId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_prompt(
InstanceId,
PromptId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/prompts/$(InstanceId)/$(PromptId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_queue(instance_id, queue_id)
delete_queue(instance_id, queue_id, params::Dict{String,<:Any})
Deletes a queue.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_id`: The identifier for the queue.
"""
function delete_queue(
InstanceId, QueueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/queues/$(InstanceId)/$(QueueId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_queue(
InstanceId,
QueueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/queues/$(InstanceId)/$(QueueId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_quick_connect(instance_id, quick_connect_id)
delete_quick_connect(instance_id, quick_connect_id, params::Dict{String,<:Any})
Deletes a quick connect. After calling DeleteUser, it's important to call
DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas. Remove deleted users so they
don't appear to agents as transfer options. Avoid the disruption of other Amazon Connect
processes, such as instance replication and syncing if you're using Amazon Connect Global
Resiliency.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `quick_connect_id`: The identifier for the quick connect.
"""
function delete_quick_connect(
InstanceId, QuickConnectId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/quick-connects/$(InstanceId)/$(QuickConnectId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_quick_connect(
InstanceId,
QuickConnectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/quick-connects/$(InstanceId)/$(QuickConnectId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_routing_profile(instance_id, routing_profile_id)
delete_routing_profile(instance_id, routing_profile_id, params::Dict{String,<:Any})
Deletes a routing profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `routing_profile_id`: The identifier of the routing profile.
"""
function delete_routing_profile(
InstanceId, RoutingProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_routing_profile(
InstanceId,
RoutingProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule(instance_id, rule_id)
delete_rule(instance_id, rule_id, params::Dict{String,<:Any})
Deletes a rule for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `rule_id`: A unique identifier for the rule.
"""
function delete_rule(InstanceId, RuleId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"DELETE",
"/rules/$(InstanceId)/$(RuleId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule(
InstanceId,
RuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/rules/$(InstanceId)/$(RuleId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_security_profile(instance_id, security_profile_id)
delete_security_profile(instance_id, security_profile_id, params::Dict{String,<:Any})
Deletes a security profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `security_profile_id`: The identifier for the security profle.
"""
function delete_security_profile(
InstanceId, SecurityProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/security-profiles/$(InstanceId)/$(SecurityProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_security_profile(
InstanceId,
SecurityProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/security-profiles/$(InstanceId)/$(SecurityProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_task_template(instance_id, task_template_id)
delete_task_template(instance_id, task_template_id, params::Dict{String,<:Any})
Deletes the task template.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `task_template_id`: A unique identifier for the task template.
"""
function delete_task_template(
InstanceId, TaskTemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/instance/$(InstanceId)/task/template/$(TaskTemplateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_task_template(
InstanceId,
TaskTemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/instance/$(InstanceId)/task/template/$(TaskTemplateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_traffic_distribution_group(traffic_distribution_group_id)
delete_traffic_distribution_group(traffic_distribution_group_id, params::Dict{String,<:Any})
Deletes a traffic distribution group. This API can be called only in the Region where the
traffic distribution group is created. For more information about deleting traffic
distribution groups, see Delete traffic distribution groups in the Amazon Connect
Administrator Guide.
# Arguments
- `traffic_distribution_group_id`: The identifier of the traffic distribution group. This
can be the ID or the ARN if the API is being called in the Region where the traffic
distribution group was created. The ARN must be provided if the call is from the replicated
Region.
"""
function delete_traffic_distribution_group(
TrafficDistributionGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/traffic-distribution-group/$(TrafficDistributionGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_traffic_distribution_group(
TrafficDistributionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/traffic-distribution-group/$(TrafficDistributionGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_use_case(instance_id, integration_association_id, use_case_id)
delete_use_case(instance_id, integration_association_id, use_case_id, params::Dict{String,<:Any})
Deletes a use case from an integration association.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `integration_association_id`: The identifier for the integration association.
- `use_case_id`: The identifier for the use case.
"""
function delete_use_case(
InstanceId,
IntegrationAssociationId,
UseCaseId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/instance/$(InstanceId)/integration-associations/$(IntegrationAssociationId)/use-cases/$(UseCaseId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_use_case(
InstanceId,
IntegrationAssociationId,
UseCaseId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/instance/$(InstanceId)/integration-associations/$(IntegrationAssociationId)/use-cases/$(UseCaseId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(instance_id, user_id)
delete_user(instance_id, user_id, params::Dict{String,<:Any})
Deletes a user account from the specified Amazon Connect instance. For information about
what happens to a user's data when their account is deleted, see Delete Users from Your
Amazon Connect Instance in the Amazon Connect Administrator Guide. After calling
DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users.
This will help you: Avoid dangling resources that impact your service quotas. Remove
deleted users so they don't appear to agents as transfer options. Avoid the disruption of
other Amazon Connect processes, such as instance replication and syncing if you're using
Amazon Connect Global Resiliency.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `user_id`: The identifier of the user.
"""
function delete_user(InstanceId, UserId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"DELETE",
"/users/$(InstanceId)/$(UserId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
InstanceId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/users/$(InstanceId)/$(UserId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_hierarchy_group(hierarchy_group_id, instance_id)
delete_user_hierarchy_group(hierarchy_group_id, instance_id, params::Dict{String,<:Any})
Deletes an existing user hierarchy group. It must not be associated with any agents or have
any active child groups.
# Arguments
- `hierarchy_group_id`: The identifier of the hierarchy group.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function delete_user_hierarchy_group(
HierarchyGroupId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/user-hierarchy-groups/$(InstanceId)/$(HierarchyGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_hierarchy_group(
HierarchyGroupId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/user-hierarchy-groups/$(InstanceId)/$(HierarchyGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_view(instance_id, view_id)
delete_view(instance_id, view_id, params::Dict{String,<:Any})
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and
aliases).
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
- `view_id`: The identifier of the view. Both ViewArn and ViewId can be used.
"""
function delete_view(InstanceId, ViewId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"DELETE",
"/views/$(InstanceId)/$(ViewId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_view(
InstanceId,
ViewId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/views/$(InstanceId)/$(ViewId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_view_version(instance_id, view_id, view_version)
delete_view_version(instance_id, view_id, view_version, params::Dict{String,<:Any})
Deletes the particular version specified in ViewVersion identifier.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
- `view_id`: The identifier of the view. Both ViewArn and ViewId can be used.
- `view_version`: The version number of the view.
"""
function delete_view_version(
InstanceId, ViewId, ViewVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/views/$(InstanceId)/$(ViewId)/versions/$(ViewVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_view_version(
InstanceId,
ViewId,
ViewVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/views/$(InstanceId)/$(ViewId)/versions/$(ViewVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vocabulary(instance_id, vocabulary_id)
delete_vocabulary(instance_id, vocabulary_id, params::Dict{String,<:Any})
Deletes the vocabulary that has the given identifier.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `vocabulary_id`: The identifier of the custom vocabulary.
"""
function delete_vocabulary(
InstanceId, VocabularyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/vocabulary-remove/$(InstanceId)/$(VocabularyId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vocabulary(
InstanceId,
VocabularyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/vocabulary-remove/$(InstanceId)/$(VocabularyId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_agent_status(agent_status_id, instance_id)
describe_agent_status(agent_status_id, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Describes an
agent status.
# Arguments
- `agent_status_id`: The identifier for the agent status.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function describe_agent_status(
AgentStatusId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/agent-status/$(InstanceId)/$(AgentStatusId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_agent_status(
AgentStatusId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/agent-status/$(InstanceId)/$(AgentStatusId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_contact(contact_id, instance_id)
describe_contact(contact_id, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Describes the
specified contact. Contact information remains available in Amazon Connect for 24 months,
and then it is deleted. Only data from November 12, 2021, and later is returned by this
API.
# Arguments
- `contact_id`: The identifier of the contact.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function describe_contact(
ContactId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/contacts/$(InstanceId)/$(ContactId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_contact(
ContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/contacts/$(InstanceId)/$(ContactId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_contact_evaluation(evaluation_id, instance_id)
describe_contact_evaluation(evaluation_id, instance_id, params::Dict{String,<:Any})
Describes a contact evaluation in the specified Amazon Connect instance.
# Arguments
- `evaluation_id`: A unique identifier for the contact evaluation.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function describe_contact_evaluation(
EvaluationId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/contact-evaluations/$(InstanceId)/$(EvaluationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_contact_evaluation(
EvaluationId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/contact-evaluations/$(InstanceId)/$(EvaluationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_contact_flow(contact_flow_id, instance_id)
describe_contact_flow(contact_flow_id, instance_id, params::Dict{String,<:Any})
Describes the specified flow. You can also create and update flows using the Amazon Connect
Flow language. Use the SAVED alias in the request to describe the SAVED content of a Flow.
For example, arn:aws:.../contact-flow/{id}:SAVED. Once a contact flow is published, SAVED
needs to be supplied to view saved content that has not been published. In the response,
Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will
initiate validation on the content. SAVED does not initiate validation of the content.
SAVED | PUBLISHED
# Arguments
- `contact_flow_id`: The identifier of the flow.
- `instance_id`: The identifier of the Amazon Connect instance.
"""
function describe_contact_flow(
ContactFlowId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/contact-flows/$(InstanceId)/$(ContactFlowId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_contact_flow(
ContactFlowId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/contact-flows/$(InstanceId)/$(ContactFlowId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_contact_flow_module(contact_flow_module_id, instance_id)
describe_contact_flow_module(contact_flow_module_id, instance_id, params::Dict{String,<:Any})
Describes the specified flow module. Use the SAVED alias in the request to describe the
SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:SAVED. Once a contact
flow is published, SAVED needs to be supplied to view saved content that has not been
published.
# Arguments
- `contact_flow_module_id`: The identifier of the flow module.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function describe_contact_flow_module(
ContactFlowModuleId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/contact-flow-modules/$(InstanceId)/$(ContactFlowModuleId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_contact_flow_module(
ContactFlowModuleId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/contact-flow-modules/$(InstanceId)/$(ContactFlowModuleId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_evaluation_form(evaluation_form_id, instance_id)
describe_evaluation_form(evaluation_form_id, instance_id, params::Dict{String,<:Any})
Describes an evaluation form in the specified Amazon Connect instance. If the version
property is not provided, the latest version of the evaluation form is described.
# Arguments
- `evaluation_form_id`: A unique identifier for the contact evaluation.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: A version of the evaluation form.
"""
function describe_evaluation_form(
EvaluationFormId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_evaluation_form(
EvaluationFormId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_hours_of_operation(hours_of_operation_id, instance_id)
describe_hours_of_operation(hours_of_operation_id, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Describes the
hours of operation.
# Arguments
- `hours_of_operation_id`: The identifier for the hours of operation.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function describe_hours_of_operation(
HoursOfOperationId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/hours-of-operations/$(InstanceId)/$(HoursOfOperationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_hours_of_operation(
HoursOfOperationId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/hours-of-operations/$(InstanceId)/$(HoursOfOperationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance(instance_id)
describe_instance(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Returns the
current state of the specified instance identifier. It tracks the instance while it is
being created and returns an error status, if applicable. If an instance is not created
successfully, the instance status reason field returns details relevant to the reason. The
instance in a failed state is returned only for 24 hours after the CreateInstance API was
invoked.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function describe_instance(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/instance/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_attribute(attribute_type, instance_id)
describe_instance_attribute(attribute_type, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Describes the
specified instance attribute.
# Arguments
- `attribute_type`: The type of attribute.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function describe_instance_attribute(
AttributeType, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/instance/$(InstanceId)/attribute/$(AttributeType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_attribute(
AttributeType,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/attribute/$(AttributeType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_storage_config(association_id, instance_id, resource_type)
describe_instance_storage_config(association_id, instance_id, resource_type, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Retrieves the
current storage configurations for the specified resource type, association ID, and
instance ID.
# Arguments
- `association_id`: The existing association identifier that uniquely identifies the
resource type and storage config for the given instance ID.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `resource_type`: A valid resource type.
"""
function describe_instance_storage_config(
AssociationId,
InstanceId,
resourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/storage-config/$(AssociationId)",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_storage_config(
AssociationId,
InstanceId,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/storage-config/$(AssociationId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_phone_number(phone_number_id)
describe_phone_number(phone_number_id, params::Dict{String,<:Any})
Gets details and status of a phone number that’s claimed to your Amazon Connect instance
or traffic distribution group. If the number is claimed to a traffic distribution group,
and you are calling in the Amazon Web Services Region where the traffic distribution group
was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI
request parameter. However, if the number is claimed to a traffic distribution group and
you are calling this API in the alternate Amazon Web Services Region associated with the
traffic distribution group, you must provide a full phone number ARN. If a UUID is provided
in this scenario, you will receive a ResourceNotFoundException.
# Arguments
- `phone_number_id`: A unique identifier for the phone number.
"""
function describe_phone_number(
PhoneNumberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/phone-number/$(PhoneNumberId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_phone_number(
PhoneNumberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/phone-number/$(PhoneNumberId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_predefined_attribute(instance_id, name)
describe_predefined_attribute(instance_id, name, params::Dict{String,<:Any})
Describes a predefined attribute for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the predefined attribute.
"""
function describe_predefined_attribute(
InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/predefined-attributes/$(InstanceId)/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_predefined_attribute(
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/predefined-attributes/$(InstanceId)/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_prompt(instance_id, prompt_id)
describe_prompt(instance_id, prompt_id, params::Dict{String,<:Any})
Describes the prompt.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `prompt_id`: A unique identifier for the prompt.
"""
function describe_prompt(
InstanceId, PromptId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/prompts/$(InstanceId)/$(PromptId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_prompt(
InstanceId,
PromptId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/prompts/$(InstanceId)/$(PromptId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_queue(instance_id, queue_id)
describe_queue(instance_id, queue_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Describes the
specified queue.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_id`: The identifier for the queue.
"""
function describe_queue(
InstanceId, QueueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/queues/$(InstanceId)/$(QueueId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_queue(
InstanceId,
QueueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/queues/$(InstanceId)/$(QueueId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_quick_connect(instance_id, quick_connect_id)
describe_quick_connect(instance_id, quick_connect_id, params::Dict{String,<:Any})
Describes the quick connect.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `quick_connect_id`: The identifier for the quick connect.
"""
function describe_quick_connect(
InstanceId, QuickConnectId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/quick-connects/$(InstanceId)/$(QuickConnectId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_quick_connect(
InstanceId,
QuickConnectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/quick-connects/$(InstanceId)/$(QuickConnectId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_routing_profile(instance_id, routing_profile_id)
describe_routing_profile(instance_id, routing_profile_id, params::Dict{String,<:Any})
Describes the specified routing profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `routing_profile_id`: The identifier of the routing profile.
"""
function describe_routing_profile(
InstanceId, RoutingProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_routing_profile(
InstanceId,
RoutingProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_rule(instance_id, rule_id)
describe_rule(instance_id, rule_id, params::Dict{String,<:Any})
Describes a rule for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `rule_id`: A unique identifier for the rule.
"""
function describe_rule(
InstanceId, RuleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/rules/$(InstanceId)/$(RuleId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_rule(
InstanceId,
RuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/rules/$(InstanceId)/$(RuleId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_security_profile(instance_id, security_profile_id)
describe_security_profile(instance_id, security_profile_id, params::Dict{String,<:Any})
Gets basic information about the security profle.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `security_profile_id`: The identifier for the security profle.
"""
function describe_security_profile(
InstanceId, SecurityProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/security-profiles/$(InstanceId)/$(SecurityProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_security_profile(
InstanceId,
SecurityProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/security-profiles/$(InstanceId)/$(SecurityProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_traffic_distribution_group(traffic_distribution_group_id)
describe_traffic_distribution_group(traffic_distribution_group_id, params::Dict{String,<:Any})
Gets details and status of a traffic distribution group.
# Arguments
- `traffic_distribution_group_id`: The identifier of the traffic distribution group. This
can be the ID or the ARN if the API is being called in the Region where the traffic
distribution group was created. The ARN must be provided if the call is from the replicated
Region.
"""
function describe_traffic_distribution_group(
TrafficDistributionGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/traffic-distribution-group/$(TrafficDistributionGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_traffic_distribution_group(
TrafficDistributionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/traffic-distribution-group/$(TrafficDistributionGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user(instance_id, user_id)
describe_user(instance_id, user_id, params::Dict{String,<:Any})
Describes the specified user. You can find the instance ID in the Amazon Connect console
(it’s the final part of the ARN). The console does not display the user IDs. Instead,
list the users and note the IDs provided in the output.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `user_id`: The identifier of the user account.
"""
function describe_user(
InstanceId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/users/$(InstanceId)/$(UserId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user(
InstanceId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/users/$(InstanceId)/$(UserId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user_hierarchy_group(hierarchy_group_id, instance_id)
describe_user_hierarchy_group(hierarchy_group_id, instance_id, params::Dict{String,<:Any})
Describes the specified hierarchy group.
# Arguments
- `hierarchy_group_id`: The identifier of the hierarchy group.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function describe_user_hierarchy_group(
HierarchyGroupId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/user-hierarchy-groups/$(InstanceId)/$(HierarchyGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user_hierarchy_group(
HierarchyGroupId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/user-hierarchy-groups/$(InstanceId)/$(HierarchyGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user_hierarchy_structure(instance_id)
describe_user_hierarchy_structure(instance_id, params::Dict{String,<:Any})
Describes the hierarchy structure of the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function describe_user_hierarchy_structure(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/user-hierarchy-structure/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user_hierarchy_structure(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/user-hierarchy-structure/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_view(instance_id, view_id)
describe_view(instance_id, view_id, params::Dict{String,<:Any})
Retrieves the view for the specified Amazon Connect instance and view identifier. The view
identifier can be supplied as a ViewId or ARN. SAVED needs to be supplied if a view is
unpublished. The view identifier can contain an optional qualifier, for example,
<view-id>:SAVED, which is either an actual version number or an Amazon Connect
managed qualifier SAVED | LATEST. If it is not supplied, then LATEST is assumed for
customer managed views and an error is returned if there is no published content available.
Version 1 is assumed for Amazon Web Services managed views.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
- `view_id`: The ViewId of the view. This must be an ARN for Amazon Web Services managed
views.
"""
function describe_view(
InstanceId, ViewId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/views/$(InstanceId)/$(ViewId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_view(
InstanceId,
ViewId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/views/$(InstanceId)/$(ViewId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vocabulary(instance_id, vocabulary_id)
describe_vocabulary(instance_id, vocabulary_id, params::Dict{String,<:Any})
Describes the specified vocabulary.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `vocabulary_id`: The identifier of the custom vocabulary.
"""
function describe_vocabulary(
InstanceId, VocabularyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/vocabulary/$(InstanceId)/$(VocabularyId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vocabulary(
InstanceId,
VocabularyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/vocabulary/$(InstanceId)/$(VocabularyId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_analytics_data_set(data_set_id, instance_id)
disassociate_analytics_data_set(data_set_id, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Removes the
dataset ID associated with a given Amazon Connect instance.
# Arguments
- `data_set_id`: The identifier of the dataset to remove.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TargetAccountId"`: The identifier of the target account. Use to associate a dataset to
a different account than the one containing the Amazon Connect instance. If not specified,
by default this value is the Amazon Web Services account that has the Amazon Connect
instance.
"""
function disassociate_analytics_data_set(
DataSetId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/analytics-data/instance/$(InstanceId)/association",
Dict{String,Any}("DataSetId" => DataSetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_analytics_data_set(
DataSetId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/analytics-data/instance/$(InstanceId)/association",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DataSetId" => DataSetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_approved_origin(instance_id, origin)
disassociate_approved_origin(instance_id, origin, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Revokes access
to integrated applications from Amazon Connect.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `origin`: The domain URL of the integrated application.
"""
function disassociate_approved_origin(
InstanceId, origin; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/instance/$(InstanceId)/approved-origin",
Dict{String,Any}("origin" => origin);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_approved_origin(
InstanceId,
origin,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/instance/$(InstanceId)/approved-origin",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("origin" => origin), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_bot(instance_id)
disassociate_bot(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Revokes
authorization from the specified instance to access the specified Amazon Lex or Amazon Lex
V2 bot.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LexBot"`:
- `"LexV2Bot"`: The Amazon Lex V2 bot to disassociate from the instance.
"""
function disassociate_bot(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"POST",
"/instance/$(InstanceId)/bot";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_bot(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/instance/$(InstanceId)/bot",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_flow(instance_id, resource_id, resource_type)
disassociate_flow(instance_id, resource_id, resource_type, params::Dict{String,<:Any})
Disassociates a connect resource from a flow.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `resource_id`: The identifier of the resource.
- `resource_type`: A valid resource type.
"""
function disassociate_flow(
InstanceId, ResourceId, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/flow-associations/$(InstanceId)/$(ResourceId)/$(ResourceType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_flow(
InstanceId,
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/flow-associations/$(InstanceId)/$(ResourceId)/$(ResourceType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_instance_storage_config(association_id, instance_id, resource_type)
disassociate_instance_storage_config(association_id, instance_id, resource_type, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Removes the
storage type configurations for the specified resource type and association ID.
# Arguments
- `association_id`: The existing association identifier that uniquely identifies the
resource type and storage config for the given instance ID.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `resource_type`: A valid resource type.
"""
function disassociate_instance_storage_config(
AssociationId,
InstanceId,
resourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/instance/$(InstanceId)/storage-config/$(AssociationId)",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_instance_storage_config(
AssociationId,
InstanceId,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/instance/$(InstanceId)/storage-config/$(AssociationId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_lambda_function(instance_id, function_arn)
disassociate_lambda_function(instance_id, function_arn, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Remove the
Lambda function from the dropdown options available in the relevant flow blocks.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance..
- `function_arn`: The Amazon Resource Name (ARN) of the Lambda function being disassociated.
"""
function disassociate_lambda_function(
InstanceId, functionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/instance/$(InstanceId)/lambda-function",
Dict{String,Any}("functionArn" => functionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_lambda_function(
InstanceId,
functionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/instance/$(InstanceId)/lambda-function",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("functionArn" => functionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_lex_bot(instance_id, bot_name, lex_region)
disassociate_lex_bot(instance_id, bot_name, lex_region, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Revokes
authorization from the specified instance to access the specified Amazon Lex bot.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `bot_name`: The name of the Amazon Lex bot. Maximum character limit of 50.
- `lex_region`: The Amazon Web Services Region in which the Amazon Lex bot has been created.
"""
function disassociate_lex_bot(
InstanceId, botName, lexRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/instance/$(InstanceId)/lex-bot",
Dict{String,Any}("botName" => botName, "lexRegion" => lexRegion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_lex_bot(
InstanceId,
botName,
lexRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/instance/$(InstanceId)/lex-bot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("botName" => botName, "lexRegion" => lexRegion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_phone_number_contact_flow(phone_number_id, instance_id)
disassociate_phone_number_contact_flow(phone_number_id, instance_id, params::Dict{String,<:Any})
Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API
using an instance in the Amazon Web Services Region where the traffic distribution group
was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group
and you are calling this API using an instance in the alternate Amazon Web Services Region
associated with the traffic distribution group, you must provide a full phone number ARN.
If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
# Arguments
- `phone_number_id`: A unique identifier for the phone number.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function disassociate_phone_number_contact_flow(
PhoneNumberId, instanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/phone-number/$(PhoneNumberId)/contact-flow",
Dict{String,Any}("instanceId" => instanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_phone_number_contact_flow(
PhoneNumberId,
instanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/phone-number/$(PhoneNumberId)/contact-flow",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceId" => instanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_queue_quick_connects(instance_id, queue_id, quick_connect_ids)
disassociate_queue_quick_connects(instance_id, queue_id, quick_connect_ids, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Disassociates a
set of quick connects from a queue.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_id`: The identifier for the queue.
- `quick_connect_ids`: The quick connects to disassociate from the queue.
"""
function disassociate_queue_quick_connects(
InstanceId, QueueId, QuickConnectIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/disassociate-quick-connects",
Dict{String,Any}("QuickConnectIds" => QuickConnectIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_queue_quick_connects(
InstanceId,
QueueId,
QuickConnectIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/disassociate-quick-connects",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("QuickConnectIds" => QuickConnectIds), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_routing_profile_queues(instance_id, queue_references, routing_profile_id)
disassociate_routing_profile_queues(instance_id, queue_references, routing_profile_id, params::Dict{String,<:Any})
Disassociates a set of queues from a routing profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_references`: The queues to disassociate from this routing profile.
- `routing_profile_id`: The identifier of the routing profile.
"""
function disassociate_routing_profile_queues(
InstanceId,
QueueReferences,
RoutingProfileId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/disassociate-queues",
Dict{String,Any}("QueueReferences" => QueueReferences);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_routing_profile_queues(
InstanceId,
QueueReferences,
RoutingProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/disassociate-queues",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("QueueReferences" => QueueReferences), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_security_key(association_id, instance_id)
disassociate_security_key(association_id, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Deletes the
specified security key.
# Arguments
- `association_id`: The existing association identifier that uniquely identifies the
resource type and storage config for the given instance ID.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function disassociate_security_key(
AssociationId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/instance/$(InstanceId)/security-key/$(AssociationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_security_key(
AssociationId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/instance/$(InstanceId)/security-key/$(AssociationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_traffic_distribution_group_user(instance_id, traffic_distribution_group_id, user_id)
disassociate_traffic_distribution_group_user(instance_id, traffic_distribution_group_id, user_id, params::Dict{String,<:Any})
Disassociates an agent from a traffic distribution group.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `traffic_distribution_group_id`: The identifier of the traffic distribution group. This
can be the ID or the ARN if the API is being called in the Region where the traffic
distribution group was created. The ARN must be provided if the call is from the replicated
Region.
- `user_id`: The identifier for the user. This can be the ID or the ARN of the user.
"""
function disassociate_traffic_distribution_group_user(
InstanceId,
TrafficDistributionGroupId,
UserId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/traffic-distribution-group/$(TrafficDistributionGroupId)/user",
Dict{String,Any}("InstanceId" => InstanceId, "UserId" => UserId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_traffic_distribution_group_user(
InstanceId,
TrafficDistributionGroupId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/traffic-distribution-group/$(TrafficDistributionGroupId)/user",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "UserId" => UserId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_user_proficiencies(instance_id, user_id, user_proficiencies)
disassociate_user_proficiencies(instance_id, user_id, user_proficiencies, params::Dict{String,<:Any})
Disassociates a set of proficiencies from a user.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `user_id`: The identifier of the user account.
- `user_proficiencies`: The proficiencies to disassociate from the user.
"""
function disassociate_user_proficiencies(
InstanceId, UserId, UserProficiencies; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/disassociate-proficiencies",
Dict{String,Any}("UserProficiencies" => UserProficiencies);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_user_proficiencies(
InstanceId,
UserId,
UserProficiencies,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/disassociate-proficiencies",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("UserProficiencies" => UserProficiencies), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
dismiss_user_contact(contact_id, instance_id, user_id)
dismiss_user_contact(contact_id, instance_id, user_id, params::Dict{String,<:Any})
Dismisses contacts from an agent’s CCP and returns the agent to an available state, which
allows the agent to receive a new routed contact. Contacts can only be dismissed if they
are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.
# Arguments
- `contact_id`: The identifier of the contact.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
- `user_id`: The identifier of the user account.
"""
function dismiss_user_contact(
ContactId, InstanceId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/contact",
Dict{String,Any}("ContactId" => ContactId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function dismiss_user_contact(
ContactId,
InstanceId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/contact",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ContactId" => ContactId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_attached_file(file_id, instance_id, associated_resource_arn)
get_attached_file(file_id, instance_id, associated_resource_arn, params::Dict{String,<:Any})
Provides a pre-signed URL for download of an approved attached file. This API also returns
metadata about the attached file. It will only return a downloadURL if the status of the
attached file is APPROVED.
# Arguments
- `file_id`: The unique identifier of the attached file resource.
- `instance_id`: The unique identifier of the Connect instance.
- `associated_resource_arn`: The resource to which the attached file is (being) uploaded
to. Cases are the only current supported resource. This value must be a valid ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"urlExpiryInSeconds"`: Optional override for the expiry of the pre-signed S3 URL in
seconds. The default value is 300.
"""
function get_attached_file(
FileId,
InstanceId,
associatedResourceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/attached-files/$(InstanceId)/$(FileId)",
Dict{String,Any}("associatedResourceArn" => associatedResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_attached_file(
FileId,
InstanceId,
associatedResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/attached-files/$(InstanceId)/$(FileId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("associatedResourceArn" => associatedResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_contact_attributes(initial_contact_id, instance_id)
get_contact_attributes(initial_contact_id, instance_id, params::Dict{String,<:Any})
Retrieves the contact attributes for the specified contact.
# Arguments
- `initial_contact_id`: The identifier of the initial contact.
- `instance_id`: The identifier of the Amazon Connect instance.
"""
function get_contact_attributes(
InitialContactId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/contact/attributes/$(InstanceId)/$(InitialContactId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_contact_attributes(
InitialContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/contact/attributes/$(InstanceId)/$(InitialContactId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_current_metric_data(current_metrics, filters, instance_id)
get_current_metric_data(current_metrics, filters, instance_id, params::Dict{String,<:Any})
Gets the real-time metric data from the specified Amazon Connect instance. For a
description of each metric, see Real-time Metrics Definitions in the Amazon Connect
Administrator Guide.
# Arguments
- `current_metrics`: The metrics to retrieve. Specify the name and unit for each metric.
The following metrics are available. For a description of all the metrics, see Real-time
Metrics Definitions in the Amazon Connect Administrator Guide. AGENTS_AFTER_CONTACT_WORK
Unit: COUNT Name in real-time metrics report: ACW AGENTS_AVAILABLE Unit: COUNT Name in
real-time metrics report: Available AGENTS_ERROR Unit: COUNT Name in real-time metrics
report: Error AGENTS_NON_PRODUCTIVE Unit: COUNT Name in real-time metrics report: NPT
(Non-Productive Time) AGENTS_ON_CALL Unit: COUNT Name in real-time metrics report: On
contact AGENTS_ON_CONTACT Unit: COUNT Name in real-time metrics report: On contact
AGENTS_ONLINE Unit: COUNT Name in real-time metrics report: Online AGENTS_STAFFED Unit:
COUNT Name in real-time metrics report: Staffed CONTACTS_IN_QUEUE Unit: COUNT Name in
real-time metrics report: In queue CONTACTS_SCHEDULED Unit: COUNT Name in real-time
metrics report: Scheduled OLDEST_CONTACT_AGE Unit: SECONDS When you use groupings, Unit
says SECONDS and the Value is returned in SECONDS. When you do not use groupings, Unit
says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response
like this: { \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" },
\"Value\": 24113.0 } The actual OLDEST_CONTACT_AGE is 24 seconds. When the filter
RoutingStepExpression is used, this metric is still calculated from enqueue time. For
example, if a contact that has been queued under <Expression 1> for 10 seconds has
expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for this queue
will be counted starting from 10, not 0. Name in real-time metrics report: Oldest
SLOTS_ACTIVE Unit: COUNT Name in real-time metrics report: Active SLOTS_AVAILABLE Unit:
COUNT Name in real-time metrics report: Availability
- `filters`: The filters to apply to returned metrics. You can filter up to the following
limits: Queues: 100 Routing profiles: 100 Channels: 3 (VOICE, CHAT, and TASK channels
are supported.) RoutingStepExpressions: 50 Metric data is retrieved only for the
resources associated with the queues or routing profiles, and by any channels included in
the filter. (You cannot filter by both queue AND routing profile.) You can include both
resource IDs and resource ARNs in the same request. When using the RoutingStepExpression
filter, you need to pass exactly one QueueId. The filter is also case sensitive so when
using the RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is required.
Currently tagging is only supported on the resources that are passed in the filter.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Groupings"`: The grouping applied to the metrics returned. For example, when grouped by
QUEUE, the metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
channels are supported. If you group by ROUTING_PROFILE, you must include either a queue
or routing profile filter. In addition, a routing profile filter is required for metrics
CONTACTS_SCHEDULED, CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE. If no Grouping is
included in the request, a summary of metrics is returned. When using the
RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is required.
- `"MaxResults"`: The maximum number of results to return per page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results. The token
expires after 5 minutes from the time it is created. Subsequent requests that use the token
must use the same request parameters as the request that generated the token.
- `"SortCriteria"`: The way to sort the resulting response based on metrics. You can enter
one sort criteria. By default resources are sorted based on AGENTS_ONLINE, DESCENDING. The
metric collection is sorted based on the input metrics. Note the following: Sorting on
SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
"""
function get_current_metric_data(
CurrentMetrics, Filters, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/metrics/current/$(InstanceId)",
Dict{String,Any}("CurrentMetrics" => CurrentMetrics, "Filters" => Filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_current_metric_data(
CurrentMetrics,
Filters,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/metrics/current/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CurrentMetrics" => CurrentMetrics, "Filters" => Filters),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_current_user_data(filters, instance_id)
get_current_user_data(filters, instance_id, params::Dict{String,<:Any})
Gets the real-time active user data from the specified Amazon Connect instance.
# Arguments
- `filters`: The filters to apply to returned user data. You can filter up to the following
limits: Queues: 100 Routing profiles: 100 Agents: 100 Contact states: 9 User
hierarchy groups: 1 The user data is retrieved for only the specified values/resources
in the filter. A maximum of one filter can be passed from queues, routing profiles, agents,
and user hierarchy groups. Currently tagging is only supported on the resources that are
passed in the filter.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function get_current_user_data(
Filters, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/metrics/userdata/$(InstanceId)",
Dict{String,Any}("Filters" => Filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_current_user_data(
Filters,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/metrics/userdata/$(InstanceId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filters" => Filters), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_federation_token(instance_id)
get_federation_token(instance_id, params::Dict{String,<:Any})
Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is
for the Amazon Connect user which corresponds to the IAM credentials that were used to
invoke this action. For more information about how SAML sign-in works in Amazon Connect,
see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
This API doesn't support root users. If you try to invoke GetFederationToken with root
credentials, an error message similar to the following one appears: Provided identity:
Principal: .... User: .... cannot be used for federation with Amazon Connect
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function get_federation_token(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/user/federate/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_federation_token(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/user/federate/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_flow_association(instance_id, resource_id, resource_type)
get_flow_association(instance_id, resource_id, resource_type, params::Dict{String,<:Any})
Retrieves the flow associated for a given resource.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `resource_id`: The identifier of the resource.
- `resource_type`: A valid resource type.
"""
function get_flow_association(
InstanceId, ResourceId, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/flow-associations/$(InstanceId)/$(ResourceId)/$(ResourceType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_flow_association(
InstanceId,
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/flow-associations/$(InstanceId)/$(ResourceId)/$(ResourceType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_metric_data(end_time, filters, historical_metrics, instance_id, start_time)
get_metric_data(end_time, filters, historical_metrics, instance_id, start_time, params::Dict{String,<:Any})
Gets historical metric data from the specified Amazon Connect instance. For a description
of each historical metric, see Historical Metrics Definitions in the Amazon Connect
Administrator Guide. We recommend using the GetMetricDataV2 API. It provides more
flexibility, features, and the ability to query longer time ranges than GetMetricData. Use
it to retrieve historical agent and contact metrics for the last 3 months, at varying
intervals. You can also use it to build custom dashboards to measure historical queue and
agent performance. For example, you can track the number of incoming contacts for the last
7 days, with data split by day, to see how contact volume changed per day of the week.
# Arguments
- `end_time`: The timestamp, in UNIX Epoch time format, at which to end the reporting
interval for the retrieval of historical metrics data. The time must be specified using an
interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time
timestamp. The time range between the start and end time must be less than 24 hours.
- `filters`: The queues, up to 100, or channels, to use to filter the metrics returned.
Metric data is retrieved only for the resources associated with the queues or channels
included in the filter. You can include both queue IDs and queue ARNs in the same request.
VOICE, CHAT, and TASK channels are supported. RoutingStepExpression is not a valid filter
for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date
features. To filter by Queues, enter the queue ID/ARN, not the name of the queue.
- `historical_metrics`: The metrics to retrieve. Specify the name, unit, and statistic for
each metric. The following historical metrics are available. For a description of each
metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide. This
API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric
missing from the documented list). ABANDON_TIME Unit: SECONDS Statistic: AVG
AFTER_CONTACT_WORK_TIME Unit: SECONDS Statistic: AVG API_CONTACTS_HANDLED Unit: COUNT
Statistic: SUM CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM CONTACTS_ABANDONED
Unit: COUNT Statistic: SUM CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM
CONTACTS_CONSULTED Unit: COUNT Statistic: SUM CONTACTS_HANDLED Unit: COUNT Statistic:
SUM CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM CONTACTS_HANDLED_OUTBOUND
Unit: COUNT Statistic: SUM CONTACTS_HOLD_ABANDONS Unit: COUNT Statistic: SUM
CONTACTS_MISSED Unit: COUNT Statistic: SUM CONTACTS_QUEUED Unit: COUNT Statistic: SUM
CONTACTS_TRANSFERRED_IN Unit: COUNT Statistic: SUM CONTACTS_TRANSFERRED_IN_FROM_QUEUE
Unit: COUNT Statistic: SUM CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM HANDLE_TIME Unit: SECONDS
Statistic: AVG HOLD_TIME Unit: SECONDS Statistic: AVG INTERACTION_AND_HOLD_TIME Unit:
SECONDS Statistic: AVG INTERACTION_TIME Unit: SECONDS Statistic: AVG OCCUPANCY Unit:
PERCENT Statistic: AVG QUEUE_ANSWER_TIME Unit: SECONDS Statistic: AVG QUEUED_TIME Unit:
SECONDS Statistic: MAX SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a
request. Unit: PERCENT Statistic: AVG Threshold: For ThresholdValue, enter any whole number
from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less
than\").
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `start_time`: The timestamp, in UNIX Epoch time format, at which to start the reporting
interval for the retrieval of historical metrics data. The time must be specified using a
multiple of 5 minutes, such as 10:05, 10:10, 10:15. The start time cannot be earlier than
24 hours before the time of the request. Historical metrics are available only for 24 hours.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Groupings"`: The grouping applied to the metrics returned. For example, when results
are grouped by queue, the metrics returned are grouped by queue. The values returned apply
to the metrics for each queue rather than aggregated for all queues. If no grouping is
specified, a summary of metrics for all queues is returned. RoutingStepExpression is not a
valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more
up-to-date features.
- `"MaxResults"`: The maximum number of results to return per page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function get_metric_data(
EndTime,
Filters,
HistoricalMetrics,
InstanceId,
StartTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/metrics/historical/$(InstanceId)",
Dict{String,Any}(
"EndTime" => EndTime,
"Filters" => Filters,
"HistoricalMetrics" => HistoricalMetrics,
"StartTime" => StartTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_metric_data(
EndTime,
Filters,
HistoricalMetrics,
InstanceId,
StartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/metrics/historical/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndTime" => EndTime,
"Filters" => Filters,
"HistoricalMetrics" => HistoricalMetrics,
"StartTime" => StartTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_metric_data_v2(end_time, filters, metrics, resource_arn, start_time)
get_metric_data_v2(end_time, filters, metrics, resource_arn, start_time, params::Dict{String,<:Any})
Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more
features than GetMetricData, the previous version of this API. It has new metrics, offers
filtering at a metric level, and offers the ability to filter and group data by channels,
queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical
data for the last 3 months, at varying intervals. For a description of the historical
metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics
definitions in the Amazon Connect Administrator Guide.
# Arguments
- `end_time`: The timestamp, in UNIX Epoch time format, at which to end the reporting
interval for the retrieval of historical metrics data. The time must be later than the
start time timestamp. It cannot be later than the current timestamp.
- `filters`: The filters to apply to returned metrics. You can filter on the following
resources: Agents Channels Feature Queues Routing profiles Routing step
expression User hierarchy groups At least one filter must be passed from queues,
routing profiles, agents, or user hierarchy groups. To filter by phone number, see Create a
historical metrics report in the Amazon Connect Administrator Guide. Note the following
limits: Filter keys: A maximum of 5 filter keys are supported in a single request. Valid
filter keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO |
AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE |
CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype |
FEATURE | FLOW_TYPE | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID |
FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | INITIATION_METHOD | RESOURCE_PUBLISHED_TIMESTAMP |
ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | QUEUE | Q_CONNECT_ENABLED | Filter values:
A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are
valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100
filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents,
and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It
is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue
examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This
filter is case and order sensitive. JSON string fields must be sorted in ascending order
and JSON array order should be kept as is. Q_CONNECT_ENABLED. TRUE and FALSE are the only
valid filterValues for the Q_CONNECT_ENABLED filter key. TRUE includes all contacts that
had Amazon Q in Connect enabled as part of the flow. FALSE includes all contacts that did
not have Amazon Q in Connect enabled as part of the flow This filter is available only
for contact record-driven metrics.
- `metrics`: The metrics to retrieve. Specify the name, groupings, and filters for each
metric. The following historical metrics are available. For a description of each metric,
see Historical metrics definitions in the Amazon Connect Administrator Guide.
ABANDONMENT_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing
Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in
Connect UI name: Abandonment rate AGENT_ADHERENT_TIME This metric is available only in
Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is
available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile,
Agent, Agent Hierarchy UI name: Adherent time AGENT_ANSWER_RATE Unit: Percent Valid
groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name:
Agent answer rate AGENT_NON_ADHERENT_TIME Unit: Seconds Valid groupings and filters:
Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Non-adherent time
AGENT_NON_RESPONSE Unit: Count Valid groupings and filters: Queue, Channel, Routing
Profile, Agent, Agent Hierarchy UI name: Agent non-response
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS Unit: Count Valid groupings and filters:
Queue, Channel, Routing Profile, Agent, Agent Hierarchy Data for this metric is available
starting from October 1, 2023 0:00:00 GMT. UI name: Agent non-response without customer
abandons AGENT_OCCUPANCY Unit: Percentage Valid groupings and filters: Routing Profile,
Agent, Agent Hierarchy UI name: Occupancy AGENT_SCHEDULE_ADHERENCE This metric is
available only in Amazon Web Services Regions where Forecasting, capacity planning, and
scheduling is available. Unit: Percent Valid groupings and filters: Queue, Channel, Routing
Profile, Agent, Agent Hierarchy UI name: Adherence AGENT_SCHEDULED_TIME This metric is
available only in Amazon Web Services Regions where Forecasting, capacity planning, and
scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing
Profile, Agent, Agent Hierarchy UI name: Scheduled time AVG_ABANDON_TIME Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average queue
abandon time AVG_ACTIVE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Average active time
AVG_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average after
contact work time Feature is a valid filter but not a valid grouping.
AVG_AGENT_CONNECTING_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD. For
now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND |
CALLBACK | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent
Hierarchy UI name: Average agent API connecting time The Negate key in Metric Level
Filters is not applicable for this metric. AVG_AGENT_PAUSE_TIME Unit: Seconds Valid
groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in
Connect UI name: Average agent pause time AVG_CASE_RELATED_CONTACTS Unit: Count Required
filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case AVG_CASE_RESOLUTION_TIME Unit: Seconds Required
filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time AVG_CONTACT_DURATION Unit: Seconds Valid groupings
and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average contact duration
Feature is a valid filter but not a valid grouping. AVG_CONVERSATION_DURATION Unit:
Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent
Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name:
Average conversation duration AVG_FLOW_TIME Unit: Seconds Valid groupings and filters:
Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID,
Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource
ID, Initiation method, Resource published timestamp UI name: Average flow time
AVG_GREETING_TIME_AGENT This metric is available only for contacts analyzed by Contact
Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
Connect UI name: Average agent greeting time AVG_HANDLE_TIME Unit: Seconds Valid
groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: Average handle
time Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average customer
hold time Feature is a valid filter but not a valid grouping.
AVG_HOLD_TIME_ALL_CONTACTS Unit: Seconds Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
Connect UI name: Average customer hold time all contacts AVG_HOLDS Unit: Count Valid
groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average holds Feature is
a valid filter but not a valid grouping. AVG_INTERACTION_AND_HOLD_TIME Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interaction
and customer hold time AVG_INTERACTION_TIME Unit: Seconds Valid metric filter key:
INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interaction
time Feature is a valid filter but not a valid grouping. AVG_INTERRUPTIONS_AGENT This
metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent
Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent
interruptions AVG_INTERRUPTION_TIME_AGENT This metric is available only for contacts
analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and
filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interruption
time AVG_NON_TALK_TIME This metric is available only for contacts analyzed by Contact
Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
Connect UI name: Average non-talk time AVG_QUEUE_ANSWER_TIME Unit: Seconds Valid
groupings and filters: Queue, Channel, Routing Profile, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average queue answer time
Feature is a valid filter but not a valid grouping. AVG_RESOLUTION_TIME Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average resolution time
AVG_TALK_TIME This metric is available only for contacts analyzed by Contact Lens
conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
Connect UI name: Average talk time AVG_TALK_TIME_AGENT This metric is available only for
contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings
and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent talk time
AVG_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens
conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
Connect UI name: Average customer talk time CASES_CREATED Unit: Count Required filter
key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name:
Cases created CONTACTS_ABANDONED Unit: Count Metric filter: Valid values: API|
Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect Valid groupings
and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect UI name:
Contact abandoned CONTACTS_ABANDONED_IN_X Unit: Count Valid groupings and filters:
Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in
seconds. For Comparison, you must enter LT (for \"Less than\"). UI name: Contacts
abandoned in X seconds CONTACTS_ANSWERED_IN_X Unit: Count Valid groupings and filters:
Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in
seconds. For Comparison, you must enter LT (for \"Less than\"). UI name: Contacts answered
in X seconds CONTACTS_CREATED Unit: Count Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts created Feature
is a valid filter but not a valid grouping. CONTACTS_HANDLED Unit: Count Valid metric
filter key: INITIATION_METHOD, DISCONNECT_REASON Valid groupings and filters: Queue,
Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect UI name: API
contacts handled Feature is a valid filter but not a valid grouping.
CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT Unit: Count Valid metric filter key:
INITIATION_METHOD Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts handled
(connected to agent timestamp) CONTACTS_HOLD_ABANDONS Unit: Count Valid groupings and
filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts hold disconnect
CONTACTS_ON_HOLD_AGENT_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts hold agent
disconnect CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT Unit: Count Valid groupings and filters:
Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts
hold customer disconnect CONTACTS_PUT_ON_HOLD Unit: Count Valid groupings and filters:
Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts put
on hold CONTACTS_TRANSFERRED_OUT_EXTERNAL Unit: Count Valid groupings and filters:
Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts
transferred out external CONTACTS_TRANSFERRED_OUT_INTERNAL Unit: Percent Valid groupings
and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name:
Contacts transferred out internal CONTACTS_QUEUED Unit: Count Valid groupings and
filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts queued
CONTACTS_QUEUED_BY_ENQUEUE Unit: Count Valid groupings and filters: Queue, Channel, Agent,
Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts queued
(enqueue timestamp) CONTACTS_RESOLVED_IN_X Unit: Count Valid groupings and filters:
Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in
seconds. For Comparison, you must enter LT (for \"Less than\"). UI name: Contacts resolved
in X CONTACTS_TRANSFERRED_OUT Unit: Count Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, Feature,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping. CONTACTS_TRANSFERRED_OUT_BY_AGENT
Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent
Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts
transferred out by agent CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: Count Valid groupings
and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts transferred out
queue CURRENT_CASES Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings
and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Current cases FLOWS_OUTCOME Unit:
Count Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow
type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows
outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name:
Flows outcome FLOWS_STARTED Unit: Count Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows
resource ID, Initiation method, Resource published timestamp UI name: Flows started
MAX_FLOW_TIME Unit: Seconds Valid groupings and filters: Channel,
contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next
resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID,
Initiation method, Resource published timestamp UI name: Maximum flow time
MAX_QUEUED_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing
Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI
name: Maximum queued time MIN_FLOW_TIME Unit: Seconds Valid groupings and filters:
Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID,
Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource
ID, Initiation method, Resource published timestamp UI name: Minimum flow time
PERCENT_CASES_FIRST_CONTACT_RESOLVED Unit: Percent Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved on
first contact PERCENT_CONTACTS_STEP_EXPIRED Unit: Percent Valid groupings and filters:
Queue, RoutingStepExpression UI name: Not available PERCENT_CONTACTS_STEP_JOINED Unit:
Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: Not available
PERCENT_FLOWS_OUTCOME Unit: Percent Valid metric filter key: FLOWS_OUTCOME_TYPE Valid
groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows
module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome
type, Flows resource ID, Initiation method, Resource published timestamp UI name: Flows
outcome percentage. The FLOWS_OUTCOME_TYPE is not a valid grouping.
PERCENT_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens
conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
Connect UI name: Non-talk time percent PERCENT_TALK_TIME This metric is available only
for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid
groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Talk time percent
PERCENT_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact
Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue,
Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Agent talk time percent
PERCENT_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact
Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue,
Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Customer talk time percent
REOPENED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings
and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases reopened RESOLVED_CASE_ACTIONS
Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters:
CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved SERVICE_LEVEL You can include up
to 20 SERVICE_LEVEL metrics in a request. Unit: Percent Valid groupings and filters: Queue,
Channel, Routing Profile, Q in Connect Threshold: For ThresholdValue, enter any whole
number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for
\"Less than\"). UI name: Service level X STEP_CONTACTS_QUEUED Unit: Count Valid
groupings and filters: Queue, RoutingStepExpression UI name: Not available
SUM_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: After contact work time
SUM_CONNECTING_TIME_AGENT Unit: Seconds Valid metric filter key: INITIATION_METHOD. This
metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND |
CALLBACK | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent
Hierarchy UI name: Agent API connecting time The Negate key in Metric Level Filters is
not applicable for this metric. SUM_CONTACT_FLOW_TIME Unit: Seconds Valid groupings and
filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name:
Contact flow time SUM_CONTACT_TIME_AGENT Unit: Seconds Valid groupings and filters:
Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent on contact time
SUM_CONTACTS_DISCONNECTED Valid metric filter key: DISCONNECT_REASON Unit: Count Valid
groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contact disconnected
SUM_ERROR_STATUS_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy UI name: Error status time SUM_HANDLE_TIME Unit:
Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent
Hierarchy, Q in Connect UI name: Contact handle time SUM_HOLD_TIME Unit: Count Valid
groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in
Connect UI name: Customer hold time SUM_IDLE_TIME_AGENT Unit: Seconds Valid groupings
and filters: Routing Profile, Agent, Agent Hierarchy UI name: Agent idle time
SUM_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Agent interaction and hold
time SUM_INTERACTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel,
Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction time
SUM_NON_PRODUCTIVE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile,
Agent, Agent Hierarchy UI name: Non-Productive Time SUM_ONLINE_TIME_AGENT Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Online time
SUM_RETRY_CALLBACK_ATTEMPTS Unit: Count Valid groupings and filters: Queue, Channel,
Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Callback
attempts
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. This includes the
instanceId an Amazon Connect instance.
- `start_time`: The timestamp, in UNIX Epoch time format, at which to start the reporting
interval for the retrieval of historical metrics data. The time must be before the end time
timestamp. The start and end time depends on the IntervalPeriod selected. By default the
time range between start and end time is 35 days. Historical metrics are available for 3
months.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Groupings"`: The grouping applied to the metrics that are returned. For example, when
results are grouped by queue, the metrics returned are grouped by queue. The values that
are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned. Valid grouping keys:
AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE
| AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS
| CHANNEL | contact/segmentAttributes/connect:Subtype | FLOWS_RESOURCE_ID |
FLOWS_MODULE_RESOURCE_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | INITIATION_METHOD |
Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE |
ROUTING_STEP_EXPRESSION
- `"Interval"`: The interval period and timezone to apply to returned metrics.
IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod
values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL. For example, if
IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon
Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN
period. By default Amazon Connect aggregates results based on the TOTAL interval period.
The following list describes restrictions on StartTime and EndTime based on which
IntervalPeriod is requested. FIFTEEN_MIN: The difference between StartTime and EndTime
must be less than 3 days. THIRTY_MIN: The difference between StartTime and EndTime must
be less than 3 days. HOUR: The difference between StartTime and EndTime must be less
than 3 days. DAY: The difference between StartTime and EndTime must be less than 35
days. WEEK: The difference between StartTime and EndTime must be less than 35 days.
TOTAL: The difference between StartTime and EndTime must be less than 35 days.
TimeZone: The timezone applied to requested metrics.
- `"MaxResults"`: The maximum number of results to return per page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function get_metric_data_v2(
EndTime,
Filters,
Metrics,
ResourceArn,
StartTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/metrics/data",
Dict{String,Any}(
"EndTime" => EndTime,
"Filters" => Filters,
"Metrics" => Metrics,
"ResourceArn" => ResourceArn,
"StartTime" => StartTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_metric_data_v2(
EndTime,
Filters,
Metrics,
ResourceArn,
StartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/metrics/data",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndTime" => EndTime,
"Filters" => Filters,
"Metrics" => Metrics,
"ResourceArn" => ResourceArn,
"StartTime" => StartTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_prompt_file(instance_id, prompt_id)
get_prompt_file(instance_id, prompt_id, params::Dict{String,<:Any})
Gets the prompt file.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `prompt_id`: A unique identifier for the prompt.
"""
function get_prompt_file(
InstanceId, PromptId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/prompts/$(InstanceId)/$(PromptId)/file";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_prompt_file(
InstanceId,
PromptId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/prompts/$(InstanceId)/$(PromptId)/file",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_task_template(instance_id, task_template_id)
get_task_template(instance_id, task_template_id, params::Dict{String,<:Any})
Gets details about a specific task template in the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `task_template_id`: A unique identifier for the task template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"snapshotVersion"`: The system generated version of a task template that is associated
with a task, when the task is created.
"""
function get_task_template(
InstanceId, TaskTemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/instance/$(InstanceId)/task/template/$(TaskTemplateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_task_template(
InstanceId,
TaskTemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/task/template/$(TaskTemplateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_traffic_distribution(id)
get_traffic_distribution(id, params::Dict{String,<:Any})
Retrieves the current traffic distribution for a given traffic distribution group.
# Arguments
- `id`: The identifier of the traffic distribution group. This can be the ID or the ARN if
the API is being called in the Region where the traffic distribution group was created. The
ARN must be provided if the call is from the replicated Region.
"""
function get_traffic_distribution(Id; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/traffic-distribution/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_traffic_distribution(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/traffic-distribution/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_phone_number(instance_id, source_phone_number_arn)
import_phone_number(instance_id, source_phone_number_arn, params::Dict{String,<:Any})
Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an
Amazon Connect instance. You can call this API only in the same Amazon Web Services Region
where the Amazon Connect instance was created.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `source_phone_number_arn`: The claimed phone number ARN being imported from the external
service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of
the phone number to import from Amazon Pinpoint.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"PhoneNumberDescription"`: The description of the phone number.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function import_phone_number(
InstanceId, SourcePhoneNumberArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/phone-number/import",
Dict{String,Any}(
"InstanceId" => InstanceId,
"SourcePhoneNumberArn" => SourcePhoneNumberArn,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_phone_number(
InstanceId,
SourcePhoneNumberArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/phone-number/import",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceId" => InstanceId,
"SourcePhoneNumberArn" => SourcePhoneNumberArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_agent_statuses(instance_id)
list_agent_statuses(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Lists agent
statuses.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentStatusTypes"`: Available agent status types.
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_agent_statuses(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/agent-status/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_agent_statuses(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/agent-status/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_analytics_data_associations(instance_id)
list_analytics_data_associations(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Lists the
association status of requested dataset ID for a given Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSetId"`: The identifier of the dataset to get the association status.
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_analytics_data_associations(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/analytics-data/instance/$(InstanceId)/association";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_analytics_data_associations(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/analytics-data/instance/$(InstanceId)/association",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_approved_origins(instance_id)
list_approved_origins(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Returns a
paginated list of all approved origins associated with the instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_approved_origins(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/instance/$(InstanceId)/approved-origins";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_approved_origins(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/approved-origins",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bots(instance_id, lex_version)
list_bots(instance_id, lex_version, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. For the
specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots
currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2
bots.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `lex_version`: The version of Amazon Lex or Amazon Lex V2.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_bots(
InstanceId, lexVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/instance/$(InstanceId)/bots",
Dict{String,Any}("lexVersion" => lexVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bots(
InstanceId,
lexVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/bots",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("lexVersion" => lexVersion), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_contact_evaluations(instance_id, contact_id)
list_contact_evaluations(instance_id, contact_id, params::Dict{String,<:Any})
Lists contact evaluations in the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `contact_id`: The identifier of the contact in this instance of Amazon Connect.
# 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. Use the value returned in the
previous response in the next request to retrieve the next set of results. This is not
expected to be set because the value returned in the previous response is always null.
"""
function list_contact_evaluations(
InstanceId, contactId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/contact-evaluations/$(InstanceId)",
Dict{String,Any}("contactId" => contactId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_contact_evaluations(
InstanceId,
contactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/contact-evaluations/$(InstanceId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("contactId" => contactId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_contact_flow_modules(instance_id)
list_contact_flow_modules(instance_id, params::Dict{String,<:Any})
Provides information about the flow modules for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"state"`: The state of the flow module.
"""
function list_contact_flow_modules(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/contact-flow-modules-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_contact_flow_modules(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/contact-flow-modules-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_contact_flows(instance_id)
list_contact_flows(instance_id, params::Dict{String,<:Any})
Provides information about the flows for the specified Amazon Connect instance. You can
also create and update flows using the Amazon Connect Flow language. For more information
about flows, see Flows in the Amazon Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contactFlowTypes"`: The type of flow.
- `"maxResults"`: The maximum number of results to return per page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_contact_flows(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/contact-flows-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_contact_flows(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/contact-flows-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_contact_references(contact_id, instance_id, reference_types)
list_contact_references(contact_id, instance_id, reference_types, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. For the
specified referenceTypes, returns a list of references associated with the contact.
References are links to documents that are related to a contact, such as emails,
attachments, or URLs.
# Arguments
- `contact_id`: The identifier of the initial contact.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `reference_types`: The type of reference.
# 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. Use the value returned in the
previous response in the next request to retrieve the next set of results. This is not
expected to be set, because the value returned in the previous response is always null.
"""
function list_contact_references(
ContactId, InstanceId, referenceTypes; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/contact/references/$(InstanceId)/$(ContactId)",
Dict{String,Any}("referenceTypes" => referenceTypes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_contact_references(
ContactId,
InstanceId,
referenceTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/contact/references/$(InstanceId)/$(ContactId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("referenceTypes" => referenceTypes), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_default_vocabularies(instance_id)
list_default_vocabularies(instance_id, params::Dict{String,<:Any})
Lists the default vocabularies for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LanguageCode"`: The language code of the vocabulary entries. For a list of languages
and their corresponding language codes, see What is Amazon Transcribe?
- `"MaxResults"`: The maximum number of results to return per page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_default_vocabularies(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/default-vocabulary-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_default_vocabularies(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/default-vocabulary-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_evaluation_form_versions(evaluation_form_id, instance_id)
list_evaluation_form_versions(evaluation_form_id, instance_id, params::Dict{String,<:Any})
Lists versions of an evaluation form in the specified Amazon Connect instance.
# Arguments
- `evaluation_form_id`: The unique identifier for the evaluation form.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_evaluation_form_versions(
EvaluationFormId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_evaluation_form_versions(
EvaluationFormId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_evaluation_forms(instance_id)
list_evaluation_forms(instance_id, params::Dict{String,<:Any})
Lists evaluation forms in the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_evaluation_forms(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/evaluation-forms/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_evaluation_forms(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/evaluation-forms/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_flow_associations(instance_id)
list_flow_associations(instance_id, params::Dict{String,<:Any})
List the flow association based on the filters.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceType"`: A valid resource type.
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_flow_associations(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/flow-associations-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_flow_associations(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/flow-associations-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_hours_of_operations(instance_id)
list_hours_of_operations(instance_id, params::Dict{String,<:Any})
Provides information about the hours of operation for the specified Amazon Connect
instance. For more information about hours of operation, see Set the Hours of Operation for
a Queue in the Amazon Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_hours_of_operations(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/hours-of-operations-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_hours_of_operations(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/hours-of-operations-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instance_attributes(instance_id)
list_instance_attributes(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Returns a
paginated list of all attribute types for the given instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_instance_attributes(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/instance/$(InstanceId)/attributes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_instance_attributes(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/attributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instance_storage_configs(instance_id, resource_type)
list_instance_storage_configs(instance_id, resource_type, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Returns a
paginated list of storage configs for the identified instance and resource type.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `resource_type`: A valid resource type.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_instance_storage_configs(
InstanceId, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/instance/$(InstanceId)/storage-configs",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_instance_storage_configs(
InstanceId,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/storage-configs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instances()
list_instances(params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Return a list
of instances which are in active state, creation-in-progress state, and failed state.
Instances that aren't successfully created (they are in a failed state) are returned only
for 24 hours after the CreateInstance API was invoked.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET", "/instance"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET", "/instance", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_integration_associations(instance_id)
list_integration_associations(instance_id, params::Dict{String,<:Any})
Provides summary information about the Amazon Web Services resource associations for the
specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"integrationArn"`: The Amazon Resource Name (ARN) of the integration.
- `"integrationType"`: The integration type.
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_integration_associations(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/instance/$(InstanceId)/integration-associations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_integration_associations(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/integration-associations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lambda_functions(instance_id)
list_lambda_functions(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Returns a
paginated list of all Lambda functions that display in the dropdown options in the relevant
flow blocks.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_lambda_functions(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/instance/$(InstanceId)/lambda-functions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_lambda_functions(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/lambda-functions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lex_bots(instance_id)
list_lex_bots(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Returns a
paginated list of all the Amazon Lex V1 bots currently associated with the instance. To
return both Amazon Lex V1 and V2 bots, use the ListBots API.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page. If no value is
specified, the default is 10.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_lex_bots(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/instance/$(InstanceId)/lex-bots";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_lex_bots(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/lex-bots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_phone_numbers(instance_id)
list_phone_numbers(instance_id, params::Dict{String,<:Any})
Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center
in the Amazon Connect Administrator Guide. We recommend using ListPhoneNumbersV2 to
return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED,
THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it
incorrectly lists them as TOLL_FREE or DID. The phone number Arn value that is returned
from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number
resources. It will fail with a ResourceNotFoundException. Instead, use the
ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone
number resources.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"phoneNumberCountryCodes"`: The ISO country code.
- `"phoneNumberTypes"`: The type of phone number. We recommend using ListPhoneNumbersV2 to
return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED,
THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as TOLL_FREE or DID.
"""
function list_phone_numbers(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/phone-numbers-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_phone_numbers(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/phone-numbers-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_phone_numbers_v2()
list_phone_numbers_v2(params::Dict{String,<:Any})
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
If the provided TargetArn is a traffic distribution group, you can call this API in both
Amazon Web Services Regions associated with traffic distribution group. For more
information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the
Amazon Connect Administrator Guide. When given an instance ARN, ListPhoneNumbersV2
returns only the phone numbers claimed to the instance. When given a traffic distribution
group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic
distribution group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceId"`: The identifier of the Amazon Connect instance that phone numbers are
claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
If both TargetArn and InstanceId are not provided, this API lists numbers claimed to all
the Amazon Connect instances belonging to your account in the same AWS Region as the
request.
- `"MaxResults"`: The maximum number of results to return per page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"PhoneNumberCountryCodes"`: The ISO country code.
- `"PhoneNumberPrefix"`: The prefix of the phone number. If provided, it must contain + as
part of the country code.
- `"PhoneNumberTypes"`: The type of phone number.
- `"TargetArn"`: The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
distribution groups that phone number inbound traffic is routed through. If both TargetArn
and InstanceId input are not provided, this API lists numbers claimed to all the Amazon
Connect instances belonging to your account in the same Amazon Web Services Region as the
request.
"""
function list_phone_numbers_v2(; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"POST", "/phone-number/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_phone_numbers_v2(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/phone-number/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_predefined_attributes(instance_id)
list_predefined_attributes(instance_id, params::Dict{String,<:Any})
Lists predefined attributes for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_predefined_attributes(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/predefined-attributes/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_predefined_attributes(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/predefined-attributes/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_prompts(instance_id)
list_prompts(instance_id, params::Dict{String,<:Any})
Provides information about the prompts for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_prompts(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/prompts-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_prompts(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/prompts-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_queue_quick_connects(instance_id, queue_id)
list_queue_quick_connects(instance_id, queue_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Lists the quick
connects associated with a queue.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_id`: The identifier for the queue.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_queue_quick_connects(
InstanceId, QueueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/queues/$(InstanceId)/$(QueueId)/quick-connects";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_queue_quick_connects(
InstanceId,
QueueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/queues/$(InstanceId)/$(QueueId)/quick-connects",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_queues(instance_id)
list_queues(instance_id, params::Dict{String,<:Any})
Provides information about the queues for the specified Amazon Connect instance. If you do
not specify a QueueTypes parameter, both standard and agent queues are returned. This might
cause an unexpected truncation of results if you have more than 1000 agents and you limit
the number of results of the API call in code. For more information about queues, see
Queues: Standard and Agent in the Amazon Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"queueTypes"`: The type of queue.
"""
function list_queues(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/queues-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_queues(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/queues-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_quick_connects(instance_id)
list_quick_connects(instance_id, params::Dict{String,<:Any})
Provides information about the quick connects for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"QuickConnectTypes"`: The type of quick connect. In the Amazon Connect admin website,
when you create a quick connect, you are prompted to assign one of the following types:
Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
- `"maxResults"`: The maximum number of results to return per page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_quick_connects(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/quick-connects/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_quick_connects(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/quick-connects/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_realtime_contact_analysis_segments_v2(contact_id, instance_id, output_type, segment_types)
list_realtime_contact_analysis_segments_v2(contact_id, instance_id, output_type, segment_types, params::Dict{String,<:Any})
Provides a list of analysis segments for a real-time analysis session.
# Arguments
- `contact_id`: The identifier of the contact in this instance of Amazon Connect.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `output_type`: The Contact Lens output type to be returned.
- `segment_types`: Enum with segment types . Each value corresponds to a segment type
returned in the segments list of the API. Each segment type has its own structure.
Different channels may have different sets of supported segment types.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_realtime_contact_analysis_segments_v2(
ContactId,
InstanceId,
OutputType,
SegmentTypes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/list-real-time-analysis-segments-v2/$(InstanceId)/$(ContactId)",
Dict{String,Any}("OutputType" => OutputType, "SegmentTypes" => SegmentTypes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_realtime_contact_analysis_segments_v2(
ContactId,
InstanceId,
OutputType,
SegmentTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/list-real-time-analysis-segments-v2/$(InstanceId)/$(ContactId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OutputType" => OutputType, "SegmentTypes" => SegmentTypes
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_routing_profile_queues(instance_id, routing_profile_id)
list_routing_profile_queues(instance_id, routing_profile_id, params::Dict{String,<:Any})
Lists the queues associated with a routing profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `routing_profile_id`: The identifier of the routing profile.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_routing_profile_queues(
InstanceId, RoutingProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/queues";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_routing_profile_queues(
InstanceId,
RoutingProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/queues",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_routing_profiles(instance_id)
list_routing_profiles(instance_id, params::Dict{String,<:Any})
Provides summary information about the routing profiles for the specified Amazon Connect
instance. For more information about routing profiles, see Routing Profiles and Create a
Routing Profile in the Amazon Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_routing_profiles(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/routing-profiles-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_routing_profiles(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/routing-profiles-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rules(instance_id)
list_rules(instance_id, params::Dict{String,<:Any})
List all rules for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"eventSourceName"`: The name of the event source.
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"publishStatus"`: The publish status of the rule.
"""
function list_rules(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/rules/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_rules(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/rules/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_security_keys(instance_id)
list_security_keys(instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Returns a
paginated list of all security keys associated with the instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_security_keys(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/instance/$(InstanceId)/security-keys";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_security_keys(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/security-keys",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_security_profile_applications(instance_id, security_profile_id)
list_security_profile_applications(instance_id, security_profile_id, params::Dict{String,<:Any})
Returns a list of third-party applications in a specific security profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `security_profile_id`: The identifier for the security profle.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_security_profile_applications(
InstanceId, SecurityProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/security-profiles-applications/$(InstanceId)/$(SecurityProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_security_profile_applications(
InstanceId,
SecurityProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/security-profiles-applications/$(InstanceId)/$(SecurityProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_security_profile_permissions(instance_id, security_profile_id)
list_security_profile_permissions(instance_id, security_profile_id, params::Dict{String,<:Any})
Lists the permissions granted to a security profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `security_profile_id`: The identifier for the security profle.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_security_profile_permissions(
InstanceId, SecurityProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/security-profiles-permissions/$(InstanceId)/$(SecurityProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_security_profile_permissions(
InstanceId,
SecurityProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/security-profiles-permissions/$(InstanceId)/$(SecurityProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_security_profiles(instance_id)
list_security_profiles(instance_id, params::Dict{String,<:Any})
Provides summary information about the security profiles for the specified Amazon Connect
instance. For more information about security profiles, see Security Profiles in the Amazon
Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_security_profiles(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/security-profiles-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_security_profiles(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/security-profiles-summary/$(InstanceId)",
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. For sample policies that use tags, see Amazon
Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. All Amazon Connect
resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN
for an instance, for example, see Find your Amazon Connect instance ID/ARN.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"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 connect(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_task_templates(instance_id)
list_task_templates(instance_id, params::Dict{String,<:Any})
Lists task templates for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page. It is not expected
that you set this.
- `"name"`: The name of the task template.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results. It is not
expected that you set this because the value returned in the previous response is always
null.
- `"status"`: Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task
that refers to this template cannot be created.
"""
function list_task_templates(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/instance/$(InstanceId)/task/template";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_task_templates(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/task/template",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_traffic_distribution_group_users(traffic_distribution_group_id)
list_traffic_distribution_group_users(traffic_distribution_group_id, params::Dict{String,<:Any})
Lists traffic distribution group users.
# Arguments
- `traffic_distribution_group_id`: The identifier of the traffic distribution group. This
can be the ID or the ARN if the API is being called in the Region where the traffic
distribution group was created. The ARN must be provided if the call is from the replicated
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 per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_traffic_distribution_group_users(
TrafficDistributionGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/traffic-distribution-group/$(TrafficDistributionGroupId)/user";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_traffic_distribution_group_users(
TrafficDistributionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/traffic-distribution-group/$(TrafficDistributionGroupId)/user",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_traffic_distribution_groups()
list_traffic_distribution_groups(params::Dict{String,<:Any})
Lists traffic distribution groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"instanceId"`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_traffic_distribution_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/traffic-distribution-groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_traffic_distribution_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/traffic-distribution-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_use_cases(instance_id, integration_association_id)
list_use_cases(instance_id, integration_association_id, params::Dict{String,<:Any})
Lists the use cases for the integration association.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `integration_association_id`: The identifier for the integration association.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_use_cases(
InstanceId, IntegrationAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/instance/$(InstanceId)/integration-associations/$(IntegrationAssociationId)/use-cases";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_use_cases(
InstanceId,
IntegrationAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/instance/$(InstanceId)/integration-associations/$(IntegrationAssociationId)/use-cases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_user_hierarchy_groups(instance_id)
list_user_hierarchy_groups(instance_id, params::Dict{String,<:Any})
Provides summary information about the hierarchy groups for the specified Amazon Connect
instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the
Amazon Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_user_hierarchy_groups(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/user-hierarchy-groups-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_user_hierarchy_groups(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/user-hierarchy-groups-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_user_proficiencies(instance_id, user_id)
list_user_proficiencies(instance_id, user_id, params::Dict{String,<:Any})
Lists proficiencies associated with a user.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `user_id`: The identifier of the user 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 per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_user_proficiencies(
InstanceId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/users/$(InstanceId)/$(UserId)/proficiencies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_user_proficiencies(
InstanceId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/users/$(InstanceId)/$(UserId)/proficiencies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users(instance_id)
list_users(instance_id, params::Dict{String,<:Any})
Provides summary information about the users for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_users(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/users-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_users(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/users-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_view_versions(instance_id, view_id)
list_view_versions(instance_id, view_id, params::Dict{String,<:Any})
Returns all the available versions for the specified Amazon Connect instance and view
identifier. Results will be sorted from highest to lowest.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
- `view_id`: The identifier of the view. Both ViewArn and ViewId can be used.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_view_versions(
InstanceId, ViewId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"GET",
"/views/$(InstanceId)/$(ViewId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_view_versions(
InstanceId,
ViewId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/views/$(InstanceId)/$(ViewId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_views(instance_id)
list_views(instance_id, params::Dict{String,<:Any})
Returns views in the given instance. Results are sorted primarily by type, and secondarily
by name.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
# 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 page. The default MaxResult
size is 100.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"type"`: The type of the view.
"""
function list_views(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"GET",
"/views/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_views(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"GET",
"/views/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
monitor_contact(contact_id, instance_id, user_id)
monitor_contact(contact_id, instance_id, user_id, params::Dict{String,<:Any})
Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user
specified by userId will be set to silent monitoring mode on the contact.
# Arguments
- `contact_id`: The identifier of the contact.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
- `user_id`: The identifier of the user account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowedMonitorCapabilities"`: Specify which monitoring actions the user is allowed to
take. For example, whether the user is allowed to escalate from silent monitoring to barge.
AllowedMonitorCapabilities is required if barge is enabled.
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function monitor_contact(
ContactId, InstanceId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact/monitor",
Dict{String,Any}(
"ContactId" => ContactId,
"InstanceId" => InstanceId,
"UserId" => UserId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function monitor_contact(
ContactId,
InstanceId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/monitor",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"InstanceId" => InstanceId,
"UserId" => UserId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
pause_contact(contact_id, instance_id)
pause_contact(contact_id, instance_id, params::Dict{String,<:Any})
Allows pausing an ongoing task contact.
# Arguments
- `contact_id`: The identifier of the contact.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContactFlowId"`: The identifier of the flow.
"""
function pause_contact(
ContactId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact/pause",
Dict{String,Any}("ContactId" => ContactId, "InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function pause_contact(
ContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/pause",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ContactId" => ContactId, "InstanceId" => InstanceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_user_status(agent_status_id, instance_id, user_id)
put_user_status(agent_status_id, instance_id, user_id, params::Dict{String,<:Any})
Changes the current status of a user or agent in Amazon Connect. If the agent is currently
handling a contact, this sets the agent's next status. For more information, see Agent
status and Set your next status in the Amazon Connect Administrator Guide.
# Arguments
- `agent_status_id`: The identifier of the agent status.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `user_id`: The identifier of the user.
"""
function put_user_status(
AgentStatusId, InstanceId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/users/$(InstanceId)/$(UserId)/status",
Dict{String,Any}("AgentStatusId" => AgentStatusId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_user_status(
AgentStatusId,
InstanceId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/users/$(InstanceId)/$(UserId)/status",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AgentStatusId" => AgentStatusId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
release_phone_number(phone_number_id)
release_phone_number(phone_number_id, params::Dict{String,<:Any})
Releases a phone number previously claimed to an Amazon Connect instance or traffic
distribution group. You can call this API only in the Amazon Web Services Region where the
number was claimed. To release phone numbers from a traffic distribution group, use the
ReleasePhoneNumber API, not the Amazon Connect admin website. After releasing a phone
number, the phone number enters into a cooldown period for up to 180 days. It cannot be
searched for or claimed again until the period has ended. If you accidentally release a
phone number, contact Amazon Web Services Support. If you plan to claim and release
numbers frequently, contact us for a service quota exception. Otherwise, it is possible you
will be blocked from claiming and releasing any more numbers until up to 180 days past the
oldest number released has expired. By default you can claim and release up to 200% of your
maximum number of active phone numbers. If you claim and release phone numbers using the UI
or API during a rolling 180 day cycle that exceeds 200% of your phone number service level
quota, you will be blocked from claiming any more numbers until 180 days past the oldest
number released has expired. For example, if you already have 99 claimed numbers and a
service level quota of 99 phone numbers, and in any 180 day period you release 99, claim
99, and then release 99, you will have exceeded the 200% limit. At that point you are
blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
# Arguments
- `phone_number_id`: A unique identifier for the phone number.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function release_phone_number(
PhoneNumberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/phone-number/$(PhoneNumberId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function release_phone_number(
PhoneNumberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/phone-number/$(PhoneNumberId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replicate_instance(instance_id, replica_alias, replica_region)
replicate_instance(instance_id, replica_alias, replica_region, params::Dict{String,<:Any})
Replicates an Amazon Connect instance in the specified Amazon Web Services Region and
copies configuration information for Amazon Connect resources across Amazon Web Services
Regions. For more information about replicating an Amazon Connect instance, see Create a
replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId, or
the entire ARN.
- `replica_alias`: The alias for the replicated instance. The ReplicaAlias must be unique.
- `replica_region`: The Amazon Web Services Region where to replicate the Amazon Connect
instance.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function replicate_instance(
InstanceId,
ReplicaAlias,
ReplicaRegion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/instance/$(InstanceId)/replicate",
Dict{String,Any}(
"ReplicaAlias" => ReplicaAlias,
"ReplicaRegion" => ReplicaRegion,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replicate_instance(
InstanceId,
ReplicaAlias,
ReplicaRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/instance/$(InstanceId)/replicate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicaAlias" => ReplicaAlias,
"ReplicaRegion" => ReplicaRegion,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resume_contact(contact_id, instance_id)
resume_contact(contact_id, instance_id, params::Dict{String,<:Any})
Allows resuming a task contact in a paused state.
# Arguments
- `contact_id`: The identifier of the contact.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContactFlowId"`: The identifier of the flow.
"""
function resume_contact(
ContactId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact/resume",
Dict{String,Any}("ContactId" => ContactId, "InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resume_contact(
ContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/resume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ContactId" => ContactId, "InstanceId" => InstanceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resume_contact_recording(contact_id, initial_contact_id, instance_id)
resume_contact_recording(contact_id, initial_contact_id, instance_id, params::Dict{String,<:Any})
When a contact is being recorded, and the recording has been suspended using
SuspendContactRecording, this API resumes recording whatever recording is selected in the
flow configuration: call, screen, or both. If only call recording or only screen recording
is enabled, then it would resume. Voice and screen recordings are supported.
# Arguments
- `contact_id`: The identifier of the contact.
- `initial_contact_id`: The identifier of the contact. This is the identifier of the
contact associated with the first interaction with the contact center.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function resume_contact_recording(
ContactId,
InitialContactId,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/resume-recording",
Dict{String,Any}(
"ContactId" => ContactId,
"InitialContactId" => InitialContactId,
"InstanceId" => InstanceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resume_contact_recording(
ContactId,
InitialContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/resume-recording",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"InitialContactId" => InitialContactId,
"InstanceId" => InstanceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_available_phone_numbers(phone_number_country_code, phone_number_type)
search_available_phone_numbers(phone_number_country_code, phone_number_type, params::Dict{String,<:Any})
Searches for available phone numbers that you can claim to your Amazon Connect instance or
traffic distribution group. If the provided TargetArn is a traffic distribution group, you
can call this API in both Amazon Web Services Regions associated with the traffic
distribution group.
# Arguments
- `phone_number_country_code`: The ISO country code.
- `phone_number_type`: The type of phone number.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceId"`: The identifier of the Amazon Connect instance that phone numbers are
claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
You must enter InstanceId or TargetArn.
- `"MaxResults"`: The maximum number of results to return per page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"PhoneNumberPrefix"`: The prefix of the phone number. If provided, it must contain + as
part of the country code.
- `"TargetArn"`: The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
distribution groups that phone number inbound traffic is routed through. You must enter
InstanceId or TargetArn.
"""
function search_available_phone_numbers(
PhoneNumberCountryCode,
PhoneNumberType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/phone-number/search-available",
Dict{String,Any}(
"PhoneNumberCountryCode" => PhoneNumberCountryCode,
"PhoneNumberType" => PhoneNumberType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_available_phone_numbers(
PhoneNumberCountryCode,
PhoneNumberType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/phone-number/search-available",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PhoneNumberCountryCode" => PhoneNumberCountryCode,
"PhoneNumberType" => PhoneNumberType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_contact_flow_modules(instance_id)
search_contact_flow_modules(instance_id, params::Dict{String,<:Any})
Searches the flow modules in an Amazon Connect instance, with optional filtering.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`: The search criteria to be used to return contact flow modules. The
name and description fields support \"contains\" queries with a minimum of 2 characters and
a maximum of 25 characters. Any queries with character lengths outside of this range will
result in invalid results.
- `"SearchFilter"`: Filters to be applied to search results.
"""
function search_contact_flow_modules(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/search-contact-flow-modules",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_contact_flow_modules(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-contact-flow-modules",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_contact_flows(instance_id)
search_contact_flows(instance_id, params::Dict{String,<:Any})
Searches the contact flows in an Amazon Connect instance, with optional filtering.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`: The search criteria to be used to return flows. The name and
description fields support \"contains\" queries with a minimum of 2 characters and a
maximum of 25 characters. Any queries with character lengths outside of this range will
result in invalid results.
- `"SearchFilter"`: Filters to be applied to search results.
"""
function search_contact_flows(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"POST",
"/search-contact-flows",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_contact_flows(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-contact-flows",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_contacts(instance_id, time_range)
search_contacts(instance_id, time_range, params::Dict{String,<:Any})
Searches contacts in an Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of Amazon Connect instance. You can find the instance ID in
the Amazon Resource Name (ARN) of the instance.
- `time_range`: Time range that you want to search results.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`: The search criteria to be used to return contacts.
- `"Sort"`: Specifies a field to sort by and a sort order.
"""
function search_contacts(
InstanceId, TimeRange; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/search-contacts",
Dict{String,Any}("InstanceId" => InstanceId, "TimeRange" => TimeRange);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_contacts(
InstanceId,
TimeRange,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-contacts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "TimeRange" => TimeRange),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_hours_of_operations(instance_id)
search_hours_of_operations(instance_id, params::Dict{String,<:Any})
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`: The search criteria to be used to return hours of operations.
- `"SearchFilter"`: Filters to be applied to search results.
"""
function search_hours_of_operations(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/search-hours-of-operations",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_hours_of_operations(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-hours-of-operations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_predefined_attributes(instance_id)
search_predefined_attributes(instance_id, params::Dict{String,<:Any})
Predefined attributes that meet certain criteria.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`: The search criteria to be used to return predefined attributes.
"""
function search_predefined_attributes(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/search-predefined-attributes",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_predefined_attributes(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-predefined-attributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_prompts(instance_id)
search_prompts(instance_id, params::Dict{String,<:Any})
Searches prompts in an Amazon Connect instance, with optional filtering.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`: The search criteria to be used to return prompts.
- `"SearchFilter"`: Filters to be applied to search results.
"""
function search_prompts(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"POST",
"/search-prompts",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_prompts(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-prompts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_queues(instance_id)
search_queues(instance_id, params::Dict{String,<:Any})
Searches queues in an Amazon Connect instance, with optional filtering.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`: The search criteria to be used to return queues. The name and
description fields support \"contains\" queries with a minimum of 2 characters and a
maximum of 25 characters. Any queries with character lengths outside of this range will
throw invalid results.
- `"SearchFilter"`: Filters to be applied to search results.
"""
function search_queues(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"POST",
"/search-queues",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_queues(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-queues",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_quick_connects(instance_id)
search_quick_connects(instance_id, params::Dict{String,<:Any})
Searches quick connects in an Amazon Connect instance, with optional filtering.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`: The search criteria to be used to return quick connects.
- `"SearchFilter"`: Filters to be applied to search results.
"""
function search_quick_connects(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/search-quick-connects",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_quick_connects(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-quick-connects",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_resource_tags(instance_id)
search_resource_tags(instance_id, params::Dict{String,<:Any})
Searches tags used in an Amazon Connect instance using optional search criteria.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"ResourceTypes"`: The list of resource types to be used to search tags from. If not
provided or if any empty list is provided, this API will search from all supported resource
types.
- `"SearchCriteria"`: The search criteria to be used to return tags.
"""
function search_resource_tags(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"POST",
"/search-resource-tags",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_resource_tags(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-resource-tags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_routing_profiles(instance_id)
search_routing_profiles(instance_id, params::Dict{String,<:Any})
Searches routing profiles in an Amazon Connect instance, with optional filtering.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`: The search criteria to be used to return routing profiles. The name
and description fields support \"contains\" queries with a minimum of 2 characters and a
maximum of 25 characters. Any queries with character lengths outside of this range will
throw invalid results.
- `"SearchFilter"`: Filters to be applied to search results.
"""
function search_routing_profiles(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/search-routing-profiles",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_routing_profiles(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-routing-profiles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_security_profiles(instance_id)
search_security_profiles(instance_id, params::Dict{String,<:Any})
Searches security profiles in an Amazon Connect instance, with optional filtering.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`: The search criteria to be used to return security profiles. The
name field support \"contains\" queries with a minimum of 2 characters and maximum of 25
characters. Any queries with character lengths outside of this range will throw invalid
results. The currently supported value for FieldName: name
- `"SearchFilter"`: Filters to be applied to search results.
"""
function search_security_profiles(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/search-security-profiles",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_security_profiles(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-security-profiles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_users(instance_id)
search_users(instance_id, params::Dict{String,<:Any})
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit is returned in milliseconds.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance. InstanceID is a required field. The
\"Required: No\" below is incorrect.
# 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 page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"SearchCriteria"`:
- `"SearchFilter"`: Filters to be applied to search results.
"""
function search_users(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"POST",
"/search-users",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_users(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/search-users",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_vocabularies(instance_id)
search_vocabularies(instance_id, params::Dict{String,<:Any})
Searches for vocabularies within a specific Amazon Connect instance using State,
NameStartsWith, and LanguageCode.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LanguageCode"`: The language code of the vocabulary entries. For a list of languages
and their corresponding language codes, see What is Amazon Transcribe?
- `"MaxResults"`: The maximum number of results to return per page.
- `"NameStartsWith"`: The starting pattern of the name of the vocabulary.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"State"`: The current state of the custom vocabulary.
"""
function search_vocabularies(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"POST",
"/vocabulary-summary/$(InstanceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_vocabularies(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/vocabulary-summary/$(InstanceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_chat_integration_event(destination_id, event, source_id)
send_chat_integration_event(destination_id, event, source_id, params::Dict{String,<:Any})
Processes chat integration events from Amazon Web Services or external integrations to
Amazon Connect. A chat integration event includes: SourceId, DestinationId, and Subtype:
a set of identifiers, uniquely representing a chat ChatEvent: details of the chat action
to perform such as sending a message, event, or disconnecting from a chat When a chat
integration event is sent with chat identifiers that do not map to an active chat contact,
a new chat contact is also created before handling chat action. Access to this API is
currently restricted to Amazon Pinpoint for supporting SMS integration.
# Arguments
- `destination_id`: Chat system identifier, used in part to uniquely identify chat. This is
associated with the Amazon Connect instance and flow to be used to start chats. For SMS,
this is the phone number destination of inbound SMS messages represented by an Amazon
Pinpoint phone number ARN.
- `event`: Chat integration event payload
- `source_id`: External identifier of chat customer participant, used in part to uniquely
identify a chat. For SMS, this is the E164 phone number of the chat customer participant.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NewSessionDetails"`: Contact properties to apply when starting a new chat. If the
integration event is handled with an existing chat, this is ignored.
- `"Subtype"`: Classification of a channel. This is used in part to uniquely identify chat.
Valid value: [\"connect:sms\"]
"""
function send_chat_integration_event(
DestinationId, Event, SourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/chat-integration-event",
Dict{String,Any}(
"DestinationId" => DestinationId, "Event" => Event, "SourceId" => SourceId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_chat_integration_event(
DestinationId,
Event,
SourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/chat-integration-event",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationId" => DestinationId,
"Event" => Event,
"SourceId" => SourceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_attached_file_upload(file_name, file_size_in_bytes, file_use_case_type, instance_id, associated_resource_arn)
start_attached_file_upload(file_name, file_size_in_bytes, file_use_case_type, instance_id, associated_resource_arn, params::Dict{String,<:Any})
Provides a pre-signed Amazon S3 URL in response for uploading your content. You may only
use this API to upload attachments to a Connect Case.
# Arguments
- `file_name`: A case-sensitive name of the attached file being uploaded.
- `file_size_in_bytes`: The size of the attached file in bytes.
- `file_use_case_type`: The use case for the file.
- `instance_id`: The unique identifier of the Connect instance.
- `associated_resource_arn`: The resource to which the attached file is (being) uploaded
to. Cases are the only current supported resource. This value must be a valid ARN.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"CreatedBy"`: Represents the identity that created the file.
- `"Tags"`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
- `"UrlExpiryInSeconds"`: Optional override for the expiry of the pre-signed S3 URL in
seconds. The default value is 300.
"""
function start_attached_file_upload(
FileName,
FileSizeInBytes,
FileUseCaseType,
InstanceId,
associatedResourceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/attached-files/$(InstanceId)",
Dict{String,Any}(
"FileName" => FileName,
"FileSizeInBytes" => FileSizeInBytes,
"FileUseCaseType" => FileUseCaseType,
"associatedResourceArn" => associatedResourceArn,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_attached_file_upload(
FileName,
FileSizeInBytes,
FileUseCaseType,
InstanceId,
associatedResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/attached-files/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileName" => FileName,
"FileSizeInBytes" => FileSizeInBytes,
"FileUseCaseType" => FileUseCaseType,
"associatedResourceArn" => associatedResourceArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_chat_contact(contact_flow_id, instance_id, participant_details)
start_chat_contact(contact_flow_id, instance_id, participant_details, params::Dict{String,<:Any})
Initiates a flow to start a new chat for the customer. Response of this API provides a
token required to obtain credentials from the CreateParticipantConnection API in the Amazon
Connect Participant Service. When a new chat contact is successfully created, clients must
subscribe to the participant’s connection for the created chat within 5 minutes. This is
achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations: API rate limit is exceeded. API TPS
throttling returns a TooManyRequests exception. The quota for concurrent active chats is
exceeded. Active chat throttling returns a LimitExceededException. If you use the
ChatDurationInMinutes parameter and receive a 400 error, your account may not support the
ability to configure custom chat durations. For more information, contact Amazon Web
Services Support. For more information about chat, see Chat in the Amazon Connect
Administrator Guide.
# Arguments
- `contact_flow_id`: The identifier of the flow for initiating the chat. To see the
ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing,
Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show
additional flow information. The ContactFlowId is the last part of the ARN, shown here in
bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact
-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `participant_details`: Information identifying the participant.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: A custom key-value pair using an attribute map. The attributes are
standard Amazon Connect attributes. They can be accessed in flows just like any other
contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per
contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
- `"ChatDurationInMinutes"`: The total duration of the newly started chat session. If not
specified, the chat session duration defaults to 25 hour. The minimum configurable time is
60 minutes. The maximum configurable time is 10,080 minutes (7 days).
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"InitialMessage"`: The initial message to be sent to the newly created chat. If you have
a Lex bot in your flow, the initial message is not delivered to the Lex bot.
- `"PersistentChat"`: Enable persistent chats. For more information about enabling
persistent chat, and for example use cases and how to configure for them, see Enable
persistent chat.
- `"RelatedContactId"`: The unique identifier for an Amazon Connect contact. This
identifier is related to the chat starting. You cannot provide data for both
RelatedContactId and PersistentChat.
- `"SegmentAttributes"`: A set of system defined key-value pairs stored on individual
contact segments using an attribute map. The attributes are standard Amazon Connect
attributes. They can be accessed in flows. Attribute keys can include only alphanumeric, -,
and _. This field can be used to show channel subtype, such as connect:Guide. The types
application/vnd.amazonaws.connect.message.interactive and
application/vnd.amazonaws.connect.message.interactive.response must be present in the
SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as {
\"connect:Subtype\": {\"valueString\" : \"connect:Guide\" }}.
- `"SupportedMessagingContentTypes"`: The supported chat message content types. Supported
types are text/plain, text/markdown, application/json,
application/vnd.amazonaws.connect.message.interactive, and
application/vnd.amazonaws.connect.message.interactive.response. Content types must always
contain text/plain. You can then put any other supported type in the list. For example, all
the following lists are valid because they contain text/plain: [text/plain, text/markdown,
application/json], [text/markdown, text/plain], [text/plain, application/json,
application/vnd.amazonaws.connect.message.interactive.response]. The type
application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow
block.
"""
function start_chat_contact(
ContactFlowId,
InstanceId,
ParticipantDetails;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact/chat",
Dict{String,Any}(
"ContactFlowId" => ContactFlowId,
"InstanceId" => InstanceId,
"ParticipantDetails" => ParticipantDetails,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_chat_contact(
ContactFlowId,
InstanceId,
ParticipantDetails,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact/chat",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactFlowId" => ContactFlowId,
"InstanceId" => InstanceId,
"ParticipantDetails" => ParticipantDetails,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_contact_evaluation(contact_id, evaluation_form_id, instance_id)
start_contact_evaluation(contact_id, evaluation_form_id, instance_id, params::Dict{String,<:Any})
Starts an empty evaluation in the specified Amazon Connect instance, using the given
evaluation form for the particular contact. The evaluation form version used for the
contact evaluation corresponds to the currently activated version. If no version is
activated for the evaluation form, the contact evaluation cannot be started. Evaluations
created through the public API do not contain answer values suggested from automation.
# Arguments
- `contact_id`: The identifier of the contact in this instance of Amazon Connect.
- `evaluation_form_id`: The unique identifier for the evaluation form.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function start_contact_evaluation(
ContactId,
EvaluationFormId,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact-evaluations/$(InstanceId)",
Dict{String,Any}(
"ContactId" => ContactId,
"EvaluationFormId" => EvaluationFormId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_contact_evaluation(
ContactId,
EvaluationFormId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact-evaluations/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"EvaluationFormId" => EvaluationFormId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_contact_recording(contact_id, initial_contact_id, instance_id, voice_recording_configuration)
start_contact_recording(contact_id, initial_contact_id, instance_id, voice_recording_configuration, params::Dict{String,<:Any})
Starts recording the contact: If the API is called before the agent joins the call,
recording starts when the agent joins the call. If the API is called after the agent
joins the call, recording starts at the time of the API call. StartContactRecording is a
one-time action. For example, if you use StopContactRecording to stop recording an ongoing
call, you can't use StartContactRecording to restart it. For scenarios where the recording
has started and you want to suspend and resume it, such as when collecting sensitive
information (for example, a credit card number), use SuspendContactRecording and
ResumeContactRecording. You can use this API to override the recording behavior configured
in the Set recording behavior block. Only voice recordings are supported at this time.
# Arguments
- `contact_id`: The identifier of the contact.
- `initial_contact_id`: The identifier of the contact. This is the identifier of the
contact associated with the first interaction with the contact center.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `voice_recording_configuration`: The person being recorded.
"""
function start_contact_recording(
ContactId,
InitialContactId,
InstanceId,
VoiceRecordingConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/start-recording",
Dict{String,Any}(
"ContactId" => ContactId,
"InitialContactId" => InitialContactId,
"InstanceId" => InstanceId,
"VoiceRecordingConfiguration" => VoiceRecordingConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_contact_recording(
ContactId,
InitialContactId,
InstanceId,
VoiceRecordingConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/start-recording",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"InitialContactId" => InitialContactId,
"InstanceId" => InstanceId,
"VoiceRecordingConfiguration" => VoiceRecordingConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_contact_streaming(chat_streaming_configuration, client_token, contact_id, instance_id)
start_contact_streaming(chat_streaming_configuration, client_token, contact_id, instance_id, params::Dict{String,<:Any})
Initiates real-time message streaming for a new chat contact. For more information about
message streaming, see Enable real-time chat message streaming in the Amazon Connect
Administrator Guide.
# Arguments
- `chat_streaming_configuration`: The streaming configuration, such as the Amazon SNS
streaming endpoint.
- `client_token`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `contact_id`: The identifier of the contact. This is the identifier of the contact
associated with the first interaction with the contact center.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function start_contact_streaming(
ChatStreamingConfiguration,
ClientToken,
ContactId,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/start-streaming",
Dict{String,Any}(
"ChatStreamingConfiguration" => ChatStreamingConfiguration,
"ClientToken" => ClientToken,
"ContactId" => ContactId,
"InstanceId" => InstanceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_contact_streaming(
ChatStreamingConfiguration,
ClientToken,
ContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/start-streaming",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ChatStreamingConfiguration" => ChatStreamingConfiguration,
"ClientToken" => ClientToken,
"ContactId" => ContactId,
"InstanceId" => InstanceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_outbound_voice_contact(contact_flow_id, destination_phone_number, instance_id)
start_outbound_voice_contact(contact_flow_id, destination_phone_number, instance_id, params::Dict{String,<:Any})
Places an outbound call to a contact, and then initiates the flow. It performs the actions
in the flow that's specified (in ContactFlowId). Agents do not initiate the outbound API,
which means that they do not dial the contact. If the flow places an outbound call to a
contact, and then puts the contact in queue, the call is then routed to the agent, like any
other inbound case. There is a 60-second dialing timeout for this operation. If the call is
not connected after 60 seconds, it fails. UK numbers with a 447 prefix are not allowed by
default. Before you can dial these UK mobile numbers, you must submit a service quota
increase request. For more information, see Amazon Connect Service Quotas in the Amazon
Connect Administrator Guide. Campaign calls are not allowed by default. Before you can
make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request
to the quota Amazon Connect campaigns.
# Arguments
- `contact_flow_id`: The identifier of the flow for the outbound call. To see the
ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing,
Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show
additional flow information. The ContactFlowId is the last part of the ARN, shown here in
bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact
-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
- `destination_phone_number`: The phone number of the customer, in E.164 format.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnswerMachineDetectionConfig"`: Configuration of the answering machine detection for
this outbound call.
- `"Attributes"`: A custom key-value pair using an attribute map. The attributes are
standard Amazon Connect attributes, and can be accessed in flows just like any other
contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per
contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
- `"CampaignId"`: The campaign identifier of the outbound communication.
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent
APIs. The token is valid for 7 days after creation. If a contact is already started, the
contact ID is returned.
- `"Description"`: A description of the voice contact that is shown to an agent in the
Contact Control Panel (CCP).
- `"Name"`: The name of a voice contact that is shown to an agent in the Contact Control
Panel (CCP).
- `"QueueId"`: The queue for the call. If you specify a queue, the phone displayed for
caller ID is the phone number specified in the queue. If you do not specify a queue, the
queue defined in the flow is used. If you do not specify a queue, you must specify a source
phone number.
- `"References"`: A formatted URL that is shown to an agent in the Contact Control Panel
(CCP). Contacts can have the following reference types at the time of creation: URL |
NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice
contact creation.
- `"RelatedContactId"`: The contactId that is related to this contact. Linking voice, task,
or chat by using RelatedContactID copies over contact attributes from the related contact
to the new contact. All updates to user-defined attributes in the new contact are limited
to the individual contact ID. There are no limits to the number of contacts that can be
linked by using RelatedContactId.
- `"SourcePhoneNumber"`: The phone number associated with the Amazon Connect instance, in
E.164 format. If you do not specify a source phone number, you must specify a queue.
- `"TrafficType"`: Denotes the class of traffic. Calls with different traffic types are
handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if
EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.
"""
function start_outbound_voice_contact(
ContactFlowId,
DestinationPhoneNumber,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact/outbound-voice",
Dict{String,Any}(
"ContactFlowId" => ContactFlowId,
"DestinationPhoneNumber" => DestinationPhoneNumber,
"InstanceId" => InstanceId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_outbound_voice_contact(
ContactFlowId,
DestinationPhoneNumber,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact/outbound-voice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactFlowId" => ContactFlowId,
"DestinationPhoneNumber" => DestinationPhoneNumber,
"InstanceId" => InstanceId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_task_contact(instance_id, name)
start_task_contact(instance_id, name, params::Dict{String,<:Any})
Initiates a flow to start a new task contact. For more information about task contacts, see
Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide. When using
PreviousContactId and RelatedContactId input parameters, note the following:
PreviousContactId Any updates to user-defined task contact attributes on any contact
linked through the same PreviousContactId will affect every contact in the chain. There
can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be
created that share the same PreviousContactId. RelatedContactId Copies contact
attributes from the related task contact to the new contact. Any update on attributes in
a new task contact does not update attributes on previous contact. There’s no limit on
the number of task contacts that can be created that use the same RelatedContactId. In
addition, when calling StartTaskContact include only one of these parameters:
ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as
the task template has a flow configured to run it. If more than one parameter is specified,
or only the TaskTemplateID is specified but it does not have a flow configured, the request
returns an error because Amazon Connect cannot identify the unique flow to run when the
task is created. A ServiceQuotaExceededException occurs when the number of open tasks
exceeds the active tasks quota or there are already 12 tasks referencing the same
PreviousContactId. For more information about service quotas for task contacts, see Amazon
Connect service quotas in the Amazon Connect Administrator Guide.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of a task that is shown to an agent in the Contact Control Panel (CCP).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attributes"`: A custom key-value pair using an attribute map. The attributes are
standard Amazon Connect attributes, and can be accessed in flows just like any other
contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per
contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"ContactFlowId"`: The identifier of the flow for initiating the tasks. To see the
ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing,
Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show
additional flow information. The ContactFlowId is the last part of the ARN, shown here in
bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact
-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
- `"Description"`: A description of the task that is shown to an agent in the Contact
Control Panel (CCP).
- `"PreviousContactId"`: The identifier of the previous chat, voice, or task contact. Any
updates to user-defined attributes to task contacts linked using the same PreviousContactID
will affect every contact in the chain. There can be a maximum of 12 linked task contacts
in a chain.
- `"QuickConnectId"`: The identifier for the quick connect. Tasks that are created by using
QuickConnectId will use the flow that is defined on agent or queue quick connect. For more
information about quick connects, see Create quick connects.
- `"References"`: A formatted URL that is shown to an agent in the Contact Control Panel
(CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER |
STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.
- `"RelatedContactId"`: The contactId that is related to this contact. Linking tasks
together by using RelatedContactID copies over contact attributes from the related task
contact to the new task contact. All updates to user-defined attributes in the new task
contact are limited to the individual contact ID, unlike what happens when tasks are linked
by using PreviousContactID. There are no limits to the number of contacts that can be
linked by using RelatedContactId.
- `"ScheduledTime"`: The timestamp, in Unix Epoch seconds format, at which to start running
the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days
in future.
- `"TaskTemplateId"`: A unique identifier for the task template. For more information about
task templates, see Create task templates in the Amazon Connect Administrator Guide.
"""
function start_task_contact(
InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/contact/task",
Dict{String,Any}(
"InstanceId" => InstanceId, "Name" => Name, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_task_contact(
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact/task",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceId" => InstanceId,
"Name" => Name,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_web_rtccontact(contact_flow_id, instance_id, participant_details)
start_web_rtccontact(contact_flow_id, instance_id, participant_details, params::Dict{String,<:Any})
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It
performs the actions in the flow that are specified (in ContactFlowId) and present in the
Amazon Connect instance (specified as InstanceId).
# Arguments
- `contact_flow_id`: The identifier of the flow for the call. To see the ContactFlowId in
the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows.
Choose the flow. On the flow page, under the name of the flow, choose Show additional flow
information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact
-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `participant_details`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowedCapabilities"`: Information about the video sharing capabilities of the
participants (customer, agent).
- `"Attributes"`: A custom key-value pair using an attribute map. The attributes are
standard Amazon Connect attributes, and can be accessed in flows just like any other
contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per
contact. Attribute keys can include only alphanumeric, -, and _ characters.
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent
APIs. The token is valid for 7 days after creation. If a contact is already started, the
contact ID is returned.
- `"Description"`: A description of the task that is shown to an agent in the Contact
Control Panel (CCP).
- `"References"`: A formatted URL that is shown to an agent in the Contact Control Panel
(CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER |
STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.
- `"RelatedContactId"`: The unique identifier for an Amazon Connect contact. This
identifier is related to the contact starting.
"""
function start_web_rtccontact(
ContactFlowId,
InstanceId,
ParticipantDetails;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact/webrtc",
Dict{String,Any}(
"ContactFlowId" => ContactFlowId,
"InstanceId" => InstanceId,
"ParticipantDetails" => ParticipantDetails,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_web_rtccontact(
ContactFlowId,
InstanceId,
ParticipantDetails,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact/webrtc",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactFlowId" => ContactFlowId,
"InstanceId" => InstanceId,
"ParticipantDetails" => ParticipantDetails,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_contact(contact_id, instance_id)
stop_contact(contact_id, instance_id, params::Dict{String,<:Any})
Ends the specified contact. Use this API to stop queued callbacks. It does not work for
voice contacts that use the following initiation methods: DISCONNECT TRANSFER
QUEUE_TRANSFER EXTERNAL_OUTBOUND MONITOR Chat and task contacts can be terminated in
any state, regardless of initiation method.
# Arguments
- `contact_id`: The ID of the contact.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisconnectReason"`: The reason a contact can be disconnected. Only Amazon Connect
outbound campaigns can provide this field.
"""
function stop_contact(
ContactId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact/stop",
Dict{String,Any}("ContactId" => ContactId, "InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_contact(
ContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/stop",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ContactId" => ContactId, "InstanceId" => InstanceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_contact_recording(contact_id, initial_contact_id, instance_id)
stop_contact_recording(contact_id, initial_contact_id, instance_id, params::Dict{String,<:Any})
Stops recording a call when a contact is being recorded. StopContactRecording is a one-time
action. If you use StopContactRecording to stop recording an ongoing call, you can't use
StartContactRecording to restart it. For scenarios where the recording has started and you
want to suspend it for sensitive information (for example, to collect a credit card
number), and then restart it, use SuspendContactRecording and ResumeContactRecording. Only
voice recordings are supported at this time.
# Arguments
- `contact_id`: The identifier of the contact.
- `initial_contact_id`: The identifier of the contact. This is the identifier of the
contact associated with the first interaction with the contact center.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function stop_contact_recording(
ContactId,
InitialContactId,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/stop-recording",
Dict{String,Any}(
"ContactId" => ContactId,
"InitialContactId" => InitialContactId,
"InstanceId" => InstanceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_contact_recording(
ContactId,
InitialContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/stop-recording",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"InitialContactId" => InitialContactId,
"InstanceId" => InstanceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_contact_streaming(contact_id, instance_id, streaming_id)
stop_contact_streaming(contact_id, instance_id, streaming_id, params::Dict{String,<:Any})
Ends message streaming on a specified contact. To restart message streaming on that
contact, call the StartContactStreaming API.
# Arguments
- `contact_id`: The identifier of the contact. This is the identifier of the contact that
is associated with the first interaction with the contact center.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `streaming_id`: The identifier of the streaming configuration enabled.
"""
function stop_contact_streaming(
ContactId, InstanceId, StreamingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact/stop-streaming",
Dict{String,Any}(
"ContactId" => ContactId,
"InstanceId" => InstanceId,
"StreamingId" => StreamingId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_contact_streaming(
ContactId,
InstanceId,
StreamingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/stop-streaming",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"InstanceId" => InstanceId,
"StreamingId" => StreamingId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
submit_contact_evaluation(evaluation_id, instance_id)
submit_contact_evaluation(evaluation_id, instance_id, params::Dict{String,<:Any})
Submits a contact evaluation in the specified Amazon Connect instance. Answers included in
the request are merged with existing answers for the given evaluation. If no answers or
notes are passed, the evaluation is submitted with the existing answers and notes. You can
delete an answer or note by passing an empty object ({}) to the question identifier. If a
contact evaluation is already in submitted state, this operation will trigger a
resubmission.
# Arguments
- `evaluation_id`: A unique identifier for the contact evaluation.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Answers"`: A map of question identifiers to answer value.
- `"Notes"`: A map of question identifiers to note value.
"""
function submit_contact_evaluation(
EvaluationId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact-evaluations/$(InstanceId)/$(EvaluationId)/submit";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function submit_contact_evaluation(
EvaluationId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact-evaluations/$(InstanceId)/$(EvaluationId)/submit",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
suspend_contact_recording(contact_id, initial_contact_id, instance_id)
suspend_contact_recording(contact_id, initial_contact_id, instance_id, params::Dict{String,<:Any})
When a contact is being recorded, this API suspends recording whatever is selected in the
flow configuration: call, screen, or both. If only call recording or only screen recording
is enabled, then it would be suspended. For example, you might suspend the screen recording
while collecting sensitive information, such as a credit card number. Then use
ResumeContactRecording to restart recording the screen. The period of time that the
recording is suspended is filled with silence in the final recording. Voice and screen
recordings are supported.
# Arguments
- `contact_id`: The identifier of the contact.
- `initial_contact_id`: The identifier of the contact. This is the identifier of the
contact associated with the first interaction with the contact center.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function suspend_contact_recording(
ContactId,
InitialContactId,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/suspend-recording",
Dict{String,Any}(
"ContactId" => ContactId,
"InitialContactId" => InitialContactId,
"InstanceId" => InstanceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function suspend_contact_recording(
ContactId,
InitialContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/suspend-recording",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"InitialContactId" => InitialContactId,
"InstanceId" => InstanceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_contact(contact_id, instance_id, tags)
tag_contact(contact_id, instance_id, tags, params::Dict{String,<:Any})
Adds the specified tags to the contact resource. For more information about this API is
used, see Set up granular billing for a detailed view of your Amazon Connect usage.
# Arguments
- `contact_id`: The identifier of the contact in this instance of Amazon Connect.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `tags`: The tags to be assigned to the contact resource. For example, { \"Tags\":
{\"key1\":\"value1\", \"key2\":\"value2\"} }. Authorization is not supported by this tag.
"""
function tag_contact(
ContactId, InstanceId, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact/tags",
Dict{String,Any}(
"ContactId" => ContactId, "InstanceId" => InstanceId, "Tags" => Tags
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_contact(
ContactId,
InstanceId,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/tags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId, "InstanceId" => InstanceId, "Tags" => Tags
),
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. Some of the supported resource types are
agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of
operation, phone numbers, security profiles, and task templates. For a complete list, see
Tagging resources in Amazon Connect. For sample policies that use tags, see Amazon Connect
Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: The tags used to organize, track, or control access for this resource. For
example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"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 connect(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
transfer_contact(contact_flow_id, contact_id, instance_id)
transfer_contact(contact_flow_id, contact_id, instance_id, params::Dict{String,<:Any})
Transfers contacts from one agent or queue to another agent or queue at any point after a
contact is created. You can transfer a contact to another queue by providing the flow which
orchestrates the contact to the destination queue. This gives you more control over contact
handling and helps you adhere to the service level agreement (SLA) guaranteed to your
customers. Note the following requirements: Transfer is supported for only TASK contacts.
Do not use both QueueId and UserId in the same call. The following flow types are
supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. The
TransferContact API can be called only on active contacts. A contact cannot be
transferred more than 11 times.
# Arguments
- `contact_flow_id`: The identifier of the flow.
- `contact_id`: The identifier of the contact in this instance of Amazon Connect.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"QueueId"`: The identifier for the queue.
- `"UserId"`: The identifier for the user. This can be the ID or the ARN of the user.
"""
function transfer_contact(
ContactFlowId, ContactId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact/transfer",
Dict{String,Any}(
"ContactFlowId" => ContactFlowId,
"ContactId" => ContactId,
"InstanceId" => InstanceId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function transfer_contact(
ContactFlowId,
ContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/transfer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactFlowId" => ContactFlowId,
"ContactId" => ContactId,
"InstanceId" => InstanceId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_contact(contact_id, instance_id, tag_keys)
untag_contact(contact_id, instance_id, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the contact resource. For more information about this API
is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
# Arguments
- `contact_id`: The identifier of the contact in this instance of Amazon Connect.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `tag_keys`: A list of tag keys. Existing tags on the contact whose keys are members of
this list will be removed.
"""
function untag_contact(
ContactId, InstanceId, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"DELETE",
"/contact/tags/$(InstanceId)/$(ContactId)",
Dict{String,Any}("TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_contact(
ContactId,
InstanceId,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"DELETE",
"/contact/tags/$(InstanceId)/$(ContactId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TagKeys" => TagKeys), 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 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 connect(
"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 connect(
"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_agent_status(agent_status_id, instance_id)
update_agent_status(agent_status_id, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Updates agent
status.
# Arguments
- `agent_status_id`: The identifier of the agent status.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the agent status.
- `"DisplayOrder"`: The display order of the agent status.
- `"Name"`: The name of the agent status.
- `"ResetOrderNumber"`: A number indicating the reset order of the agent status.
- `"State"`: The state of the agent status.
"""
function update_agent_status(
AgentStatusId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/agent-status/$(InstanceId)/$(AgentStatusId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_agent_status(
AgentStatusId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/agent-status/$(InstanceId)/$(AgentStatusId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact(contact_id, instance_id)
update_contact(contact_id, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Adds or updates
user-defined contact information associated with the specified contact. At least one field
to be updated must be present in the request. You can add or update user-defined contact
information for both ongoing and completed contacts.
# Arguments
- `contact_id`: The identifier of the contact. This is the identifier of the contact
associated with the first interaction with your contact center.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the contact.
- `"Name"`: The name of the contact.
- `"References"`: Well-formed data on contact, shown to agents on Contact Control Panel
(CCP).
"""
function update_contact(
ContactId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contacts/$(InstanceId)/$(ContactId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact(
ContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contacts/$(InstanceId)/$(ContactId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_attributes(attributes, initial_contact_id, instance_id)
update_contact_attributes(attributes, initial_contact_id, instance_id, params::Dict{String,<:Any})
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts.
For example, while the call is active, you can update the customer's name or the reason the
customer called. You can add notes about steps that the agent took during the call that
display to the next agent that takes the call. You can also update attributes for a contact
using data from your CRM application and save the data with the contact in Amazon Connect.
You could also flag calls for additional analysis, such as legal review or to identify
abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are
then deleted. For information about contact record retention and the maximum size of the
contact record attributes section, see Feature specifications in the Amazon Connect
Administrator Guide.
# Arguments
- `attributes`: The Amazon Connect attributes. These attributes can be accessed in flows
just like any other contact attributes. You can have up to 32,768 UTF-8 bytes across all
attributes for a contact. Attribute keys can include only alphanumeric, dash, and
underscore characters. When the attributes for a contact exceed 32 KB, the contact is
routed down the Error branch of the flow. As a mitigation, consider the following options:
Remove unnecessary attributes by setting their values to empty. If the attributes are
only used in one flow and don't need to be referred to outside of that flow (for example,
by a Lambda or another flow), then use flow attributes. This way you aren't needlessly
persisting the 32 KB of information from one flow to another. For more information, see
Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
- `initial_contact_id`: The identifier of the contact. This is the identifier of the
contact associated with the first interaction with the contact center.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function update_contact_attributes(
Attributes,
InitialContactId,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/attributes",
Dict{String,Any}(
"Attributes" => Attributes,
"InitialContactId" => InitialContactId,
"InstanceId" => InstanceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_attributes(
Attributes,
InitialContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/attributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Attributes" => Attributes,
"InitialContactId" => InitialContactId,
"InstanceId" => InstanceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_evaluation(evaluation_id, instance_id)
update_contact_evaluation(evaluation_id, instance_id, params::Dict{String,<:Any})
Updates details about a contact evaluation in the specified Amazon Connect instance. A
contact evaluation must be in draft state. Answers included in the request are merged with
existing answers for the given evaluation. An answer or note can be deleted by passing an
empty object ({}) to the question identifier.
# Arguments
- `evaluation_id`: A unique identifier for the contact evaluation.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Answers"`: A map of question identifiers to answer value.
- `"Notes"`: A map of question identifiers to note value.
"""
function update_contact_evaluation(
EvaluationId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact-evaluations/$(InstanceId)/$(EvaluationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_evaluation(
EvaluationId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact-evaluations/$(InstanceId)/$(EvaluationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_flow_content(contact_flow_id, content, instance_id)
update_contact_flow_content(contact_flow_id, content, instance_id, params::Dict{String,<:Any})
Updates the specified flow. You can also create and update flows using the Amazon Connect
Flow language. Use the SAVED alias in the request to describe the SAVED content of a Flow.
For example, arn:aws:.../contact-flow/{id}:SAVED. Once a contact flow is published, SAVED
needs to be supplied to view saved content that has not been published.
# Arguments
- `contact_flow_id`: The identifier of the flow.
- `content`: The JSON string that represents the content of the flow. For an example, see
Example flow in Amazon Connect Flow language. Length Constraints: Minimum length of 1.
Maximum length of 256000.
- `instance_id`: The identifier of the Amazon Connect instance.
"""
function update_contact_flow_content(
ContactFlowId, Content, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact-flows/$(InstanceId)/$(ContactFlowId)/content",
Dict{String,Any}("Content" => Content);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_flow_content(
ContactFlowId,
Content,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact-flows/$(InstanceId)/$(ContactFlowId)/content",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Content" => Content), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_flow_metadata(contact_flow_id, instance_id)
update_contact_flow_metadata(contact_flow_id, instance_id, params::Dict{String,<:Any})
Updates metadata about specified flow.
# Arguments
- `contact_flow_id`: The identifier of the flow.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContactFlowState"`: The state of flow.
- `"Description"`: The description of the flow.
- `"Name"`: The name of the flow.
"""
function update_contact_flow_metadata(
ContactFlowId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact-flows/$(InstanceId)/$(ContactFlowId)/metadata";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_flow_metadata(
ContactFlowId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact-flows/$(InstanceId)/$(ContactFlowId)/metadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_flow_module_content(contact_flow_module_id, content, instance_id)
update_contact_flow_module_content(contact_flow_module_id, content, instance_id, params::Dict{String,<:Any})
Updates specified flow module for the specified Amazon Connect instance. Use the SAVED
alias in the request to describe the SAVED content of a Flow. For example,
arn:aws:.../contact-flow/{id}:SAVED. Once a contact flow is published, SAVED needs to be
supplied to view saved content that has not been published.
# Arguments
- `contact_flow_module_id`: The identifier of the flow module.
- `content`: The JSON string that represents the content of the flow. For an example, see
Example flow in Amazon Connect Flow language.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function update_contact_flow_module_content(
ContactFlowModuleId,
Content,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact-flow-modules/$(InstanceId)/$(ContactFlowModuleId)/content",
Dict{String,Any}("Content" => Content);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_flow_module_content(
ContactFlowModuleId,
Content,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact-flow-modules/$(InstanceId)/$(ContactFlowModuleId)/content",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Content" => Content), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_flow_module_metadata(contact_flow_module_id, instance_id)
update_contact_flow_module_metadata(contact_flow_module_id, instance_id, params::Dict{String,<:Any})
Updates metadata about specified flow module.
# Arguments
- `contact_flow_module_id`: The identifier of the flow module.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the flow module.
- `"Name"`: The name of the flow module.
- `"State"`: The state of flow module.
"""
function update_contact_flow_module_metadata(
ContactFlowModuleId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact-flow-modules/$(InstanceId)/$(ContactFlowModuleId)/metadata";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_flow_module_metadata(
ContactFlowModuleId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact-flow-modules/$(InstanceId)/$(ContactFlowModuleId)/metadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_flow_name(contact_flow_id, instance_id)
update_contact_flow_name(contact_flow_id, instance_id, params::Dict{String,<:Any})
The name of the flow. You can also create and update flows using the Amazon Connect Flow
language.
# Arguments
- `contact_flow_id`: The identifier of the flow.
- `instance_id`: The identifier of the Amazon Connect instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the flow.
- `"Name"`: The name of the flow.
"""
function update_contact_flow_name(
ContactFlowId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact-flows/$(InstanceId)/$(ContactFlowId)/name";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_flow_name(
ContactFlowId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact-flows/$(InstanceId)/$(ContactFlowId)/name",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_routing_data(contact_id, instance_id)
update_contact_routing_data(contact_id, instance_id, params::Dict{String,<:Any})
Updates routing priority and age on the contact (QueuePriority and
QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position
in the queue. For example, you can move a contact to the back of the queue by setting a
lower routing priority relative to other contacts in queue; or you can move a contact to
the front of the queue by increasing the routing age which will make the contact look
artificially older and therefore higher up in the first-in-first-out routing order. Note
that adjusting the routing age of a contact affects only its position in queue, and not its
actual queue wait time as reported through metrics. These properties can also be updated by
using the Set routing priority / age flow block. Either QueuePriority or
QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.
# Arguments
- `contact_id`: The identifier of the contact in this instance of Amazon Connect.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"QueuePriority"`: Priority of the contact in the queue. The default priority for new
contacts is 5. You can raise the priority of a contact compared to other contacts in the
queue by assigning them a higher priority, such as 1 or 2.
- `"QueueTimeAdjustmentSeconds"`: The number of seconds to add or subtract from the
contact's routing age. Contacts are routed to agents on a first-come, first-serve basis.
This means that changing their amount of time in queue compared to others also changes
their position in queue.
"""
function update_contact_routing_data(
ContactId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contacts/$(InstanceId)/$(ContactId)/routing-data";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_routing_data(
ContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contacts/$(InstanceId)/$(ContactId)/routing-data",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contact_schedule(contact_id, instance_id, scheduled_time)
update_contact_schedule(contact_id, instance_id, scheduled_time, params::Dict{String,<:Any})
Updates the scheduled time of a task contact that is already scheduled.
# Arguments
- `contact_id`: The identifier of the contact.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `scheduled_time`: The timestamp, in Unix Epoch seconds format, at which to start running
the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days
in future.
"""
function update_contact_schedule(
ContactId, InstanceId, ScheduledTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/contact/schedule",
Dict{String,Any}(
"ContactId" => ContactId,
"InstanceId" => InstanceId,
"ScheduledTime" => ScheduledTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contact_schedule(
ContactId,
InstanceId,
ScheduledTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/contact/schedule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContactId" => ContactId,
"InstanceId" => InstanceId,
"ScheduledTime" => ScheduledTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_evaluation_form(evaluation_form_id, evaluation_form_version, instance_id, items, title)
update_evaluation_form(evaluation_form_id, evaluation_form_version, instance_id, items, title, params::Dict{String,<:Any})
Updates details about a specific evaluation form version in the specified Amazon Connect
instance. Question and section identifiers cannot be duplicated within the same evaluation
form. This operation does not support partial updates. Instead it does a full update of
evaluation form content.
# Arguments
- `evaluation_form_id`: The unique identifier for the evaluation form.
- `evaluation_form_version`: A version of the evaluation form to update.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `items`: Items that are part of the evaluation form. The total number of sections and
questions must not exceed 100 each. Questions must be contained in a section.
- `title`: A title of the evaluation form.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"CreateNewVersion"`: A flag indicating whether the operation must create a new version.
- `"Description"`: The description of the evaluation form.
- `"ScoringStrategy"`: A scoring strategy of the evaluation form.
"""
function update_evaluation_form(
EvaluationFormId,
EvaluationFormVersion,
InstanceId,
Items,
Title;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)",
Dict{String,Any}(
"EvaluationFormVersion" => EvaluationFormVersion,
"Items" => Items,
"Title" => Title,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_evaluation_form(
EvaluationFormId,
EvaluationFormVersion,
InstanceId,
Items,
Title,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/evaluation-forms/$(InstanceId)/$(EvaluationFormId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EvaluationFormVersion" => EvaluationFormVersion,
"Items" => Items,
"Title" => Title,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_hours_of_operation(hours_of_operation_id, instance_id)
update_hours_of_operation(hours_of_operation_id, instance_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Updates the
hours of operation.
# Arguments
- `hours_of_operation_id`: The identifier of the hours of operation.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Config"`: Configuration information of the hours of operation.
- `"Description"`: The description of the hours of operation.
- `"Name"`: The name of the hours of operation.
- `"TimeZone"`: The time zone of the hours of operation.
"""
function update_hours_of_operation(
HoursOfOperationId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/hours-of-operations/$(InstanceId)/$(HoursOfOperationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_hours_of_operation(
HoursOfOperationId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/hours-of-operations/$(InstanceId)/$(HoursOfOperationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_instance_attribute(attribute_type, instance_id, value)
update_instance_attribute(attribute_type, instance_id, value, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Updates the
value for the specified attribute type.
# Arguments
- `attribute_type`: The type of attribute. Only allowlisted customers can consume
USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for
allowlisting.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `value`: The value for the attribute. Maximum character limit is 100.
"""
function update_instance_attribute(
AttributeType, InstanceId, Value; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/instance/$(InstanceId)/attribute/$(AttributeType)",
Dict{String,Any}("Value" => Value);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_instance_attribute(
AttributeType,
InstanceId,
Value,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/instance/$(InstanceId)/attribute/$(AttributeType)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Value" => Value), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_instance_storage_config(association_id, instance_id, storage_config, resource_type)
update_instance_storage_config(association_id, instance_id, storage_config, resource_type, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Updates an
existing configuration for a resource type. This API is idempotent.
# Arguments
- `association_id`: The existing association identifier that uniquely identifies the
resource type and storage config for the given instance ID.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `storage_config`:
- `resource_type`: A valid resource type.
"""
function update_instance_storage_config(
AssociationId,
InstanceId,
StorageConfig,
resourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/instance/$(InstanceId)/storage-config/$(AssociationId)",
Dict{String,Any}("StorageConfig" => StorageConfig, "resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_instance_storage_config(
AssociationId,
InstanceId,
StorageConfig,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/instance/$(InstanceId)/storage-config/$(AssociationId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StorageConfig" => StorageConfig, "resourceType" => resourceType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_participant_role_config(channel_configuration, contact_id, instance_id)
update_participant_role_config(channel_configuration, contact_id, instance_id, params::Dict{String,<:Any})
Updates timeouts for when human chat participants are to be considered idle, and when
agents are automatically disconnected from a chat due to idleness. You can set four timers:
Customer idle timeout Customer auto-disconnect timeout Agent idle timeout Agent
auto-disconnect timeout For more information about how chat timeouts work, see Set up
chat timeouts for human participants.
# Arguments
- `channel_configuration`: The Amazon Connect channel you want to configure.
- `contact_id`: The identifier of the contact in this instance of Amazon Connect.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function update_participant_role_config(
ChannelConfiguration,
ContactId,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact/participant-role-config/$(InstanceId)/$(ContactId)",
Dict{String,Any}("ChannelConfiguration" => ChannelConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_participant_role_config(
ChannelConfiguration,
ContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/contact/participant-role-config/$(InstanceId)/$(ContactId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ChannelConfiguration" => ChannelConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_phone_number(phone_number_id)
update_phone_number(phone_number_id, params::Dict{String,<:Any})
Updates your claimed phone number from its current Amazon Connect instance or traffic
distribution group to another Amazon Connect instance or traffic distribution group in the
same Amazon Web Services Region. After using this API, you must verify that the phone
number is attached to the correct flow in the target instance or traffic distribution
group. You need to do this because the API switches only the phone number to a new instance
or traffic distribution group. It doesn't migrate the flow configuration of the phone
number, too. You can call DescribePhoneNumber API to verify the status of a previous
UpdatePhoneNumber operation.
# Arguments
- `phone_number_id`: A unique identifier for the phone number.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"InstanceId"`: The identifier of the Amazon Connect instance that phone numbers are
claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
You must enter InstanceId or TargetArn.
- `"TargetArn"`: The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
distribution groups that phone number inbound traffic is routed through. You must enter
InstanceId or TargetArn.
"""
function update_phone_number(
PhoneNumberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/phone-number/$(PhoneNumberId)",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_phone_number(
PhoneNumberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/phone-number/$(PhoneNumberId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_phone_number_metadata(phone_number_id)
update_phone_number_metadata(phone_number_id, params::Dict{String,<:Any})
Updates a phone number’s metadata. To verify the status of a previous
UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
# Arguments
- `phone_number_id`: The Amazon Resource Name (ARN) or resource ID of the phone number.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"PhoneNumberDescription"`: The description of the phone number.
"""
function update_phone_number_metadata(
PhoneNumberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/phone-number/$(PhoneNumberId)/metadata",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_phone_number_metadata(
PhoneNumberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/phone-number/$(PhoneNumberId)/metadata",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_predefined_attribute(instance_id, name)
update_predefined_attribute(instance_id, name, params::Dict{String,<:Any})
Updates a predefined attribute for the specified Amazon Connect instance.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the predefined attribute.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Values"`: The values of the predefined attribute.
"""
function update_predefined_attribute(
InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/predefined-attributes/$(InstanceId)/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_predefined_attribute(
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/predefined-attributes/$(InstanceId)/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_prompt(instance_id, prompt_id)
update_prompt(instance_id, prompt_id, params::Dict{String,<:Any})
Updates a prompt.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `prompt_id`: A unique identifier for the prompt.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the prompt.
- `"Name"`: The name of the prompt.
- `"S3Uri"`: The URI for the S3 bucket where the prompt is stored. You can provide S3
pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
"""
function update_prompt(
InstanceId, PromptId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/prompts/$(InstanceId)/$(PromptId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_prompt(
InstanceId,
PromptId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/prompts/$(InstanceId)/$(PromptId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_queue_hours_of_operation(hours_of_operation_id, instance_id, queue_id)
update_queue_hours_of_operation(hours_of_operation_id, instance_id, queue_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Updates the
hours of operation for the specified queue.
# Arguments
- `hours_of_operation_id`: The identifier for the hours of operation.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_id`: The identifier for the queue.
"""
function update_queue_hours_of_operation(
HoursOfOperationId,
InstanceId,
QueueId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/hours-of-operation",
Dict{String,Any}("HoursOfOperationId" => HoursOfOperationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_queue_hours_of_operation(
HoursOfOperationId,
InstanceId,
QueueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/hours-of-operation",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("HoursOfOperationId" => HoursOfOperationId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_queue_max_contacts(instance_id, queue_id)
update_queue_max_contacts(instance_id, queue_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Updates the
maximum number of contacts allowed in a queue before it is considered full.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_id`: The identifier for the queue.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxContacts"`: The maximum number of contacts that can be in the queue before it is
considered full.
"""
function update_queue_max_contacts(
InstanceId, QueueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/max-contacts";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_queue_max_contacts(
InstanceId,
QueueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/max-contacts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_queue_name(instance_id, queue_id)
update_queue_name(instance_id, queue_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Updates the
name and description of a queue. At least Name or Description must be provided.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_id`: The identifier for the queue.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the queue.
- `"Name"`: The name of the queue.
"""
function update_queue_name(
InstanceId, QueueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/name";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_queue_name(
InstanceId,
QueueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/name",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_queue_outbound_caller_config(instance_id, outbound_caller_config, queue_id)
update_queue_outbound_caller_config(instance_id, outbound_caller_config, queue_id, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Updates the
outbound caller ID name, number, and outbound whisper flow for a specified queue. If the
phone number is claimed to a traffic distribution group that was created in the same Region
as the Amazon Connect instance where you are calling this API, then you can use a full
phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is
claimed to a traffic distribution group that is in one Region, and you are calling this API
from an instance in another Amazon Web Services Region that is associated with the traffic
distribution group, you must provide a full phone number ARN. If a UUID is provided in this
scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN
format that doesn't contain instance in the path, for example,
arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is
returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to
allow/deny access to this API for phone number resources claimed to a traffic distribution
group, see Allow or Deny queue API actions for phone numbers in a replica Region.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `outbound_caller_config`: The outbound caller ID name, number, and outbound whisper flow.
- `queue_id`: The identifier for the queue.
"""
function update_queue_outbound_caller_config(
InstanceId,
OutboundCallerConfig,
QueueId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/outbound-caller-config",
Dict{String,Any}("OutboundCallerConfig" => OutboundCallerConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_queue_outbound_caller_config(
InstanceId,
OutboundCallerConfig,
QueueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/outbound-caller-config",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("OutboundCallerConfig" => OutboundCallerConfig),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_queue_status(instance_id, queue_id, status)
update_queue_status(instance_id, queue_id, status, params::Dict{String,<:Any})
This API is in preview release for Amazon Connect and is subject to change. Updates the
status of the queue.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_id`: The identifier for the queue.
- `status`: The status of the queue.
"""
function update_queue_status(
InstanceId, QueueId, Status; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/status",
Dict{String,Any}("Status" => Status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_queue_status(
InstanceId,
QueueId,
Status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/queues/$(InstanceId)/$(QueueId)/status",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Status" => Status), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_quick_connect_config(instance_id, quick_connect_config, quick_connect_id)
update_quick_connect_config(instance_id, quick_connect_config, quick_connect_id, params::Dict{String,<:Any})
Updates the configuration settings for the specified quick connect.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `quick_connect_config`: Information about the configuration settings for the quick
connect.
- `quick_connect_id`: The identifier for the quick connect.
"""
function update_quick_connect_config(
InstanceId,
QuickConnectConfig,
QuickConnectId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/quick-connects/$(InstanceId)/$(QuickConnectId)/config",
Dict{String,Any}("QuickConnectConfig" => QuickConnectConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_quick_connect_config(
InstanceId,
QuickConnectConfig,
QuickConnectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/quick-connects/$(InstanceId)/$(QuickConnectId)/config",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("QuickConnectConfig" => QuickConnectConfig), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_quick_connect_name(instance_id, quick_connect_id)
update_quick_connect_name(instance_id, quick_connect_id, params::Dict{String,<:Any})
Updates the name and description of a quick connect. The request accepts the following data
in JSON format. At least Name or Description must be provided.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `quick_connect_id`: The identifier for the quick connect.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the quick connect.
- `"Name"`: The name of the quick connect.
"""
function update_quick_connect_name(
InstanceId, QuickConnectId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/quick-connects/$(InstanceId)/$(QuickConnectId)/name";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_quick_connect_name(
InstanceId,
QuickConnectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/quick-connects/$(InstanceId)/$(QuickConnectId)/name",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_routing_profile_agent_availability_timer(agent_availability_timer, instance_id, routing_profile_id)
update_routing_profile_agent_availability_timer(agent_availability_timer, instance_id, routing_profile_id, params::Dict{String,<:Any})
Whether agents with this routing profile will have their routing order calculated based on
time since their last inbound contact or longest idle time.
# Arguments
- `agent_availability_timer`: Whether agents with this routing profile will have their
routing order calculated based on time since their last inbound contact or longest idle
time.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `routing_profile_id`: The identifier of the routing profile.
"""
function update_routing_profile_agent_availability_timer(
AgentAvailabilityTimer,
InstanceId,
RoutingProfileId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/agent-availability-timer",
Dict{String,Any}("AgentAvailabilityTimer" => AgentAvailabilityTimer);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_routing_profile_agent_availability_timer(
AgentAvailabilityTimer,
InstanceId,
RoutingProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/agent-availability-timer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AgentAvailabilityTimer" => AgentAvailabilityTimer),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_routing_profile_concurrency(instance_id, media_concurrencies, routing_profile_id)
update_routing_profile_concurrency(instance_id, media_concurrencies, routing_profile_id, params::Dict{String,<:Any})
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a
routing profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `media_concurrencies`: The channels that agents can handle in the Contact Control Panel
(CCP).
- `routing_profile_id`: The identifier of the routing profile.
"""
function update_routing_profile_concurrency(
InstanceId,
MediaConcurrencies,
RoutingProfileId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/concurrency",
Dict{String,Any}("MediaConcurrencies" => MediaConcurrencies);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_routing_profile_concurrency(
InstanceId,
MediaConcurrencies,
RoutingProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/concurrency",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("MediaConcurrencies" => MediaConcurrencies), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_routing_profile_default_outbound_queue(default_outbound_queue_id, instance_id, routing_profile_id)
update_routing_profile_default_outbound_queue(default_outbound_queue_id, instance_id, routing_profile_id, params::Dict{String,<:Any})
Updates the default outbound queue of a routing profile.
# Arguments
- `default_outbound_queue_id`: The identifier for the default outbound queue.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `routing_profile_id`: The identifier of the routing profile.
"""
function update_routing_profile_default_outbound_queue(
DefaultOutboundQueueId,
InstanceId,
RoutingProfileId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/default-outbound-queue",
Dict{String,Any}("DefaultOutboundQueueId" => DefaultOutboundQueueId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_routing_profile_default_outbound_queue(
DefaultOutboundQueueId,
InstanceId,
RoutingProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/default-outbound-queue",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DefaultOutboundQueueId" => DefaultOutboundQueueId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_routing_profile_name(instance_id, routing_profile_id)
update_routing_profile_name(instance_id, routing_profile_id, params::Dict{String,<:Any})
Updates the name and description of a routing profile. The request accepts the following
data in JSON format. At least Name or Description must be provided.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `routing_profile_id`: The identifier of the routing profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the routing profile. Must not be more than 250
characters.
- `"Name"`: The name of the routing profile. Must not be more than 127 characters.
"""
function update_routing_profile_name(
InstanceId, RoutingProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/name";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_routing_profile_name(
InstanceId,
RoutingProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/name",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_routing_profile_queues(instance_id, queue_configs, routing_profile_id)
update_routing_profile_queues(instance_id, queue_configs, routing_profile_id, params::Dict{String,<:Any})
Updates the properties associated with a set of queues for a routing profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `queue_configs`: The queues to be updated for this routing profile. Queues must first be
associated to the routing profile. You can do this using AssociateRoutingProfileQueues.
- `routing_profile_id`: The identifier of the routing profile.
"""
function update_routing_profile_queues(
InstanceId,
QueueConfigs,
RoutingProfileId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/queues",
Dict{String,Any}("QueueConfigs" => QueueConfigs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_routing_profile_queues(
InstanceId,
QueueConfigs,
RoutingProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/routing-profiles/$(InstanceId)/$(RoutingProfileId)/queues",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("QueueConfigs" => QueueConfigs), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule(actions, function, instance_id, name, publish_status, rule_id)
update_rule(actions, function, instance_id, name, publish_status, rule_id, params::Dict{String,<:Any})
Updates a rule for the specified Amazon Connect instance. Use the Rules Function language
to code conditions for the rule.
# Arguments
- `actions`: A list of actions to be run when the rule is triggered.
- `function`: The conditions of the rule.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the rule. You can change the name only if TriggerEventSource is one
of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
OnSalesforceCaseCreate
- `publish_status`: The publish status of the rule.
- `rule_id`: A unique identifier for the rule.
"""
function update_rule(
Actions,
Function,
InstanceId,
Name,
PublishStatus,
RuleId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/rules/$(InstanceId)/$(RuleId)",
Dict{String,Any}(
"Actions" => Actions,
"Function" => Function,
"Name" => Name,
"PublishStatus" => PublishStatus,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule(
Actions,
Function,
InstanceId,
Name,
PublishStatus,
RuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"PUT",
"/rules/$(InstanceId)/$(RuleId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Actions" => Actions,
"Function" => Function,
"Name" => Name,
"PublishStatus" => PublishStatus,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_security_profile(instance_id, security_profile_id)
update_security_profile(instance_id, security_profile_id, params::Dict{String,<:Any})
Updates a security profile.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `security_profile_id`: The identifier for the security profle.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowedAccessControlHierarchyGroupId"`: The identifier of the hierarchy group that a
security profile uses to restrict access to resources in Amazon Connect.
- `"AllowedAccessControlTags"`: The list of tags that a security profile uses to restrict
access to resources in Amazon Connect.
- `"Applications"`: A list of the third-party application's metadata.
- `"Description"`: The description of the security profile.
- `"HierarchyRestrictedResources"`: The list of resources that a security profile applies
hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.
- `"Permissions"`: The permissions granted to a security profile. For a list of valid
permissions, see List of security profile permissions.
- `"TagRestrictedResources"`: The list of resources that a security profile applies tag
restrictions to in Amazon Connect.
"""
function update_security_profile(
InstanceId, SecurityProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/security-profiles/$(InstanceId)/$(SecurityProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_security_profile(
InstanceId,
SecurityProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/security-profiles/$(InstanceId)/$(SecurityProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_task_template(instance_id, task_template_id)
update_task_template(instance_id, task_template_id, params::Dict{String,<:Any})
Updates details about a specific task template in the specified Amazon Connect instance.
This operation does not support partial updates. Instead it does a full update of template
content.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `task_template_id`: A unique identifier for the task template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Constraints"`: Constraints that are applicable to the fields listed.
- `"ContactFlowId"`: The identifier of the flow that runs by default when a task is created
by referencing this template.
- `"Defaults"`: The default values for fields when a task is created by referencing this
template.
- `"Description"`: The description of the task template.
- `"Fields"`: Fields that are part of the template.
- `"Name"`: The name of the task template.
- `"Status"`: Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task
that refers to this template cannot be created.
"""
function update_task_template(
InstanceId, TaskTemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/instance/$(InstanceId)/task/template/$(TaskTemplateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_task_template(
InstanceId,
TaskTemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/instance/$(InstanceId)/task/template/$(TaskTemplateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_traffic_distribution(id)
update_traffic_distribution(id, params::Dict{String,<:Any})
Updates the traffic distribution for a given traffic distribution group. The SignInConfig
distribution is available only on a default TrafficDistributionGroup (see the IsDefault
parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution
with a modified SignInConfig and a non-default TrafficDistributionGroup, an
InvalidRequestException is returned. For more information about updating a traffic
distribution group, see Update telephony traffic distribution across Amazon Web Services
Regions in the Amazon Connect Administrator Guide.
# Arguments
- `id`: The identifier of the traffic distribution group. This can be the ID or the ARN if
the API is being called in the Region where the traffic distribution group was created. The
ARN must be provided if the call is from the replicated Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentConfig"`: The distribution of agents between the instance and its replica(s).
- `"SignInConfig"`: The distribution that determines which Amazon Web Services Regions
should be used to sign in agents in to both the instance and its replica(s).
- `"TelephonyConfig"`: The distribution of traffic between the instance and its replica(s).
"""
function update_traffic_distribution(Id; aws_config::AbstractAWSConfig=global_aws_config())
return connect(
"PUT",
"/traffic-distribution/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_traffic_distribution(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"PUT",
"/traffic-distribution/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_hierarchy(instance_id, user_id)
update_user_hierarchy(instance_id, user_id, params::Dict{String,<:Any})
Assigns the specified hierarchy group to the specified user.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `user_id`: The identifier of the user account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HierarchyGroupId"`: The identifier of the hierarchy group.
"""
function update_user_hierarchy(
InstanceId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/hierarchy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_hierarchy(
InstanceId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/hierarchy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_hierarchy_group_name(hierarchy_group_id, instance_id, name)
update_user_hierarchy_group_name(hierarchy_group_id, instance_id, name, params::Dict{String,<:Any})
Updates the name of the user hierarchy group.
# Arguments
- `hierarchy_group_id`: The identifier of the hierarchy group.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `name`: The name of the hierarchy group. Must not be more than 100 characters.
"""
function update_user_hierarchy_group_name(
HierarchyGroupId, InstanceId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/user-hierarchy-groups/$(InstanceId)/$(HierarchyGroupId)/name",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_hierarchy_group_name(
HierarchyGroupId,
InstanceId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/user-hierarchy-groups/$(InstanceId)/$(HierarchyGroupId)/name",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_hierarchy_structure(hierarchy_structure, instance_id)
update_user_hierarchy_structure(hierarchy_structure, instance_id, params::Dict{String,<:Any})
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
# Arguments
- `hierarchy_structure`: The hierarchy levels to update.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
"""
function update_user_hierarchy_structure(
HierarchyStructure, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/user-hierarchy-structure/$(InstanceId)",
Dict{String,Any}("HierarchyStructure" => HierarchyStructure);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_hierarchy_structure(
HierarchyStructure,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/user-hierarchy-structure/$(InstanceId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("HierarchyStructure" => HierarchyStructure), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_identity_info(identity_info, instance_id, user_id)
update_user_identity_info(identity_info, instance_id, user_id, params::Dict{String,<:Any})
Updates the identity information for the specified user. We strongly recommend limiting
who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change
the login credentials of other users by changing their email address. This poses a security
risk to your organization. They can change the email address of a user to the attacker's
email address, and then reset the password through email. For more information, see Best
Practices for Security Profiles in the Amazon Connect Administrator Guide.
# Arguments
- `identity_info`: The identity information for the user.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `user_id`: The identifier of the user account.
"""
function update_user_identity_info(
IdentityInfo, InstanceId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/identity-info",
Dict{String,Any}("IdentityInfo" => IdentityInfo);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_identity_info(
IdentityInfo,
InstanceId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/identity-info",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IdentityInfo" => IdentityInfo), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_phone_config(instance_id, phone_config, user_id)
update_user_phone_config(instance_id, phone_config, user_id, params::Dict{String,<:Any})
Updates the phone configuration settings for the specified user.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `phone_config`: Information about phone configuration settings for the user.
- `user_id`: The identifier of the user account.
"""
function update_user_phone_config(
InstanceId, PhoneConfig, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/phone-config",
Dict{String,Any}("PhoneConfig" => PhoneConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_phone_config(
InstanceId,
PhoneConfig,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/phone-config",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PhoneConfig" => PhoneConfig), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_proficiencies(instance_id, user_id, user_proficiencies)
update_user_proficiencies(instance_id, user_id, user_proficiencies, params::Dict{String,<:Any})
Updates the properties associated with the proficiencies of a user.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `user_id`: The identifier of the user account.
- `user_proficiencies`: The proficiencies to be updated for the user. Proficiencies must
first be associated to the user. You can do this using AssociateUserProficiencies API.
"""
function update_user_proficiencies(
InstanceId, UserId, UserProficiencies; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/proficiencies",
Dict{String,Any}("UserProficiencies" => UserProficiencies);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_proficiencies(
InstanceId,
UserId,
UserProficiencies,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/proficiencies",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("UserProficiencies" => UserProficiencies), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_routing_profile(instance_id, routing_profile_id, user_id)
update_user_routing_profile(instance_id, routing_profile_id, user_id, params::Dict{String,<:Any})
Assigns the specified routing profile to the specified user.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `routing_profile_id`: The identifier of the routing profile for the user.
- `user_id`: The identifier of the user account.
"""
function update_user_routing_profile(
InstanceId, RoutingProfileId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/routing-profile",
Dict{String,Any}("RoutingProfileId" => RoutingProfileId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_routing_profile(
InstanceId,
RoutingProfileId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/routing-profile",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RoutingProfileId" => RoutingProfileId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_security_profiles(instance_id, security_profile_ids, user_id)
update_user_security_profiles(instance_id, security_profile_ids, user_id, params::Dict{String,<:Any})
Assigns the specified security profiles to the specified user.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.
- `security_profile_ids`: The identifiers of the security profiles for the user.
- `user_id`: The identifier of the user account.
"""
function update_user_security_profiles(
InstanceId,
SecurityProfileIds,
UserId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/security-profiles",
Dict{String,Any}("SecurityProfileIds" => SecurityProfileIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_security_profiles(
InstanceId,
SecurityProfileIds,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/users/$(InstanceId)/$(UserId)/security-profiles",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SecurityProfileIds" => SecurityProfileIds), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_view_content(content, instance_id, status, view_id)
update_view_content(content, instance_id, status, view_id, params::Dict{String,<:Any})
Updates the view content of the given view identifier in the specified Amazon Connect
instance. It performs content validation if Status is set to SAVED and performs full
content validation if Status is PUBLISHED. Note that the SAVED alias' content will always
be updated, but the LATEST alias' content will only be updated if Status is PUBLISHED.
# Arguments
- `content`: View content containing all content necessary to render a view except for
runtime input data and the runtime input schema, which is auto-generated by this operation.
The total uncompressed content has a maximum file size of 400kB.
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
- `status`: Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status
will initiate validation on the content.
- `view_id`: The identifier of the view. Both ViewArn and ViewId can be used.
"""
function update_view_content(
Content, InstanceId, Status, ViewId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/views/$(InstanceId)/$(ViewId)",
Dict{String,Any}("Content" => Content, "Status" => Status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_view_content(
Content,
InstanceId,
Status,
ViewId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/views/$(InstanceId)/$(ViewId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Content" => Content, "Status" => Status), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_view_metadata(instance_id, view_id)
update_view_metadata(instance_id, view_id, params::Dict{String,<:Any})
Updates the view metadata. Note that either Name or Description must be provided.
# Arguments
- `instance_id`: The identifier of the Amazon Connect instance. You can find the instanceId
in the ARN of the instance.
- `view_id`: The identifier of the view. Both ViewArn and ViewId can be used.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the view.
- `"Name"`: The name of the view.
"""
function update_view_metadata(
InstanceId, ViewId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect(
"POST",
"/views/$(InstanceId)/$(ViewId)/metadata";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_view_metadata(
InstanceId,
ViewId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect(
"POST",
"/views/$(InstanceId)/$(ViewId)/metadata",
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 | 1813 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: connect_contact_lens
using AWS.Compat
using AWS.UUIDs
"""
list_realtime_contact_analysis_segments(contact_id, instance_id)
list_realtime_contact_analysis_segments(contact_id, instance_id, params::Dict{String,<:Any})
Provides a list of analysis segments for a real-time analysis session.
# Arguments
- `contact_id`: The identifier of the contact.
- `instance_id`: The identifier of the Amazon Connect instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximimum number of results to return per page.
- `"NextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_realtime_contact_analysis_segments(
ContactId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connect_contact_lens(
"POST",
"/realtime-contact-analysis/analysis-segments",
Dict{String,Any}("ContactId" => ContactId, "InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_realtime_contact_analysis_segments(
ContactId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connect_contact_lens(
"POST",
"/realtime-contact-analysis/analysis-segments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ContactId" => ContactId, "InstanceId" => InstanceId),
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 | 19644 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: connectcampaigns
using AWS.Compat
using AWS.UUIDs
"""
create_campaign(connect_instance_id, dialer_config, name, outbound_call_config)
create_campaign(connect_instance_id, dialer_config, name, outbound_call_config, params::Dict{String,<:Any})
Creates a campaign for the specified Amazon Connect account. This API is idempotent.
# Arguments
- `connect_instance_id`:
- `dialer_config`:
- `name`:
- `outbound_call_config`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`:
"""
function create_campaign(
connectInstanceId,
dialerConfig,
name,
outboundCallConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"PUT",
"/campaigns",
Dict{String,Any}(
"connectInstanceId" => connectInstanceId,
"dialerConfig" => dialerConfig,
"name" => name,
"outboundCallConfig" => outboundCallConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_campaign(
connectInstanceId,
dialerConfig,
name,
outboundCallConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"PUT",
"/campaigns",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectInstanceId" => connectInstanceId,
"dialerConfig" => dialerConfig,
"name" => name,
"outboundCallConfig" => outboundCallConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_campaign(id)
delete_campaign(id, params::Dict{String,<:Any})
Deletes a campaign from the specified Amazon Connect account.
# Arguments
- `id`:
"""
function delete_campaign(id; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"DELETE", "/campaigns/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_campaign(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"DELETE",
"/campaigns/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connect_instance_config(connect_instance_id)
delete_connect_instance_config(connect_instance_id, params::Dict{String,<:Any})
Deletes a connect instance config from the specified AWS account.
# Arguments
- `connect_instance_id`:
"""
function delete_connect_instance_config(
connectInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"DELETE",
"/connect-instance/$(connectInstanceId)/config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connect_instance_config(
connectInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"DELETE",
"/connect-instance/$(connectInstanceId)/config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance_onboarding_job(connect_instance_id)
delete_instance_onboarding_job(connect_instance_id, params::Dict{String,<:Any})
Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
# Arguments
- `connect_instance_id`:
"""
function delete_instance_onboarding_job(
connectInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"DELETE",
"/connect-instance/$(connectInstanceId)/onboarding";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance_onboarding_job(
connectInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"DELETE",
"/connect-instance/$(connectInstanceId)/onboarding",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_campaign(id)
describe_campaign(id, params::Dict{String,<:Any})
Describes the specific campaign.
# Arguments
- `id`:
"""
function describe_campaign(id; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"GET", "/campaigns/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_campaign(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"GET",
"/campaigns/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_campaign_state(id)
get_campaign_state(id, params::Dict{String,<:Any})
Get state of a campaign for the specified Amazon Connect account.
# Arguments
- `id`:
"""
function get_campaign_state(id; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"GET",
"/campaigns/$(id)/state";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_campaign_state(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"GET",
"/campaigns/$(id)/state",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_campaign_state_batch(campaign_ids)
get_campaign_state_batch(campaign_ids, params::Dict{String,<:Any})
Get state of campaigns for the specified Amazon Connect account.
# Arguments
- `campaign_ids`:
"""
function get_campaign_state_batch(
campaignIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"POST",
"/campaigns-state",
Dict{String,Any}("campaignIds" => campaignIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_campaign_state_batch(
campaignIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"POST",
"/campaigns-state",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("campaignIds" => campaignIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connect_instance_config(connect_instance_id)
get_connect_instance_config(connect_instance_id, params::Dict{String,<:Any})
Get the specific Connect instance config.
# Arguments
- `connect_instance_id`:
"""
function get_connect_instance_config(
connectInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"GET",
"/connect-instance/$(connectInstanceId)/config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connect_instance_config(
connectInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"GET",
"/connect-instance/$(connectInstanceId)/config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_onboarding_job_status(connect_instance_id)
get_instance_onboarding_job_status(connect_instance_id, params::Dict{String,<:Any})
Get the specific instance onboarding job status.
# Arguments
- `connect_instance_id`:
"""
function get_instance_onboarding_job_status(
connectInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"GET",
"/connect-instance/$(connectInstanceId)/onboarding";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_onboarding_job_status(
connectInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"GET",
"/connect-instance/$(connectInstanceId)/onboarding",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_campaigns()
list_campaigns(params::Dict{String,<:Any})
Provides summary information about the campaigns under the specified Amazon Connect account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`:
- `"maxResults"`:
- `"nextToken"`:
"""
function list_campaigns(; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"POST", "/campaigns-summary"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_campaigns(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"POST",
"/campaigns-summary",
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})
List tags for a resource.
# Arguments
- `arn`:
"""
function list_tags_for_resource(arn; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"GET", "/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 connectcampaigns(
"GET",
"/tags/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
pause_campaign(id)
pause_campaign(id, params::Dict{String,<:Any})
Pauses a campaign for the specified Amazon Connect account.
# Arguments
- `id`:
"""
function pause_campaign(id; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"POST",
"/campaigns/$(id)/pause";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function pause_campaign(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"POST",
"/campaigns/$(id)/pause",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_dial_request_batch(dial_requests, id)
put_dial_request_batch(dial_requests, id, params::Dict{String,<:Any})
Creates dials requests for the specified campaign Amazon Connect account. This API is
idempotent.
# Arguments
- `dial_requests`:
- `id`:
"""
function put_dial_request_batch(
dialRequests, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"PUT",
"/campaigns/$(id)/dial-requests",
Dict{String,Any}("dialRequests" => dialRequests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_dial_request_batch(
dialRequests,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"PUT",
"/campaigns/$(id)/dial-requests",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("dialRequests" => dialRequests), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resume_campaign(id)
resume_campaign(id, params::Dict{String,<:Any})
Stops a campaign for the specified Amazon Connect account.
# Arguments
- `id`:
"""
function resume_campaign(id; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"POST",
"/campaigns/$(id)/resume";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resume_campaign(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"POST",
"/campaigns/$(id)/resume",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_campaign(id)
start_campaign(id, params::Dict{String,<:Any})
Starts a campaign for the specified Amazon Connect account.
# Arguments
- `id`:
"""
function start_campaign(id; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"POST",
"/campaigns/$(id)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_campaign(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"POST",
"/campaigns/$(id)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_instance_onboarding_job(connect_instance_id, encryption_config)
start_instance_onboarding_job(connect_instance_id, encryption_config, params::Dict{String,<:Any})
Onboard the specific Amazon Connect instance to Connect Campaigns.
# Arguments
- `connect_instance_id`:
- `encryption_config`:
"""
function start_instance_onboarding_job(
connectInstanceId, encryptionConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"PUT",
"/connect-instance/$(connectInstanceId)/onboarding",
Dict{String,Any}("encryptionConfig" => encryptionConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_instance_onboarding_job(
connectInstanceId,
encryptionConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"PUT",
"/connect-instance/$(connectInstanceId)/onboarding",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("encryptionConfig" => encryptionConfig), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_campaign(id)
stop_campaign(id, params::Dict{String,<:Any})
Stops a campaign for the specified Amazon Connect account.
# Arguments
- `id`:
"""
function stop_campaign(id; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"POST",
"/campaigns/$(id)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_campaign(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"POST",
"/campaigns/$(id)/stop",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(arn, tags)
tag_resource(arn, tags, params::Dict{String,<:Any})
Tag a resource.
# Arguments
- `arn`:
- `tags`:
"""
function tag_resource(arn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"POST",
"/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 connectcampaigns(
"POST",
"/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})
Untag a resource.
# Arguments
- `arn`:
- `tag_keys`:
"""
function untag_resource(arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"DELETE",
"/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 connectcampaigns(
"DELETE",
"/tags/$(arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_campaign_dialer_config(dialer_config, id)
update_campaign_dialer_config(dialer_config, id, params::Dict{String,<:Any})
Updates the dialer config of a campaign. This API is idempotent.
# Arguments
- `dialer_config`:
- `id`:
"""
function update_campaign_dialer_config(
dialerConfig, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"POST",
"/campaigns/$(id)/dialer-config",
Dict{String,Any}("dialerConfig" => dialerConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_campaign_dialer_config(
dialerConfig,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"POST",
"/campaigns/$(id)/dialer-config",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("dialerConfig" => dialerConfig), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_campaign_name(id, name)
update_campaign_name(id, name, params::Dict{String,<:Any})
Updates the name of a campaign. This API is idempotent.
# Arguments
- `id`:
- `name`:
"""
function update_campaign_name(id, name; aws_config::AbstractAWSConfig=global_aws_config())
return connectcampaigns(
"POST",
"/campaigns/$(id)/name",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_campaign_name(
id,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcampaigns(
"POST",
"/campaigns/$(id)/name",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_campaign_outbound_call_config(id)
update_campaign_outbound_call_config(id, params::Dict{String,<:Any})
Updates the outbound call config of a campaign. This API is idempotent.
# Arguments
- `id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"answerMachineDetectionConfig"`:
- `"connectContactFlowId"`:
- `"connectSourcePhoneNumber"`:
"""
function update_campaign_outbound_call_config(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"POST",
"/campaigns/$(id)/outbound-call-config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_campaign_outbound_call_config(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcampaigns(
"POST",
"/campaigns/$(id)/outbound-call-config",
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 | 45523 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: connectcases
using AWS.Compat
using AWS.UUIDs
"""
batch_get_field(domain_id, fields)
batch_get_field(domain_id, fields, params::Dict{String,<:Any})
Returns the description for the list of fields in the request parameters.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `fields`: A list of unique field identifiers.
"""
function batch_get_field(
domainId, fields; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/fields-batch",
Dict{String,Any}("fields" => fields);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_field(
domainId,
fields,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/fields-batch",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fields" => fields), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_put_field_options(domain_id, field_id, options)
batch_put_field_options(domain_id, field_id, options, params::Dict{String,<:Any})
Creates and updates a set of field options for a single select field in a Cases domain.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `field_id`: The unique identifier of a field.
- `options`: A list of FieldOption objects.
"""
function batch_put_field_options(
domainId, fieldId, options; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"PUT",
"/domains/$(domainId)/fields/$(fieldId)/options",
Dict{String,Any}("options" => options);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_field_options(
domainId,
fieldId,
options,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"PUT",
"/domains/$(domainId)/fields/$(fieldId)/options",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("options" => options), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_case(domain_id, fields, template_id)
create_case(domain_id, fields, template_id, params::Dict{String,<:Any})
If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser
permission on the User ARN resource that you provide <p>Creates a case in the
specified Cases domain. Case system and custom fields are taken as an array id/value pairs
with a declared data types.</p> <p>The following fields are required when
creating a case:</p> <ul> <li> <p>
<code>customer_id</code> - You must provide the full customer profile ARN in
this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account
ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p>
</li> <li> <p> <code>title</code> </p> </li>
</ul>
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `fields`: An array of objects with field ID (matching ListFields/DescribeField) and value
union data.
- `template_id`: A unique identifier of a 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"performedBy"`:
"""
function create_case(
domainId, fields, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/cases",
Dict{String,Any}(
"fields" => fields, "templateId" => templateId, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_case(
domainId,
fields,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"fields" => fields,
"templateId" => templateId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain(name)
create_domain(name, params::Dict{String,<:Any})
Creates a domain, which is a container for all case data, such as cases, fields, templates
and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
This will not associate your connect instance to Cases domain. Instead, use the Amazon
Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully
associate the Cases domain. For more information, see Onboard to Cases. </important>
# Arguments
- `name`: The name for your Cases domain. It must be unique for your Amazon Web Services
account.
"""
function create_domain(name; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_field(domain_id, name, type)
create_field(domain_id, name, type, params::Dict{String,<:Any})
Creates a field in the Cases domain. This field is used to define the case object model
(that is, defines what data can be captured on cases) in a Cases domain.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `name`: The name of the field.
- `type`: Defines the data type, some system constraints, and default display of the field.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the field.
"""
function create_field(
domainId, name, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/fields",
Dict{String,Any}("name" => name, "type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_field(
domainId,
name,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/fields",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("name" => name, "type" => type), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_layout(content, domain_id, name)
create_layout(content, domain_id, name, params::Dict{String,<:Any})
Creates a layout in the Cases domain. Layouts define the following configuration in the top
section and More Info tab of the Cases user interface: Fields to display to the users
Field ordering Title and Status fields cannot be part of layouts since they are not
configurable.
# Arguments
- `content`: Information about which fields will be present in the layout, and information
about the order of the fields.
- `domain_id`: The unique identifier of the Cases domain.
- `name`: The name of the layout. It must be unique for the Cases domain.
"""
function create_layout(
content, domainId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/layouts",
Dict{String,Any}("content" => content, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_layout(
content,
domainId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/layouts",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("content" => content, "name" => name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_related_item(case_id, content, domain_id, type)
create_related_item(case_id, content, domain_id, type, params::Dict{String,<:Any})
Creates a related item (comments, tasks, and contacts) and associates it with a case. A
Related Item is a resource that is associated with a case. It may or may not have an
external identifier linking it to an external resource (for example, a contactArn). All
Related Items have their own internal identifier, the relatedItemArn. Examples of related
items include comments and contacts. If you provide a value for performedBy.userArn you
must also have DescribeUser permission on the ARN of the user that you provide.
</note>
# Arguments
- `case_id`: A unique identifier of the case.
- `content`: The content of a related item to be created.
- `domain_id`: The unique identifier of the Cases domain.
- `type`: The type of a related item.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"performedBy"`: Represents the creator of the related item.
"""
function create_related_item(
caseId, content, domainId, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)/related-items/",
Dict{String,Any}("content" => content, "type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_related_item(
caseId,
content,
domainId,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)/related-items/",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("content" => content, "type" => type), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_template(domain_id, name)
create_template(domain_id, name, params::Dict{String,<:Any})
Creates a template in the Cases domain. This template is used to define the case object
model (that is, to define what data can be captured on cases) in a Cases domain. A template
must have a unique name within a domain, and it must reference existing field IDs and
layout IDs. Additionally, multiple fields with same IDs are not allowed within the same
Template. A template can be either Active or Inactive, as indicated by its status. Inactive
templates cannot be used to create cases.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `name`: A name for the template. It must be unique per domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the template.
- `"layoutConfiguration"`: Configuration of layouts associated to the template.
- `"requiredFields"`: A list of fields that must contain a value for a case to be
successfully created with this template.
- `"status"`: The status of the template.
"""
function create_template(domainId, name; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/templates",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_template(
domainId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/templates",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain(domain_id)
delete_domain(domain_id, params::Dict{String,<:Any})
Deletes a Cases domain. <note> <p>After deleting your domain you must
disassociate the deleted domain from your Amazon Connect instance with another API call
before being able to use Cases again with this Amazon Connect instance. See <a
href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAsso
ciation.html">DeleteIntegrationAssociation</a>.</p> </note>
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
"""
function delete_domain(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"DELETE",
"/domains/$(domainId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_domain(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"DELETE",
"/domains/$(domainId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_field(domain_id, field_id)
delete_field(domain_id, field_id, params::Dict{String,<:Any})
Deletes a field from a cases template. You can delete up to 100 fields per domain. After a
field is deleted: You can still retrieve the field by calling BatchGetField. You cannot
update a deleted field by calling UpdateField; it throws a ValidationException. Deleted
fields are not included in the ListFields response. Calling CreateCase with a deleted
field throws a ValidationException denoting which field IDs in the request have been
deleted. Calling GetCase with a deleted field ID returns the deleted field's value if one
exists. Calling UpdateCase with a deleted field ID throws a ValidationException if the
case does not already contain a value for the deleted field. Otherwise it succeeds,
allowing you to update or remove (using emptyValue: {}) the field's value from the case.
GetTemplate does not return field IDs for deleted fields. GetLayout does not return
field IDs for deleted fields. Calling SearchCases with the deleted field ID as a filter
returns any cases that have a value for the deleted field that matches the filter criteria.
Calling SearchCases with a searchTerm value that matches a deleted field's value on a
case returns the case in the response. Calling BatchPutFieldOptions with a deleted field
ID throw a ValidationException. Calling GetCaseEventConfiguration does not return field
IDs for deleted fields.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `field_id`: Unique identifier of the field.
"""
function delete_field(domainId, fieldId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"DELETE",
"/domains/$(domainId)/fields/$(fieldId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_field(
domainId,
fieldId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"DELETE",
"/domains/$(domainId)/fields/$(fieldId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_layout(domain_id, layout_id)
delete_layout(domain_id, layout_id, params::Dict{String,<:Any})
Deletes a layout from a cases template. You can delete up to 100 layouts per domain.
<p>After a layout is deleted:</p> <ul> <li> <p>You can still
retrieve the layout by calling <code>GetLayout</code>.</p> </li>
<li> <p>You cannot update a deleted layout by calling
<code>UpdateLayout</code>; it throws a
<code>ValidationException</code>.</p> </li> <li>
<p>Deleted layouts are not included in the <code>ListLayouts</code>
response.</p> </li> </ul>
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `layout_id`: The unique identifier of the layout.
"""
function delete_layout(
domainId, layoutId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"DELETE",
"/domains/$(domainId)/layouts/$(layoutId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_layout(
domainId,
layoutId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"DELETE",
"/domains/$(domainId)/layouts/$(layoutId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_template(domain_id, template_id)
delete_template(domain_id, template_id, params::Dict{String,<:Any})
Deletes a cases template. You can delete up to 100 templates per domain. <p>After a
cases template is deleted:</p> <ul> <li> <p>You can still retrieve
the template by calling <code>GetTemplate</code>.</p> </li>
<li> <p>You cannot update the template. </p> </li> <li>
<p>You cannot create a case by using the deleted template.</p> </li>
<li> <p>Deleted templates are not included in the
<code>ListTemplates</code> response.</p> </li> </ul>
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `template_id`: A unique identifier of a template.
"""
function delete_template(
domainId, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"DELETE",
"/domains/$(domainId)/templates/$(templateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_template(
domainId,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"DELETE",
"/domains/$(domainId)/templates/$(templateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_case(case_id, domain_id, fields)
get_case(case_id, domain_id, fields, params::Dict{String,<:Any})
Returns information about a specific case if it exists.
# Arguments
- `case_id`: A unique identifier of the case.
- `domain_id`: The unique identifier of the Cases domain.
- `fields`: A list of unique field identifiers.
# 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. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function get_case(
caseId, domainId, fields; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)",
Dict{String,Any}("fields" => fields);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_case(
caseId,
domainId,
fields,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fields" => fields), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_case_audit_events(case_id, domain_id)
get_case_audit_events(case_id, domain_id, params::Dict{String,<:Any})
Returns the audit history about a specific case if it exists.
# Arguments
- `case_id`: A unique identifier of the case.
- `domain_id`: The unique identifier of the Cases domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of audit events to return. The current maximum
supported value is 25. This is also the default when no other value is provided.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function get_case_audit_events(
caseId, domainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)/audit-history";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_case_audit_events(
caseId,
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)/audit-history",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_case_event_configuration(domain_id)
get_case_event_configuration(domain_id, params::Dict{String,<:Any})
Returns the case event publishing configuration.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
"""
function get_case_event_configuration(
domainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/case-event-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_case_event_configuration(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/case-event-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain(domain_id)
get_domain(domain_id, params::Dict{String,<:Any})
Returns information about a specific domain if it exists.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
"""
function get_domain(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_layout(domain_id, layout_id)
get_layout(domain_id, layout_id, params::Dict{String,<:Any})
Returns the details for the requested layout.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `layout_id`: The unique identifier of the layout.
"""
function get_layout(domainId, layoutId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/layouts/$(layoutId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_layout(
domainId,
layoutId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/layouts/$(layoutId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_template(domain_id, template_id)
get_template(domain_id, template_id, params::Dict{String,<:Any})
Returns the details for the requested template.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `template_id`: A unique identifier of a template.
"""
function get_template(
domainId, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/templates/$(templateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_template(
domainId,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/templates/$(templateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cases_for_contact(contact_arn, domain_id)
list_cases_for_contact(contact_arn, domain_id, params::Dict{String,<:Any})
Lists cases for a given contact.
# Arguments
- `contact_arn`: A unique identifier of a contact in Amazon Connect.
- `domain_id`: The unique identifier of the Cases domain.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_cases_for_contact(
contactArn, domainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/list-cases-for-contact",
Dict{String,Any}("contactArn" => contactArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cases_for_contact(
contactArn,
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/list-cases-for-contact",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("contactArn" => contactArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains()
list_domains(params::Dict{String,<:Any})
Lists all cases domains in the Amazon Web Services account. Each list item is a condensed
summary object of the domain.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST", "/domains-list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_field_options(domain_id, field_id)
list_field_options(domain_id, field_id, params::Dict{String,<:Any})
Lists all of the field options for a field identifier in the domain.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `field_id`: The unique identifier of a 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 per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"values"`: A list of FieldOption values to filter on for ListFieldOptions.
"""
function list_field_options(
domainId, fieldId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/fields/$(fieldId)/options-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_field_options(
domainId,
fieldId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/fields/$(fieldId)/options-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fields(domain_id)
list_fields(domain_id, params::Dict{String,<:Any})
Lists all fields in a Cases domain.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_fields(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/fields-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_fields(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/fields-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_layouts(domain_id)
list_layouts(domain_id, params::Dict{String,<:Any})
Lists all layouts in the given cases domain. Each list item is a condensed summary object
of the layout.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_layouts(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/layouts-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_layouts(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/layouts-list",
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 tags for a resource.
# Arguments
- `arn`: The Amazon Resource Name (ARN)
"""
function list_tags_for_resource(arn; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"GET", "/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 connectcases(
"GET",
"/tags/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_templates(domain_id)
list_templates(domain_id, params::Dict{String,<:Any})
Lists all of the templates in a Cases domain. Each list item is a condensed summary object
of the template.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
# 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 page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"status"`: A list of status values to filter on.
"""
function list_templates(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/templates-list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_templates(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/templates-list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_case_event_configuration(domain_id, event_bridge)
put_case_event_configuration(domain_id, event_bridge, params::Dict{String,<:Any})
Adds case event publishing configuration. For a complete list of fields you can add to the
event message, see Create case fields in the Amazon Connect Administrator Guide
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `event_bridge`: Configuration to enable EventBridge case event delivery and determine
what data is delivered.
"""
function put_case_event_configuration(
domainId, eventBridge; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"PUT",
"/domains/$(domainId)/case-event-configuration",
Dict{String,Any}("eventBridge" => eventBridge);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_case_event_configuration(
domainId,
eventBridge,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"PUT",
"/domains/$(domainId)/case-event-configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("eventBridge" => eventBridge), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_cases(domain_id)
search_cases(domain_id, params::Dict{String,<:Any})
Searches for cases within their associated Cases domain. Search results are returned as a
paginated list of abridged case documents. For customer_id you must provide the full
customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account
ID:domains/profiles domain name/profiles/profile ID.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"fields"`: The list of field identifiers to be returned as part of the response.
- `"filter"`: A list of filter objects.
- `"maxResults"`: The maximum number of cases to return. The current maximum supported
value is 25. This is also the default value when no other value is provided.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
- `"searchTerm"`: A word or phrase used to perform a quick search.
- `"sorts"`: A list of sorts where each sort specifies a field and their sort order to be
applied to the results.
"""
function search_cases(domainId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/domains/$(domainId)/cases-search";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_cases(
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases-search",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_related_items(case_id, domain_id)
search_related_items(case_id, domain_id, params::Dict{String,<:Any})
Searches for related items that are associated with a case. If no filters are provided,
this returns all related items associated with a case.
# Arguments
- `case_id`: A unique identifier of the case.
- `domain_id`: The unique identifier of the Cases domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The list of types of related items and their parameters to use for filtering.
- `"maxResults"`: The maximum number of results to return per page.
- `"nextToken"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function search_related_items(
caseId, domainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)/related-items-search";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_related_items(
caseId,
domainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"POST",
"/domains/$(domainId)/cases/$(caseId)/related-items-search",
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 resource.
# Arguments
- `arn`: The Amazon Resource Name (ARN)
- `tags`: A map of of key-value pairs that represent tags on a resource. Tags are used to
organize, track, or control access for this resource.
"""
function tag_resource(arn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"POST",
"/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 connectcases(
"POST",
"/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})
Untags a resource.
# Arguments
- `arn`: The Amazon Resource Name (ARN)
- `tag_keys`: List of tag keys.
"""
function untag_resource(arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"DELETE",
"/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 connectcases(
"DELETE",
"/tags/$(arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_case(case_id, domain_id, fields)
update_case(case_id, domain_id, fields, params::Dict{String,<:Any})
If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser
permission on the User ARN resource that you provide <p>Updates the values of
fields on a case. Fields to be updated are received as an array of id/value pairs identical
to the <code>CreateCase</code> input .</p> <p>If the action is
successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>
# Arguments
- `case_id`: A unique identifier of the case.
- `domain_id`: The unique identifier of the Cases domain.
- `fields`: An array of objects with fieldId (matching ListFields/DescribeField) and value
union data, structured identical to CreateCase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"performedBy"`:
"""
function update_case(
caseId, domainId, fields; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"PUT",
"/domains/$(domainId)/cases/$(caseId)",
Dict{String,Any}("fields" => fields);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_case(
caseId,
domainId,
fields,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"PUT",
"/domains/$(domainId)/cases/$(caseId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("fields" => fields), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_field(domain_id, field_id)
update_field(domain_id, field_id, params::Dict{String,<:Any})
Updates the properties of an existing field.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `field_id`: The unique identifier of a field.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of a field.
- `"name"`: The name of the field.
"""
function update_field(domainId, fieldId; aws_config::AbstractAWSConfig=global_aws_config())
return connectcases(
"PUT",
"/domains/$(domainId)/fields/$(fieldId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_field(
domainId,
fieldId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"PUT",
"/domains/$(domainId)/fields/$(fieldId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_layout(domain_id, layout_id)
update_layout(domain_id, layout_id, params::Dict{String,<:Any})
Updates the attributes of an existing layout. If the action is successful, the service
sends back an HTTP 200 response with an empty HTTP body. A ValidationException is returned
when you add non-existent fieldIds to a layout. Title and Status fields cannot be part of
layouts because they are not configurable.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `layout_id`: The unique identifier of the layout.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"content"`: Information about which fields will be present in the layout, the order of
the fields.
- `"name"`: The name of the layout. It must be unique per domain.
"""
function update_layout(
domainId, layoutId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"PUT",
"/domains/$(domainId)/layouts/$(layoutId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_layout(
domainId,
layoutId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"PUT",
"/domains/$(domainId)/layouts/$(layoutId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_template(domain_id, template_id)
update_template(domain_id, template_id, params::Dict{String,<:Any})
Updates the attributes of an existing template. The template attributes that can be
modified include name, description, layoutConfiguration, requiredFields, and status. At
least one of these attributes must not be null. If a null value is provided for a given
attribute, that attribute is ignored and its current value is preserved.
# Arguments
- `domain_id`: The unique identifier of the Cases domain.
- `template_id`: A unique identifier for the template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A brief description of the template.
- `"layoutConfiguration"`: Configuration of layouts associated to the template.
- `"name"`: The name of the template. It must be unique per domain.
- `"requiredFields"`: A list of fields that must contain a value for a case to be
successfully created with this template.
- `"status"`: The status of the template.
"""
function update_template(
domainId, templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectcases(
"PUT",
"/domains/$(domainId)/templates/$(templateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_template(
domainId,
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectcases(
"PUT",
"/domains/$(domainId)/templates/$(templateId)",
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 | 21310 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: connectparticipant
using AWS.Compat
using AWS.UUIDs
"""
complete_attachment_upload(attachment_ids, client_token, x-_amz-_bearer)
complete_attachment_upload(attachment_ids, client_token, x-_amz-_bearer, params::Dict{String,<:Any})
Allows you to confirm that the attachment has been uploaded using the pre-signed URL
provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment
with that identifier is already being uploaded. ConnectionToken is used for invoking this
API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use
Signature Version 4 authentication.
# Arguments
- `attachment_ids`: A list of unique identifiers for the attachments.
- `client_token`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `x-_amz-_bearer`: The authentication token associated with the participant's connection.
"""
function complete_attachment_upload(
AttachmentIds,
ClientToken,
X_Amz_Bearer;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"POST",
"/participant/complete-attachment-upload",
Dict{String,Any}(
"AttachmentIds" => AttachmentIds,
"ClientToken" => ClientToken,
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function complete_attachment_upload(
AttachmentIds,
ClientToken,
X_Amz_Bearer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"POST",
"/participant/complete-attachment-upload",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttachmentIds" => AttachmentIds,
"ClientToken" => ClientToken,
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_participant_connection(x-_amz-_bearer)
create_participant_connection(x-_amz-_bearer, params::Dict{String,<:Any})
Creates the participant's connection. ParticipantToken is used for invoking this API
instead of ConnectionToken. The participant token is valid for the lifetime of the
participant – until they are part of a contact. The response URL for WEBSOCKET Type has a
connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL
and subscribe to the desired topic. For chat, you need to publish the following on the
established websocket connection:
{\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}} Upon websocket URL
expiry, as specified in the response ConnectionExpiry parameter, clients need to call this
API again to obtain a new websocket URL and perform the same steps as before. Message
streaming support: This API can also be used together with the StartContactStreaming API to
create a participant connection for chat contacts that are not using a websocket. For more
information about message streaming, Enable real-time chat message streaming in the Amazon
Connect Administrator Guide. Feature specifications: For information about feature
specifications, such as the allowed number of open websocket connections per participant,
see Feature specifications in the Amazon Connect Administrator Guide. The Amazon Connect
Participant Service APIs do not use Signature Version 4 authentication.
# Arguments
- `x-_amz-_bearer`: This is a header parameter. The ParticipantToken as obtained from
StartChatContact API response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectParticipant"`: Amazon Connect Participant is used to mark the participant as
connected for customer participant in message streaming, as well as for agent or manager
participant in non-streaming chats.
- `"Type"`: Type of connection information required. If you need CONNECTION_CREDENTIALS
along with marking participant as connected, pass CONNECTION_CREDENTIALS in Type.
"""
function create_participant_connection(
X_Amz_Bearer; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectparticipant(
"POST",
"/participant/connection",
Dict{String,Any}("headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_participant_connection(
X_Amz_Bearer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"POST",
"/participant/connection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_view(view_token, x-_amz-_bearer)
describe_view(view_token, x-_amz-_bearer, params::Dict{String,<:Any})
Retrieves the view for the specified view token.
# Arguments
- `view_token`: An encrypted token originating from the interactive message of a ShowView
block operation. Represents the desired view.
- `x-_amz-_bearer`: The connection token.
"""
function describe_view(
ViewToken, X_Amz_Bearer; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectparticipant(
"GET",
"/participant/views/$(ViewToken)",
Dict{String,Any}("headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_view(
ViewToken,
X_Amz_Bearer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"GET",
"/participant/views/$(ViewToken)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disconnect_participant(x-_amz-_bearer)
disconnect_participant(x-_amz-_bearer, params::Dict{String,<:Any})
Disconnects a participant. ConnectionToken is used for invoking this API instead of
ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version
4 authentication.
# Arguments
- `x-_amz-_bearer`: The authentication token associated with the participant's connection.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function disconnect_participant(
X_Amz_Bearer; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectparticipant(
"POST",
"/participant/disconnect",
Dict{String,Any}(
"ClientToken" => string(uuid4()),
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disconnect_participant(
X_Amz_Bearer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"POST",
"/participant/disconnect",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => string(uuid4()),
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_attachment(attachment_id, x-_amz-_bearer)
get_attachment(attachment_id, x-_amz-_bearer, params::Dict{String,<:Any})
Provides a pre-signed URL for download of a completed attachment. This is an asynchronous
API for use with active contacts. ConnectionToken is used for invoking this API instead
of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature
Version 4 authentication.
# Arguments
- `attachment_id`: A unique identifier for the attachment.
- `x-_amz-_bearer`: The authentication token associated with the participant's connection.
"""
function get_attachment(
AttachmentId, X_Amz_Bearer; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectparticipant(
"POST",
"/participant/attachment",
Dict{String,Any}(
"AttachmentId" => AttachmentId,
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_attachment(
AttachmentId,
X_Amz_Bearer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"POST",
"/participant/attachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttachmentId" => AttachmentId,
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transcript(x-_amz-_bearer)
get_transcript(x-_amz-_bearer, params::Dict{String,<:Any})
Retrieves a transcript of the session, including details about any attachments. For
information about accessing past chat contact transcripts for a persistent chat, see Enable
persistent chat. If you have a process that consumes events in the transcript of an chat
that has ended, note that chat transcripts contain the following event content types if the
event has occurred during the chat session:
application/vnd.amazonaws.connect.event.participant.left
application/vnd.amazonaws.connect.event.participant.joined
application/vnd.amazonaws.connect.event.chat.ended
application/vnd.amazonaws.connect.event.transfer.succeeded
application/vnd.amazonaws.connect.event.transfer.failed ConnectionToken is used for
invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs
do not use Signature Version 4 authentication.
# Arguments
- `x-_amz-_bearer`: The authentication token associated with the participant's connection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContactId"`: The contactId from the current contact chain for which transcript is
needed.
- `"MaxResults"`: The maximum number of results to return in the page. Default: 10.
- `"NextToken"`: The pagination token. Use the value returned previously in the next
subsequent request to retrieve the next set of results.
- `"ScanDirection"`: The direction from StartPosition from which to retrieve message.
Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
- `"SortOrder"`: The sort order for the records. Default: DESCENDING.
- `"StartPosition"`: A filtering option for where to start.
"""
function get_transcript(X_Amz_Bearer; aws_config::AbstractAWSConfig=global_aws_config())
return connectparticipant(
"POST",
"/participant/transcript",
Dict{String,Any}("headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transcript(
X_Amz_Bearer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"POST",
"/participant/transcript",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_event(content_type, x-_amz-_bearer)
send_event(content_type, x-_amz-_bearer, params::Dict{String,<:Any})
The application/vnd.amazonaws.connect.event.connection.acknowledged ContentType will no
longer be supported starting December 31, 2024. This event has been migrated to the
CreateParticipantConnection API using the ConnectParticipant field. Sends an event.
Message receipts are not supported when there are more than two active participants in the
chat. Using the SendEvent API for message receipts when a supervisor is barged-in will
result in a conflict exception. ConnectionToken is used for invoking this API instead of
ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version
4 authentication.
# Arguments
- `content_type`: The content type of the request. Supported types are:
application/vnd.amazonaws.connect.event.typing
application/vnd.amazonaws.connect.event.connection.acknowledged (will be deprecated on
December 31, 2024) application/vnd.amazonaws.connect.event.message.delivered
application/vnd.amazonaws.connect.event.message.read
- `x-_amz-_bearer`: The authentication token associated with the participant's connection.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `"Content"`: The content of the event to be sent (for example, message text). For content
related to message receipts, this is supported in the form of a JSON string. Sample
Content: \"{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}\"
"""
function send_event(
ContentType, X_Amz_Bearer; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectparticipant(
"POST",
"/participant/event",
Dict{String,Any}(
"ContentType" => ContentType,
"ClientToken" => string(uuid4()),
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_event(
ContentType,
X_Amz_Bearer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"POST",
"/participant/event",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContentType" => ContentType,
"ClientToken" => string(uuid4()),
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_message(content, content_type, x-_amz-_bearer)
send_message(content, content_type, x-_amz-_bearer, params::Dict{String,<:Any})
Sends a message. ConnectionToken is used for invoking this API instead of
ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version
4 authentication.
# Arguments
- `content`: The content of the message. For text/plain and text/markdown, the Length
Constraints are Minimum of 1, Maximum of 1024. For application/json, the Length
Constraints are Minimum of 1, Maximum of 12000. For
application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are
Minimum of 1, Maximum of 12288.
- `content_type`: The type of the content. Supported types are text/plain, text/markdown,
application/json, and application/vnd.amazonaws.connect.message.interactive.response.
- `x-_amz-_bearer`: The authentication token associated with the connection.
# 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. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
"""
function send_message(
Content, ContentType, X_Amz_Bearer; aws_config::AbstractAWSConfig=global_aws_config()
)
return connectparticipant(
"POST",
"/participant/message",
Dict{String,Any}(
"Content" => Content,
"ContentType" => ContentType,
"ClientToken" => string(uuid4()),
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_message(
Content,
ContentType,
X_Amz_Bearer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"POST",
"/participant/message",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Content" => Content,
"ContentType" => ContentType,
"ClientToken" => string(uuid4()),
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_attachment_upload(attachment_name, attachment_size_in_bytes, client_token, content_type, x-_amz-_bearer)
start_attachment_upload(attachment_name, attachment_size_in_bytes, client_token, content_type, x-_amz-_bearer, params::Dict{String,<:Any})
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon
Connect Participant Service APIs do not use Signature Version 4 authentication.
# Arguments
- `attachment_name`: A case-sensitive name of the attachment being uploaded.
- `attachment_size_in_bytes`: The size of the attachment in bytes.
- `client_token`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK populates this
field. For more information about idempotency, see Making retries safe with idempotent APIs.
- `content_type`: Describes the MIME file type of the attachment. For a list of supported
file types, see Feature specifications in the Amazon Connect Administrator Guide.
- `x-_amz-_bearer`: The authentication token associated with the participant's connection.
"""
function start_attachment_upload(
AttachmentName,
AttachmentSizeInBytes,
ClientToken,
ContentType,
X_Amz_Bearer;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"POST",
"/participant/start-attachment-upload",
Dict{String,Any}(
"AttachmentName" => AttachmentName,
"AttachmentSizeInBytes" => AttachmentSizeInBytes,
"ClientToken" => ClientToken,
"ContentType" => ContentType,
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_attachment_upload(
AttachmentName,
AttachmentSizeInBytes,
ClientToken,
ContentType,
X_Amz_Bearer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return connectparticipant(
"POST",
"/participant/start-attachment-upload",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttachmentName" => AttachmentName,
"AttachmentSizeInBytes" => AttachmentSizeInBytes,
"ClientToken" => ClientToken,
"ContentType" => ContentType,
"headers" => Dict{String,Any}("X-Amz-Bearer" => X_Amz_Bearer),
),
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 | 3654 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: controlcatalog
using AWS.Compat
using AWS.UUIDs
"""
list_common_controls()
list_common_controls(params::Dict{String,<:Any})
Returns a paginated list of common controls from the Amazon Web Services Control Catalog.
You can apply an optional filter to see common controls that have a specific objective. If
you don’t provide a filter, the operation returns all common controls.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CommonControlFilter"`: An optional filter that narrows the results to a specific
objective. This filter allows you to specify one objective ARN at a time. Passing multiple
ARNs in the CommonControlFilter isn’t currently supported.
- `"maxResults"`: The maximum number of results on a page or for an API request call.
- `"nextToken"`: The pagination token that's used to fetch the next set of results.
"""
function list_common_controls(; aws_config::AbstractAWSConfig=global_aws_config())
return controlcatalog(
"POST", "/common-controls"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_common_controls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return controlcatalog(
"POST",
"/common-controls",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains()
list_domains(params::Dict{String,<:Any})
Returns a paginated list of domains from the Amazon Web Services Control Catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results on a page or for an API request call.
- `"nextToken"`: The pagination token that's used to fetch the next set of results.
"""
function list_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return controlcatalog(
"POST", "/domains"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return controlcatalog(
"POST", "/domains", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_objectives()
list_objectives(params::Dict{String,<:Any})
Returns a paginated list of objectives from the Amazon Web Services Control Catalog. You
can apply an optional filter to see the objectives that belong to a specific domain. If you
don’t provide a filter, the operation returns all objectives.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ObjectiveFilter"`: An optional filter that narrows the results to a specific domain.
This filter allows you to specify one domain ARN at a time. Passing multiple ARNs in the
ObjectiveFilter isn’t currently supported.
- `"maxResults"`: The maximum number of results on a page or for an API request call.
- `"nextToken"`: The pagination token that's used to fetch the next set of results.
"""
function list_objectives(; aws_config::AbstractAWSConfig=global_aws_config())
return controlcatalog(
"POST", "/objectives"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_objectives(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return controlcatalog(
"POST",
"/objectives",
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 | 36262 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: controltower
using AWS.Compat
using AWS.UUIDs
"""
create_landing_zone(manifest, version)
create_landing_zone(manifest, version, params::Dict{String,<:Any})
Creates a new landing zone. This API call starts an asynchronous operation that creates and
configures a landing zone, based on the parameters specified in the manifest JSON file.
# Arguments
- `manifest`: The manifest JSON file is a text file that describes your Amazon Web Services
resources. For examples, review Launch your landing zone.
- `version`: The landing zone version, for example, 3.0.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: Tags to be applied to the landing zone.
"""
function create_landing_zone(
manifest, version; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/create-landingzone",
Dict{String,Any}("manifest" => manifest, "version" => version);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_landing_zone(
manifest,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/create-landingzone",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("manifest" => manifest, "version" => version),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_landing_zone(landing_zone_identifier)
delete_landing_zone(landing_zone_identifier, params::Dict{String,<:Any})
Decommissions a landing zone. This API call starts an asynchronous operation that deletes
Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web
Services Control Tower.
# Arguments
- `landing_zone_identifier`: The unique identifier of the landing zone.
"""
function delete_landing_zone(
landingZoneIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/delete-landingzone",
Dict{String,Any}("landingZoneIdentifier" => landingZoneIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_landing_zone(
landingZoneIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/delete-landingzone",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("landingZoneIdentifier" => landingZoneIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_baseline(enabled_baseline_identifier)
disable_baseline(enabled_baseline_identifier, params::Dict{String,<:Any})
Disable an EnabledBaseline resource on the specified Target. This API starts an
asynchronous operation to remove all resources deployed as part of the baseline enablement.
The resource will vary depending on the enabled baseline. For usage examples, see the
Amazon Web Services Control Tower User Guide .
# Arguments
- `enabled_baseline_identifier`: Identifier of the EnabledBaseline resource to be
deactivated, in ARN format.
"""
function disable_baseline(
enabledBaselineIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/disable-baseline",
Dict{String,Any}("enabledBaselineIdentifier" => enabledBaselineIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_baseline(
enabledBaselineIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/disable-baseline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("enabledBaselineIdentifier" => enabledBaselineIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_control(control_identifier, target_identifier)
disable_control(control_identifier, target_identifier, params::Dict{String,<:Any})
This API call turns off a control. It starts an asynchronous operation that deletes AWS
resources on the specified organizational unit and the accounts it contains. The resources
will vary according to the control that you specify. For usage examples, see the Amazon
Web Services Control Tower User Guide .
# Arguments
- `control_identifier`: The ARN of the control. Only Strongly recommended and Elective
controls are permitted, with the exception of the Region deny control. For information on
how to find the controlIdentifier, see the overview page.
- `target_identifier`: The ARN of the organizational unit. For information on how to find
the targetIdentifier, see the overview page.
"""
function disable_control(
controlIdentifier, targetIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/disable-control",
Dict{String,Any}(
"controlIdentifier" => controlIdentifier, "targetIdentifier" => targetIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_control(
controlIdentifier,
targetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/disable-control",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"controlIdentifier" => controlIdentifier,
"targetIdentifier" => targetIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_baseline(baseline_identifier, baseline_version, target_identifier)
enable_baseline(baseline_identifier, baseline_version, target_identifier, params::Dict{String,<:Any})
Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy
resources specified by the Baseline to the specified Target. For usage examples, see the
Amazon Web Services Control Tower User Guide .
# Arguments
- `baseline_identifier`: The ARN of the baseline to be enabled.
- `baseline_version`: The specific version to be enabled of the specified baseline.
- `target_identifier`: The ARN of the target on which the baseline will be enabled. Only
OUs are supported as targets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parameters"`: A list of key-value objects that specify enablement parameters, where key
is a string and value is a document of any type.
- `"tags"`: Tags associated with input to EnableBaseline.
"""
function enable_baseline(
baselineIdentifier,
baselineVersion,
targetIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/enable-baseline",
Dict{String,Any}(
"baselineIdentifier" => baselineIdentifier,
"baselineVersion" => baselineVersion,
"targetIdentifier" => targetIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_baseline(
baselineIdentifier,
baselineVersion,
targetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/enable-baseline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"baselineIdentifier" => baselineIdentifier,
"baselineVersion" => baselineVersion,
"targetIdentifier" => targetIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_control(control_identifier, target_identifier)
enable_control(control_identifier, target_identifier, params::Dict{String,<:Any})
This API call activates a control. It starts an asynchronous operation that creates Amazon
Web Services resources on the specified organizational unit and the accounts it contains.
The resources created will vary according to the control that you specify. For usage
examples, see the Amazon Web Services Control Tower User Guide .
# Arguments
- `control_identifier`: The ARN of the control. Only Strongly recommended and Elective
controls are permitted, with the exception of the Region deny control. For information on
how to find the controlIdentifier, see the overview page.
- `target_identifier`: The ARN of the organizational unit. For information on how to find
the targetIdentifier, see the overview page.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parameters"`: A list of input parameter values, which are specified to configure the
control when you enable it.
- `"tags"`: Tags to be applied to the EnabledControl resource.
"""
function enable_control(
controlIdentifier, targetIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/enable-control",
Dict{String,Any}(
"controlIdentifier" => controlIdentifier, "targetIdentifier" => targetIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_control(
controlIdentifier,
targetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/enable-control",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"controlIdentifier" => controlIdentifier,
"targetIdentifier" => targetIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_baseline(baseline_identifier)
get_baseline(baseline_identifier, params::Dict{String,<:Any})
Retrieve details about an existing Baseline resource by specifying its identifier. For
usage examples, see the Amazon Web Services Control Tower User Guide .
# Arguments
- `baseline_identifier`: The ARN of the Baseline resource to be retrieved.
"""
function get_baseline(baselineIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return controltower(
"POST",
"/get-baseline",
Dict{String,Any}("baselineIdentifier" => baselineIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_baseline(
baselineIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/get-baseline",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("baselineIdentifier" => baselineIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_baseline_operation(operation_identifier)
get_baseline_operation(operation_identifier, params::Dict{String,<:Any})
Returns the details of an asynchronous baseline operation, as initiated by any of these
APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A
status message is displayed in case of operation failure. For usage examples, see the
Amazon Web Services Control Tower User Guide .
# Arguments
- `operation_identifier`: The operation ID returned from mutating asynchronous APIs
(Enable, Disable, Update, Reset).
"""
function get_baseline_operation(
operationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/get-baseline-operation",
Dict{String,Any}("operationIdentifier" => operationIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_baseline_operation(
operationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/get-baseline-operation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("operationIdentifier" => operationIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_control_operation(operation_identifier)
get_control_operation(operation_identifier, params::Dict{String,<:Any})
Returns the status of a particular EnableControl or DisableControl operation. Displays a
message in case of error. Details for an operation are available for 90 days. For usage
examples, see the Amazon Web Services Control Tower User Guide .
# Arguments
- `operation_identifier`: The ID of the asynchronous operation, which is used to track
status. The operation is available for 90 days.
"""
function get_control_operation(
operationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/get-control-operation",
Dict{String,Any}("operationIdentifier" => operationIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_control_operation(
operationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/get-control-operation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("operationIdentifier" => operationIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_enabled_baseline(enabled_baseline_identifier)
get_enabled_baseline(enabled_baseline_identifier, params::Dict{String,<:Any})
Retrieve details of an EnabledBaseline resource by specifying its identifier.
# Arguments
- `enabled_baseline_identifier`: Identifier of the EnabledBaseline resource to be
retrieved, in ARN format.
"""
function get_enabled_baseline(
enabledBaselineIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/get-enabled-baseline",
Dict{String,Any}("enabledBaselineIdentifier" => enabledBaselineIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_enabled_baseline(
enabledBaselineIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/get-enabled-baseline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("enabledBaselineIdentifier" => enabledBaselineIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_enabled_control(enabled_control_identifier)
get_enabled_control(enabled_control_identifier, params::Dict{String,<:Any})
Retrieves details about an enabled control. For usage examples, see the Amazon Web
Services Control Tower User Guide .
# Arguments
- `enabled_control_identifier`: The controlIdentifier of the enabled control.
"""
function get_enabled_control(
enabledControlIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/get-enabled-control",
Dict{String,Any}("enabledControlIdentifier" => enabledControlIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_enabled_control(
enabledControlIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/get-enabled-control",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("enabledControlIdentifier" => enabledControlIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_landing_zone(landing_zone_identifier)
get_landing_zone(landing_zone_identifier, params::Dict{String,<:Any})
Returns details about the landing zone. Displays a message in case of error.
# Arguments
- `landing_zone_identifier`: The unique identifier of the landing zone.
"""
function get_landing_zone(
landingZoneIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/get-landingzone",
Dict{String,Any}("landingZoneIdentifier" => landingZoneIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_landing_zone(
landingZoneIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/get-landingzone",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("landingZoneIdentifier" => landingZoneIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_landing_zone_operation(operation_identifier)
get_landing_zone_operation(operation_identifier, params::Dict{String,<:Any})
Returns the status of the specified landing zone operation. Details for an operation are
available for 90 days.
# Arguments
- `operation_identifier`: A unique identifier assigned to a landing zone operation.
"""
function get_landing_zone_operation(
operationIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/get-landingzone-operation",
Dict{String,Any}("operationIdentifier" => operationIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_landing_zone_operation(
operationIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/get-landingzone-operation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("operationIdentifier" => operationIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_baselines()
list_baselines(params::Dict{String,<:Any})
Returns a summary list of all available baselines. For usage examples, see the Amazon Web
Services Control Tower 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 be shown.
- `"nextToken"`: A pagination token.
"""
function list_baselines(; aws_config::AbstractAWSConfig=global_aws_config())
return controltower(
"POST", "/list-baselines"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_baselines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/list-baselines",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_control_operations()
list_control_operations(params::Dict{String,<:Any})
Provides a list of operations in progress or queued.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: An input filter for the ListControlOperations API that lets you select the
types of control operations to view.
- `"maxResults"`: The maximum number of results to be shown.
- `"nextToken"`: A pagination token.
"""
function list_control_operations(; aws_config::AbstractAWSConfig=global_aws_config())
return controltower(
"POST",
"/list-control-operations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_control_operations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/list-control-operations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_enabled_baselines()
list_enabled_baselines(params::Dict{String,<:Any})
Returns a list of summaries describing EnabledBaseline resources. You can filter the list
by the corresponding Baseline or Target of the EnabledBaseline resources. For usage
examples, see the Amazon Web Services Control Tower User Guide .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: A filter applied on the ListEnabledBaseline operation. Allowed filters are
baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
- `"maxResults"`: The maximum number of results to be shown.
- `"nextToken"`: A pagination token.
"""
function list_enabled_baselines(; aws_config::AbstractAWSConfig=global_aws_config())
return controltower(
"POST",
"/list-enabled-baselines";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_enabled_baselines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/list-enabled-baselines",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_enabled_controls()
list_enabled_controls(params::Dict{String,<:Any})
Lists the controls enabled by Amazon Web Services Control Tower on the specified
organizational unit and the accounts it contains. For usage examples, see the Amazon Web
Services Control Tower User Guide .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: An input filter for the ListCEnabledControls API that lets you select the
types of control operations to view.
- `"maxResults"`: How many results to return per API call.
- `"nextToken"`: The token to continue the list from a previous API call with the same
parameters.
- `"targetIdentifier"`: The ARN of the organizational unit. For information on how to find
the targetIdentifier, see the overview page.
"""
function list_enabled_controls(; aws_config::AbstractAWSConfig=global_aws_config())
return controltower(
"POST",
"/list-enabled-controls";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_enabled_controls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/list-enabled-controls",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_landing_zones()
list_landing_zones(params::Dict{String,<:Any})
Returns the landing zone ARN for the landing zone deployed in your managed account. This
API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of returned landing zone ARNs, which is one.
- `"nextToken"`: The token to continue the list from a previous API call with the same
parameters.
"""
function list_landing_zones(; aws_config::AbstractAWSConfig=global_aws_config())
return controltower(
"POST", "/list-landingzones"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_landing_zones(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/list-landingzones",
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 resource. For usage examples, see the Amazon
Web Services Control Tower User Guide .
# Arguments
- `resource_arn`: The ARN of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"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 controltower(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_enabled_baseline(enabled_baseline_identifier)
reset_enabled_baseline(enabled_baseline_identifier, params::Dict{String,<:Any})
Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing
Baseline after a new member account is moved to the target OU. For usage examples, see the
Amazon Web Services Control Tower User Guide .
# Arguments
- `enabled_baseline_identifier`: Specifies the ID of the EnabledBaseline resource to be
re-enabled, in ARN format.
"""
function reset_enabled_baseline(
enabledBaselineIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/reset-enabled-baseline",
Dict{String,Any}("enabledBaselineIdentifier" => enabledBaselineIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_enabled_baseline(
enabledBaselineIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/reset-enabled-baseline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("enabledBaselineIdentifier" => enabledBaselineIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_landing_zone(landing_zone_identifier)
reset_landing_zone(landing_zone_identifier, params::Dict{String,<:Any})
This API call resets a landing zone. It starts an asynchronous operation that resets the
landing zone to the parameters specified in its original configuration.
# Arguments
- `landing_zone_identifier`: The unique identifier of the landing zone.
"""
function reset_landing_zone(
landingZoneIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/reset-landingzone",
Dict{String,Any}("landingZoneIdentifier" => landingZoneIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_landing_zone(
landingZoneIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/reset-landingzone",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("landingZoneIdentifier" => landingZoneIdentifier),
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 a resource. For usage examples, see the Amazon Web Services Control Tower
User Guide .
# Arguments
- `resource_arn`: The ARN of the resource to be tagged.
- `tags`: Tags to be applied to the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return controltower(
"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 controltower(
"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. For usage examples, see the Amazon Web Services Control
Tower User Guide .
# Arguments
- `resource_arn`: The ARN of the resource.
- `tag_keys`: Tag keys to be removed from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"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 controltower(
"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_enabled_baseline(baseline_version, enabled_baseline_identifier)
update_enabled_baseline(baseline_version, enabled_baseline_identifier, params::Dict{String,<:Any})
Updates an EnabledBaseline resource's applied parameters or version. For usage examples,
see the Amazon Web Services Control Tower User Guide .
# Arguments
- `baseline_version`: Specifies the new Baseline version, to which the EnabledBaseline
should be updated.
- `enabled_baseline_identifier`: Specifies the EnabledBaseline resource to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parameters"`: Parameters to apply when making an update.
"""
function update_enabled_baseline(
baselineVersion,
enabledBaselineIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/update-enabled-baseline",
Dict{String,Any}(
"baselineVersion" => baselineVersion,
"enabledBaselineIdentifier" => enabledBaselineIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_enabled_baseline(
baselineVersion,
enabledBaselineIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/update-enabled-baseline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"baselineVersion" => baselineVersion,
"enabledBaselineIdentifier" => enabledBaselineIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_enabled_control(enabled_control_identifier, parameters)
update_enabled_control(enabled_control_identifier, parameters, params::Dict{String,<:Any})
Updates the configuration of an already enabled control. If the enabled control shows an
EnablementStatus of SUCCEEDED, supply parameters that are different from the currently
configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the
request. If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services
Control Tower will update the control to match any valid parameters that you supply. If the
DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead,
you can update the control by calling DisableControl and again calling EnableControl, or
you can run an extending governance operation. For usage examples, see the Amazon Web
Services Control Tower User Guide
# Arguments
- `enabled_control_identifier`: The ARN of the enabled control that will be updated.
- `parameters`: A key/value pair, where Key is of type String and Value is of type Document.
"""
function update_enabled_control(
enabledControlIdentifier, parameters; aws_config::AbstractAWSConfig=global_aws_config()
)
return controltower(
"POST",
"/update-enabled-control",
Dict{String,Any}(
"enabledControlIdentifier" => enabledControlIdentifier,
"parameters" => parameters,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_enabled_control(
enabledControlIdentifier,
parameters,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/update-enabled-control",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"enabledControlIdentifier" => enabledControlIdentifier,
"parameters" => parameters,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_landing_zone(landing_zone_identifier, manifest, version)
update_landing_zone(landing_zone_identifier, manifest, version, params::Dict{String,<:Any})
This API call updates the landing zone. It starts an asynchronous operation that updates
the landing zone based on the new landing zone version, or on the changed parameters
specified in the updated manifest file.
# Arguments
- `landing_zone_identifier`: The unique identifier of the landing zone.
- `manifest`: The manifest JSON file is a text file that describes your Amazon Web Services
resources. For examples, review Launch your landing zone.
- `version`: The landing zone version, for example, 3.2.
"""
function update_landing_zone(
landingZoneIdentifier,
manifest,
version;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/update-landingzone",
Dict{String,Any}(
"landingZoneIdentifier" => landingZoneIdentifier,
"manifest" => manifest,
"version" => version,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_landing_zone(
landingZoneIdentifier,
manifest,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return controltower(
"POST",
"/update-landingzone",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"landingZoneIdentifier" => landingZoneIdentifier,
"manifest" => manifest,
"version" => version,
),
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 | 8001 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: cost_and_usage_report_service
using AWS.Compat
using AWS.UUIDs
"""
delete_report_definition(report_name)
delete_report_definition(report_name, params::Dict{String,<:Any})
Deletes the specified report. Any tags associated with the report are also deleted.
# Arguments
- `report_name`: The name of the report that you want to delete. The name must be unique,
is case sensitive, and can't include spaces.
"""
function delete_report_definition(
ReportName; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_and_usage_report_service(
"DeleteReportDefinition",
Dict{String,Any}("ReportName" => ReportName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_report_definition(
ReportName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_and_usage_report_service(
"DeleteReportDefinition",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ReportName" => ReportName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_report_definitions()
describe_report_definitions(params::Dict{String,<:Any})
Lists the Amazon Web Services Cost and Usage Report available to this account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`:
- `"NextToken"`:
"""
function describe_report_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return cost_and_usage_report_service(
"DescribeReportDefinitions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_report_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_and_usage_report_service(
"DescribeReportDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(report_name)
list_tags_for_resource(report_name, params::Dict{String,<:Any})
Lists the tags associated with the specified report definition.
# Arguments
- `report_name`: The report name of the report definition that tags are to be returned for.
"""
function list_tags_for_resource(
ReportName; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_and_usage_report_service(
"ListTagsForResource",
Dict{String,Any}("ReportName" => ReportName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
ReportName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_and_usage_report_service(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ReportName" => ReportName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_report_definition(report_definition, report_name)
modify_report_definition(report_definition, report_name, params::Dict{String,<:Any})
Allows you to programmatically update your report preferences.
# Arguments
- `report_definition`:
- `report_name`:
"""
function modify_report_definition(
ReportDefinition, ReportName; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_and_usage_report_service(
"ModifyReportDefinition",
Dict{String,Any}(
"ReportDefinition" => ReportDefinition, "ReportName" => ReportName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_report_definition(
ReportDefinition,
ReportName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_and_usage_report_service(
"ModifyReportDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReportDefinition" => ReportDefinition, "ReportName" => ReportName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_report_definition(report_definition)
put_report_definition(report_definition, params::Dict{String,<:Any})
Creates a new report using the description that you provide.
# Arguments
- `report_definition`: Represents the output of the PutReportDefinition operation. The
content consists of the detailed metadata and data file information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to be assigned to the report definition resource.
"""
function put_report_definition(
ReportDefinition; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_and_usage_report_service(
"PutReportDefinition",
Dict{String,Any}("ReportDefinition" => ReportDefinition);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_report_definition(
ReportDefinition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_and_usage_report_service(
"PutReportDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReportDefinition" => ReportDefinition), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(report_name, tags)
tag_resource(report_name, tags, params::Dict{String,<:Any})
Associates a set of tags with a report definition.
# Arguments
- `report_name`: The report name of the report definition that tags are to be associated
with.
- `tags`: The tags to be assigned to the report definition resource.
"""
function tag_resource(ReportName, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return cost_and_usage_report_service(
"TagResource",
Dict{String,Any}("ReportName" => ReportName, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ReportName,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_and_usage_report_service(
"TagResource",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReportName" => ReportName, "Tags" => Tags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(report_name, tag_keys)
untag_resource(report_name, tag_keys, params::Dict{String,<:Any})
Disassociates a set of tags from a report definition.
# Arguments
- `report_name`: The report name of the report definition that tags are to be disassociated
from.
- `tag_keys`: The tags to be disassociated from the report definition resource.
"""
function untag_resource(
ReportName, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_and_usage_report_service(
"UntagResource",
Dict{String,Any}("ReportName" => ReportName, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ReportName,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_and_usage_report_service(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReportName" => ReportName, "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 | 96959 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: cost_explorer
using AWS.Compat
using AWS.UUIDs
"""
create_anomaly_monitor(anomaly_monitor)
create_anomaly_monitor(anomaly_monitor, params::Dict{String,<:Any})
Creates a new cost anomaly detection monitor with the requested type and monitor
specification.
# Arguments
- `anomaly_monitor`: The cost anomaly detection monitor object that you want to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceTags"`: An optional list of tags to associate with the specified
AnomalyMonitor . You can use resource tags to control access to your monitor using IAM
policies. Each tag consists of a key and a value, and each key must be unique for the
resource. The following restrictions apply to resource tags: Although the maximum number
of array members is 200, you can assign a maximum of 50 user-tags to one resource. The
remaining are reserved for Amazon Web Services use The maximum length of a key is 128
characters The maximum length of a value is 256 characters Keys and values can only
contain alphanumeric characters, spaces, and any of the following: _.:/=+@- Keys and
values are case sensitive Keys and values are trimmed for any leading or trailing
whitespaces Don’t use aws: as a prefix for your keys. This prefix is reserved for
Amazon Web Services use
"""
function create_anomaly_monitor(
AnomalyMonitor; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"CreateAnomalyMonitor",
Dict{String,Any}("AnomalyMonitor" => AnomalyMonitor);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_anomaly_monitor(
AnomalyMonitor,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"CreateAnomalyMonitor",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AnomalyMonitor" => AnomalyMonitor), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_anomaly_subscription(anomaly_subscription)
create_anomaly_subscription(anomaly_subscription, params::Dict{String,<:Any})
Adds an alert subscription to a cost anomaly detection monitor. You can use each
subscription to define subscribers with email or SNS notifications. Email subscribers can
set an absolute or percentage threshold and a time frequency for receiving notifications.
# Arguments
- `anomaly_subscription`: The cost anomaly subscription object that you want to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceTags"`: An optional list of tags to associate with the specified
AnomalySubscription . You can use resource tags to control access to your subscription
using IAM policies. Each tag consists of a key and a value, and each key must be unique for
the resource. The following restrictions apply to resource tags: Although the maximum
number of array members is 200, you can assign a maximum of 50 user-tags to one resource.
The remaining are reserved for Amazon Web Services use The maximum length of a key is 128
characters The maximum length of a value is 256 characters Keys and values can only
contain alphanumeric characters, spaces, and any of the following: _.:/=+@- Keys and
values are case sensitive Keys and values are trimmed for any leading or trailing
whitespaces Don’t use aws: as a prefix for your keys. This prefix is reserved for
Amazon Web Services use
"""
function create_anomaly_subscription(
AnomalySubscription; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"CreateAnomalySubscription",
Dict{String,Any}("AnomalySubscription" => AnomalySubscription);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_anomaly_subscription(
AnomalySubscription,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"CreateAnomalySubscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AnomalySubscription" => AnomalySubscription),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cost_category_definition(name, rule_version, rules)
create_cost_category_definition(name, rule_version, rules, params::Dict{String,<:Any})
Creates a new Cost Category with the requested name and rules.
# Arguments
- `name`:
- `rule_version`:
- `rules`: The Cost Category rules used to categorize costs. For more information, see
CostCategoryRule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultValue"`:
- `"EffectiveStart"`: The Cost Category's effective start date. It can only be a billing
start date (first day of the month). If the date isn't provided, it's the first day of the
current month. Dates can't be before the previous twelve months, or in the future.
- `"ResourceTags"`: An optional list of tags to associate with the specified CostCategory
. You can use resource tags to control access to your cost category using IAM policies.
Each tag consists of a key and a value, and each key must be unique for the resource. The
following restrictions apply to resource tags: Although the maximum number of array
members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are
reserved for Amazon Web Services use The maximum length of a key is 128 characters The
maximum length of a value is 256 characters Keys and values can only contain alphanumeric
characters, spaces, and any of the following: _.:/=+@- Keys and values are case
sensitive Keys and values are trimmed for any leading or trailing whitespaces Don’t
use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use
- `"SplitChargeRules"`: The split charge rules used to allocate your charges between your
Cost Category values.
"""
function create_cost_category_definition(
Name, RuleVersion, Rules; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"CreateCostCategoryDefinition",
Dict{String,Any}("Name" => Name, "RuleVersion" => RuleVersion, "Rules" => Rules);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cost_category_definition(
Name,
RuleVersion,
Rules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"CreateCostCategoryDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "RuleVersion" => RuleVersion, "Rules" => Rules
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_anomaly_monitor(monitor_arn)
delete_anomaly_monitor(monitor_arn, params::Dict{String,<:Any})
Deletes a cost anomaly monitor.
# Arguments
- `monitor_arn`: The unique identifier of the cost anomaly monitor that you want to delete.
"""
function delete_anomaly_monitor(
MonitorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"DeleteAnomalyMonitor",
Dict{String,Any}("MonitorArn" => MonitorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_anomaly_monitor(
MonitorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"DeleteAnomalyMonitor",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MonitorArn" => MonitorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_anomaly_subscription(subscription_arn)
delete_anomaly_subscription(subscription_arn, params::Dict{String,<:Any})
Deletes a cost anomaly subscription.
# Arguments
- `subscription_arn`: The unique identifier of the cost anomaly subscription that you want
to delete.
"""
function delete_anomaly_subscription(
SubscriptionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"DeleteAnomalySubscription",
Dict{String,Any}("SubscriptionArn" => SubscriptionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_anomaly_subscription(
SubscriptionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"DeleteAnomalySubscription",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionArn" => SubscriptionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cost_category_definition(cost_category_arn)
delete_cost_category_definition(cost_category_arn, params::Dict{String,<:Any})
Deletes a Cost Category. Expenses from this month going forward will no longer be
categorized with this Cost Category.
# Arguments
- `cost_category_arn`: The unique identifier for your Cost Category.
"""
function delete_cost_category_definition(
CostCategoryArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"DeleteCostCategoryDefinition",
Dict{String,Any}("CostCategoryArn" => CostCategoryArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cost_category_definition(
CostCategoryArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"DeleteCostCategoryDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CostCategoryArn" => CostCategoryArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cost_category_definition(cost_category_arn)
describe_cost_category_definition(cost_category_arn, params::Dict{String,<:Any})
Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a
Cost Category that's defined in the account. You have the option to use EffectiveOn to
return a Cost Category that's active on a specific date. If there's no EffectiveOn
specified, you see a Cost Category that's effective on the current date. If Cost Category
is still effective, EffectiveEnd is omitted in the response.
# Arguments
- `cost_category_arn`: The unique identifier for your Cost Category.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EffectiveOn"`: The date when the Cost Category was effective.
"""
function describe_cost_category_definition(
CostCategoryArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"DescribeCostCategoryDefinition",
Dict{String,Any}("CostCategoryArn" => CostCategoryArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cost_category_definition(
CostCategoryArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"DescribeCostCategoryDefinition",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CostCategoryArn" => CostCategoryArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_anomalies(date_interval)
get_anomalies(date_interval, params::Dict{String,<:Any})
Retrieves all of the cost anomalies detected on your account during the time period that's
specified by the DateInterval object. Anomalies are available for up to 90 days.
# Arguments
- `date_interval`: Assigns the start and end dates for retrieving cost anomalies. The
returned anomaly object will have an AnomalyEndDate in the specified time range.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Feedback"`: Filters anomaly results by the feedback field on the anomaly object.
- `"MaxResults"`: The number of entries a paginated response contains.
- `"MonitorArn"`: Retrieves all of the cost anomalies detected for a specific cost anomaly
monitor Amazon Resource Name (ARN).
- `"NextPageToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
- `"TotalImpact"`: Filters anomaly results by the total impact field on the anomaly object.
For example, you can filter anomalies GREATER_THAN 200.00 to retrieve anomalies, with an
estimated dollar impact greater than 200.
"""
function get_anomalies(DateInterval; aws_config::AbstractAWSConfig=global_aws_config())
return cost_explorer(
"GetAnomalies",
Dict{String,Any}("DateInterval" => DateInterval);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_anomalies(
DateInterval,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetAnomalies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DateInterval" => DateInterval), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_anomaly_monitors()
get_anomaly_monitors(params::Dict{String,<:Any})
Retrieves the cost anomaly monitor definitions for your account. You can filter using a
list of cost anomaly monitor Amazon Resource Names (ARNs).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of entries that a paginated response contains.
- `"MonitorArnList"`: A list of cost anomaly monitor ARNs.
- `"NextPageToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
"""
function get_anomaly_monitors(; aws_config::AbstractAWSConfig=global_aws_config())
return cost_explorer(
"GetAnomalyMonitors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_anomaly_monitors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetAnomalyMonitors", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_anomaly_subscriptions()
get_anomaly_subscriptions(params::Dict{String,<:Any})
Retrieves the cost anomaly subscription objects for your account. You can filter using a
list of cost anomaly monitor Amazon Resource Names (ARNs).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of entries a paginated response contains.
- `"MonitorArn"`: Cost anomaly monitor ARNs.
- `"NextPageToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
- `"SubscriptionArnList"`: A list of cost anomaly subscription ARNs.
"""
function get_anomaly_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return cost_explorer(
"GetAnomalySubscriptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_anomaly_subscriptions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetAnomalySubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_approximate_usage_records(approximation_dimension, granularity)
get_approximate_usage_records(approximation_dimension, granularity, params::Dict{String,<:Any})
Retrieves estimated usage records for hourly granularity or resource-level data at daily
granularity.
# Arguments
- `approximation_dimension`: The service to evaluate for the usage records. You can choose
resource-level data at daily granularity, or hourly granularity with or without
resource-level data.
- `granularity`: How granular you want the data to be. You can enable data at hourly or
daily granularity.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Services"`: The service metadata for the service or services you want to query. If not
specified, all elements are returned.
"""
function get_approximate_usage_records(
ApproximationDimension, Granularity; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetApproximateUsageRecords",
Dict{String,Any}(
"ApproximationDimension" => ApproximationDimension, "Granularity" => Granularity
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_approximate_usage_records(
ApproximationDimension,
Granularity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetApproximateUsageRecords",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApproximationDimension" => ApproximationDimension,
"Granularity" => Granularity,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cost_and_usage(granularity, metrics, time_period)
get_cost_and_usage(granularity, metrics, time_period, params::Dict{String,<:Any})
Retrieves cost and usage metrics for your account. You can specify which cost and
usage-related metric that you want the request to return. For example, you can specify
BlendedCosts or UsageQuantity. You can also filter and group your data by various
dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid
dimensions, see the GetDimensionValues operation. Management account in an organization in
Organizations have access to all member accounts. For information about filter limitations,
see Quotas and restrictions in the Billing and Cost Management User Guide.
# Arguments
- `granularity`: Sets the Amazon Web Services cost granularity to MONTHLY or DAILY, or
HOURLY. If Granularity isn't set, the response object doesn't include the Granularity,
either MONTHLY or DAILY, or HOURLY.
- `metrics`: Which metrics are returned in the query. For more information about blended
and unblended rates, see Why does the \"blended\" annotation appear on some line items in
my bill?. Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost,
NormalizedUsageAmount, UnblendedCost, and UsageQuantity. If you return the UsageQuantity
metric, the service aggregates all usage numbers without taking into account the units. For
example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't
meaningful because Amazon EC2 compute hours and data transfer are measured in different
units (for example, hours and GB). To get more meaningful UsageQuantity metrics, filter by
UsageType or UsageTypeGroups. Metrics is required for GetCostAndUsage requests.
- `time_period`: Sets the start date and end date for retrieving Amazon Web Services costs.
The start date is inclusive, but the end date is exclusive. For example, if start is
2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01
up to and including 2017-04-30 but not including 2017-05-01.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters Amazon Web Services costs by different dimensions. For example, you
can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that
account's usage of that service. You can nest Expression objects to define any combination
of dimension filters. For more information, see Expression. Valid values for MatchOptions
for Dimensions are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for
CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE. Default values are EQUALS
and CASE_SENSITIVE.
- `"GroupBy"`: You can group Amazon Web Services costs using up to two different groups,
either dimensions, tag keys, cost categories, or any two group by types. Valid values for
the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY,
LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and
USAGE_TYPE. When you group by the TAG type and include a valid tag key, you get all tag
values, including empty strings.
- `"NextPageToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
"""
function get_cost_and_usage(
Granularity, Metrics, TimePeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetCostAndUsage",
Dict{String,Any}(
"Granularity" => Granularity, "Metrics" => Metrics, "TimePeriod" => TimePeriod
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cost_and_usage(
Granularity,
Metrics,
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetCostAndUsage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Granularity" => Granularity,
"Metrics" => Metrics,
"TimePeriod" => TimePeriod,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cost_and_usage_with_resources(filter, granularity, time_period)
get_cost_and_usage_with_resources(filter, granularity, time_period, params::Dict{String,<:Any})
Retrieves cost and usage metrics with resources for your account. You can specify which
cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the
request to return. You can also filter and group your data by various dimensions, such as
SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the
GetDimensionValues operation. Management account in an organization in Organizations have
access to all member accounts. Hourly granularity is only available for EC2-Instances
(Elastic Compute Cloud) resource-level data. All other resource-level data is available at
daily granularity. This is an opt-in only feature. You can enable this feature from the
Cost Explorer Settings page. For information about how to access the Settings page, see
Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.
# Arguments
- `filter`: Filters Amazon Web Services costs by different dimensions. For example, you can
specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that
account's usage of that service. You can nest Expression objects to define any combination
of dimension filters. For more information, see Expression. The
GetCostAndUsageWithResources operation requires that you either group by or filter by a
ResourceId. It requires the Expression \"SERVICE = Amazon Elastic Compute Cloud - Compute\"
in the filter. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.
Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and
CASE_SENSITIVE. Default values are EQUALS and CASE_SENSITIVE.
- `granularity`: Sets the Amazon Web Services cost granularity to MONTHLY, DAILY, or
HOURLY. If Granularity isn't set, the response object doesn't include the Granularity,
MONTHLY, DAILY, or HOURLY.
- `time_period`: Sets the start and end dates for retrieving Amazon Web Services costs. The
range must be within the last 14 days (the start date cannot be earlier than 14 days ago).
The start date is inclusive, but the end date is exclusive. For example, if start is
2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01
up to and including 2017-04-30 but not including 2017-05-01.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GroupBy"`: You can group Amazon Web Services costs using up to two different groups:
DIMENSION, TAG, COST_CATEGORY.
- `"Metrics"`: Which metrics are returned in the query. For more information about blended
and unblended rates, see Why does the \"blended\" annotation appear on some line items in
my bill?. Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost,
NormalizedUsageAmount, UnblendedCost, and UsageQuantity. If you return the UsageQuantity
metric, the service aggregates all usage numbers without taking the units into account. For
example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't
meaningful because Amazon EC2 compute hours and data transfer are measured in different
units (for example, hour or GB). To get more meaningful UsageQuantity metrics, filter by
UsageType or UsageTypeGroups. Metrics is required for GetCostAndUsageWithResources
requests.
- `"NextPageToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
"""
function get_cost_and_usage_with_resources(
Filter, Granularity, TimePeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetCostAndUsageWithResources",
Dict{String,Any}(
"Filter" => Filter, "Granularity" => Granularity, "TimePeriod" => TimePeriod
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cost_and_usage_with_resources(
Filter,
Granularity,
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetCostAndUsageWithResources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Filter" => Filter,
"Granularity" => Granularity,
"TimePeriod" => TimePeriod,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cost_categories(time_period)
get_cost_categories(time_period, params::Dict{String,<:Any})
Retrieves an array of Cost Category names and values incurred cost. If some Cost Category
names and values are not associated with any cost, they will not be returned by this API.
# Arguments
- `time_period`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CostCategoryName"`:
- `"Filter"`:
- `"MaxResults"`: This field is only used when the SortBy value is provided in the request.
The maximum number of objects that are returned for this request. If MaxResults isn't
specified with the SortBy value, the request returns 1000 results as the default value for
this parameter. For GetCostCategories, MaxResults has an upper quota of 1000.
- `"NextPageToken"`: If the number of objects that are still available for retrieval
exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To
retrieve the next batch of objects, provide the NextPageToken from the previous call in
your next request.
- `"SearchString"`: The value that you want to search the filter values for. If you don't
specify a CostCategoryName, SearchString is used to filter Cost Category names that match
the SearchString pattern. If you specify a CostCategoryName, SearchString is used to filter
Cost Category values that match the SearchString pattern.
- `"SortBy"`: The value that you sort the data by. The key represents the cost and usage
metrics. The following values are supported: BlendedCost UnblendedCost
AmortizedCost NetAmortizedCost NetUnblendedCost UsageQuantity
NormalizedUsageAmount The supported key values for the SortOrder value are ASCENDING and
DESCENDING. When you use the SortBy value, the NextPageToken and SearchString key values
aren't supported.
"""
function get_cost_categories(TimePeriod; aws_config::AbstractAWSConfig=global_aws_config())
return cost_explorer(
"GetCostCategories",
Dict{String,Any}("TimePeriod" => TimePeriod);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cost_categories(
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetCostCategories",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TimePeriod" => TimePeriod), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cost_forecast(granularity, metric, time_period)
get_cost_forecast(granularity, metric, time_period, params::Dict{String,<:Any})
Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the
forecast time period that you select, based on your past costs.
# Arguments
- `granularity`: How granular you want the forecast to be. You can get 3 months of DAILY
forecasts or 12 months of MONTHLY forecasts. The GetCostForecast operation supports only
DAILY and MONTHLY granularities.
- `metric`: Which metric Cost Explorer uses to create your forecast. For more information
about blended and unblended rates, see Why does the \"blended\" annotation appear on some
line items in my bill?. Valid values for a GetCostForecast call are the following:
AMORTIZED_COST BLENDED_COST NET_AMORTIZED_COST NET_UNBLENDED_COST UNBLENDED_COST
- `time_period`: The period of time that you want the forecast to cover. The start date
must be equal to or no later than the current date to avoid a validation error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters that you want to use to filter your forecast. The GetCostForecast
API supports filtering by the following dimensions: AZ INSTANCE_TYPE
LINKED_ACCOUNT LINKED_ACCOUNT_NAME OPERATION PURCHASE_TYPE REGION
SERVICE USAGE_TYPE USAGE_TYPE_GROUP RECORD_TYPE OPERATING_SYSTEM
TENANCY SCOPE PLATFORM SUBSCRIPTION_ID LEGAL_ENTITY_NAME
DEPLOYMENT_OPTION DATABASE_ENGINE INSTANCE_TYPE_FAMILY BILLING_ENTITY
RESERVATION_ID SAVINGS_PLAN_ARN
- `"PredictionIntervalLevel"`: Cost Explorer always returns the mean forecast as a single
point. You can request a prediction interval around the mean by specifying a confidence
level. The higher the confidence level, the more confident Cost Explorer is about the
actual value falling in the prediction interval. Higher confidence levels result in wider
prediction intervals.
"""
function get_cost_forecast(
Granularity, Metric, TimePeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetCostForecast",
Dict{String,Any}(
"Granularity" => Granularity, "Metric" => Metric, "TimePeriod" => TimePeriod
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cost_forecast(
Granularity,
Metric,
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetCostForecast",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Granularity" => Granularity,
"Metric" => Metric,
"TimePeriod" => TimePeriod,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dimension_values(dimension, time_period)
get_dimension_values(dimension, time_period, params::Dict{String,<:Any})
Retrieves all available filter values for a specified filter over a period of time. You can
search the dimension values for an arbitrary string.
# Arguments
- `dimension`: The name of the dimension. Each Dimension is available for a different
Context. For more information, see Context. LINK_ACCOUNT_NAME and SERVICE_CODE can only be
used in CostCategoryRule.
- `time_period`: The start date and end date for retrieving the dimension values. The start
date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and
end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
including 2017-04-30 but not including 2017-05-01.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Context"`: The context for the call to GetDimensionValues. This can be RESERVATIONS or
COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS,
the resulting dimension values can be used in the GetReservationUtilization operation. If
the context is set to COST_AND_USAGE, the resulting dimension values can be used in the
GetCostAndUsage operation. If you set the context to COST_AND_USAGE, you can use the
following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a.
BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible
values are the following: - Amazon Web Services(Amazon Web Services): The entity that sells
Amazon Web Services. - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity
that's an acting reseller for Amazon Web Services in India. - Amazon Web Services
Marketplace: The entity that supports the sale of solutions that are built on Amazon Web
Services by third-party software providers. CACHE_ENGINE - The Amazon ElastiCache
operating system. Examples are Windows or Linux. DEPLOYMENT_OPTION - The scope of Amazon
Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or
MySQL. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases.
Examples are Compute Optimized (for example, C4, C5, C6g, and C7g), Memory Optimization
(for example, R4, R5n, R5b, and R6g). INVOICING_ENTITY - The name of the entity that
issues the Amazon Web Services invoice. LEGAL_ENTITY_NAME - The name of the organization
that sells you Amazon Web Services services, such as Amazon Web Services. LINKED_ACCOUNT
- The description in the attribute map that includes the full name of the member account.
The value field contains the Amazon Web Services ID of the member account.
OPERATING_SYSTEM - The operating system. Examples are Windows or Linux. OPERATION - The
action performed. Examples include RunInstance and CreateBucket. PLATFORM - The Amazon
EC2 operating system. Examples are Windows or Linux. PURCHASE_TYPE - The reservation type
of the purchase that this usage is related to. Examples include On-Demand Instances and
Standard Reserved Instances. RESERVATION_ID - The unique identifier for an Amazon Web
Services Reservation Instance. SAVINGS_PLAN_ARN - The unique identifier for your Savings
Plans. SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute). SERVICE -
The Amazon Web Services service such as Amazon DynamoDB. TENANCY - The tenancy of a
resource. Examples are shared or dedicated. USAGE_TYPE - The type of usage. An example is
DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit
attribute. Examples include GB and Hrs. USAGE_TYPE_GROUP - The grouping of common usage
types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation
includes a unit attribute. REGION - The Amazon Web Services Region. RECORD_TYPE - The
different types of charges such as Reserved Instance (RI) fees, usage costs, tax refunds,
and credits. RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in
feature only available for last 14 days for EC2-Compute Service. If you set the context
to RESERVATIONS, you can use the following dimensions for searching: AZ - The
Availability Zone. An example is us-east-1a. CACHE_ENGINE - The Amazon ElastiCache
operating system. Examples are Windows or Linux. DEPLOYMENT_OPTION - The scope of Amazon
Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LINKED_ACCOUNT
- The description in the attribute map that includes the full name of the member account.
The value field contains the Amazon Web Services ID of the member account. PLATFORM - The
Amazon EC2 operating system. Examples are Windows or Linux. REGION - The Amazon Web
Services Region. SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values
are regional or a single Availability Zone. TAG (Coverage only) - The tags that are
associated with a Reserved Instance (RI). TENANCY - The tenancy of a resource. Examples
are shared or dedicated. If you set the context to SAVINGS_PLANS, you can use the
following dimensions for searching: SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2
Instance or Compute) PAYMENT_OPTION - The payment option for the given Savings Plans (for
example, All Upfront) REGION - The Amazon Web Services Region. INSTANCE_TYPE_FAMILY -
The family of instances (For example, m5) LINKED_ACCOUNT - The description in the
attribute map that includes the full name of the member account. The value field contains
the Amazon Web Services ID of the member account. SAVINGS_PLAN_ARN - The unique
identifier for your Savings Plans.
- `"Filter"`:
- `"MaxResults"`: This field is only used when SortBy is provided in the request. The
maximum number of objects that are returned for this request. If MaxResults isn't specified
with SortBy, the request returns 1000 results as the default value for this parameter. For
GetDimensionValues, MaxResults has an upper limit of 1000.
- `"NextPageToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
- `"SearchString"`: The value that you want to search the filter values for.
- `"SortBy"`: The value that you want to sort the data by. The key represents cost and
usage metrics. The following values are supported: BlendedCost UnblendedCost
AmortizedCost NetAmortizedCost NetUnblendedCost UsageQuantity
NormalizedUsageAmount The supported values for the SortOrder key are ASCENDING or
DESCENDING. When you specify a SortBy paramater, the context must be COST_AND_USAGE.
Further, when using SortBy, NextPageToken and SearchString aren't supported.
"""
function get_dimension_values(
Dimension, TimePeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetDimensionValues",
Dict{String,Any}("Dimension" => Dimension, "TimePeriod" => TimePeriod);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dimension_values(
Dimension,
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetDimensionValues",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Dimension" => Dimension, "TimePeriod" => TimePeriod),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reservation_coverage(time_period)
get_reservation_coverage(time_period, params::Dict{String,<:Any})
Retrieves the reservation coverage for your account, which you can use to see how much of
your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service,
or Amazon Redshift usage is covered by a reservation. An organization's management account
can see the coverage of the associated member accounts. This supports dimensions, Cost
Categories, and nested expressions. For any time period, you can filter data about
reservation usage by the following dimensions: AZ CACHE_ENGINE DATABASE_ENGINE
DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION
SERVICE TAG TENANCY To determine valid values for a dimension, use the
GetDimensionValues operation.
# Arguments
- `time_period`: The start and end dates of the period that you want to retrieve data about
reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12
months and the current month. The start date is inclusive, but the end date is exclusive.
For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is
retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters utilization data by dimensions. You can filter by the following
dimensions: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE
LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY
GetReservationCoverage uses the same Expression object as the other operations, but only
AND is supported among each dimension. You can nest only one level deep. If there are
multiple values for a dimension, they are OR'd together. If you don't provide a SERVICE
filter, Cost Explorer defaults to EC2. Cost category is also supported.
- `"Granularity"`: The granularity of the Amazon Web Services cost data for the
reservation. Valid values are MONTHLY and DAILY. If GroupBy is set, Granularity can't be
set. If Granularity isn't set, the response object doesn't include Granularity, either
MONTHLY or DAILY. The GetReservationCoverage operation supports only DAILY and MONTHLY
granularities.
- `"GroupBy"`: You can group the data by the following attributes: AZ CACHE_ENGINE
DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE INVOICING_ENTITY LINKED_ACCOUNT
OPERATING_SYSTEM PLATFORM REGION TENANCY
- `"MaxResults"`: The maximum number of objects that you returned for this request. If more
objects are available, in the response, Amazon Web Services provides a NextPageToken value
that you can use in a subsequent call to get the next batch of objects.
- `"Metrics"`: The measurement that you want your reservation coverage reported in. Valid
values are Hour, Unit, and Cost. You can use multiple values in a request.
- `"NextPageToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
- `"SortBy"`: The value by which you want to sort the data. The following values are
supported for Key: OnDemandCost CoverageHoursPercentage OnDemandHours
ReservedHours TotalRunningHours CoverageNormalizedUnitsPercentage
OnDemandNormalizedUnits ReservedNormalizedUnits TotalRunningNormalizedUnits
Time Supported values for SortOrder are ASCENDING or DESCENDING.
"""
function get_reservation_coverage(
TimePeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetReservationCoverage",
Dict{String,Any}("TimePeriod" => TimePeriod);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reservation_coverage(
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetReservationCoverage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TimePeriod" => TimePeriod), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reservation_purchase_recommendation(service)
get_reservation_purchase_recommendation(service, params::Dict{String,<:Any})
Gets recommendations for reservation purchases. These recommendations might help you to
reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to
On-Demand pricing. Amazon Web Services generates your recommendations by identifying your
On-Demand usage during a specific time period and collecting your usage into categories
that are eligible for a reservation. After Amazon Web Services has these categories, it
simulates every combination of reservations in each category of usage to identify the best
number of each type of Reserved Instance (RI) to purchase to maximize your estimated
savings. For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux,
shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you
buy size-flexible regional reservations to apply to the c4 family usage. Amazon Web
Services recommends the smallest size instance in an instance family. This makes it easier
to purchase a size-flexible Reserved Instance (RI). Amazon Web Services also shows the
equal number of normalized units. This way, you can purchase any instance size that you
want. For this example, your RI recommendation is for c4.large because that is the smallest
size instance in the c4 instance family.
# Arguments
- `service`: The specific service that you want recommendations for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountId"`: The account ID that's associated with the recommendation.
- `"AccountScope"`: The account scope that you want your recommendations for. Amazon Web
Services calculates recommendations including the management account and member accounts if
the value is set to PAYER. If the value is LINKED, recommendations are calculated for
individual member accounts only.
- `"Filter"`:
- `"LookbackPeriodInDays"`: The number of previous days that you want Amazon Web Services
to consider when it calculates your recommendations.
- `"NextPageToken"`: The pagination token that indicates the next set of results that you
want to retrieve.
- `"PageSize"`: The number of recommendations that you want returned in a single response
object.
- `"PaymentOption"`: The reservation purchase option that you want recommendations for.
- `"ServiceSpecification"`: The hardware specifications for the service instances that you
want recommendations for, such as standard or convertible Amazon EC2 instances.
- `"TermInYears"`: The reservation term that you want recommendations for.
"""
function get_reservation_purchase_recommendation(
Service; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetReservationPurchaseRecommendation",
Dict{String,Any}("Service" => Service);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reservation_purchase_recommendation(
Service, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetReservationPurchaseRecommendation",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Service" => Service), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reservation_utilization(time_period)
get_reservation_utilization(time_period, params::Dict{String,<:Any})
Retrieves the reservation utilization for your account. Management account in an
organization have access to member accounts. You can filter data by dimensions in a time
period. You can use GetDimensionValues to determine the possible dimension values.
Currently, you can group only by SUBSCRIPTION_ID.
# Arguments
- `time_period`: Sets the start and end dates for retrieving Reserved Instance (RI)
utilization. The start date is inclusive, but the end date is exclusive. For example, if
start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from
2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters utilization data by dimensions. You can filter by the following
dimensions: AZ CACHE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT
OPERATING_SYSTEM PLATFORM REGION SERVICE SCOPE TENANCY
GetReservationUtilization uses the same Expression object as the other operations, but only
AND is supported among each dimension, and nesting is supported up to only one level deep.
If there are multiple values for a dimension, they are OR'd together.
- `"Granularity"`: If GroupBy is set, Granularity can't be set. If Granularity isn't set,
the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy
and Granularity aren't set, GetReservationUtilization defaults to DAILY. The
GetReservationUtilization operation supports only DAILY and MONTHLY granularities.
- `"GroupBy"`: Groups only by SUBSCRIPTION_ID. Metadata is included.
- `"MaxResults"`: The maximum number of objects that you returned for this request. If more
objects are available, in the response, Amazon Web Services provides a NextPageToken value
that you can use in a subsequent call to get the next batch of objects.
- `"NextPageToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
- `"SortBy"`: The value that you want to sort the data by. The following values are
supported for Key: UtilizationPercentage UtilizationPercentageInUnits
PurchasedHours PurchasedUnits TotalActualHours TotalActualUnits UnusedHours
UnusedUnits OnDemandCostOfRIHoursUsed NetRISavings TotalPotentialRISavings
AmortizedUpfrontFee AmortizedRecurringFee TotalAmortizedFee
RICostForUnusedHours RealizedSavings UnrealizedSavings The supported values for
SortOrder are ASCENDING and DESCENDING.
"""
function get_reservation_utilization(
TimePeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetReservationUtilization",
Dict{String,Any}("TimePeriod" => TimePeriod);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reservation_utilization(
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetReservationUtilization",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TimePeriod" => TimePeriod), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_rightsizing_recommendation(service)
get_rightsizing_recommendation(service, params::Dict{String,<:Any})
Creates recommendations that help you save cost by identifying idle and underutilized
Amazon EC2 instances. Recommendations are generated to either downsize or terminate
instances, along with providing savings detail and metrics. For more information about
calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the
Billing and Cost Management User Guide.
# Arguments
- `service`: The specific service that you want recommendations for. The only valid value
for GetRightsizingRecommendation is \"AmazonEC2\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Configuration"`: You can use Configuration to customize recommendations across two
attributes. You can choose to view recommendations for instances within the same instance
families or across different instance families. You can also choose to view your estimated
savings that are associated with recommendations with consideration of existing Savings
Plans or RI benefits, or neither.
- `"Filter"`:
- `"NextPageToken"`: The pagination token that indicates the next set of results that you
want to retrieve.
- `"PageSize"`: The number of recommendations that you want returned in a single response
object.
"""
function get_rightsizing_recommendation(
Service; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetRightsizingRecommendation",
Dict{String,Any}("Service" => Service);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rightsizing_recommendation(
Service, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetRightsizingRecommendation",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Service" => Service), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_savings_plan_purchase_recommendation_details(recommendation_detail_id)
get_savings_plan_purchase_recommendation_details(recommendation_detail_id, params::Dict{String,<:Any})
Retrieves the details for a Savings Plan recommendation. These details include the hourly
data-points that construct the cost, coverage, and utilization charts.
# Arguments
- `recommendation_detail_id`: The ID that is associated with the Savings Plan
recommendation.
"""
function get_savings_plan_purchase_recommendation_details(
RecommendationDetailId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetSavingsPlanPurchaseRecommendationDetails",
Dict{String,Any}("RecommendationDetailId" => RecommendationDetailId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_savings_plan_purchase_recommendation_details(
RecommendationDetailId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetSavingsPlanPurchaseRecommendationDetails",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RecommendationDetailId" => RecommendationDetailId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_savings_plans_coverage(time_period)
get_savings_plans_coverage(time_period, params::Dict{String,<:Any})
Retrieves the Savings Plans covered for your account. This enables you to see how much of
your cost is covered by a Savings Plan. An organization’s management account can see the
coverage of the associated member accounts. This supports dimensions, Cost Categories, and
nested expressions. For any time period, you can filter data for Savings Plans usage with
the following dimensions: LINKED_ACCOUNT REGION SERVICE INSTANCE_FAMILY
To determine valid values for a dimension, use the GetDimensionValues operation.
# Arguments
- `time_period`: The time period that you want the usage and costs for. The Start date must
be within 13 months. The End date must be after the Start date, and before the current
date. Future dates can't be used as an End date.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters Savings Plans coverage data by dimensions. You can filter data for
Savings Plans usage with the following dimensions: LINKED_ACCOUNT REGION SERVICE
INSTANCE_FAMILY GetSavingsPlansCoverage uses the same Expression object as the
other operations, but only AND is supported among each dimension. If there are multiple
values for a dimension, they are OR'd together. Cost category is also supported.
- `"Granularity"`: The granularity of the Amazon Web Services cost data for your Savings
Plans. Granularity can't be set if GroupBy is set. The GetSavingsPlansCoverage operation
supports only DAILY and MONTHLY granularities.
- `"GroupBy"`: You can group the data using the attributes INSTANCE_FAMILY, REGION, or
SERVICE.
- `"MaxResults"`: The number of items to be returned in a response. The default is 20, with
a minimum value of 1.
- `"Metrics"`: The measurement that you want your Savings Plans coverage reported in. The
only valid value is SpendCoveredBySavingsPlans.
- `"NextToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
- `"SortBy"`: The value that you want to sort the data by. The following values are
supported for Key: SpendCoveredBySavingsPlan OnDemandCost CoveragePercentage
TotalCost InstanceFamily Region Service The supported values for SortOrder
are ASCENDING and DESCENDING.
"""
function get_savings_plans_coverage(
TimePeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetSavingsPlansCoverage",
Dict{String,Any}("TimePeriod" => TimePeriod);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_savings_plans_coverage(
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetSavingsPlansCoverage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TimePeriod" => TimePeriod), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_savings_plans_purchase_recommendation(lookback_period_in_days, payment_option, savings_plans_type, term_in_years)
get_savings_plans_purchase_recommendation(lookback_period_in_days, payment_option, savings_plans_type, term_in_years, params::Dict{String,<:Any})
Retrieves the Savings Plans recommendations for your account. First use
StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations,
and then use GetSavingsPlansPurchaseRecommendation to retrieve them.
# Arguments
- `lookback_period_in_days`: The lookback period that's used to generate the recommendation.
- `payment_option`: The payment option that's used to generate these recommendations.
- `savings_plans_type`: The Savings Plans recommendation type that's requested.
- `term_in_years`: The savings plan recommendation term that's used to generate these
recommendations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountScope"`: The account scope that you want your recommendations for. Amazon Web
Services calculates recommendations including the management account and member accounts if
the value is set to PAYER. If the value is LINKED, recommendations are calculated for
individual member accounts only.
- `"Filter"`: You can filter your recommendations by Account ID with the LINKED_ACCOUNT
dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and
Value as the comma-separated Acount ID(s) that you want to see Savings Plans purchase
recommendations for. For GetSavingsPlansPurchaseRecommendation, the Filter doesn't include
CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be
LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs
that you want to see Savings Plans Purchase Recommendations for. AND and OR operators are
not supported.
- `"NextPageToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
- `"PageSize"`: The number of recommendations that you want returned in a single response
object.
"""
function get_savings_plans_purchase_recommendation(
LookbackPeriodInDays,
PaymentOption,
SavingsPlansType,
TermInYears;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetSavingsPlansPurchaseRecommendation",
Dict{String,Any}(
"LookbackPeriodInDays" => LookbackPeriodInDays,
"PaymentOption" => PaymentOption,
"SavingsPlansType" => SavingsPlansType,
"TermInYears" => TermInYears,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_savings_plans_purchase_recommendation(
LookbackPeriodInDays,
PaymentOption,
SavingsPlansType,
TermInYears,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetSavingsPlansPurchaseRecommendation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LookbackPeriodInDays" => LookbackPeriodInDays,
"PaymentOption" => PaymentOption,
"SavingsPlansType" => SavingsPlansType,
"TermInYears" => TermInYears,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_savings_plans_utilization(time_period)
get_savings_plans_utilization(time_period, params::Dict{String,<:Any})
Retrieves the Savings Plans utilization for your account across date ranges with daily or
monthly granularity. Management account in an organization have access to member accounts.
You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.
You can't group by any dimension values for GetSavingsPlansUtilization.
# Arguments
- `time_period`: The time period that you want the usage and costs for. The Start date must
be within 13 months. The End date must be after the Start date, and before the current
date. Future dates can't be used as an End date.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters Savings Plans utilization coverage data for active Savings Plans
dimensions. You can filter data with the following dimensions: LINKED_ACCOUNT
SAVINGS_PLAN_ARN SAVINGS_PLANS_TYPE REGION PAYMENT_OPTION
INSTANCE_TYPE_FAMILY GetSavingsPlansUtilization uses the same Expression object as the
other operations, but only AND is supported among each dimension.
- `"Granularity"`: The granularity of the Amazon Web Services utillization data for your
Savings Plans. The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY
granularities.
- `"SortBy"`: The value that you want to sort the data by. The following values are
supported for Key: UtilizationPercentage TotalCommitment UsedCommitment
UnusedCommitment NetSavings The supported values for SortOrder are ASCENDING and
DESCENDING.
"""
function get_savings_plans_utilization(
TimePeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetSavingsPlansUtilization",
Dict{String,Any}("TimePeriod" => TimePeriod);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_savings_plans_utilization(
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetSavingsPlansUtilization",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TimePeriod" => TimePeriod), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_savings_plans_utilization_details(time_period)
get_savings_plans_utilization_details(time_period, params::Dict{String,<:Any})
Retrieves attribute data along with aggregate utilization and savings data for a given time
period. This doesn't support granular or grouped data (daily/monthly) in response. You
can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but
you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing
individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible
dimension values. GetSavingsPlanUtilizationDetails internally groups data by
SavingsPlansArn.
# Arguments
- `time_period`: The time period that you want the usage and costs for. The Start date must
be within 13 months. The End date must be after the Start date, and before the current
date. Future dates can't be used as an End date.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataType"`: The data type.
- `"Filter"`: Filters Savings Plans utilization coverage data for active Savings Plans
dimensions. You can filter data with the following dimensions: LINKED_ACCOUNT
SAVINGS_PLAN_ARN REGION PAYMENT_OPTION INSTANCE_TYPE_FAMILY
GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations,
but only AND is supported among each dimension.
- `"MaxResults"`: The number of items to be returned in a response. The default is 20, with
a minimum value of 1.
- `"NextToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
- `"SortBy"`: The value that you want to sort the data by. The following values are
supported for Key: UtilizationPercentage TotalCommitment UsedCommitment
UnusedCommitment NetSavings AmortizedRecurringCommitment
AmortizedUpfrontCommitment The supported values for SortOrder are ASCENDING and
DESCENDING.
"""
function get_savings_plans_utilization_details(
TimePeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetSavingsPlansUtilizationDetails",
Dict{String,Any}("TimePeriod" => TimePeriod);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_savings_plans_utilization_details(
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetSavingsPlansUtilizationDetails",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TimePeriod" => TimePeriod), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_tags(time_period)
get_tags(time_period, params::Dict{String,<:Any})
Queries for available tag keys and tag values for a specified period. You can search the
tag values for an arbitrary string.
# Arguments
- `time_period`: The start and end dates for retrieving the dimension values. The start
date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and
end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
including 2017-04-30 but not including 2017-05-01.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`:
- `"MaxResults"`: This field is only used when SortBy is provided in the request. The
maximum number of objects that are returned for this request. If MaxResults isn't specified
with SortBy, the request returns 1000 results as the default value for this parameter. For
GetTags, MaxResults has an upper quota of 1000.
- `"NextPageToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
- `"SearchString"`: The value that you want to search for.
- `"SortBy"`: The value that you want to sort the data by. The key represents cost and
usage metrics. The following values are supported: BlendedCost UnblendedCost
AmortizedCost NetAmortizedCost NetUnblendedCost UsageQuantity
NormalizedUsageAmount The supported values for SortOrder are ASCENDING and DESCENDING.
When you use SortBy, NextPageToken and SearchString aren't supported.
- `"TagKey"`: The key of the tag that you want to return values for.
"""
function get_tags(TimePeriod; aws_config::AbstractAWSConfig=global_aws_config())
return cost_explorer(
"GetTags",
Dict{String,Any}("TimePeriod" => TimePeriod);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_tags(
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TimePeriod" => TimePeriod), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_usage_forecast(granularity, metric, time_period)
get_usage_forecast(granularity, metric, time_period, params::Dict{String,<:Any})
Retrieves a forecast for how much Amazon Web Services predicts that you will use over the
forecast time period that you select, based on your past usage.
# Arguments
- `granularity`: How granular you want the forecast to be. You can get 3 months of DAILY
forecasts or 12 months of MONTHLY forecasts. The GetUsageForecast operation supports only
DAILY and MONTHLY granularities.
- `metric`: Which metric Cost Explorer uses to create your forecast. Valid values for a
GetUsageForecast call are the following: USAGE_QUANTITY NORMALIZED_USAGE_AMOUNT
- `time_period`: The start and end dates of the period that you want to retrieve usage
forecast for. The start date is included in the period, but the end date isn't included in
the period. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and
usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including
2017-05-01. The start date must be equal to or later than the current date to avoid a
validation error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters that you want to use to filter your forecast. The
GetUsageForecast API supports filtering by the following dimensions: AZ
INSTANCE_TYPE LINKED_ACCOUNT LINKED_ACCOUNT_NAME OPERATION PURCHASE_TYPE
REGION SERVICE USAGE_TYPE USAGE_TYPE_GROUP RECORD_TYPE
OPERATING_SYSTEM TENANCY SCOPE PLATFORM SUBSCRIPTION_ID
LEGAL_ENTITY_NAME DEPLOYMENT_OPTION DATABASE_ENGINE INSTANCE_TYPE_FAMILY
BILLING_ENTITY RESERVATION_ID SAVINGS_PLAN_ARN
- `"PredictionIntervalLevel"`: Amazon Web Services Cost Explorer always returns the mean
forecast as a single point. You can request a prediction interval around the mean by
specifying a confidence level. The higher the confidence level, the more confident Cost
Explorer is about the actual value falling in the prediction interval. Higher confidence
levels result in wider prediction intervals.
"""
function get_usage_forecast(
Granularity, Metric, TimePeriod; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"GetUsageForecast",
Dict{String,Any}(
"Granularity" => Granularity, "Metric" => Metric, "TimePeriod" => TimePeriod
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_usage_forecast(
Granularity,
Metric,
TimePeriod,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"GetUsageForecast",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Granularity" => Granularity,
"Metric" => Metric,
"TimePeriod" => TimePeriod,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cost_allocation_tag_backfill_history()
list_cost_allocation_tag_backfill_history(params::Dict{String,<:Any})
Retrieves a list of your historical cost allocation tag backfill requests.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of objects that are returned for this request.
- `"NextToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
"""
function list_cost_allocation_tag_backfill_history(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"ListCostAllocationTagBackfillHistory";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cost_allocation_tag_backfill_history(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"ListCostAllocationTagBackfillHistory",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cost_allocation_tags()
list_cost_allocation_tags(params::Dict{String,<:Any})
Get a list of cost allocation tags. All inputs in the API are optional and serve as
filters. By default, all cost allocation tags are returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of objects that are returned for this request. By
default, the request returns 100 results.
- `"NextToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
- `"Status"`: The status of cost allocation tag keys that are returned for this request.
- `"TagKeys"`: The list of cost allocation tag keys that are returned for this request.
- `"Type"`: The type of CostAllocationTag object that are returned for this request. The
AWSGenerated type tags are tags that Amazon Web Services defines and applies to support
Amazon Web Services resources for cost allocation purposes. The UserDefined type tags are
tags that you define, create, and apply to resources.
"""
function list_cost_allocation_tags(; aws_config::AbstractAWSConfig=global_aws_config())
return cost_explorer(
"ListCostAllocationTags"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_cost_allocation_tags(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"ListCostAllocationTags",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cost_category_definitions()
list_cost_category_definitions(params::Dict{String,<:Any})
Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective dates of all Cost
Categories defined in the account. You have the option to use EffectiveOn to return a list
of Cost Categories that were active on a specific date. If there is no EffectiveOn
specified, you’ll see Cost Categories that are effective on the current date. If Cost
Category is still effective, EffectiveEnd is omitted in the response.
ListCostCategoryDefinitions supports pagination. The request can have a MaxResults range up
to 100.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EffectiveOn"`: The date when the Cost Category was effective.
- `"MaxResults"`: The number of entries a paginated response contains.
- `"NextToken"`: The token to retrieve the next set of results. Amazon Web Services
provides the token when the response from a previous call has more results than the maximum
page size.
"""
function list_cost_category_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return cost_explorer(
"ListCostCategoryDefinitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cost_category_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"ListCostCategoryDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_savings_plans_purchase_recommendation_generation()
list_savings_plans_purchase_recommendation_generation(params::Dict{String,<:Any})
Retrieves a list of your historical recommendation generations within the past 30 days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GenerationStatus"`: The status of the recommendation generation.
- `"NextPageToken"`: The token to retrieve the next set of results.
- `"PageSize"`: The number of recommendations that you want returned in a single response
object.
- `"RecommendationIds"`: The IDs for each specific recommendation.
"""
function list_savings_plans_purchase_recommendation_generation(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"ListSavingsPlansPurchaseRecommendationGeneration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_savings_plans_purchase_recommendation_generation(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"ListSavingsPlansPurchaseRecommendationGeneration",
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 resource tags associated with the resource specified by the Amazon
Resource Name (ARN).
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. For a list of supported
resources, see ResourceTag.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"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 cost_explorer(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
provide_anomaly_feedback(anomaly_id, feedback)
provide_anomaly_feedback(anomaly_id, feedback, params::Dict{String,<:Any})
Modifies the feedback property of a given cost anomaly.
# Arguments
- `anomaly_id`: A cost anomaly ID.
- `feedback`: Describes whether the cost anomaly was a planned activity or you considered
it an anomaly.
"""
function provide_anomaly_feedback(
AnomalyId, Feedback; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"ProvideAnomalyFeedback",
Dict{String,Any}("AnomalyId" => AnomalyId, "Feedback" => Feedback);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function provide_anomaly_feedback(
AnomalyId,
Feedback,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"ProvideAnomalyFeedback",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AnomalyId" => AnomalyId, "Feedback" => Feedback),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_cost_allocation_tag_backfill(backfill_from)
start_cost_allocation_tag_backfill(backfill_from, params::Dict{String,<:Any})
Request a cost allocation tag backfill. This will backfill the activation status (either
active or inactive) for all tag keys from para:BackfillFrom up to the when this request is
made. You can request a backfill once every 24 hours.
# Arguments
- `backfill_from`: The date you want the backfill to start from. The date can only be a
first day of the month (a billing start date). Dates can't precede the previous twelve
months, or in the future.
"""
function start_cost_allocation_tag_backfill(
BackfillFrom; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"StartCostAllocationTagBackfill",
Dict{String,Any}("BackfillFrom" => BackfillFrom);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_cost_allocation_tag_backfill(
BackfillFrom,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"StartCostAllocationTagBackfill",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BackfillFrom" => BackfillFrom), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_savings_plans_purchase_recommendation_generation()
start_savings_plans_purchase_recommendation_generation(params::Dict{String,<:Any})
Requests a Savings Plans recommendation generation. This enables you to calculate a fresh
set of Savings Plans recommendations that takes your latest usage data and current Savings
Plans inventory into account. You can refresh Savings Plans recommendations up to three
times daily for a consolidated billing family.
StartSavingsPlansPurchaseRecommendationGeneration has no request syntax because no input
parameters are needed to support this operation.
"""
function start_savings_plans_purchase_recommendation_generation(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"StartSavingsPlansPurchaseRecommendationGeneration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_savings_plans_purchase_recommendation_generation(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"StartSavingsPlansPurchaseRecommendationGeneration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, resource_tags)
tag_resource(resource_arn, resource_tags, params::Dict{String,<:Any})
An API operation for adding one or more tags (key-value pairs) to a resource. 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 you specify replaces the previous value for that tag. Although the maximum number
of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web
Services use.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. For a list of supported
resources, see ResourceTag.
- `resource_tags`: A list of tag key-value pairs to be added to the resource. Each tag
consists of a key and a value, and each key must be unique for the resource. The following
restrictions apply to resource tags: Although the maximum number of array members is 200,
you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for
Amazon Web Services use The maximum length of a key is 128 characters The maximum
length of a value is 256 characters Keys and values can only contain alphanumeric
characters, spaces, and any of the following: _.:/=+@- Keys and values are case
sensitive Keys and values are trimmed for any leading or trailing whitespaces Don’t
use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use
"""
function tag_resource(
ResourceArn, ResourceTags; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "ResourceTags" => ResourceTags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
ResourceTags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceArn" => ResourceArn, "ResourceTags" => ResourceTags
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, resource_tag_keys)
untag_resource(resource_arn, resource_tag_keys, params::Dict{String,<:Any})
Removes one or more tags from a resource. Specify only tag keys in your request. Don't
specify the value.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource. For a list of supported
resources, see ResourceTag.
- `resource_tag_keys`: A list of tag keys associated with tags that need to be removed from
the resource. If you specify a tag key that doesn't exist, it's ignored. Although the
maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved
for Amazon Web Services use.
"""
function untag_resource(
ResourceArn, ResourceTagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"UntagResource",
Dict{String,Any}(
"ResourceArn" => ResourceArn, "ResourceTagKeys" => ResourceTagKeys
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
ResourceTagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceArn" => ResourceArn, "ResourceTagKeys" => ResourceTagKeys
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_anomaly_monitor(monitor_arn)
update_anomaly_monitor(monitor_arn, params::Dict{String,<:Any})
Updates an existing cost anomaly monitor. The changes made are applied going forward, and
doesn't change anomalies detected in the past.
# Arguments
- `monitor_arn`: Cost anomaly monitor Amazon Resource Names (ARNs).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MonitorName"`: The new name for the cost anomaly monitor.
"""
function update_anomaly_monitor(
MonitorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"UpdateAnomalyMonitor",
Dict{String,Any}("MonitorArn" => MonitorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_anomaly_monitor(
MonitorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"UpdateAnomalyMonitor",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MonitorArn" => MonitorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_anomaly_subscription(subscription_arn)
update_anomaly_subscription(subscription_arn, params::Dict{String,<:Any})
Updates an existing cost anomaly subscription. Specify the fields that you want to update.
Omitted fields are unchanged. The JSON below describes the generic construct for each
type. See Request Parameters for possible values as they apply to AnomalySubscription.
# Arguments
- `subscription_arn`: A cost anomaly subscription Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Frequency"`: The update to the frequency value that subscribers receive notifications.
- `"MonitorArnList"`: A list of cost anomaly monitor ARNs.
- `"Subscribers"`: The update to the subscriber list.
- `"SubscriptionName"`: The new name of the subscription.
- `"Threshold"`: (deprecated) The update to the threshold value for receiving
notifications. This field has been deprecated. To update a threshold, use
ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a
ThresholdExpression. You can specify either Threshold or ThresholdExpression, but not both.
- `"ThresholdExpression"`: The update to the Expression object used to specify the
anomalies that you want to generate alerts for. This supports dimensions and nested
expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and
ANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding to an anomaly’s TotalImpact and
TotalImpactPercentage, respectively (see Impact for more details). The supported nested
expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL is required. Values
must be numbers between 0 and 10,000,000,000 in string format. You can specify either
Threshold or ThresholdExpression, but not both. The following are examples of valid
ThresholdExpressions: Absolute threshold: { \"Dimensions\": { \"Key\":
\"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ],
\"Values\": [ \"100\" ] } } Percentage threshold: { \"Dimensions\": { \"Key\":
\"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ],
\"Values\": [ \"100\" ] } } AND two thresholds together: { \"And\": [ { \"Dimensions\":
{ \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\"
], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\":
\"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ],
\"Values\": [ \"100\" ] } } ] } OR two thresholds together: { \"Or\": [ {
\"Dimensions\": { \"Key\": \"ANOMALY_TOTAL_IMPACT_ABSOLUTE\", \"MatchOptions\": [
\"GREATER_THAN_OR_EQUAL\" ], \"Values\": [ \"100\" ] } }, { \"Dimensions\": { \"Key\":
\"ANOMALY_TOTAL_IMPACT_PERCENTAGE\", \"MatchOptions\": [ \"GREATER_THAN_OR_EQUAL\" ],
\"Values\": [ \"100\" ] } } ] }
"""
function update_anomaly_subscription(
SubscriptionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"UpdateAnomalySubscription",
Dict{String,Any}("SubscriptionArn" => SubscriptionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_anomaly_subscription(
SubscriptionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"UpdateAnomalySubscription",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionArn" => SubscriptionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cost_allocation_tags_status(cost_allocation_tags_status)
update_cost_allocation_tags_status(cost_allocation_tags_status, params::Dict{String,<:Any})
Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag
status that's updated is the same as the existing tag status, the request doesn't fail.
Instead, it doesn't have any effect on the tag status (for example, activating the active
tag).
# Arguments
- `cost_allocation_tags_status`: The list of CostAllocationTagStatusEntry objects that are
used to update cost allocation tags status for this request.
"""
function update_cost_allocation_tags_status(
CostAllocationTagsStatus; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"UpdateCostAllocationTagsStatus",
Dict{String,Any}("CostAllocationTagsStatus" => CostAllocationTagsStatus);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cost_allocation_tags_status(
CostAllocationTagsStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"UpdateCostAllocationTagsStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CostAllocationTagsStatus" => CostAllocationTagsStatus),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cost_category_definition(cost_category_arn, rule_version, rules)
update_cost_category_definition(cost_category_arn, rule_version, rules, params::Dict{String,<:Any})
Updates an existing Cost Category. Changes made to the Cost Category rules will be used to
categorize the current month’s expenses and future expenses. This won’t change
categorization for the previous months.
# Arguments
- `cost_category_arn`: The unique identifier for your Cost Category.
- `rule_version`:
- `rules`: The Expression object used to categorize costs. For more information, see
CostCategoryRule .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultValue"`:
- `"EffectiveStart"`: The Cost Category's effective start date. It can only be a billing
start date (first day of the month). If the date isn't provided, it's the first day of the
current month. Dates can't be before the previous twelve months, or in the future.
- `"SplitChargeRules"`: The split charge rules used to allocate your charges between your
Cost Category values.
"""
function update_cost_category_definition(
CostCategoryArn, RuleVersion, Rules; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_explorer(
"UpdateCostCategoryDefinition",
Dict{String,Any}(
"CostCategoryArn" => CostCategoryArn,
"RuleVersion" => RuleVersion,
"Rules" => Rules,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cost_category_definition(
CostCategoryArn,
RuleVersion,
Rules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_explorer(
"UpdateCostCategoryDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CostCategoryArn" => CostCategoryArn,
"RuleVersion" => RuleVersion,
"Rules" => Rules,
),
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 | 8495 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: cost_optimization_hub
using AWS.Compat
using AWS.UUIDs
"""
get_preferences()
get_preferences(params::Dict{String,<:Any})
Returns a set of preferences for an account in order to add account-specific preferences
into the service. These preferences impact how the savings associated with recommendations
are presented—estimated savings after discounts or estimated savings before discounts,
for example.
"""
function get_preferences(; aws_config::AbstractAWSConfig=global_aws_config())
return cost_optimization_hub(
"GetPreferences"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_preferences(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_optimization_hub(
"GetPreferences", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_recommendation(recommendation_id)
get_recommendation(recommendation_id, params::Dict{String,<:Any})
Returns both the current and recommended resource configuration and the estimated cost
impact for a recommendation. The recommendationId is only valid for up to a maximum of 24
hours as recommendations are refreshed daily. To retrieve the recommendationId, use the
ListRecommendations API.
# Arguments
- `recommendation_id`: The ID for the recommendation.
"""
function get_recommendation(
recommendationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_optimization_hub(
"GetRecommendation",
Dict{String,Any}("recommendationId" => recommendationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recommendation(
recommendationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return cost_optimization_hub(
"GetRecommendation",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recommendationId" => recommendationId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_enrollment_statuses()
list_enrollment_statuses(params::Dict{String,<:Any})
Retrieves the enrollment status for an account. It can also return the list of accounts
that are enrolled under the organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountId"`: The account ID of a member account in the organization.
- `"includeOrganizationInfo"`: Indicates whether to return the enrollment status for the
organization.
- `"maxResults"`: The maximum number of objects that are returned for the request.
- `"nextToken"`: The token to retrieve the next set of results.
"""
function list_enrollment_statuses(; aws_config::AbstractAWSConfig=global_aws_config())
return cost_optimization_hub(
"ListEnrollmentStatuses"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_enrollment_statuses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_optimization_hub(
"ListEnrollmentStatuses",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recommendation_summaries(group_by)
list_recommendation_summaries(group_by, params::Dict{String,<:Any})
Returns a concise representation of savings estimates for resources. Also returns de-duped
savings across different types of recommendations. The following filters are not supported
for this API: recommendationIds, resourceArns, and resourceIds.
# Arguments
- `group_by`: The grouping of recommendations by a dimension.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`:
- `"maxResults"`: The maximum number of recommendations that are returned for the request.
- `"nextToken"`: The token to retrieve the next set of results.
"""
function list_recommendation_summaries(
groupBy; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_optimization_hub(
"ListRecommendationSummaries",
Dict{String,Any}("groupBy" => groupBy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_recommendation_summaries(
groupBy, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_optimization_hub(
"ListRecommendationSummaries",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("groupBy" => groupBy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recommendations()
list_recommendations(params::Dict{String,<:Any})
Returns a list of recommendations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: The constraints that you want all returned recommendations to match.
- `"includeAllRecommendations"`: List of all recommendations for a resource, or a single
recommendation if de-duped by resourceId.
- `"maxResults"`: The maximum number of recommendations that are returned for the request.
- `"nextToken"`: The token to retrieve the next set of results.
- `"orderBy"`: The ordering of recommendations by a dimension.
"""
function list_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return cost_optimization_hub(
"ListRecommendations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_optimization_hub(
"ListRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_enrollment_status(status)
update_enrollment_status(status, params::Dict{String,<:Any})
Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization
Hub service. If the account is a management account of an organization, this action can
also be used to enroll member accounts of the organization. You must have the appropriate
permissions to opt in to Cost Optimization Hub and to view its recommendations. When you
opt in, Cost Optimization Hub automatically creates a service-linked role in your account
to access its data.
# Arguments
- `status`: Sets the account status.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeMemberAccounts"`: Indicates whether to enroll member accounts of the
organization if the account is the management account.
"""
function update_enrollment_status(status; aws_config::AbstractAWSConfig=global_aws_config())
return cost_optimization_hub(
"UpdateEnrollmentStatus",
Dict{String,Any}("status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_enrollment_status(
status, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_optimization_hub(
"UpdateEnrollmentStatus",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("status" => status), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_preferences()
update_preferences(params::Dict{String,<:Any})
Updates a set of preferences for an account in order to add account-specific preferences
into the service. These preferences impact how the savings associated with recommendations
are presented.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"memberAccountDiscountVisibility"`: Sets the \"member account discount visibility\"
preference.
- `"savingsEstimationMode"`: Sets the \"savings estimation mode\" preference.
"""
function update_preferences(; aws_config::AbstractAWSConfig=global_aws_config())
return cost_optimization_hub(
"UpdatePreferences"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_preferences(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return cost_optimization_hub(
"UpdatePreferences", 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 | 85308 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: customer_profiles
using AWS.Compat
using AWS.UUIDs
"""
add_profile_key(domain_name, key_name, profile_id, values)
add_profile_key(domain_name, key_name, profile_id, values, params::Dict{String,<:Any})
Associates a new key value with a specific profile, such as a Contact Record ContactId. A
profile object can have a single unique key and any number of additional keys that can be
used to identify the profile that it belongs to.
# Arguments
- `domain_name`: The unique name of the domain.
- `key_name`: A searchable identifier of a customer profile. The predefined keys you can
use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email,
_ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId,
_salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId,
_serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId,
_shopifyOrderId.
- `profile_id`: The unique identifier of a customer profile.
- `values`: A list of key values.
"""
function add_profile_key(
DomainName,
KeyName,
ProfileId,
Values;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/keys",
Dict{String,Any}(
"KeyName" => KeyName, "ProfileId" => ProfileId, "Values" => Values
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_profile_key(
DomainName,
KeyName,
ProfileId,
Values,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/keys",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyName" => KeyName, "ProfileId" => ProfileId, "Values" => Values
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_calculated_attribute_definition(attribute_details, calculated_attribute_name, domain_name, statistic)
create_calculated_attribute_definition(attribute_details, calculated_attribute_name, domain_name, statistic, params::Dict{String,<:Any})
Creates a new calculated attribute definition. After creation, new object data ingested
into Customer Profiles will be included in the calculated attribute, which can be retrieved
for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated
attribute makes it available for all profiles within a domain. Each calculated attribute
can only reference one ObjectType and at most, two fields from that ObjectType.
# Arguments
- `attribute_details`: Mathematical expression and a list of attribute items specified in
that expression.
- `calculated_attribute_name`: The unique name of the calculated attribute.
- `domain_name`: The unique name of the domain.
- `statistic`: The aggregation operation to perform for the calculated attribute.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Conditions"`: The conditions including range, object count, and threshold for the
calculated attribute.
- `"Description"`: The description of the calculated attribute.
- `"DisplayName"`: The display name of the calculated attribute.
- `"Tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_calculated_attribute_definition(
AttributeDetails,
CalculatedAttributeName,
DomainName,
Statistic;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/calculated-attributes/$(CalculatedAttributeName)",
Dict{String,Any}("AttributeDetails" => AttributeDetails, "Statistic" => Statistic);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_calculated_attribute_definition(
AttributeDetails,
CalculatedAttributeName,
DomainName,
Statistic,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/calculated-attributes/$(CalculatedAttributeName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttributeDetails" => AttributeDetails, "Statistic" => Statistic
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain(default_expiration_days, domain_name)
create_domain(default_expiration_days, domain_name, params::Dict{String,<:Any})
Creates a domain, which is a container for all customer data, such as customer profile
attributes, object types, profile keys, and encryption keys. You can create multiple
domains, and each domain can have multiple third-party integrations. Each Amazon Connect
instance can be associated with only one domain. Multiple Amazon Connect instances can be
associated with one domain. Use this API or UpdateDomain to enable identity resolution: set
Matching to true. To prevent cross-service impersonation when you call this API, see
Cross-service confused deputy prevention for sample policies that you should apply. It is
not possible to associate a Customer Profiles domain with an Amazon Connect Instance
directly from the API. If you would like to create a domain and associate a Customer
Profiles domain, use the Amazon Connect admin website. For more information, see Enable
Customer Profiles. Each Amazon Connect instance can be associated with only one domain.
Multiple Amazon Connect instances can be associated with one domain.
# Arguments
- `default_expiration_days`: The default number of days until the data within the domain
expires.
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeadLetterQueueUrl"`: The URL of the SQS dead letter queue, which is used for reporting
errors associated with ingesting data from third party applications. You must set up a
policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect
Customer Profiles to send messages to the DeadLetterQueue.
- `"DefaultEncryptionKey"`: The default encryption key, which is an AWS managed key, is
used when no specific type of encryption key is specified. It is used to encrypt all data
before it is placed in permanent or semi-permanent storage.
- `"Matching"`: The process of matching duplicate profiles. If Matching = true, Amazon
Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If
you do not specify a date and time for Identity Resolution Job to run, by default it runs
every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the
Identity Resolution Job completes, use the GetMatches API to return and review the results.
Or, if you have configured ExportingConfig in the MatchingRequest, you can download the
results from S3.
- `"RuleBasedMatching"`: The process of matching duplicate profiles using the Rule-Based
matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match
and merge your profiles according to your configuration in the RuleBasedMatchingRequest.
You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the
results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you
can download the results from S3.
- `"Tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_domain(
DefaultExpirationDays, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"POST",
"/domains/$(DomainName)",
Dict{String,Any}("DefaultExpirationDays" => DefaultExpirationDays);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain(
DefaultExpirationDays,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DefaultExpirationDays" => DefaultExpirationDays),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_event_stream(domain_name, event_stream_name, uri)
create_event_stream(domain_name, event_stream_name, uri, params::Dict{String,<:Any})
Creates an event stream, which is a subscription to real-time events, such as when profiles
are created and updated through Amazon Connect Customer Profiles. Each event stream can be
associated with only one Kinesis Data Stream destination in the same region and Amazon Web
Services account as the customer profiles domain
# Arguments
- `domain_name`: The unique name of the domain.
- `event_stream_name`: The name of the event stream.
- `uri`: The StreamARN of the destination to deliver profile events to. For example,
arn:aws:kinesis:region:account-id:stream/stream-name
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_event_stream(
DomainName, EventStreamName, Uri; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/event-streams/$(EventStreamName)",
Dict{String,Any}("Uri" => Uri);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_event_stream(
DomainName,
EventStreamName,
Uri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/event-streams/$(EventStreamName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Uri" => Uri), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_integration_workflow(domain_name, integration_config, object_type_name, role_arn, workflow_type)
create_integration_workflow(domain_name, integration_config, object_type_name, role_arn, workflow_type, params::Dict{String,<:Any})
Creates an integration workflow. An integration workflow is an async process which ingests
historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow
sources are Salesforce, ServiceNow, and Marketo.
# Arguments
- `domain_name`: The unique name of the domain.
- `integration_config`: Configuration data for integration workflow.
- `object_type_name`: The name of the profile object type.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes
this role to create resources on your behalf as part of workflow execution.
- `workflow_type`: The type of workflow. The only supported value is APPFLOW_INTEGRATION.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_integration_workflow(
DomainName,
IntegrationConfig,
ObjectTypeName,
RoleArn,
WorkflowType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/workflows/integrations",
Dict{String,Any}(
"IntegrationConfig" => IntegrationConfig,
"ObjectTypeName" => ObjectTypeName,
"RoleArn" => RoleArn,
"WorkflowType" => WorkflowType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_integration_workflow(
DomainName,
IntegrationConfig,
ObjectTypeName,
RoleArn,
WorkflowType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/workflows/integrations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IntegrationConfig" => IntegrationConfig,
"ObjectTypeName" => ObjectTypeName,
"RoleArn" => RoleArn,
"WorkflowType" => WorkflowType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_profile(domain_name)
create_profile(domain_name, params::Dict{String,<:Any})
Creates a standard profile. A standard profile represents the following attributes for a
customer profile in a domain.
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountNumber"`: An account number that you have given to the customer.
- `"AdditionalInformation"`: Any additional information relevant to the customer’s
profile.
- `"Address"`: A generic address associated with the customer that is not mailing,
shipping, or billing.
- `"Attributes"`: A key value pair of attributes of a customer profile.
- `"BillingAddress"`: The customer’s billing address.
- `"BirthDate"`: The customer’s birth date.
- `"BusinessEmailAddress"`: The customer’s business email address.
- `"BusinessName"`: The name of the customer’s business.
- `"BusinessPhoneNumber"`: The customer’s business phone number.
- `"EmailAddress"`: The customer’s email address, which has not been specified as a
personal or business address.
- `"FirstName"`: The customer’s first name.
- `"Gender"`: The gender with which the customer identifies.
- `"GenderString"`: An alternative to Gender which accepts any string as input.
- `"HomePhoneNumber"`: The customer’s home phone number.
- `"LastName"`: The customer’s last name.
- `"MailingAddress"`: The customer’s mailing address.
- `"MiddleName"`: The customer’s middle name.
- `"MobilePhoneNumber"`: The customer’s mobile phone number.
- `"PartyType"`: The type of profile used to describe the customer.
- `"PartyTypeString"`: An alternative to PartyType which accepts any string as input.
- `"PersonalEmailAddress"`: The customer’s personal email address.
- `"PhoneNumber"`: The customer’s phone number, which has not been specified as a mobile,
home, or business number.
- `"ShippingAddress"`: The customer’s shipping address.
"""
function create_profile(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_profile(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_calculated_attribute_definition(calculated_attribute_name, domain_name)
delete_calculated_attribute_definition(calculated_attribute_name, domain_name, params::Dict{String,<:Any})
Deletes an existing calculated attribute definition. Note that deleting a default
calculated attribute is possible, however once deleted, you will be unable to undo that
action and will need to recreate it on your own using the
CreateCalculatedAttributeDefinition API if you want it back.
# Arguments
- `calculated_attribute_name`: The unique name of the calculated attribute.
- `domain_name`: The unique name of the domain.
"""
function delete_calculated_attribute_definition(
CalculatedAttributeName, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"DELETE",
"/domains/$(DomainName)/calculated-attributes/$(CalculatedAttributeName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_calculated_attribute_definition(
CalculatedAttributeName,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"DELETE",
"/domains/$(DomainName)/calculated-attributes/$(CalculatedAttributeName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain(domain_name)
delete_domain(domain_name, params::Dict{String,<:Any})
Deletes a specific domain and all of its customer data, such as customer profile attributes
and their related objects.
# Arguments
- `domain_name`: The unique name of the domain.
"""
function delete_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"DELETE",
"/domains/$(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 customer_profiles(
"DELETE",
"/domains/$(DomainName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_stream(domain_name, event_stream_name)
delete_event_stream(domain_name, event_stream_name, params::Dict{String,<:Any})
Disables and deletes the specified event stream.
# Arguments
- `domain_name`: The unique name of the domain.
- `event_stream_name`: The name of the event stream
"""
function delete_event_stream(
DomainName, EventStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"DELETE",
"/domains/$(DomainName)/event-streams/$(EventStreamName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_stream(
DomainName,
EventStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"DELETE",
"/domains/$(DomainName)/event-streams/$(EventStreamName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_integration(domain_name, uri)
delete_integration(domain_name, uri, params::Dict{String,<:Any})
Removes an integration from a specific domain.
# Arguments
- `domain_name`: The unique name of the domain.
- `uri`: The URI of the S3 bucket or any other type of data source.
"""
function delete_integration(
DomainName, Uri; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/integrations/delete",
Dict{String,Any}("Uri" => Uri);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_integration(
DomainName,
Uri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/integrations/delete",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Uri" => Uri), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profile(domain_name, profile_id)
delete_profile(domain_name, profile_id, params::Dict{String,<:Any})
Deletes the standard customer profile and all data pertaining to the profile.
# Arguments
- `domain_name`: The unique name of the domain.
- `profile_id`: The unique identifier of a customer profile.
"""
function delete_profile(
DomainName, ProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/delete",
Dict{String,Any}("ProfileId" => ProfileId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profile(
DomainName,
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/delete",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProfileId" => ProfileId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profile_key(domain_name, key_name, profile_id, values)
delete_profile_key(domain_name, key_name, profile_id, values, params::Dict{String,<:Any})
Removes a searchable key from a customer profile.
# Arguments
- `domain_name`: The unique name of the domain.
- `key_name`: A searchable identifier of a customer profile.
- `profile_id`: The unique identifier of a customer profile.
- `values`: A list of key values.
"""
function delete_profile_key(
DomainName,
KeyName,
ProfileId,
Values;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/keys/delete",
Dict{String,Any}(
"KeyName" => KeyName, "ProfileId" => ProfileId, "Values" => Values
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profile_key(
DomainName,
KeyName,
ProfileId,
Values,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/keys/delete",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"KeyName" => KeyName, "ProfileId" => ProfileId, "Values" => Values
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profile_object(domain_name, object_type_name, profile_id, profile_object_unique_key)
delete_profile_object(domain_name, object_type_name, profile_id, profile_object_unique_key, params::Dict{String,<:Any})
Removes an object associated with a profile of a given ProfileObjectType.
# Arguments
- `domain_name`: The unique name of the domain.
- `object_type_name`: The name of the profile object type.
- `profile_id`: The unique identifier of a customer profile.
- `profile_object_unique_key`: The unique identifier of the profile object generated by the
service.
"""
function delete_profile_object(
DomainName,
ObjectTypeName,
ProfileId,
ProfileObjectUniqueKey;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/objects/delete",
Dict{String,Any}(
"ObjectTypeName" => ObjectTypeName,
"ProfileId" => ProfileId,
"ProfileObjectUniqueKey" => ProfileObjectUniqueKey,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profile_object(
DomainName,
ObjectTypeName,
ProfileId,
ProfileObjectUniqueKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/objects/delete",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ObjectTypeName" => ObjectTypeName,
"ProfileId" => ProfileId,
"ProfileObjectUniqueKey" => ProfileObjectUniqueKey,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profile_object_type(domain_name, object_type_name)
delete_profile_object_type(domain_name, object_type_name, params::Dict{String,<:Any})
Removes a ProfileObjectType from a specific domain as well as removes all the
ProfileObjects of that type. It also disables integrations from this specific
ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that
were populated from this ProfileObjectType.
# Arguments
- `domain_name`: The unique name of the domain.
- `object_type_name`: The name of the profile object type.
"""
function delete_profile_object_type(
DomainName, ObjectTypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"DELETE",
"/domains/$(DomainName)/object-types/$(ObjectTypeName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profile_object_type(
DomainName,
ObjectTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"DELETE",
"/domains/$(DomainName)/object-types/$(ObjectTypeName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workflow(domain_name, workflow_id)
delete_workflow(domain_name, workflow_id, params::Dict{String,<:Any})
Deletes the specified workflow and all its corresponding resources. This is an async
process.
# Arguments
- `domain_name`: The unique name of the domain.
- `workflow_id`: Unique identifier for the workflow.
"""
function delete_workflow(
DomainName, WorkflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"DELETE",
"/domains/$(DomainName)/workflows/$(WorkflowId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workflow(
DomainName,
WorkflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"DELETE",
"/domains/$(DomainName)/workflows/$(WorkflowId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detect_profile_object_type(domain_name, objects)
detect_profile_object_type(domain_name, objects, params::Dict{String,<:Any})
The process of detecting profile object type mapping by using given objects.
# Arguments
- `domain_name`: The unique name of the domain.
- `objects`: A string that is serialized from a JSON object.
"""
function detect_profile_object_type(
DomainName, Objects; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/detect/object-types",
Dict{String,Any}("Objects" => Objects);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detect_profile_object_type(
DomainName,
Objects,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/detect/object-types",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Objects" => Objects), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_auto_merging_preview(conflict_resolution, consolidation, domain_name)
get_auto_merging_preview(conflict_resolution, consolidation, domain_name, params::Dict{String,<:Any})
Tests the auto-merging settings of your Identity Resolution Job without merging your data.
It randomly selects a sample of matching groups from the existing matching results, and
applies the automerging settings that you provided. You can then view the number of
profiles in the sample, the number of matches, and the number of profiles identified to be
merged. This enables you to evaluate the accuracy of the attributes in your matching list.
You can't view which profiles are matched and would be merged. We strongly recommend you
use this API to do a dry run of the automerging process before running the Identity
Resolution Job. Include at least two matching attributes. If your matching list includes
too few attributes (such as only FirstName or only LastName), there may be a large number
of matches. This increases the chances of erroneous merges.
# Arguments
- `conflict_resolution`: How the auto-merging process should resolve conflicts between
different profiles.
- `consolidation`: A list of matching attributes that represent matching criteria.
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MinAllowedConfidenceScoreForMerging"`: Minimum confidence score required for profiles
within a matching group to be merged during the auto-merge process.
"""
function get_auto_merging_preview(
ConflictResolution,
Consolidation,
DomainName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/identity-resolution-jobs/auto-merging-preview",
Dict{String,Any}(
"ConflictResolution" => ConflictResolution, "Consolidation" => Consolidation
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_auto_merging_preview(
ConflictResolution,
Consolidation,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/identity-resolution-jobs/auto-merging-preview",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConflictResolution" => ConflictResolution,
"Consolidation" => Consolidation,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_calculated_attribute_definition(calculated_attribute_name, domain_name)
get_calculated_attribute_definition(calculated_attribute_name, domain_name, params::Dict{String,<:Any})
Provides more information on a calculated attribute definition for Customer Profiles.
# Arguments
- `calculated_attribute_name`: The unique name of the calculated attribute.
- `domain_name`: The unique name of the domain.
"""
function get_calculated_attribute_definition(
CalculatedAttributeName, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/calculated-attributes/$(CalculatedAttributeName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_calculated_attribute_definition(
CalculatedAttributeName,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/calculated-attributes/$(CalculatedAttributeName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_calculated_attribute_for_profile(calculated_attribute_name, domain_name, profile_id)
get_calculated_attribute_for_profile(calculated_attribute_name, domain_name, profile_id, params::Dict{String,<:Any})
Retrieve a calculated attribute for a customer profile.
# Arguments
- `calculated_attribute_name`: The unique name of the calculated attribute.
- `domain_name`: The unique name of the domain.
- `profile_id`: The unique identifier of a customer profile.
"""
function get_calculated_attribute_for_profile(
CalculatedAttributeName,
DomainName,
ProfileId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/profile/$(ProfileId)/calculated-attributes/$(CalculatedAttributeName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_calculated_attribute_for_profile(
CalculatedAttributeName,
DomainName,
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/profile/$(ProfileId)/calculated-attributes/$(CalculatedAttributeName)",
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.
# Arguments
- `domain_name`: The unique name of the domain.
"""
function get_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"GET",
"/domains/$(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 customer_profiles(
"GET",
"/domains/$(DomainName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_event_stream(domain_name, event_stream_name)
get_event_stream(domain_name, event_stream_name, params::Dict{String,<:Any})
Returns information about the specified event stream in a specific domain.
# Arguments
- `domain_name`: The unique name of the domain.
- `event_stream_name`: The name of the event stream provided during create operations.
"""
function get_event_stream(
DomainName, EventStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/event-streams/$(EventStreamName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_event_stream(
DomainName,
EventStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/event-streams/$(EventStreamName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_identity_resolution_job(domain_name, job_id)
get_identity_resolution_job(domain_name, job_id, params::Dict{String,<:Any})
Returns information about an Identity Resolution Job in a specific domain. Identity
Resolution Jobs are set up using the Amazon Connect admin console. For more information,
see Use Identity Resolution to consolidate similar profiles.
# Arguments
- `domain_name`: The unique name of the domain.
- `job_id`: The unique identifier of the Identity Resolution Job.
"""
function get_identity_resolution_job(
DomainName, JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/identity-resolution-jobs/$(JobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_identity_resolution_job(
DomainName,
JobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/identity-resolution-jobs/$(JobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_integration(domain_name, uri)
get_integration(domain_name, uri, params::Dict{String,<:Any})
Returns an integration for a domain.
# Arguments
- `domain_name`: The unique name of the domain.
- `uri`: The URI of the S3 bucket or any other type of data source.
"""
function get_integration(DomainName, Uri; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"POST",
"/domains/$(DomainName)/integrations",
Dict{String,Any}("Uri" => Uri);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_integration(
DomainName,
Uri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/integrations",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Uri" => Uri), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_matches(domain_name)
get_matches(domain_name, params::Dict{String,<:Any})
Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution:
set Matching to true. GetMatches returns potentially matching profiles, based on the
results of the latest run of a machine learning process. The process of matching
duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly
batch process called Identity Resolution Job. If you do not specify a date and time for
Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect
duplicate profiles in your domains. After the Identity Resolution Job completes, use the
GetMatches API to return and review the results. Or, if you have configured ExportingConfig
in the MatchingRequest, you can download the results from S3. Amazon Connect uses the
following profile attributes to identify matches: PhoneNumber HomePhoneNumber
BusinessPhoneNumber MobilePhoneNumber EmailAddress PersonalEmailAddress
BusinessEmailAddress FullName For example, two or more profiles—with spelling
mistakes such as John Doe and Jhn Doe, or different casing email addresses such as
[email protected] and [email protected], or different phone number formats such
as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer
John Doe and merged into a unified profile.
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to return per page.
- `"next-token"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function get_matches(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"GET",
"/domains/$(DomainName)/matches";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_matches(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/matches",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_profile_object_type(domain_name, object_type_name)
get_profile_object_type(domain_name, object_type_name, params::Dict{String,<:Any})
Returns the object types for a specific domain.
# Arguments
- `domain_name`: The unique name of the domain.
- `object_type_name`: The name of the profile object type.
"""
function get_profile_object_type(
DomainName, ObjectTypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/object-types/$(ObjectTypeName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_profile_object_type(
DomainName,
ObjectTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/object-types/$(ObjectTypeName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_profile_object_type_template(template_id)
get_profile_object_type_template(template_id, params::Dict{String,<:Any})
Returns the template information for a specific object type. A template is a predefined
ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a
user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that
matches one of the TemplateIds, it uses the mappings from the template.
# Arguments
- `template_id`: A unique identifier for the object template.
"""
function get_profile_object_type_template(
TemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/templates/$(TemplateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_profile_object_type_template(
TemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/templates/$(TemplateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_similar_profiles(domain_name, match_type, search_key, search_value)
get_similar_profiles(domain_name, match_type, search_key, search_value, params::Dict{String,<:Any})
Returns a set of profiles that belong to the same matching group using the matchId or
profileId. You can also specify the type of matching that you want for finding similar
profiles using either RULE_BASED_MATCHING or ML_BASED_MATCHING.
# Arguments
- `domain_name`: The unique name of the domain.
- `match_type`: Specify the type of matching to get similar profiles for.
- `search_key`: The string indicating the search key to be used.
- `search_value`: The string based on SearchKey to be searched for similar profiles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of objects returned per page.
- `"next-token"`: The pagination token from the previous GetSimilarProfiles API call.
"""
function get_similar_profiles(
DomainName,
MatchType,
SearchKey,
SearchValue;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/matches",
Dict{String,Any}(
"MatchType" => MatchType, "SearchKey" => SearchKey, "SearchValue" => SearchValue
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_similar_profiles(
DomainName,
MatchType,
SearchKey,
SearchValue,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/matches",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MatchType" => MatchType,
"SearchKey" => SearchKey,
"SearchValue" => SearchValue,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow(domain_name, workflow_id)
get_workflow(domain_name, workflow_id, params::Dict{String,<:Any})
Get details of specified workflow.
# Arguments
- `domain_name`: The unique name of the domain.
- `workflow_id`: Unique identifier for the workflow.
"""
function get_workflow(
DomainName, WorkflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/workflows/$(WorkflowId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow(
DomainName,
WorkflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/workflows/$(WorkflowId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow_steps(domain_name, workflow_id)
get_workflow_steps(domain_name, workflow_id, params::Dict{String,<:Any})
Get granular list of steps in workflow.
# Arguments
- `domain_name`: The unique name of the domain.
- `workflow_id`: Unique identifier for the workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to return per page.
- `"next-token"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function get_workflow_steps(
DomainName, WorkflowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/workflows/$(WorkflowId)/steps";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow_steps(
DomainName,
WorkflowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/workflows/$(WorkflowId)/steps",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_account_integrations(uri)
list_account_integrations(uri, params::Dict{String,<:Any})
Lists all of the integrations associated to a specific URI in the AWS account.
# Arguments
- `uri`: The URI of the S3 bucket or any other type of data source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"include-hidden"`: Boolean to indicate if hidden integration should be returned.
Defaults to False.
- `"max-results"`: The maximum number of objects returned per page.
- `"next-token"`: The pagination token from the previous ListAccountIntegrations API call.
"""
function list_account_integrations(Uri; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"POST",
"/integrations",
Dict{String,Any}("Uri" => Uri);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_account_integrations(
Uri, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"POST",
"/integrations",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Uri" => Uri), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_calculated_attribute_definitions(domain_name)
list_calculated_attribute_definitions(domain_name, params::Dict{String,<:Any})
Lists calculated attribute definitions for Customer Profiles
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of calculated attribute definitions returned per page.
- `"next-token"`: The pagination token from the previous call to
ListCalculatedAttributeDefinitions.
"""
function list_calculated_attribute_definitions(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/calculated-attributes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_calculated_attribute_definitions(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/calculated-attributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_calculated_attributes_for_profile(domain_name, profile_id)
list_calculated_attributes_for_profile(domain_name, profile_id, params::Dict{String,<:Any})
Retrieve a list of calculated attributes for a customer profile.
# Arguments
- `domain_name`: The unique name of the domain.
- `profile_id`: The unique identifier of a customer profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of calculated attributes returned per page.
- `"next-token"`: The pagination token from the previous call to
ListCalculatedAttributesForProfile.
"""
function list_calculated_attributes_for_profile(
DomainName, ProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/profile/$(ProfileId)/calculated-attributes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_calculated_attributes_for_profile(
DomainName,
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/profile/$(ProfileId)/calculated-attributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains()
list_domains(params::Dict{String,<:Any})
Returns a list of all the domains for an AWS account that have been created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of objects returned per page.
- `"next-token"`: The pagination token from the previous ListDomain API call.
"""
function list_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"GET", "/domains"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET", "/domains", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_event_streams(domain_name)
list_event_streams(domain_name, params::Dict{String,<:Any})
Returns a list of all the event streams in a specific domain.
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of objects returned per page.
- `"next-token"`: Identifies the next page of results to return.
"""
function list_event_streams(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"GET",
"/domains/$(DomainName)/event-streams";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_event_streams(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/event-streams",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_identity_resolution_jobs(domain_name)
list_identity_resolution_jobs(domain_name, params::Dict{String,<:Any})
Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
JobStartTime.
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of results to return per page.
- `"next-token"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_identity_resolution_jobs(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/identity-resolution-jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_identity_resolution_jobs(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/identity-resolution-jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_integrations(domain_name)
list_integrations(domain_name, params::Dict{String,<:Any})
Lists all of the integrations in your domain.
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"include-hidden"`: Boolean to indicate if hidden integration should be returned.
Defaults to False.
- `"max-results"`: The maximum number of objects returned per page.
- `"next-token"`: The pagination token from the previous ListIntegrations API call.
"""
function list_integrations(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"GET",
"/domains/$(DomainName)/integrations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_integrations(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/integrations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profile_object_type_templates()
list_profile_object_type_templates(params::Dict{String,<:Any})
Lists all of the template information for object types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of objects returned per page.
- `"next-token"`: The pagination token from the previous ListObjectTypeTemplates API call.
"""
function list_profile_object_type_templates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET", "/templates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_profile_object_type_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET", "/templates", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_profile_object_types(domain_name)
list_profile_object_types(domain_name, params::Dict{String,<:Any})
Lists all of the templates available within the service.
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of objects returned per page.
- `"next-token"`: Identifies the next page of results to return.
"""
function list_profile_object_types(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/object-types";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_profile_object_types(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/object-types",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profile_objects(domain_name, object_type_name, profile_id)
list_profile_objects(domain_name, object_type_name, profile_id, params::Dict{String,<:Any})
Returns a list of objects associated with a profile of a given ProfileObjectType.
# Arguments
- `domain_name`: The unique name of the domain.
- `object_type_name`: The name of the profile object type.
- `profile_id`: The unique identifier of a customer profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ObjectFilter"`: Applies a filter to the response to include profile objects with the
specified index values.
- `"max-results"`: The maximum number of objects returned per page.
- `"next-token"`: The pagination token from the previous call to ListProfileObjects.
"""
function list_profile_objects(
DomainName, ObjectTypeName, ProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/objects",
Dict{String,Any}("ObjectTypeName" => ObjectTypeName, "ProfileId" => ProfileId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_profile_objects(
DomainName,
ObjectTypeName,
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/objects",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ObjectTypeName" => ObjectTypeName, "ProfileId" => ProfileId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rule_based_matches(domain_name)
list_rule_based_matches(domain_name, params::Dict{String,<:Any})
Returns a set of MatchIds that belong to the given domain.
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"max-results"`: The maximum number of MatchIds returned per page.
- `"next-token"`: The pagination token from the previous ListRuleBasedMatches API call.
"""
function list_rule_based_matches(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/profiles/ruleBasedMatches";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_rule_based_matches(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"GET",
"/domains/$(DomainName)/profiles/ruleBasedMatches",
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 an Amazon Connect Customer Profiles resource. In Connect
Customer Profiles, domains, profile object types, and integrations can be tagged.
# Arguments
- `resource_arn`: The ARN of the resource for which you want to view tags.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"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 customer_profiles(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflows(domain_name)
list_workflows(domain_name, params::Dict{String,<:Any})
Query to list all workflows.
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"QueryEndDate"`: Retrieve workflows ended after timestamp.
- `"QueryStartDate"`: Retrieve workflows started after timestamp.
- `"Status"`: Status of workflow execution.
- `"WorkflowType"`: The type of workflow. The only supported value is APPFLOW_INTEGRATION.
- `"max-results"`: The maximum number of results to return per page.
- `"next-token"`: The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of results.
"""
function list_workflows(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"POST",
"/domains/$(DomainName)/workflows";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workflows(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/workflows",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
merge_profiles(domain_name, main_profile_id, profile_ids_to_be_merged)
merge_profiles(domain_name, main_profile_id, profile_ids_to_be_merged, params::Dict{String,<:Any})
Runs an AWS Lambda job that does the following: All the profileKeys in the
ProfileToBeMerged will be moved to the main profile. All the objects in the
ProfileToBeMerged will be moved to the main profile. All the ProfileToBeMerged will be
deleted at the end. All the profileKeys in the ProfileIdsToBeMerged will be moved to the
main profile. Standard fields are merged as follows: Fields are always \"union\"-ed if
there are no conflicts in standard fields or attributeKeys. When there are conflicting
fields: If no SourceProfileIds entry is specified, the main Profile value is always
taken. If a SourceProfileIds entry is specified, the specified profileId is always
taken, even if it is a NULL value. You can use MergeProfiles together with
GetMatches, which returns potentially matching profiles, or use it with the results of
another matching system. After profiles have been merged, they cannot be separated
(unmerged).
# Arguments
- `domain_name`: The unique name of the domain.
- `main_profile_id`: The identifier of the profile to be taken.
- `profile_ids_to_be_merged`: The identifier of the profile to be merged into MainProfileId.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FieldSourceProfileIds"`: The identifiers of the fields in the profile that has the
information you want to apply to the merge. For example, say you want to merge EmailAddress
from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in
Profile1.
"""
function merge_profiles(
DomainName,
MainProfileId,
ProfileIdsToBeMerged;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/objects/merge",
Dict{String,Any}(
"MainProfileId" => MainProfileId, "ProfileIdsToBeMerged" => ProfileIdsToBeMerged
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function merge_profiles(
DomainName,
MainProfileId,
ProfileIdsToBeMerged,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/objects/merge",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MainProfileId" => MainProfileId,
"ProfileIdsToBeMerged" => ProfileIdsToBeMerged,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_integration(domain_name)
put_integration(domain_name, params::Dict{String,<:Any})
Adds an integration between the service and a third-party service, which includes Amazon
AppFlow and Amazon Connect. An integration can belong to only one domain. To add or remove
tags on an existing Integration, see TagResource / UntagResource.
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FlowDefinition"`: The configuration that controls how Customer Profiles retrieves data
from the source.
- `"ObjectTypeName"`: The name of the profile object type.
- `"ObjectTypeNames"`: A map in which each key is an event type from an external
application such as Segment or Shopify, and each value is an ObjectTypeName (template) used
to ingest the event. It supports the following event types: SegmentIdentify,
ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders,
ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
- `"Tags"`: The tags used to organize, track, or control access for this resource.
- `"Uri"`: The URI of the S3 bucket or any other type of data source.
"""
function put_integration(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"PUT",
"/domains/$(DomainName)/integrations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_integration(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"PUT",
"/domains/$(DomainName)/integrations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_profile_object(domain_name, object, object_type_name)
put_profile_object(domain_name, object, object_type_name, params::Dict{String,<:Any})
Adds additional objects to customer profiles of a given ObjectType. When adding a specific
profile object, like a Contact Record, an inferred profile can get created if it is not
mapped to an existing profile. The resulting profile will only have a phone number
populated in the standard ProfileObject. Any additional Contact Records with the same phone
number will be mapped to the same inferred profile. When a ProfileObject is created and if
a ProfileObjectType already exists for the ProfileObject, it will provide data to a
standard profile depending on the ProfileObjectType definition. PutProfileObject needs an
ObjectType, which can be created using PutProfileObjectType.
# Arguments
- `domain_name`: The unique name of the domain.
- `object`: A string that is serialized from a JSON object.
- `object_type_name`: The name of the profile object type.
"""
function put_profile_object(
DomainName, Object, ObjectTypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"PUT",
"/domains/$(DomainName)/profiles/objects",
Dict{String,Any}("Object" => Object, "ObjectTypeName" => ObjectTypeName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_profile_object(
DomainName,
Object,
ObjectTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"PUT",
"/domains/$(DomainName)/profiles/objects",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Object" => Object, "ObjectTypeName" => ObjectTypeName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_profile_object_type(description, domain_name, object_type_name)
put_profile_object_type(description, domain_name, object_type_name, params::Dict{String,<:Any})
Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, see
TagResource/UntagResource.
# Arguments
- `description`: Description of the profile object type.
- `domain_name`: The unique name of the domain.
- `object_type_name`: The name of the profile object type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowProfileCreation"`: Indicates whether a profile should be created when data is
received if one doesn’t exist for an object of this type. The default is FALSE. If the
AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard
profile and associate this object with the profile. If it is set to TRUE, and if no match
is found, then the service creates a new standard profile.
- `"EncryptionKey"`: The customer-provided key to encrypt the profile object that will be
created in this profile object type.
- `"ExpirationDays"`: The number of days until the data in the object expires.
- `"Fields"`: A map of the name and ObjectType field.
- `"Keys"`: A list of unique keys that can be used to map data to the profile.
- `"MaxProfileObjectCount"`: The amount of profile object max count assigned to the object
type
- `"SourceLastUpdatedTimestampFormat"`: The format of your sourceLastUpdatedTimestamp that
was previously set up.
- `"Tags"`: The tags used to organize, track, or control access for this resource.
- `"TemplateId"`: A unique identifier for the object template. For some attributes in the
request, the service will use the default value from the object template when TemplateId is
present. If these attributes are present in the request, the service may return a
BadRequestException. These attributes include: AllowProfileCreation,
SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is
set to true when TemplateId is set, the service may return a BadRequestException.
"""
function put_profile_object_type(
Description,
DomainName,
ObjectTypeName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"PUT",
"/domains/$(DomainName)/object-types/$(ObjectTypeName)",
Dict{String,Any}("Description" => Description);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_profile_object_type(
Description,
DomainName,
ObjectTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"PUT",
"/domains/$(DomainName)/object-types/$(ObjectTypeName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Description" => Description), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_profiles(domain_name, key_name, values)
search_profiles(domain_name, key_name, values, params::Dict{String,<:Any})
Searches for profiles within a specific domain using one or more predefined search keys
(e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A
search key is a data type pair that consists of a KeyName and Values list. This operation
supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5
key-value(s) pairs using either AND or OR logic.
# Arguments
- `domain_name`: The unique name of the domain.
- `key_name`: A searchable identifier of a customer profile. The predefined keys you can
use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName,
_phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId,
_salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId,
_serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId,
_shopifyOrderId.
- `values`: A list of key values.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalSearchKeys"`: A list of AdditionalSearchKey objects that are each searchable
identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of
Values associated with that specific key (i.e., a key-value(s) pair). These additional
search keys will be used in conjunction with the LogicalOperator and the required KeyName
and Values parameters to search for profiles that satisfy the search criteria.
- `"LogicalOperator"`: Relationship between all specified search keys that will be used to
search for profiles. This includes the required KeyName and Values parameters as well as
any key-value(s) pairs specified in the AdditionalSearchKeys list. This parameter
influences which profiles will be returned in the response in the following manner: AND
- The response only includes profiles that match all of the search keys. OR - The
response includes profiles that match at least one of the search keys. The OR
relationship is the default behavior if this parameter is not included in the request.
- `"max-results"`: The maximum number of objects returned per page. The default is 20 if
this parameter is not included in the request.
- `"next-token"`: The pagination token from the previous SearchProfiles API call.
"""
function search_profiles(
DomainName, KeyName, Values; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/search",
Dict{String,Any}("KeyName" => KeyName, "Values" => Values);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_profiles(
DomainName,
KeyName,
Values,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"POST",
"/domains/$(DomainName)/profiles/search",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("KeyName" => KeyName, "Values" => Values), 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 Connect Customer
Profiles 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. In Connect Customer Profiles, domains, profile object
types, and integrations can be tagged. Tags don't have any semantic meaning to AWS 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, 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. You can associate as many as 50 tags with a resource.
# Arguments
- `resource_arn`: The ARN of the resource that you're adding tags to.
- `tags`: The tags used to organize, track, or control access for this resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"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 customer_profiles(
"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 Connect Customer Profiles resource. In
Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
# Arguments
- `resource_arn`: The ARN of the resource from which you are removing tags.
- `tag_keys`: The list of tag keys to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"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 customer_profiles(
"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_calculated_attribute_definition(calculated_attribute_name, domain_name)
update_calculated_attribute_definition(calculated_attribute_name, domain_name, params::Dict{String,<:Any})
Updates an existing calculated attribute definition. When updating the Conditions, note
that increasing the date range of a calculated attribute will not trigger inclusion of
historical data greater than the current date range.
# Arguments
- `calculated_attribute_name`: The unique name of the calculated attribute.
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Conditions"`: The conditions including range, object count, and threshold for the
calculated attribute.
- `"Description"`: The description of the calculated attribute.
- `"DisplayName"`: The display name of the calculated attribute.
"""
function update_calculated_attribute_definition(
CalculatedAttributeName, DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"PUT",
"/domains/$(DomainName)/calculated-attributes/$(CalculatedAttributeName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_calculated_attribute_definition(
CalculatedAttributeName,
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"PUT",
"/domains/$(DomainName)/calculated-attributes/$(CalculatedAttributeName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_domain(domain_name)
update_domain(domain_name, params::Dict{String,<:Any})
Updates the properties of a domain, including creating or selecting a dead letter queue or
an encryption key. After a domain is created, the name can’t be changed. Use this API or
CreateDomain to enable identity resolution: set Matching to true. To prevent cross-service
impersonation when you call this API, see Cross-service confused deputy prevention for
sample policies that you should apply. To add or remove tags on an existing Domain, see
TagResource/UntagResource.
# Arguments
- `domain_name`: The unique name of the domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeadLetterQueueUrl"`: The URL of the SQS dead letter queue, which is used for reporting
errors associated with ingesting data from third party applications. If specified as an
empty string, it will clear any existing value. You must set up a policy on the
DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to
send messages to the DeadLetterQueue.
- `"DefaultEncryptionKey"`: The default encryption key, which is an AWS managed key, is
used when no specific type of encryption key is specified. It is used to encrypt all data
before it is placed in permanent or semi-permanent storage. If specified as an empty
string, it will clear any existing value.
- `"DefaultExpirationDays"`: The default number of days until the data within the domain
expires.
- `"Matching"`: The process of matching duplicate profiles. If Matching = true, Amazon
Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If
you do not specify a date and time for Identity Resolution Job to run, by default it runs
every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the
Identity Resolution Job completes, use the GetMatches API to return and review the results.
Or, if you have configured ExportingConfig in the MatchingRequest, you can download the
results from S3.
- `"RuleBasedMatching"`: The process of matching duplicate profiles using the rule-Based
matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match
and merge your profiles according to your configuration in the RuleBasedMatchingRequest.
You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the
results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you
can download the results from S3.
- `"Tags"`: The tags used to organize, track, or control access for this resource.
"""
function update_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return customer_profiles(
"PUT",
"/domains/$(DomainName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"PUT",
"/domains/$(DomainName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_profile(domain_name, profile_id)
update_profile(domain_name, profile_id, params::Dict{String,<:Any})
Updates the properties of a profile. The ProfileId is required for updating a customer
profile. When calling the UpdateProfile API, specifying an empty string value means that
any existing value will be removed. Not specifying a string value means that any value
already there will be kept.
# Arguments
- `domain_name`: The unique name of the domain.
- `profile_id`: The unique identifier of a customer profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountNumber"`: An account number that you have given to the customer.
- `"AdditionalInformation"`: Any additional information relevant to the customer’s
profile.
- `"Address"`: A generic address associated with the customer that is not mailing,
shipping, or billing.
- `"Attributes"`: A key value pair of attributes of a customer profile.
- `"BillingAddress"`: The customer’s billing address.
- `"BirthDate"`: The customer’s birth date.
- `"BusinessEmailAddress"`: The customer’s business email address.
- `"BusinessName"`: The name of the customer’s business.
- `"BusinessPhoneNumber"`: The customer’s business phone number.
- `"EmailAddress"`: The customer’s email address, which has not been specified as a
personal or business address.
- `"FirstName"`: The customer’s first name.
- `"Gender"`: The gender with which the customer identifies.
- `"GenderString"`: An alternative to Gender which accepts any string as input.
- `"HomePhoneNumber"`: The customer’s home phone number.
- `"LastName"`: The customer’s last name.
- `"MailingAddress"`: The customer’s mailing address.
- `"MiddleName"`: The customer’s middle name.
- `"MobilePhoneNumber"`: The customer’s mobile phone number.
- `"PartyType"`: The type of profile used to describe the customer.
- `"PartyTypeString"`: An alternative to PartyType which accepts any string as input.
- `"PersonalEmailAddress"`: The customer’s personal email address.
- `"PhoneNumber"`: The customer’s phone number, which has not been specified as a mobile,
home, or business number.
- `"ShippingAddress"`: The customer’s shipping address.
"""
function update_profile(
DomainName, ProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return customer_profiles(
"PUT",
"/domains/$(DomainName)/profiles",
Dict{String,Any}("ProfileId" => ProfileId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_profile(
DomainName,
ProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return customer_profiles(
"PUT",
"/domains/$(DomainName)/profiles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProfileId" => ProfileId), 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 | 32579 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: data_pipeline
using AWS.Compat
using AWS.UUIDs
"""
activate_pipeline(pipeline_id)
activate_pipeline(pipeline_id, params::Dict{String,<:Any})
Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does
not pass validation, activation fails. If you need to pause the pipeline to investigate an
issue with a component, such as a data source or script, call DeactivatePipeline. To
activate a finished pipeline, modify the end date for the pipeline and then activate it.
# Arguments
- `pipeline_id`: The ID of the pipeline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parameterValues"`: A list of parameter values to pass to the pipeline at activation.
- `"startTimestamp"`: The date and time to resume the pipeline. By default, the pipeline
resumes from the last completed execution.
"""
function activate_pipeline(pipelineId; aws_config::AbstractAWSConfig=global_aws_config())
return data_pipeline(
"ActivatePipeline",
Dict{String,Any}("pipelineId" => pipelineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function activate_pipeline(
pipelineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"ActivatePipeline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("pipelineId" => pipelineId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_tags(pipeline_id, tags)
add_tags(pipeline_id, tags, params::Dict{String,<:Any})
Adds or modifies tags for the specified pipeline.
# Arguments
- `pipeline_id`: The ID of the pipeline.
- `tags`: The tags to add, as key/value pairs.
"""
function add_tags(pipelineId, tags; aws_config::AbstractAWSConfig=global_aws_config())
return data_pipeline(
"AddTags",
Dict{String,Any}("pipelineId" => pipelineId, "tags" => tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags(
pipelineId,
tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"AddTags",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("pipelineId" => pipelineId, "tags" => tags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_pipeline(name, unique_id)
create_pipeline(name, unique_id, params::Dict{String,<:Any})
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
# Arguments
- `name`: The name for the pipeline. You can use the same name for multiple pipelines
associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique
pipeline identifier.
- `unique_id`: A unique identifier. This identifier is not the same as the pipeline
identifier assigned by AWS Data Pipeline. You are responsible for defining the format and
ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency
during repeated calls to CreatePipeline. For example, if the first call to CreatePipeline
does not succeed, you can pass in the same unique identifier and pipeline name combination
on a subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already
exists with the same name and unique identifier, a new pipeline is not created. Instead,
you'll receive the pipeline identifier from the previous attempt. The uniqueness of the
name and unique identifier combination is scoped to the AWS account or IAM user credentials.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description for the pipeline.
- `"tags"`: A list of tags to associate with the pipeline at creation. Tags let you control
access to pipelines. For more information, see Controlling User Access to Pipelines in the
AWS Data Pipeline Developer Guide.
"""
function create_pipeline(name, uniqueId; aws_config::AbstractAWSConfig=global_aws_config())
return data_pipeline(
"CreatePipeline",
Dict{String,Any}("name" => name, "uniqueId" => uniqueId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_pipeline(
name,
uniqueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"CreatePipeline",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "uniqueId" => uniqueId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deactivate_pipeline(pipeline_id)
deactivate_pipeline(pipeline_id, params::Dict{String,<:Any})
Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state
until the deactivation process completes. To resume a deactivated pipeline, use
ActivatePipeline. By default, the pipeline resumes from the last completed execution.
Optionally, you can specify the date and time to resume the pipeline.
# Arguments
- `pipeline_id`: The ID of the pipeline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cancelActive"`: Indicates whether to cancel any running objects. The default is true,
which sets the state of any running objects to CANCELED. If this value is false, the
pipeline is deactivated after all running objects finish.
"""
function deactivate_pipeline(pipelineId; aws_config::AbstractAWSConfig=global_aws_config())
return data_pipeline(
"DeactivatePipeline",
Dict{String,Any}("pipelineId" => pipelineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deactivate_pipeline(
pipelineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"DeactivatePipeline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("pipelineId" => pipelineId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_pipeline(pipeline_id)
delete_pipeline(pipeline_id, params::Dict{String,<:Any})
Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline
attempts to cancel instances associated with the pipeline that are currently being
processed by task runners. Deleting a pipeline cannot be undone. You cannot query or
restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call
SetStatus with the status set to PAUSE on individual components. Components that are paused
by SetStatus can be resumed.
# Arguments
- `pipeline_id`: The ID of the pipeline.
"""
function delete_pipeline(pipelineId; aws_config::AbstractAWSConfig=global_aws_config())
return data_pipeline(
"DeletePipeline",
Dict{String,Any}("pipelineId" => pipelineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_pipeline(
pipelineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"DeletePipeline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("pipelineId" => pipelineId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_objects(object_ids, pipeline_id)
describe_objects(object_ids, pipeline_id, params::Dict{String,<:Any})
Gets the object definitions for a set of objects associated with the pipeline. Object
definitions are composed of a set of fields that define the properties of the object.
# Arguments
- `object_ids`: The IDs of the pipeline objects that contain the definitions to be
described. You can pass as many as 25 identifiers in a single call to DescribeObjects.
- `pipeline_id`: The ID of the pipeline that contains the object definitions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"evaluateExpressions"`: Indicates whether any expressions in the object should be
evaluated when the object descriptions are returned.
- `"marker"`: The starting point for the results to be returned. For the first call, this
value should be empty. As long as there are more results, continue to call DescribeObjects
with the marker value from the previous call to retrieve the next set of results.
"""
function describe_objects(
objectIds, pipelineId; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"DescribeObjects",
Dict{String,Any}("objectIds" => objectIds, "pipelineId" => pipelineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_objects(
objectIds,
pipelineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"DescribeObjects",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("objectIds" => objectIds, "pipelineId" => pipelineId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pipelines(pipeline_ids)
describe_pipelines(pipeline_ids, params::Dict{String,<:Any})
Retrieves metadata about one or more pipelines. The information retrieved includes the name
of the pipeline, the pipeline identifier, its current state, and the user account that owns
the pipeline. Using account credentials, you can retrieve metadata about pipelines that you
or your IAM users have created. If you are using an IAM user account, you can retrieve
metadata about only those pipelines for which you have read permissions. To retrieve the
full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.
# Arguments
- `pipeline_ids`: The IDs of the pipelines to describe. You can pass as many as 25
identifiers in a single call. To obtain pipeline IDs, call ListPipelines.
"""
function describe_pipelines(pipelineIds; aws_config::AbstractAWSConfig=global_aws_config())
return data_pipeline(
"DescribePipelines",
Dict{String,Any}("pipelineIds" => pipelineIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_pipelines(
pipelineIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"DescribePipelines",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("pipelineIds" => pipelineIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
evaluate_expression(expression, object_id, pipeline_id)
evaluate_expression(expression, object_id, pipeline_id, params::Dict{String,<:Any})
Task runners call EvaluateExpression to evaluate a string in the context of the specified
object. For example, a task runner can evaluate SQL queries stored in Amazon S3.
# Arguments
- `expression`: The expression to evaluate.
- `object_id`: The ID of the object.
- `pipeline_id`: The ID of the pipeline.
"""
function evaluate_expression(
expression, objectId, pipelineId; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"EvaluateExpression",
Dict{String,Any}(
"expression" => expression, "objectId" => objectId, "pipelineId" => pipelineId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function evaluate_expression(
expression,
objectId,
pipelineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"EvaluateExpression",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"expression" => expression,
"objectId" => objectId,
"pipelineId" => pipelineId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_pipeline_definition(pipeline_id)
get_pipeline_definition(pipeline_id, params::Dict{String,<:Any})
Gets the definition of the specified pipeline. You can call GetPipelineDefinition to
retrieve the pipeline definition that you provided using PutPipelineDefinition.
# Arguments
- `pipeline_id`: The ID of the pipeline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The version of the pipeline definition to retrieve. Set this parameter to
latest (default) to use the last definition saved to the pipeline or active to use the last
definition that was activated.
"""
function get_pipeline_definition(
pipelineId; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"GetPipelineDefinition",
Dict{String,Any}("pipelineId" => pipelineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_pipeline_definition(
pipelineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"GetPipelineDefinition",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("pipelineId" => pipelineId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pipelines()
list_pipelines(params::Dict{String,<:Any})
Lists the pipeline identifiers for all active pipelines that you have permission to access.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"marker"`: The starting point for the results to be returned. For the first call, this
value should be empty. As long as there are more results, continue to call ListPipelines
with the marker value from the previous call to retrieve the next set of results.
"""
function list_pipelines(; aws_config::AbstractAWSConfig=global_aws_config())
return data_pipeline(
"ListPipelines"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_pipelines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"ListPipelines", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
poll_for_task(worker_group)
poll_for_task(worker_group, params::Dict{String,<:Any})
Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task
runner specifies which tasks it can perform by setting a value for the workerGroup
parameter. The task returned can come from any of the pipelines that match the workerGroup
value passed in by the task runner and that was launched using the IAM user credentials
specified by the task runner. If tasks are ready in the work queue, PollForTask returns a
response immediately. If no tasks are available in the queue, PollForTask uses long-polling
and holds on to a poll connection for up to a 90 seconds, during which time the first newly
scheduled task is handed to the task runner. To accomodate this, set the socket timeout in
your task runner to 90 seconds. The task runner should not call PollForTask again on the
same workerGroup until it receives a response, and this can take up to 90 seconds.
# Arguments
- `worker_group`: The type of task the task runner is configured to accept and process. The
worker group is set as a field on objects in the pipeline when they are created. You can
only specify a single value for workerGroup in the call to PollForTask. There are no
wildcard values permitted in workerGroup; the string must be an exact, case-sensitive,
match.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"hostname"`: The public DNS name of the calling task runner.
- `"instanceIdentity"`: Identity information for the EC2 instance that is hosting the task
runner. You can get this value from the instance using
http://169.254.169.254/latest/meta-data/instance-id. For more information, see Instance
Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that
your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline
service charges are applied to your pipeline.
"""
function poll_for_task(workerGroup; aws_config::AbstractAWSConfig=global_aws_config())
return data_pipeline(
"PollForTask",
Dict{String,Any}("workerGroup" => workerGroup);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function poll_for_task(
workerGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"PollForTask",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("workerGroup" => workerGroup), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_pipeline_definition(pipeline_id, pipeline_objects)
put_pipeline_definition(pipeline_id, pipeline_objects, params::Dict{String,<:Any})
Adds tasks, schedules, and preconditions to the specified pipeline. You can use
PutPipelineDefinition to populate a new pipeline. PutPipelineDefinition also validates the
configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one
of the following three validation errors exists in the pipeline. An object is missing a
name or identifier field. A string or reference field is empty. The number of objects in
the pipeline exceeds the maximum allowed objects. The pipeline is in a FINISHED state.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by
the GetPipelineDefinition action.
# Arguments
- `pipeline_id`: The ID of the pipeline.
- `pipeline_objects`: The objects that define the pipeline. These objects overwrite the
existing pipeline definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parameterObjects"`: The parameter objects used with the pipeline.
- `"parameterValues"`: The parameter values used with the pipeline.
"""
function put_pipeline_definition(
pipelineId, pipelineObjects; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"PutPipelineDefinition",
Dict{String,Any}("pipelineId" => pipelineId, "pipelineObjects" => pipelineObjects);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_pipeline_definition(
pipelineId,
pipelineObjects,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"PutPipelineDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"pipelineId" => pipelineId, "pipelineObjects" => pipelineObjects
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
query_objects(pipeline_id, sphere)
query_objects(pipeline_id, sphere, params::Dict{String,<:Any})
Queries the specified pipeline for the names of objects that match the specified set of
conditions.
# Arguments
- `pipeline_id`: The ID of the pipeline.
- `sphere`: Indicates whether the query applies to components or instances. The possible
values are: COMPONENT, INSTANCE, and ATTEMPT.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`: The maximum number of object names that QueryObjects will return in a single
call. The default value is 100.
- `"marker"`: The starting point for the results to be returned. For the first call, this
value should be empty. As long as there are more results, continue to call QueryObjects
with the marker value from the previous call to retrieve the next set of results.
- `"query"`: The query that defines the objects to be returned. The Query object can
contain a maximum of ten selectors. The conditions in the query are limited to top-level
String fields in the object. These filters can be applied to components, instances, and
attempts.
"""
function query_objects(
pipelineId, sphere; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"QueryObjects",
Dict{String,Any}("pipelineId" => pipelineId, "sphere" => sphere);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function query_objects(
pipelineId,
sphere,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"QueryObjects",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("pipelineId" => pipelineId, "sphere" => sphere),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags(pipeline_id, tag_keys)
remove_tags(pipeline_id, tag_keys, params::Dict{String,<:Any})
Removes existing tags from the specified pipeline.
# Arguments
- `pipeline_id`: The ID of the pipeline.
- `tag_keys`: The keys of the tags to remove.
"""
function remove_tags(pipelineId, tagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return data_pipeline(
"RemoveTags",
Dict{String,Any}("pipelineId" => pipelineId, "tagKeys" => tagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags(
pipelineId,
tagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"RemoveTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("pipelineId" => pipelineId, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
report_task_progress(task_id)
report_task_progress(task_id, params::Dict{String,<:Any})
Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the
task. If the web service does not receive this acknowledgement within 2 minutes, it assigns
the task in a subsequent PollForTask call. After this initial acknowledgement, the task
runner only needs to report progress every 15 minutes to maintain its ownership of the
task. You can change this reporting time from 15 minutes by specifying a
reportProgressTimeout field in your pipeline. If a task runner does not report its status
after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the
task and reassigns the task in a subsequent response to PollForTask. Task runners should
call ReportTaskProgress every 60 seconds.
# Arguments
- `task_id`: The ID of the task assigned to the task runner. This value is provided in the
response for PollForTask.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"fields"`: Key-value pairs that define the properties of the ReportTaskProgressInput
object.
"""
function report_task_progress(taskId; aws_config::AbstractAWSConfig=global_aws_config())
return data_pipeline(
"ReportTaskProgress",
Dict{String,Any}("taskId" => taskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function report_task_progress(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"ReportTaskProgress",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("taskId" => taskId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
report_task_runner_heartbeat(taskrunner_id)
report_task_runner_heartbeat(taskrunner_id, params::Dict{String,<:Any})
Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are
operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS
Data Pipeline, the web service can use this call to detect when the task runner application
has failed and restart a new instance.
# Arguments
- `taskrunner_id`: The ID of the task runner. This value should be unique across your AWS
account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS
Data Pipeline, the web service provides a unique identifier when it launches the
application. If you have written a custom task runner, you should assign a unique
identifier for the task runner.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"hostname"`: The public DNS name of the task runner.
- `"workerGroup"`: The type of task the task runner is configured to accept and process.
The worker group is set as a field on objects in the pipeline when they are created. You
can only specify a single value for workerGroup. There are no wildcard values permitted in
workerGroup; the string must be an exact, case-sensitive, match.
"""
function report_task_runner_heartbeat(
taskrunnerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"ReportTaskRunnerHeartbeat",
Dict{String,Any}("taskrunnerId" => taskrunnerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function report_task_runner_heartbeat(
taskrunnerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"ReportTaskRunnerHeartbeat",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("taskrunnerId" => taskrunnerId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_status(object_ids, pipeline_id, status)
set_status(object_ids, pipeline_id, status, params::Dict{String,<:Any})
Requests that the status of the specified physical or logical pipeline objects be updated
in the specified pipeline. This update might not occur immediately, but is eventually
consistent. The status that can be set depends on the type of object (for example, DataNode
or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do
so returns InvalidRequestException.
# Arguments
- `object_ids`: The IDs of the objects. The corresponding objects can be either physical or
components, but not a mix of both types.
- `pipeline_id`: The ID of the pipeline that contains the objects.
- `status`: The status to be set on all the objects specified in objectIds. For components,
use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.
"""
function set_status(
objectIds, pipelineId, status; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"SetStatus",
Dict{String,Any}(
"objectIds" => objectIds, "pipelineId" => pipelineId, "status" => status
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_status(
objectIds,
pipelineId,
status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"SetStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"objectIds" => objectIds, "pipelineId" => pipelineId, "status" => status
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_task_status(task_id, task_status)
set_task_status(task_id, task_status, params::Dict{String,<:Any})
Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and
provide information about the final status. A task runner makes this call regardless of
whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks
that are canceled by the web service during a call to ReportTaskProgress.
# Arguments
- `task_id`: The ID of the task assigned to the task runner. This value is provided in the
response for PollForTask.
- `task_status`: If FINISHED, the task successfully completed. If FAILED, the task ended
unsuccessfully. Preconditions use false.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"errorId"`: If an error occurred during the task, this value specifies the error code.
This value is set on the physical attempt object. It is used to display error information
to the user. It should not start with string \"Service_\" which is reserved by the system.
- `"errorMessage"`: If an error occurred during the task, this value specifies a text
description of the error. This value is set on the physical attempt object. It is used to
display error information to the user. The web service does not parse this value.
- `"errorStackTrace"`: If an error occurred during the task, this value specifies the stack
trace associated with the error. This value is set on the physical attempt object. It is
used to display error information to the user. The web service does not parse this value.
"""
function set_task_status(
taskId, taskStatus; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"SetTaskStatus",
Dict{String,Any}("taskId" => taskId, "taskStatus" => taskStatus);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_task_status(
taskId,
taskStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"SetTaskStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("taskId" => taskId, "taskStatus" => taskStatus),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
validate_pipeline_definition(pipeline_id, pipeline_objects)
validate_pipeline_definition(pipeline_id, pipeline_objects, params::Dict{String,<:Any})
Validates the specified pipeline definition to ensure that it is well formed and can be run
without error.
# Arguments
- `pipeline_id`: The ID of the pipeline.
- `pipeline_objects`: The objects that define the pipeline changes to validate against the
pipeline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parameterObjects"`: The parameter objects used with the pipeline.
- `"parameterValues"`: The parameter values used with the pipeline.
"""
function validate_pipeline_definition(
pipelineId, pipelineObjects; aws_config::AbstractAWSConfig=global_aws_config()
)
return data_pipeline(
"ValidatePipelineDefinition",
Dict{String,Any}("pipelineId" => pipelineId, "pipelineObjects" => pipelineObjects);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function validate_pipeline_definition(
pipelineId,
pipelineObjects,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return data_pipeline(
"ValidatePipelineDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"pipelineId" => pipelineId, "pipelineObjects" => pipelineObjects
),
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 | 223112 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: database_migration_service
using AWS.Compat
using AWS.UUIDs
"""
add_tags_to_resource(resource_arn, tags)
add_tags_to_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet
group, and migration task. These tags can also be used with cost allocation reporting to
track cost associated with DMS resources, or used in a Condition statement in an IAM policy
for DMS. For more information, see Tag data type description.
# Arguments
- `resource_arn`: Identifies the DMS resource to which tags should be added. The value for
this parameter is an Amazon Resource Name (ARN). For DMS, you can tag a replication
instance, an endpoint, or a replication task.
- `tags`: One or more tags to be assigned to the resource.
"""
function add_tags_to_resource(
ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"AddTagsToResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags_to_resource(
ResourceArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"AddTagsToResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
apply_pending_maintenance_action(apply_action, opt_in_type, replication_instance_arn)
apply_pending_maintenance_action(apply_action, opt_in_type, replication_instance_arn, params::Dict{String,<:Any})
Applies a pending maintenance action to a resource (for example, to a replication instance).
# Arguments
- `apply_action`: The pending maintenance action to apply to this resource. Valid values:
os-upgrade, system-update, db-upgrade
- `opt_in_type`: A value that specifies the type of opt-in request, or undoes an opt-in
request. You can't undo an opt-in request of type immediate. 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.
- `replication_instance_arn`: The Amazon Resource Name (ARN) of the DMS resource that the
pending maintenance action applies to.
"""
function apply_pending_maintenance_action(
ApplyAction,
OptInType,
ReplicationInstanceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ApplyPendingMaintenanceAction",
Dict{String,Any}(
"ApplyAction" => ApplyAction,
"OptInType" => OptInType,
"ReplicationInstanceArn" => ReplicationInstanceArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function apply_pending_maintenance_action(
ApplyAction,
OptInType,
ReplicationInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ApplyPendingMaintenanceAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplyAction" => ApplyAction,
"OptInType" => OptInType,
"ReplicationInstanceArn" => ReplicationInstanceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_start_recommendations()
batch_start_recommendations(params::Dict{String,<:Any})
Starts the analysis of up to 20 source databases to recommend target engines for each
source database. This is a batch version of StartRecommendations. The result of analysis of
each source database is reported individually in the response. Because the batch request
can result in a combination of successful and unsuccessful actions, you should check for
batch errors even when the call returns an HTTP status code of 200.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Data"`: Provides information about source databases to analyze. After this analysis,
Fleet Advisor recommends target engines for each source database.
"""
function batch_start_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"BatchStartRecommendations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function batch_start_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"BatchStartRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_replication_task_assessment_run(replication_task_assessment_run_arn)
cancel_replication_task_assessment_run(replication_task_assessment_run_arn, params::Dict{String,<:Any})
Cancels a single premigration assessment run. This operation prevents any individual
assessments from running if they haven't started running. It also attempts to cancel any
individual assessments that are currently running.
# Arguments
- `replication_task_assessment_run_arn`: Amazon Resource Name (ARN) of the premigration
assessment run to be canceled.
"""
function cancel_replication_task_assessment_run(
ReplicationTaskAssessmentRunArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"CancelReplicationTaskAssessmentRun",
Dict{String,Any}(
"ReplicationTaskAssessmentRunArn" => ReplicationTaskAssessmentRunArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_replication_task_assessment_run(
ReplicationTaskAssessmentRunArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CancelReplicationTaskAssessmentRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationTaskAssessmentRunArn" => ReplicationTaskAssessmentRunArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_provider(engine, settings)
create_data_provider(engine, settings, params::Dict{String,<:Any})
Creates a data provider using the provided settings. A data provider stores a data store
type and location information about your database.
# Arguments
- `engine`: The type of database engine for the data provider. Valid values include
\"aurora\", \"aurora-postgresql\", \"mysql\", \"oracle\", \"postgres\", \"sqlserver\",
redshift, mariadb, mongodb, and docdb. A value of \"aurora\" represents Amazon Aurora
MySQL-Compatible Edition.
- `settings`: The settings in JSON format for a data provider.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataProviderName"`: A user-friendly name for the data provider.
- `"Description"`: A user-friendly description of the data provider.
- `"Tags"`: One or more tags to be assigned to the data provider.
"""
function create_data_provider(
Engine, Settings; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"CreateDataProvider",
Dict{String,Any}("Engine" => Engine, "Settings" => Settings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_provider(
Engine,
Settings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateDataProvider",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Engine" => Engine, "Settings" => Settings), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_endpoint(endpoint_identifier, endpoint_type, engine_name)
create_endpoint(endpoint_identifier, endpoint_type, engine_name, params::Dict{String,<:Any})
Creates an endpoint using the provided settings. For a MySQL source or target endpoint,
don't explicitly specify the database using the DatabaseName request parameter on the
CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint
replicates all the task tables to this single database. For MySQL endpoints, you specify
the database only when you specify the schema in the table-mapping rules of the DMS task.
# Arguments
- `endpoint_identifier`: The database endpoint identifier. Identifiers must begin with a
letter and must contain only ASCII letters, digits, and hyphens. They can't end with a
hyphen, or contain two consecutive hyphens.
- `endpoint_type`: The type of endpoint. Valid values are source and target.
- `engine_name`: The type of engine for the endpoint. Valid values, depending on the
EndpointType value, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\",
\"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\", \"db2\", \"db2-zos\",
\"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\",
\"elasticsearch\", \"docdb\", \"sqlserver\", \"neptune\", and \"babelfish\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificateArn"`: The Amazon Resource Name (ARN) for the certificate.
- `"DatabaseName"`: The name of the endpoint database. For a MySQL source or target
endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting
and targetDbType.
- `"DmsTransferSettings"`: The settings in JSON format for the DMS transfer type of source
endpoint. Possible settings include the following: ServiceAccessRoleArn - The Amazon
Resource Name (ARN) used by the service access IAM role. The role must allow the
iam:PassRole action. BucketName - The name of the S3 bucket to use. Shorthand syntax
for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string JSON
syntax for these settings is as follows: { \"ServiceAccessRoleArn\": \"string\",
\"BucketName\": \"string\", }
- `"DocDbSettings"`:
- `"DynamoDbSettings"`: Settings in JSON format for the target Amazon DynamoDB endpoint.
For information about other available settings, see Using Object Mapping to Migrate Data to
DynamoDB in the Database Migration Service User Guide.
- `"ElasticsearchSettings"`: Settings in JSON format for the target OpenSearch endpoint.
For more information about the available settings, see Extra Connection Attributes When
Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.
- `"ExternalTableDefinition"`: The external table definition.
- `"ExtraConnectionAttributes"`: Additional attributes associated with the connection. Each
attribute is specified as a name-value pair associated by an equal sign (=). Multiple
attributes are separated by a semicolon (;) with no additional white space. For information
on the attributes available for connecting your source or target endpoint, see Working with
DMS Endpoints in the Database Migration Service User Guide.
- `"GcpMySQLSettings"`: Settings in JSON format for the source GCP MySQL endpoint.
- `"IBMDb2Settings"`: Settings in JSON format for the source IBM Db2 LUW endpoint. For
information about other available settings, see Extra connection attributes when using Db2
LUW as a source for DMS in the Database Migration Service User Guide.
- `"KafkaSettings"`: Settings in JSON format for the target Apache Kafka endpoint. For more
information about the available settings, see Using object mapping to migrate data to a
Kafka topic in the Database Migration Service User Guide.
- `"KinesisSettings"`: Settings in JSON format for the target endpoint for Amazon Kinesis
Data Streams. For more information about the available settings, see Using object mapping
to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
- `"KmsKeyId"`: An KMS key identifier that is used to encrypt the connection parameters for
the endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS uses your
default encryption key. KMS creates the default encryption key for your Amazon Web Services
account. Your Amazon Web Services account has a different default encryption key for each
Amazon Web Services Region.
- `"MicrosoftSQLServerSettings"`: Settings in JSON format for the source and target
Microsoft SQL Server endpoint. For information about other available settings, see Extra
connection attributes when using SQL Server as a source for DMS and Extra connection
attributes when using SQL Server as a target for DMS in the Database Migration Service User
Guide.
- `"MongoDbSettings"`: Settings in JSON format for the source MongoDB endpoint. For more
information about the available settings, see Endpoint configuration settings when using
MongoDB as a source for Database Migration Service in the Database Migration Service User
Guide.
- `"MySQLSettings"`: Settings in JSON format for the source and target MySQL endpoint. For
information about other available settings, see Extra connection attributes when using
MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible
database as a target for DMS in the Database Migration Service User Guide.
- `"NeptuneSettings"`: Settings in JSON format for the target Amazon Neptune endpoint. For
more information about the available settings, see Specifying graph-mapping rules using
Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User
Guide.
- `"OracleSettings"`: Settings in JSON format for the source and target Oracle endpoint.
For information about other available settings, see Extra connection attributes when using
Oracle as a source for DMS and Extra connection attributes when using Oracle as a target
for DMS in the Database Migration Service User Guide.
- `"Password"`: The password to be used to log in to the endpoint database.
- `"Port"`: The port used by the endpoint database.
- `"PostgreSQLSettings"`: Settings in JSON format for the source and target PostgreSQL
endpoint. For information about other available settings, see Extra connection attributes
when using PostgreSQL as a source for DMS and Extra connection attributes when using
PostgreSQL as a target for DMS in the Database Migration Service User Guide.
- `"RedisSettings"`: Settings in JSON format for the target Redis endpoint.
- `"RedshiftSettings"`:
- `"ResourceIdentifier"`: A friendly name for the resource identifier at the end of the
EndpointArn response parameter that is returned in the created Endpoint object. The value
for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,
and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and
can only begin with a letter, such as Example-App-ARN1. For example, this value might
result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If
you don't specify a ResourceIdentifier value, DMS generates a default identifier value for
the end of EndpointArn.
- `"S3Settings"`: Settings in JSON format for the target Amazon S3 endpoint. For more
information about the available settings, see Extra Connection Attributes When Using Amazon
S3 as a Target for DMS in the Database Migration Service User Guide.
- `"ServerName"`: The name of the server where the endpoint database resides.
- `"ServiceAccessRoleArn"`: The Amazon Resource Name (ARN) for the service access role
that you want to use to create the endpoint. The role must allow the iam:PassRole action.
- `"SslMode"`: The Secure Sockets Layer (SSL) mode to use for the SSL connection. The
default is none
- `"SybaseSettings"`: Settings in JSON format for the source and target SAP ASE endpoint.
For information about other available settings, see Extra connection attributes when using
SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target
for DMS in the Database Migration Service User Guide.
- `"Tags"`: One or more tags to be assigned to the endpoint.
- `"TimestreamSettings"`: Settings in JSON format for the target Amazon Timestream endpoint.
- `"Username"`: The user name to be used to log in to the endpoint database.
"""
function create_endpoint(
EndpointIdentifier,
EndpointType,
EngineName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateEndpoint",
Dict{String,Any}(
"EndpointIdentifier" => EndpointIdentifier,
"EndpointType" => EndpointType,
"EngineName" => EngineName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_endpoint(
EndpointIdentifier,
EndpointType,
EngineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointIdentifier" => EndpointIdentifier,
"EndpointType" => EndpointType,
"EngineName" => EngineName,
),
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 DMS event notification subscription. You can specify the type of source
(SourceType) you want to be notified of, provide a list of DMS source IDs (SourceIds) that
triggers the events, and provide a list of event categories (EventCategories) for events
you want to be notified of. If you specify both the SourceType and SourceIds, such as
SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be
notified of all the replication instance events for the specified source. If you specify a
SourceType but don't specify a SourceIdentifier, you receive notice of the events for that
source type for all your DMS sources. If you don't specify either SourceType nor
SourceIdentifier, you will be notified of events generated from all DMS sources belonging
to your customer account. For more information about DMS events, see Working with Events
and Notifications in the Database Migration Service User Guide.
# Arguments
- `sns_topic_arn`: The Amazon Resource Name (ARN) of the Amazon 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 DMS event notification subscription. This 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, or set to false
to create the subscription but not activate it.
- `"EventCategories"`: A list of event categories for a source type that you want to
subscribe to. For more information, see Working with Events and Notifications in the
Database Migration Service User Guide.
- `"SourceIds"`: A list of identifiers for which DMS provides notification events. If you
don't specify a value, notifications are provided for all sources. If you specify multiple
values, they must be of the same type. For example, if you specify a database instance ID,
then all of the other values must be database instance IDs.
- `"SourceType"`: The type of DMS resource that generates the events. For example, if you
want to be notified of events generated by a replication instance, you set this parameter
to replication-instance. If this value isn't specified, all events are returned. Valid
values: replication-instance | replication-task
- `"Tags"`: One or more tags to be assigned to the event subscription.
"""
function create_event_subscription(
SnsTopicArn, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"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 database_migration_service(
"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_fleet_advisor_collector(collector_name, s3_bucket_name, service_access_role_arn)
create_fleet_advisor_collector(collector_name, s3_bucket_name, service_access_role_arn, params::Dict{String,<:Any})
Creates a Fleet Advisor collector using the specified parameters.
# Arguments
- `collector_name`: The name of your Fleet Advisor collector (for example,
sample-collector).
- `s3_bucket_name`: The Amazon S3 bucket that the Fleet Advisor collector uses to store
inventory metadata.
- `service_access_role_arn`: The IAM role that grants permissions to access the specified
Amazon S3 bucket.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A summary description of your Fleet Advisor collector.
"""
function create_fleet_advisor_collector(
CollectorName,
S3BucketName,
ServiceAccessRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateFleetAdvisorCollector",
Dict{String,Any}(
"CollectorName" => CollectorName,
"S3BucketName" => S3BucketName,
"ServiceAccessRoleArn" => ServiceAccessRoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fleet_advisor_collector(
CollectorName,
S3BucketName,
ServiceAccessRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateFleetAdvisorCollector",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CollectorName" => CollectorName,
"S3BucketName" => S3BucketName,
"ServiceAccessRoleArn" => ServiceAccessRoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance_profile()
create_instance_profile(params::Dict{String,<:Any})
Creates the instance profile using the specified parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZone"`: The Availability Zone where the instance profile will be created.
The default value is a random, system-chosen Availability Zone in the Amazon Web Services
Region where your data provider is created, for examplem us-east-1d.
- `"Description"`: A user-friendly description of the instance profile.
- `"InstanceProfileName"`: A user-friendly name for the instance profile.
- `"KmsKeyArn"`: The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the
connection parameters for the instance profile. If you don't specify a value for the
KmsKeyArn parameter, then DMS uses your default encryption key. KMS creates the default
encryption key for your Amazon Web Services account. Your Amazon Web Services account has a
different default encryption key for each Amazon Web Services Region.
- `"NetworkType"`: Specifies the network type for the instance profile. A value of IPV4
represents an instance profile with IPv4 network type and only supports IPv4 addressing. A
value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6
addressing. A value of DUAL represents an instance profile with dual network type that
supports IPv4 and IPv6 addressing.
- `"PubliclyAccessible"`: Specifies the accessibility options for the instance profile. A
value of true represents an instance profile with a public IP address. A value of false
represents an instance profile with a private IP address. The default value is true.
- `"SubnetGroupIdentifier"`: A subnet group to associate with the instance profile.
- `"Tags"`: One or more tags to be assigned to the instance profile.
- `"VpcSecurityGroups"`: Specifies the VPC security group names to be used with the
instance profile. The VPC security group must work with the VPC containing the instance
profile.
"""
function create_instance_profile(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"CreateInstanceProfile"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_instance_profile(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"CreateInstanceProfile",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_migration_project(instance_profile_identifier, source_data_provider_descriptors, target_data_provider_descriptors)
create_migration_project(instance_profile_identifier, source_data_provider_descriptors, target_data_provider_descriptors, params::Dict{String,<:Any})
Creates the migration project using the specified parameters. You can run this action only
after you create an instance profile and data providers using CreateInstanceProfile and
CreateDataProvider.
# Arguments
- `instance_profile_identifier`: The identifier of the associated instance profile.
Identifiers must begin with a letter and must contain only ASCII letters, digits, and
hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
- `source_data_provider_descriptors`: Information about the source data provider, including
the name, ARN, and Secrets Manager parameters.
- `target_data_provider_descriptors`: Information about the target data provider, including
the name, ARN, and Amazon Web Services Secrets Manager parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A user-friendly description of the migration project.
- `"MigrationProjectName"`: A user-friendly name for the migration project.
- `"SchemaConversionApplicationAttributes"`: The schema conversion application attributes,
including the Amazon S3 bucket name and Amazon S3 role ARN.
- `"Tags"`: One or more tags to be assigned to the migration project.
- `"TransformationRules"`: The settings in JSON format for migration rules. Migration rules
make it possible for you to change the object names according to the rules that you
specify. For example, you can change an object name to lowercase or uppercase, add or
remove a prefix or suffix, or rename objects.
"""
function create_migration_project(
InstanceProfileIdentifier,
SourceDataProviderDescriptors,
TargetDataProviderDescriptors;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateMigrationProject",
Dict{String,Any}(
"InstanceProfileIdentifier" => InstanceProfileIdentifier,
"SourceDataProviderDescriptors" => SourceDataProviderDescriptors,
"TargetDataProviderDescriptors" => TargetDataProviderDescriptors,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_migration_project(
InstanceProfileIdentifier,
SourceDataProviderDescriptors,
TargetDataProviderDescriptors,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateMigrationProject",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceProfileIdentifier" => InstanceProfileIdentifier,
"SourceDataProviderDescriptors" => SourceDataProviderDescriptors,
"TargetDataProviderDescriptors" => TargetDataProviderDescriptors,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_replication_config(compute_config, replication_config_identifier, replication_type, source_endpoint_arn, table_mappings, target_endpoint_arn)
create_replication_config(compute_config, replication_config_identifier, replication_type, source_endpoint_arn, table_mappings, target_endpoint_arn, params::Dict{String,<:Any})
Creates a configuration that you can later provide to configure and start an DMS Serverless
replication. You can also provide options to validate the configuration inputs before you
start the replication.
# Arguments
- `compute_config`: Configuration parameters for provisioning an DMS Serverless replication.
- `replication_config_identifier`: A unique identifier that you want to use to create a
ReplicationConfigArn that is returned as part of the output from this action. You can then
pass this output ReplicationConfigArn as the value of the ReplicationConfigArn option for
other actions to identify both DMS Serverless replications and replication configurations
that you want those actions to operate on. For some actions, you can also use either this
unique identifier or a corresponding ARN in action filters to identify the specific
replication and replication configuration to operate on.
- `replication_type`: The type of DMS Serverless replication to provision using this
replication configuration. Possible values: \"full-load\" \"cdc\"
\"full-load-and-cdc\"
- `source_endpoint_arn`: The Amazon Resource Name (ARN) of the source endpoint for this DMS
Serverless replication configuration.
- `table_mappings`: JSON table mappings for DMS Serverless replications that are
provisioned using this replication configuration. For more information, see Specifying
table selection and transformations rules using JSON.
- `target_endpoint_arn`: The Amazon Resource Name (ARN) of the target endpoint for this DMS
serverless replication configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReplicationSettings"`: Optional JSON settings for DMS Serverless replications that are
provisioned using this replication configuration. For example, see Change processing
tuning settings.
- `"ResourceIdentifier"`: Optional unique value or name that you set for a given resource
that can be used to construct an Amazon Resource Name (ARN) for that resource. For more
information, see Fine-grained access control using resource names and tags.
- `"SupplementalSettings"`: Optional JSON settings for specifying supplemental data. For
more information, see Specifying supplemental data for task settings.
- `"Tags"`: One or more optional tags associated with resources used by the DMS Serverless
replication. For more information, see Tagging resources in Database Migration Service.
"""
function create_replication_config(
ComputeConfig,
ReplicationConfigIdentifier,
ReplicationType,
SourceEndpointArn,
TableMappings,
TargetEndpointArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateReplicationConfig",
Dict{String,Any}(
"ComputeConfig" => ComputeConfig,
"ReplicationConfigIdentifier" => ReplicationConfigIdentifier,
"ReplicationType" => ReplicationType,
"SourceEndpointArn" => SourceEndpointArn,
"TableMappings" => TableMappings,
"TargetEndpointArn" => TargetEndpointArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replication_config(
ComputeConfig,
ReplicationConfigIdentifier,
ReplicationType,
SourceEndpointArn,
TableMappings,
TargetEndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateReplicationConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ComputeConfig" => ComputeConfig,
"ReplicationConfigIdentifier" => ReplicationConfigIdentifier,
"ReplicationType" => ReplicationType,
"SourceEndpointArn" => SourceEndpointArn,
"TableMappings" => TableMappings,
"TargetEndpointArn" => TargetEndpointArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_replication_instance(replication_instance_class, replication_instance_identifier)
create_replication_instance(replication_instance_class, replication_instance_identifier, params::Dict{String,<:Any})
Creates the replication instance using the specified parameters. DMS requires that your
account have certain roles with appropriate permissions before you can create a replication
instance. For information on the required roles, see Creating the IAM Roles to Use With the
CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to
Use DMS. If you don't specify a version when creating a replication instance, DMS will
create the instance using the default engine version. For information about the default
engine version, see Release Notes.
# Arguments
- `replication_instance_class`: The compute and memory capacity of the replication instance
as defined for the specified replication instance class. For example to specify the
instance class dms.c4.large, set this parameter to \"dms.c4.large\". For more information
on the settings and capacities for the available replication instance classes, see
Choosing the right DMS replication instance; and, Selecting the best size for a replication
instance.
- `replication_instance_identifier`: The replication instance identifier. This parameter is
stored as a lowercase string. Constraints: Must contain 1-63 alphanumeric characters or
hyphens. First character must be a letter. Can't end with a hyphen or contain two
consecutive hyphens. Example: myrepinstance
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: The amount of storage (in gigabytes) to be initially allocated for
the replication instance.
- `"AutoMinorVersionUpgrade"`: A value that indicates whether minor engine upgrades are
applied automatically to the replication instance during the maintenance window. This
parameter defaults to true. Default: true
- `"AvailabilityZone"`: The Availability Zone where the replication instance will be
created. The default value is a random, system-chosen Availability Zone in the endpoint's
Amazon Web Services Region, for example: us-east-1d.
- `"DnsNameServers"`: A list of custom DNS name servers supported for the replication
instance to access your on-premise source or target database. This list overrides the
default name servers supported by the replication instance. You can specify a
comma-separated list of internet addresses for up to four on-premise DNS name servers. For
example: \"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"
- `"EngineVersion"`: The engine version number of the replication instance. If an engine
version number is not specified when a replication instance is created, the default is the
latest engine version available.
- `"KmsKeyId"`: An KMS key identifier that is used to encrypt the data on the replication
instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses your
default encryption key. KMS creates the default encryption key for your Amazon Web Services
account. Your Amazon Web Services account has a different default encryption key for each
Amazon Web Services Region.
- `"MultiAZ"`: Specifies whether the replication instance is a Multi-AZ deployment. You
can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
- `"NetworkType"`: The type of IP address protocol used by a replication instance, such as
IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet
supported.
- `"PreferredMaintenanceWindow"`: The weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A
30-minute window selected at random from an 8-hour block of time per Amazon Web Services
Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat,
Sun Constraints: Minimum 30-minute window.
- `"PubliclyAccessible"`: Specifies the accessibility options for the replication
instance. A value of true represents an instance with a public IP address. A value of false
represents an instance with a private IP address. The default value is true.
- `"ReplicationSubnetGroupIdentifier"`: A subnet group to associate with the replication
instance.
- `"ResourceIdentifier"`: A friendly name for the resource identifier at the end of the
EndpointArn response parameter that is returned in the created Endpoint object. The value
for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,
and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and
can only begin with a letter, such as Example-App-ARN1. For example, this value might
result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If
you don't specify a ResourceIdentifier value, DMS generates a default identifier value for
the end of EndpointArn.
- `"Tags"`: One or more tags to be assigned to the replication instance.
- `"VpcSecurityGroupIds"`: Specifies the VPC security group to be used with the
replication instance. The VPC security group must work with the VPC containing the
replication instance.
"""
function create_replication_instance(
ReplicationInstanceClass,
ReplicationInstanceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateReplicationInstance",
Dict{String,Any}(
"ReplicationInstanceClass" => ReplicationInstanceClass,
"ReplicationInstanceIdentifier" => ReplicationInstanceIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replication_instance(
ReplicationInstanceClass,
ReplicationInstanceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateReplicationInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationInstanceClass" => ReplicationInstanceClass,
"ReplicationInstanceIdentifier" => ReplicationInstanceIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_replication_subnet_group(replication_subnet_group_description, replication_subnet_group_identifier, subnet_ids)
create_replication_subnet_group(replication_subnet_group_description, replication_subnet_group_identifier, subnet_ids, params::Dict{String,<:Any})
Creates a replication subnet group given a list of the subnet IDs in a VPC. The VPC needs
to have at least one subnet in at least two availability zones in the Amazon Web Services
Region, otherwise the service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs
exception. If a replication subnet group exists in your Amazon Web Services account, the
CreateReplicationSubnetGroup action returns the following error message: The Replication
Subnet Group already exists. In this case, delete the existing replication subnet group. To
do so, use the DeleteReplicationSubnetGroup action. Optionally, choose Subnet groups in the
DMS console, then choose your subnet group. Next, choose Delete from Actions.
# Arguments
- `replication_subnet_group_description`: The description for the subnet group.
- `replication_subnet_group_identifier`: The name for the replication subnet group. This
value is stored as a lowercase string. Constraints: Must contain no more than 255
alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be \"default\".
Example: mySubnetgroup
- `subnet_ids`: Two or more subnet IDs to be assigned to the subnet group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: One or more tags to be assigned to the subnet group.
"""
function create_replication_subnet_group(
ReplicationSubnetGroupDescription,
ReplicationSubnetGroupIdentifier,
SubnetIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateReplicationSubnetGroup",
Dict{String,Any}(
"ReplicationSubnetGroupDescription" => ReplicationSubnetGroupDescription,
"ReplicationSubnetGroupIdentifier" => ReplicationSubnetGroupIdentifier,
"SubnetIds" => SubnetIds,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replication_subnet_group(
ReplicationSubnetGroupDescription,
ReplicationSubnetGroupIdentifier,
SubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateReplicationSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationSubnetGroupDescription" =>
ReplicationSubnetGroupDescription,
"ReplicationSubnetGroupIdentifier" => ReplicationSubnetGroupIdentifier,
"SubnetIds" => SubnetIds,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_replication_task(migration_type, replication_instance_arn, replication_task_identifier, source_endpoint_arn, table_mappings, target_endpoint_arn)
create_replication_task(migration_type, replication_instance_arn, replication_task_identifier, source_endpoint_arn, table_mappings, target_endpoint_arn, params::Dict{String,<:Any})
Creates a replication task using the specified parameters.
# Arguments
- `migration_type`: The migration type. Valid values: full-load | cdc | full-load-and-cdc
- `replication_instance_arn`: The Amazon Resource Name (ARN) of a replication instance.
- `replication_task_identifier`: An identifier for the replication task. Constraints:
Must contain 1-255 alphanumeric characters or hyphens. First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
- `source_endpoint_arn`: An Amazon Resource Name (ARN) that uniquely identifies the source
endpoint.
- `table_mappings`: The table mappings for the task, in JSON format. For more information,
see Using Table Mapping to Specify Task Settings in the Database Migration Service User
Guide.
- `target_endpoint_arn`: An Amazon Resource Name (ARN) that uniquely identifies the target
endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CdcStartPosition"`: Indicates when you want a change data capture (CDC) operation to
start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation
to start. Specifying both values results in an error. The value can be in date,
checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position
\"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changel
og.157832:1876#0#0#*#0#93\" LSN Example: --cdc-start-position
“mysql-bin-changelog.000024:373” When you use this task setting with a source
PostgreSQL database, a logical replication slot should already be created and associated
with the source endpoint. You can verify this by setting the slotName extra connection
attribute to the name of this logical replication slot. For more information, see Extra
Connection Attributes When Using PostgreSQL as a Source for DMS.
- `"CdcStartTime"`: Indicates the start time for a change data capture (CDC) operation. Use
either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.
Specifying both values results in an error. Timestamp Example: --cdc-start-time
“2018-03-08T12:12:12”
- `"CdcStopPosition"`: Indicates when you want a change data capture (CDC) operation to
stop. The value can be either server time or commit time. Server time example:
--cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example:
--cdc-stop-position “commit_time:2018-02-09T12:12:12“
- `"ReplicationTaskSettings"`: Overall settings for the task, in JSON format. For more
information, see Specifying Task Settings for Database Migration Service Tasks in the
Database Migration Service User Guide.
- `"ResourceIdentifier"`: A friendly name for the resource identifier at the end of the
EndpointArn response parameter that is returned in the created Endpoint object. The value
for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,
and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and
can only begin with a letter, such as Example-App-ARN1. For example, this value might
result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If
you don't specify a ResourceIdentifier value, DMS generates a default identifier value for
the end of EndpointArn.
- `"Tags"`: One or more tags to be assigned to the replication task.
- `"TaskData"`: Supplemental information that the task requires to migrate the data for
certain source and target endpoints. For more information, see Specifying Supplemental Data
for Task Settings in the Database Migration Service User Guide.
"""
function create_replication_task(
MigrationType,
ReplicationInstanceArn,
ReplicationTaskIdentifier,
SourceEndpointArn,
TableMappings,
TargetEndpointArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateReplicationTask",
Dict{String,Any}(
"MigrationType" => MigrationType,
"ReplicationInstanceArn" => ReplicationInstanceArn,
"ReplicationTaskIdentifier" => ReplicationTaskIdentifier,
"SourceEndpointArn" => SourceEndpointArn,
"TableMappings" => TableMappings,
"TargetEndpointArn" => TargetEndpointArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replication_task(
MigrationType,
ReplicationInstanceArn,
ReplicationTaskIdentifier,
SourceEndpointArn,
TableMappings,
TargetEndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"CreateReplicationTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationType" => MigrationType,
"ReplicationInstanceArn" => ReplicationInstanceArn,
"ReplicationTaskIdentifier" => ReplicationTaskIdentifier,
"SourceEndpointArn" => SourceEndpointArn,
"TableMappings" => TableMappings,
"TargetEndpointArn" => TargetEndpointArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_certificate(certificate_arn)
delete_certificate(certificate_arn, params::Dict{String,<:Any})
Deletes the specified certificate.
# Arguments
- `certificate_arn`: The Amazon Resource Name (ARN) of the certificate.
"""
function delete_certificate(
CertificateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteCertificate",
Dict{String,Any}("CertificateArn" => CertificateArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_certificate(
CertificateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteCertificate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CertificateArn" => CertificateArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connection(endpoint_arn, replication_instance_arn)
delete_connection(endpoint_arn, replication_instance_arn, params::Dict{String,<:Any})
Deletes the connection between a replication instance and an endpoint.
# Arguments
- `endpoint_arn`: The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
- `replication_instance_arn`: The Amazon Resource Name (ARN) of the replication instance.
"""
function delete_connection(
EndpointArn, ReplicationInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteConnection",
Dict{String,Any}(
"EndpointArn" => EndpointArn, "ReplicationInstanceArn" => ReplicationInstanceArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connection(
EndpointArn,
ReplicationInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointArn" => EndpointArn,
"ReplicationInstanceArn" => ReplicationInstanceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_provider(data_provider_identifier)
delete_data_provider(data_provider_identifier, params::Dict{String,<:Any})
Deletes the specified data provider. All migration projects associated with the data
provider must be deleted or modified before you can delete the data provider.
# Arguments
- `data_provider_identifier`: The identifier of the data provider to delete.
"""
function delete_data_provider(
DataProviderIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteDataProvider",
Dict{String,Any}("DataProviderIdentifier" => DataProviderIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_provider(
DataProviderIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteDataProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DataProviderIdentifier" => DataProviderIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_endpoint(endpoint_arn)
delete_endpoint(endpoint_arn, params::Dict{String,<:Any})
Deletes the specified endpoint. All tasks associated with the endpoint must be deleted
before you can delete the endpoint.
# Arguments
- `endpoint_arn`: The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
"""
function delete_endpoint(EndpointArn; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DeleteEndpoint",
Dict{String,Any}("EndpointArn" => EndpointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_endpoint(
EndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointArn" => EndpointArn), 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 DMS event subscription.
# Arguments
- `subscription_name`: The name of the DMS event notification subscription to be deleted.
"""
function delete_event_subscription(
SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"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 database_migration_service(
"DeleteEventSubscription",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionName" => SubscriptionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fleet_advisor_collector(collector_referenced_id)
delete_fleet_advisor_collector(collector_referenced_id, params::Dict{String,<:Any})
Deletes the specified Fleet Advisor collector.
# Arguments
- `collector_referenced_id`: The reference ID of the Fleet Advisor collector to delete.
"""
function delete_fleet_advisor_collector(
CollectorReferencedId; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteFleetAdvisorCollector",
Dict{String,Any}("CollectorReferencedId" => CollectorReferencedId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fleet_advisor_collector(
CollectorReferencedId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteFleetAdvisorCollector",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CollectorReferencedId" => CollectorReferencedId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fleet_advisor_databases(database_ids)
delete_fleet_advisor_databases(database_ids, params::Dict{String,<:Any})
Deletes the specified Fleet Advisor collector databases.
# Arguments
- `database_ids`: The IDs of the Fleet Advisor collector databases to delete.
"""
function delete_fleet_advisor_databases(
DatabaseIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteFleetAdvisorDatabases",
Dict{String,Any}("DatabaseIds" => DatabaseIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fleet_advisor_databases(
DatabaseIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteFleetAdvisorDatabases",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatabaseIds" => DatabaseIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance_profile(instance_profile_identifier)
delete_instance_profile(instance_profile_identifier, params::Dict{String,<:Any})
Deletes the specified instance profile. All migration projects associated with the
instance profile must be deleted or modified before you can delete the instance profile.
# Arguments
- `instance_profile_identifier`: The identifier of the instance profile to delete.
"""
function delete_instance_profile(
InstanceProfileIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteInstanceProfile",
Dict{String,Any}("InstanceProfileIdentifier" => InstanceProfileIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance_profile(
InstanceProfileIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteInstanceProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceProfileIdentifier" => InstanceProfileIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_migration_project(migration_project_identifier)
delete_migration_project(migration_project_identifier, params::Dict{String,<:Any})
Deletes the specified migration project. The migration project must be closed before you
can delete it.
# Arguments
- `migration_project_identifier`: The name or Amazon Resource Name (ARN) of the migration
project to delete.
"""
function delete_migration_project(
MigrationProjectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteMigrationProject",
Dict{String,Any}("MigrationProjectIdentifier" => MigrationProjectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_migration_project(
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteMigrationProject",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replication_config(replication_config_arn)
delete_replication_config(replication_config_arn, params::Dict{String,<:Any})
Deletes an DMS Serverless replication configuration. This effectively deprovisions any and
all replications that use this configuration. You can't delete the configuration for an DMS
Serverless replication that is ongoing. You can delete the configuration when the
replication is in a non-RUNNING and non-STARTING state.
# Arguments
- `replication_config_arn`: The replication config to delete.
"""
function delete_replication_config(
ReplicationConfigArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteReplicationConfig",
Dict{String,Any}("ReplicationConfigArn" => ReplicationConfigArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replication_config(
ReplicationConfigArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteReplicationConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReplicationConfigArn" => ReplicationConfigArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replication_instance(replication_instance_arn)
delete_replication_instance(replication_instance_arn, params::Dict{String,<:Any})
Deletes the specified replication instance. You must delete any migration tasks that are
associated with the replication instance before you can delete it.
# Arguments
- `replication_instance_arn`: The Amazon Resource Name (ARN) of the replication instance to
be deleted.
"""
function delete_replication_instance(
ReplicationInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteReplicationInstance",
Dict{String,Any}("ReplicationInstanceArn" => ReplicationInstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replication_instance(
ReplicationInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteReplicationInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReplicationInstanceArn" => ReplicationInstanceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replication_subnet_group(replication_subnet_group_identifier)
delete_replication_subnet_group(replication_subnet_group_identifier, params::Dict{String,<:Any})
Deletes a subnet group.
# Arguments
- `replication_subnet_group_identifier`: The subnet group name of the replication instance.
"""
function delete_replication_subnet_group(
ReplicationSubnetGroupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteReplicationSubnetGroup",
Dict{String,Any}(
"ReplicationSubnetGroupIdentifier" => ReplicationSubnetGroupIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replication_subnet_group(
ReplicationSubnetGroupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteReplicationSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationSubnetGroupIdentifier" => ReplicationSubnetGroupIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replication_task(replication_task_arn)
delete_replication_task(replication_task_arn, params::Dict{String,<:Any})
Deletes the specified replication task.
# Arguments
- `replication_task_arn`: The Amazon Resource Name (ARN) of the replication task to be
deleted.
"""
function delete_replication_task(
ReplicationTaskArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteReplicationTask",
Dict{String,Any}("ReplicationTaskArn" => ReplicationTaskArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replication_task(
ReplicationTaskArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteReplicationTask",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReplicationTaskArn" => ReplicationTaskArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replication_task_assessment_run(replication_task_assessment_run_arn)
delete_replication_task_assessment_run(replication_task_assessment_run_arn, params::Dict{String,<:Any})
Deletes the record of a single premigration assessment run. This operation removes all
metadata that DMS maintains about this assessment run. However, the operation leaves
untouched all information about this assessment run that is stored in your Amazon S3 bucket.
# Arguments
- `replication_task_assessment_run_arn`: Amazon Resource Name (ARN) of the premigration
assessment run to be deleted.
"""
function delete_replication_task_assessment_run(
ReplicationTaskAssessmentRunArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DeleteReplicationTaskAssessmentRun",
Dict{String,Any}(
"ReplicationTaskAssessmentRunArn" => ReplicationTaskAssessmentRunArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replication_task_assessment_run(
ReplicationTaskAssessmentRunArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DeleteReplicationTaskAssessmentRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationTaskAssessmentRunArn" => ReplicationTaskAssessmentRunArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_attributes()
describe_account_attributes(params::Dict{String,<:Any})
Lists all of the DMS attributes for a customer account. These attributes include DMS quotas
for the account and a unique account identifier in a particular DMS region. DMS quotas
include a list of resource quotas supported by the account, such as the number of
replication instances allowed. The description for each resource quota, includes the quota
name, current usage toward that quota, and the quota's maximum value. DMS uses the unique
account identifier to name each artifact used by DMS in the given region. This command does
not take any parameters.
"""
function describe_account_attributes(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"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 database_migration_service(
"DescribeAccountAttributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_applicable_individual_assessments()
describe_applicable_individual_assessments(params::Dict{String,<:Any})
Provides a list of individual assessments that you can specify for a new premigration
assessment run, given one or more parameters. If you specify an existing migration task,
this operation provides the default individual assessments you can specify for that task.
Otherwise, the specified parameters model elements of a possible migration task on which to
base a premigration assessment run. To use these migration task modeling parameters, you
must specify an existing replication instance, a source database engine, a target database
engine, and a migration type. This combination of parameters potentially limits the default
individual assessments available for an assessment run created for a corresponding
migration task. If you specify no parameters, this operation provides a list of all
possible individual assessments that you can specify for an assessment run. If you specify
any one of the task modeling parameters, you must specify all of them or the operation
cannot provide a list of individual assessments. The only parameter that you can specify
alone is for an existing migration task. The specified task definition then determines the
default list of individual assessments that you can specify in an assessment run for the
task.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: 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"`: 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.
- `"MigrationType"`: Name of the migration type that each provided individual assessment
must support.
- `"ReplicationInstanceArn"`: ARN of a replication instance on which you want to base the
default list of individual assessments.
- `"ReplicationTaskArn"`: Amazon Resource Name (ARN) of a migration task on which you want
to base the default list of individual assessments.
- `"SourceEngineName"`: Name of a database engine that the specified replication instance
supports as a source.
- `"TargetEngineName"`: Name of a database engine that the specified replication instance
supports as a target.
"""
function describe_applicable_individual_assessments(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeApplicableIndividualAssessments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_applicable_individual_assessments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeApplicableIndividualAssessments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_certificates()
describe_certificates(params::Dict{String,<:Any})
Provides a description of the certificate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the certificates described in the form of key-value
pairs. Valid values are certificate-arn and certificate-id.
- `"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
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: 10
"""
function describe_certificates(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeCertificates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeCertificates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_connections()
describe_connections(params::Dict{String,<:Any})
Describes the status of the connections that have been made between the replication
instance and an endpoint. Connections are created when you test an endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The filters applied to the connection. Valid filter names: endpoint-arn |
replication-instance-arn
- `"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
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_connections(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeConnections"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeConnections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_conversion_configuration(migration_project_identifier)
describe_conversion_configuration(migration_project_identifier, params::Dict{String,<:Any})
Returns configuration parameters for a schema conversion project.
# Arguments
- `migration_project_identifier`: The name or Amazon Resource Name (ARN) for the schema
conversion project to describe.
"""
function describe_conversion_configuration(
MigrationProjectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeConversionConfiguration",
Dict{String,Any}("MigrationProjectIdentifier" => MigrationProjectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_conversion_configuration(
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeConversionConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_providers()
describe_data_providers(params::Dict{String,<:Any})
Returns a paginated list of data providers for your account in the current region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the data providers described in the form of key-value
pairs. Valid filter names: data-provider-identifier
- `"Marker"`: Specifies the unique pagination token that makes it possible to display the
next page of results. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a
previous response, there are more results available. The value of Marker is a unique
pagination token for each page. To retrieve the next page, make the call again using the
returned token and keeping all other arguments unchanged.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, DMS includes a pagination token in the response
so that you can retrieve the remaining results.
"""
function describe_data_providers(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeDataProviders"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_data_providers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeDataProviders",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoint_settings(engine_name)
describe_endpoint_settings(engine_name, params::Dict{String,<:Any})
Returns information about the possible endpoint settings available when you create an
endpoint for a specific database engine.
# Arguments
- `engine_name`: The database engine used for your source or target endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"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 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.
"""
function describe_endpoint_settings(
EngineName; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeEndpointSettings",
Dict{String,Any}("EngineName" => EngineName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_endpoint_settings(
EngineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeEndpointSettings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EngineName" => EngineName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoint_types()
describe_endpoint_types(params::Dict{String,<:Any})
Returns information about the type of endpoints available.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the endpoint types. Valid filter names: engine-name |
endpoint-type
- `"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
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_endpoint_types(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeEndpointTypes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_endpoint_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeEndpointTypes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoints()
describe_endpoints(params::Dict{String,<:Any})
Returns information about the endpoints for your account in the current region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the endpoints. Valid filter names: endpoint-arn |
endpoint-type | endpoint-id | engine-name
- `"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
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_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeEndpoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_engine_versions()
describe_engine_versions(params::Dict{String,<:Any})
Returns information about the replication instance versions used in the project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"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 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.
"""
function describe_engine_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"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 database_migration_service(
"DescribeEngineVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_categories()
describe_event_categories(params::Dict{String,<:Any})
Lists categories for all event source types, or, if specified, for a specified source type.
You can see a list of the event categories and source types in Working with Events and
Notifications in the Database Migration Service User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the event categories.
- `"SourceType"`: The type of DMS resource that generates events. Valid values:
replication-instance | replication-task
"""
function describe_event_categories(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"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 database_migration_service(
"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 event subscriptions for a customer account. The description of a subscription
includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and
Status. If you specify SubscriptionName, this action lists the description for that
subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to event subscriptions. Valid filter names:
event-subscription-arn | event-subscription-id
- `"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
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 DMS event subscription to be described.
"""
function describe_event_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"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 database_migration_service(
"DescribeEventSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Lists events for a given source identifier and source type. You can also specify a start
and end time. For more information on DMS events, see Working with Events and Notifications
in the Database Migration Service User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Duration"`: The duration of the events to be listed.
- `"EndTime"`: The end time for the events to be listed.
- `"EventCategories"`: A list of event categories for the source type that you've chosen.
- `"Filters"`: Filters applied to events. The only valid filter is replication-instance-id.
- `"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
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 an event source.
- `"SourceType"`: The type of DMS resource that generates events. Valid values:
replication-instance | replication-task
- `"StartTime"`: The start time for the events to be listed.
"""
function describe_events(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeEvents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_extension_pack_associations(migration_project_identifier)
describe_extension_pack_associations(migration_project_identifier, params::Dict{String,<:Any})
Returns a paginated list of extension pack associations for the specified migration
project. An extension pack is an add-on module that emulates functions present in a source
database that are required when converting objects to the target database.
# Arguments
- `migration_project_identifier`: The name or Amazon Resource Name (ARN) for the migration
project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the extension pack associations described in the form of
key-value pairs.
- `"Marker"`: Specifies the unique pagination token that makes it possible to display the
next page of results. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a
previous response, there are more results available. The value of Marker is a unique
pagination token for each page. To retrieve the next page, make the call again using the
returned token and keeping all other arguments unchanged.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, DMS includes a pagination token in the response
so that you can retrieve the remaining results.
"""
function describe_extension_pack_associations(
MigrationProjectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeExtensionPackAssociations",
Dict{String,Any}("MigrationProjectIdentifier" => MigrationProjectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_extension_pack_associations(
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeExtensionPackAssociations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_advisor_collectors()
describe_fleet_advisor_collectors(params::Dict{String,<:Any})
Returns a list of the Fleet Advisor collectors in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: If you specify any of the following filters, the output includes
information for only those collectors that meet the filter criteria:
collector-referenced-id – The ID of the collector agent, for example
d4610ac5-e323-4ad9-bc50-eaf7249dfe9d. collector-name – The name of the collector
agent. An example is: describe-fleet-advisor-collectors --filter
Name=\"collector-referenced-id\",Values=\"d4610ac5-e323-4ad9-bc50-eaf7249dfe9d\"
- `"MaxRecords"`: Sets the maximum number of records returned in the response.
- `"NextToken"`: If NextToken is returned by a previous response, 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_fleet_advisor_collectors(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeFleetAdvisorCollectors";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_advisor_collectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeFleetAdvisorCollectors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_advisor_databases()
describe_fleet_advisor_databases(params::Dict{String,<:Any})
Returns a list of Fleet Advisor databases in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: If you specify any of the following filters, the output includes
information for only those databases that meet the filter criteria: database-id – The
ID of the database. database-name – The name of the database. database-engine –
The name of the database engine. server-ip-address – The IP address of the database
server. database-ip-address – The IP address of the database. collector-name –
The name of the associated Fleet Advisor collector. An example is:
describe-fleet-advisor-databases --filter Name=\"database-id\",Values=\"45\"
- `"MaxRecords"`: Sets the maximum number of records returned in the response.
- `"NextToken"`: If NextToken is returned by a previous response, 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_fleet_advisor_databases(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeFleetAdvisorDatabases";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_advisor_databases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeFleetAdvisorDatabases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_advisor_lsa_analysis()
describe_fleet_advisor_lsa_analysis(params::Dict{String,<:Any})
Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet
Advisor collectors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxRecords"`: Sets the maximum number of records returned in the response.
- `"NextToken"`: If NextToken is returned by a previous response, 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_fleet_advisor_lsa_analysis(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeFleetAdvisorLsaAnalysis";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_advisor_lsa_analysis(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeFleetAdvisorLsaAnalysis",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_advisor_schema_object_summary()
describe_fleet_advisor_schema_object_summary(params::Dict{String,<:Any})
Provides descriptions of the schemas discovered by your Fleet Advisor collectors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: If you specify any of the following filters, the output includes
information for only those schema objects that meet the filter criteria: schema-id –
The ID of the schema, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d. Example:
describe-fleet-advisor-schema-object-summary --filter Name=\"schema-id\",Values=\"50\"
- `"MaxRecords"`: Sets the maximum number of records returned in the response.
- `"NextToken"`: If NextToken is returned by a previous response, 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_fleet_advisor_schema_object_summary(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeFleetAdvisorSchemaObjectSummary";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_advisor_schema_object_summary(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeFleetAdvisorSchemaObjectSummary",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_advisor_schemas()
describe_fleet_advisor_schemas(params::Dict{String,<:Any})
Returns a list of schemas detected by Fleet Advisor Collectors in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: If you specify any of the following filters, the output includes
information for only those schemas that meet the filter criteria: complexity – The
schema's complexity, for example Simple. database-id – The ID of the schema's
database. database-ip-address – The IP address of the schema's database.
database-name – The name of the schema's database. database-engine – The name of the
schema database's engine. original-schema-name – The name of the schema's database's
main schema. schema-id – The ID of the schema, for example 15. schema-name – The
name of the schema. server-ip-address – The IP address of the schema database's
server. An example is: describe-fleet-advisor-schemas --filter
Name=\"schema-id\",Values=\"50\"
- `"MaxRecords"`: Sets the maximum number of records returned in the response.
- `"NextToken"`: If NextToken is returned by a previous response, 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_fleet_advisor_schemas(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeFleetAdvisorSchemas";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_advisor_schemas(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeFleetAdvisorSchemas",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_profiles()
describe_instance_profiles(params::Dict{String,<:Any})
Returns a paginated list of instance profiles for your account in the current region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the instance profiles described in the form of key-value
pairs.
- `"Marker"`: Specifies the unique pagination token that makes it possible to display the
next page of results. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a
previous response, there are more results available. The value of Marker is a unique
pagination token for each page. To retrieve the next page, make the call again using the
returned token and keeping all other arguments unchanged.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, DMS includes a pagination token in the response
so that you can retrieve the remaining results.
"""
function describe_instance_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeInstanceProfiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_instance_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeInstanceProfiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_metadata_model_assessments(migration_project_identifier)
describe_metadata_model_assessments(migration_project_identifier, params::Dict{String,<:Any})
Returns a paginated list of metadata model assessments for your account in the current
region.
# Arguments
- `migration_project_identifier`: The name or Amazon Resource Name (ARN) of the migration
project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the metadata model assessments described in the form of
key-value pairs.
- `"Marker"`: Specifies the unique pagination token that makes it possible to display the
next page of results. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a
previous response, there are more results available. The value of Marker is a unique
pagination token for each page. To retrieve the next page, make the call again using the
returned token and keeping all other arguments unchanged.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, DMS includes a pagination token in the response
so that you can retrieve the remaining results.
"""
function describe_metadata_model_assessments(
MigrationProjectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeMetadataModelAssessments",
Dict{String,Any}("MigrationProjectIdentifier" => MigrationProjectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_metadata_model_assessments(
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeMetadataModelAssessments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_metadata_model_conversions(migration_project_identifier)
describe_metadata_model_conversions(migration_project_identifier, params::Dict{String,<:Any})
Returns a paginated list of metadata model conversions for a migration project.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the metadata model conversions described in the form of
key-value pairs.
- `"Marker"`: Specifies the unique pagination token that makes it possible to display the
next page of results. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a
previous response, there are more results available. The value of Marker is a unique
pagination token for each page. To retrieve the next page, make the call again using the
returned token and keeping all other arguments unchanged.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, DMS includes a pagination token in the response
so that you can retrieve the remaining results.
"""
function describe_metadata_model_conversions(
MigrationProjectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeMetadataModelConversions",
Dict{String,Any}("MigrationProjectIdentifier" => MigrationProjectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_metadata_model_conversions(
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeMetadataModelConversions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_metadata_model_exports_as_script(migration_project_identifier)
describe_metadata_model_exports_as_script(migration_project_identifier, params::Dict{String,<:Any})
Returns a paginated list of metadata model exports.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the metadata model exports described in the form of
key-value pairs.
- `"Marker"`: Specifies the unique pagination token that makes it possible to display the
next page of results. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a
previous response, there are more results available. The value of Marker is a unique
pagination token for each page. To retrieve the next page, make the call again using the
returned token and keeping all other arguments unchanged.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, DMS includes a pagination token in the response
so that you can retrieve the remaining results.
"""
function describe_metadata_model_exports_as_script(
MigrationProjectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeMetadataModelExportsAsScript",
Dict{String,Any}("MigrationProjectIdentifier" => MigrationProjectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_metadata_model_exports_as_script(
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeMetadataModelExportsAsScript",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_metadata_model_exports_to_target(migration_project_identifier)
describe_metadata_model_exports_to_target(migration_project_identifier, params::Dict{String,<:Any})
Returns a paginated list of metadata model exports.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the metadata model exports described in the form of
key-value pairs.
- `"Marker"`: Specifies the unique pagination token that makes it possible to display the
next page of results. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a
previous response, there are more results available. The value of Marker is a unique
pagination token for each page. To retrieve the next page, make the call again using the
returned token and keeping all other arguments unchanged.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, DMS includes a pagination token in the response
so that you can retrieve the remaining results.
"""
function describe_metadata_model_exports_to_target(
MigrationProjectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeMetadataModelExportsToTarget",
Dict{String,Any}("MigrationProjectIdentifier" => MigrationProjectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_metadata_model_exports_to_target(
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeMetadataModelExportsToTarget",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_metadata_model_imports(migration_project_identifier)
describe_metadata_model_imports(migration_project_identifier, params::Dict{String,<:Any})
Returns a paginated list of metadata model imports.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the metadata model imports described in the form of
key-value pairs.
- `"Marker"`: Specifies the unique pagination token that makes it possible to display the
next page of results. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a
previous response, there are more results available. The value of Marker is a unique
pagination token for each page. To retrieve the next page, make the call again using the
returned token and keeping all other arguments unchanged.
- `"MaxRecords"`: A paginated list of metadata model imports.
"""
function describe_metadata_model_imports(
MigrationProjectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeMetadataModelImports",
Dict{String,Any}("MigrationProjectIdentifier" => MigrationProjectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_metadata_model_imports(
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeMetadataModelImports",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_migration_projects()
describe_migration_projects(params::Dict{String,<:Any})
Returns a paginated list of migration projects for your account in the current region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the migration projects described in the form of key-value
pairs.
- `"Marker"`: Specifies the unique pagination token that makes it possible to display the
next page of results. If this parameter is specified, the response includes only records
beyond the marker, up to the value specified by MaxRecords. If Marker is returned by a
previous response, there are more results available. The value of Marker is a unique
pagination token for each page. To retrieve the next page, make the call again using the
returned token and keeping all other arguments unchanged.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, DMS includes a pagination token in the response
so that you can retrieve the remaining results.
"""
function describe_migration_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeMigrationProjects"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_migration_projects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeMigrationProjects",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_orderable_replication_instances()
describe_orderable_replication_instances(params::Dict{String,<:Any})
Returns information about the replication instance types that can be created in the
specified region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"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
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_orderable_replication_instances(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeOrderableReplicationInstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_orderable_replication_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeOrderableReplicationInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pending_maintenance_actions()
describe_pending_maintenance_actions(params::Dict{String,<:Any})
For internal use only
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`:
- `"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
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.
- `"ReplicationInstanceArn"`: The Amazon Resource Name (ARN) of the replication instance.
"""
function describe_pending_maintenance_actions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"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 database_migration_service(
"DescribePendingMaintenanceActions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_recommendation_limitations()
describe_recommendation_limitations(params::Dict{String,<:Any})
Returns a paginated list of limitations for recommendations of target Amazon Web Services
engines.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the limitations described in the form of key-value pairs.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, Fleet Advisor includes a pagination token in the
response so that you can retrieve the remaining results.
- `"NextToken"`: Specifies the unique pagination token that makes it possible to display
the next page of results. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords. If NextToken is
returned by a previous response, 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_recommendation_limitations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeRecommendationLimitations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_recommendation_limitations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeRecommendationLimitations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_recommendations()
describe_recommendations(params::Dict{String,<:Any})
Returns a paginated list of target engine recommendations for your source databases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the target engine recommendations described in the form
of key-value pairs.
- `"MaxRecords"`: The maximum number of records to include in the response. If more records
exist than the specified MaxRecords value, Fleet Advisor includes a pagination token in the
response so that you can retrieve the remaining results.
- `"NextToken"`: Specifies the unique pagination token that makes it possible to display
the next page of results. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords. If NextToken is
returned by a previous response, 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_recommendations(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeRecommendations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_recommendations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeRecommendations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_refresh_schemas_status(endpoint_arn)
describe_refresh_schemas_status(endpoint_arn, params::Dict{String,<:Any})
Returns the status of the RefreshSchemas operation.
# Arguments
- `endpoint_arn`: The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
"""
function describe_refresh_schemas_status(
EndpointArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeRefreshSchemasStatus",
Dict{String,Any}("EndpointArn" => EndpointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_refresh_schemas_status(
EndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeRefreshSchemasStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointArn" => EndpointArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_configs()
describe_replication_configs(params::Dict{String,<:Any})
Returns one or more existing DMS Serverless replication configurations as a list of
structures.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the replication configs.
- `"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 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.
"""
function describe_replication_configs(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeReplicationConfigs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_replication_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationConfigs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_instance_task_logs(replication_instance_arn)
describe_replication_instance_task_logs(replication_instance_arn, params::Dict{String,<:Any})
Returns information about the task logs for the specified task.
# Arguments
- `replication_instance_arn`: The Amazon Resource Name (ARN) of the replication instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"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
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_replication_instance_task_logs(
ReplicationInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationInstanceTaskLogs",
Dict{String,Any}("ReplicationInstanceArn" => ReplicationInstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replication_instance_task_logs(
ReplicationInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeReplicationInstanceTaskLogs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReplicationInstanceArn" => ReplicationInstanceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_instances()
describe_replication_instances(params::Dict{String,<:Any})
Returns information about replication instances for your account in the current region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to replication instances. Valid filter names:
replication-instance-arn | replication-instance-id | replication-instance-class |
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
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_replication_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeReplicationInstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replication_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_subnet_groups()
describe_replication_subnet_groups(params::Dict{String,<:Any})
Returns information about the replication subnet groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to replication subnet groups. Valid filter names:
replication-subnet-group-id
- `"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
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_replication_subnet_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationSubnetGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replication_subnet_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationSubnetGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_table_statistics(replication_config_arn)
describe_replication_table_statistics(replication_config_arn, params::Dict{String,<:Any})
Returns table and schema statistics for one or more provisioned replications that use a
given DMS Serverless replication configuration.
# Arguments
- `replication_config_arn`: The replication config to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the replication table statistics.
- `"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 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.
"""
function describe_replication_table_statistics(
ReplicationConfigArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationTableStatistics",
Dict{String,Any}("ReplicationConfigArn" => ReplicationConfigArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replication_table_statistics(
ReplicationConfigArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeReplicationTableStatistics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReplicationConfigArn" => ReplicationConfigArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_task_assessment_results()
describe_replication_task_assessment_results(params::Dict{String,<:Any})
Returns the task assessment results from the Amazon S3 bucket that DMS creates in your
Amazon Web Services account. This action always returns the latest results. For more
information about DMS task assessments, see Creating a task assessment report in the
Database Migration Service User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"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
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.
- `"ReplicationTaskArn"`: The Amazon Resource Name (ARN) string that uniquely identifies
the task. When this input parameter is specified, the API returns only one result and
ignore the values of the MaxRecords and Marker parameters.
"""
function describe_replication_task_assessment_results(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationTaskAssessmentResults";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replication_task_assessment_results(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationTaskAssessmentResults",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_task_assessment_runs()
describe_replication_task_assessment_runs(params::Dict{String,<:Any})
Returns a paginated list of premigration assessment runs based on filter settings. These
filter settings can specify a combination of premigration assessment runs, migration tasks,
replication instances, and assessment run status values. This operation doesn't return
information about individual assessments. For this information, see the
DescribeReplicationTaskIndividualAssessments operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the premigration assessment runs described in the form of
key-value pairs. Valid filter names: replication-task-assessment-run-arn,
replication-task-arn, replication-instance-arn, status
- `"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 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.
"""
function describe_replication_task_assessment_runs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationTaskAssessmentRuns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replication_task_assessment_runs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationTaskAssessmentRuns",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_task_individual_assessments()
describe_replication_task_individual_assessments(params::Dict{String,<:Any})
Returns a paginated list of individual assessments based on filter settings. These filter
settings can specify a combination of premigration assessment runs, migration tasks, and
assessment status values.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the individual assessments described in the form of
key-value pairs. Valid filter names: replication-task-assessment-run-arn,
replication-task-arn, status
- `"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 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.
"""
function describe_replication_task_individual_assessments(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationTaskIndividualAssessments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replication_task_individual_assessments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationTaskIndividualAssessments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_tasks()
describe_replication_tasks(params::Dict{String,<:Any})
Returns information about replication tasks for your account in the current region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to replication tasks. Valid filter names:
replication-task-arn | replication-task-id | migration-type | endpoint-arn |
replication-instance-arn
- `"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
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.
- `"WithoutSettings"`: An option to set to avoid returning information about settings. Use
this to reduce overhead when setting information is too large. To use this option, choose
true; otherwise, choose false (the default).
"""
function describe_replication_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeReplicationTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_replication_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplicationTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replications()
describe_replications(params::Dict{String,<:Any})
Provides details on replication progress by returning status information for one or more
provisioned DMS Serverless replications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to the replications.
- `"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 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.
"""
function describe_replications(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeReplications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_replications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeReplications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_schemas(endpoint_arn)
describe_schemas(endpoint_arn, params::Dict{String,<:Any})
Returns information about the schema for the specified endpoint.
# Arguments
- `endpoint_arn`: The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"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
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_schemas(EndpointArn; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"DescribeSchemas",
Dict{String,Any}("EndpointArn" => EndpointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_schemas(
EndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeSchemas",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointArn" => EndpointArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_table_statistics(replication_task_arn)
describe_table_statistics(replication_task_arn, params::Dict{String,<:Any})
Returns table statistics on the database migration task, including table name, rows
inserted, rows updated, and rows deleted. Note that the \"last updated\" column the DMS
console only indicates the time that DMS last updated the table statistics record for a
table. It does not indicate the time of the last update to the table.
# Arguments
- `replication_task_arn`: The Amazon Resource Name (ARN) of the replication task.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters applied to table statistics. Valid filter names: schema-name |
table-name | table-state A combination of filters creates an AND condition where each
record matches all specified filters.
- `"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
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 500.
"""
function describe_table_statistics(
ReplicationTaskArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"DescribeTableStatistics",
Dict{String,Any}("ReplicationTaskArn" => ReplicationTaskArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_table_statistics(
ReplicationTaskArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"DescribeTableStatistics",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReplicationTaskArn" => ReplicationTaskArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_metadata_model_assessment(migration_project_identifier, selection_rules)
export_metadata_model_assessment(migration_project_identifier, selection_rules, params::Dict{String,<:Any})
Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can
save your assessment report as a comma-separated value (CSV) or a PDF file.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
- `selection_rules`: A value that specifies the database objects to assess.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssessmentReportTypes"`: The file format of the assessment file.
- `"FileName"`: The name of the assessment file to create in your Amazon S3 bucket.
"""
function export_metadata_model_assessment(
MigrationProjectIdentifier,
SelectionRules;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ExportMetadataModelAssessment",
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"SelectionRules" => SelectionRules,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_metadata_model_assessment(
MigrationProjectIdentifier,
SelectionRules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ExportMetadataModelAssessment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"SelectionRules" => SelectionRules,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_certificate(certificate_identifier)
import_certificate(certificate_identifier, params::Dict{String,<:Any})
Uploads the specified certificate.
# Arguments
- `certificate_identifier`: A customer-assigned name for the certificate. Identifiers must
begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't
end with a hyphen or contain two consecutive hyphens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificatePem"`: The contents of a .pem file, which contains an X.509 certificate.
- `"CertificateWallet"`: The location of an imported Oracle Wallet certificate for use with
SSL. Provide the name of a .sso file using the fileb:// prefix. You can't provide the
certificate inline. Example: filebase64(\"{path.root}/rds-ca-2019-root.sso\")
- `"Tags"`: The tags associated with the certificate.
"""
function import_certificate(
CertificateIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"ImportCertificate",
Dict{String,Any}("CertificateIdentifier" => CertificateIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_certificate(
CertificateIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ImportCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CertificateIdentifier" => CertificateIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource()
list_tags_for_resource(params::Dict{String,<:Any})
Lists all metadata tags attached to an DMS resource, including replication instance,
endpoint, subnet group, and migration task. For more information, see Tag data type
description.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceArn"`: The Amazon Resource Name (ARN) string that uniquely identifies the DMS
resource to list tags for. This returns a list of keys (names of tags) created for the
resource and their associated tag values.
- `"ResourceArnList"`: List of ARNs that identify multiple DMS resources that you want to
list tags for. This returns a list of keys (tag names) and their associated tag values. It
also returns each tag's associated ResourceArn value, which is the ARN of the resource for
which each listed tag is created.
"""
function list_tags_for_resource(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"ListTagsForResource"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_tags_for_resource(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"ListTagsForResource",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_conversion_configuration(conversion_configuration, migration_project_identifier)
modify_conversion_configuration(conversion_configuration, migration_project_identifier, params::Dict{String,<:Any})
Modifies the specified schema conversion configuration using the provided parameters.
# Arguments
- `conversion_configuration`: The new conversion configuration.
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
"""
function modify_conversion_configuration(
ConversionConfiguration,
MigrationProjectIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyConversionConfiguration",
Dict{String,Any}(
"ConversionConfiguration" => ConversionConfiguration,
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_conversion_configuration(
ConversionConfiguration,
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyConversionConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConversionConfiguration" => ConversionConfiguration,
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_data_provider(data_provider_identifier)
modify_data_provider(data_provider_identifier, params::Dict{String,<:Any})
Modifies the specified data provider using the provided settings. You must remove the data
provider from all migration projects before you can modify it.
# Arguments
- `data_provider_identifier`: The identifier of the data provider. Identifiers must begin
with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with
a hyphen, or contain two consecutive hyphens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataProviderName"`: The name of the data provider.
- `"Description"`: A user-friendly description of the data provider.
- `"Engine"`: The type of database engine for the data provider. Valid values include
\"aurora\", \"aurora-postgresql\", \"mysql\", \"oracle\", \"postgres\", \"sqlserver\",
redshift, mariadb, mongodb, and docdb. A value of \"aurora\" represents Amazon Aurora
MySQL-Compatible Edition.
- `"ExactSettings"`: If this attribute is Y, the current call to ModifyDataProvider
replaces all existing data provider settings with the exact settings that you specify in
this call. If this attribute is N, the current call to ModifyDataProvider does two things:
It replaces any data provider settings that already exist with new values, for settings
with the same names. It creates new data provider settings that you specify in the call,
for settings with different names.
- `"Settings"`: The settings in JSON format for a data provider.
"""
function modify_data_provider(
DataProviderIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"ModifyDataProvider",
Dict{String,Any}("DataProviderIdentifier" => DataProviderIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_data_provider(
DataProviderIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyDataProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DataProviderIdentifier" => DataProviderIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_endpoint(endpoint_arn)
modify_endpoint(endpoint_arn, params::Dict{String,<:Any})
Modifies the specified endpoint. For a MySQL source or target endpoint, don't explicitly
specify the database using the DatabaseName request parameter on the ModifyEndpoint API
call. Specifying DatabaseName when you modify a MySQL endpoint replicates all the task
tables to this single database. For MySQL endpoints, you specify the database only when you
specify the schema in the table-mapping rules of the DMS task.
# Arguments
- `endpoint_arn`: The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificateArn"`: The Amazon Resource Name (ARN) of the certificate used for SSL
connection.
- `"DatabaseName"`: The name of the endpoint database. For a MySQL source or target
endpoint, do not specify DatabaseName.
- `"DmsTransferSettings"`: The settings in JSON format for the DMS transfer type of source
endpoint. Attributes include the following: serviceAccessRoleArn - The Amazon Resource
Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole
action. BucketName - The name of the S3 bucket to use. Shorthand syntax for these
settings is as follows: ServiceAccessRoleArn=string ,BucketName=string JSON syntax for
these settings is as follows: { \"ServiceAccessRoleArn\": \"string\", \"BucketName\":
\"string\"}
- `"DocDbSettings"`: Settings in JSON format for the source DocumentDB endpoint. For more
information about the available settings, see the configuration properties section in
Using DocumentDB as a Target for Database Migration Service in the Database Migration
Service User Guide.
- `"DynamoDbSettings"`: Settings in JSON format for the target Amazon DynamoDB endpoint.
For information about other available settings, see Using Object Mapping to Migrate Data to
DynamoDB in the Database Migration Service User Guide.
- `"ElasticsearchSettings"`: Settings in JSON format for the target OpenSearch endpoint.
For more information about the available settings, see Extra Connection Attributes When
Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.
- `"EndpointIdentifier"`: The database endpoint identifier. Identifiers must begin with a
letter and must contain only ASCII letters, digits, and hyphens. They can't end with a
hyphen or contain two consecutive hyphens.
- `"EndpointType"`: The type of endpoint. Valid values are source and target.
- `"EngineName"`: The database engine name. Valid values, depending on the EndpointType,
include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\",
\"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"db2-zos\", \"azuredb\", \"sybase\",
\"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\",
\"sqlserver\", \"neptune\", and \"babelfish\".
- `"ExactSettings"`: If this attribute is Y, the current call to ModifyEndpoint replaces
all existing endpoint settings with the exact settings that you specify in this call. If
this attribute is N, the current call to ModifyEndpoint does two things: It replaces any
endpoint settings that already exist with new values, for settings with the same names.
It creates new endpoint settings that you specify in the call, for settings with different
names. For example, if you call create-endpoint ... --endpoint-settings '{\"a\":1}' ...,
the endpoint has the following endpoint settings: '{\"a\":1}'. If you then call
modify-endpoint ... --endpoint-settings '{\"b\":2}' ... for the same endpoint, the endpoint
has the following settings: '{\"a\":1,\"b\":2}'. However, suppose that you follow this
with a call to modify-endpoint ... --endpoint-settings '{\"b\":2}' --exact-settings ... for
that same endpoint again. Then the endpoint has the following settings: '{\"b\":2}'. All
existing settings are replaced with the exact settings that you specify.
- `"ExternalTableDefinition"`: The external table definition.
- `"ExtraConnectionAttributes"`: Additional attributes associated with the connection. To
reset this parameter, pass the empty string (\"\") as an argument.
- `"GcpMySQLSettings"`: Settings in JSON format for the source GCP MySQL endpoint.
- `"IBMDb2Settings"`: Settings in JSON format for the source IBM Db2 LUW endpoint. For
information about other available settings, see Extra connection attributes when using Db2
LUW as a source for DMS in the Database Migration Service User Guide.
- `"KafkaSettings"`: Settings in JSON format for the target Apache Kafka endpoint. For more
information about the available settings, see Using object mapping to migrate data to a
Kafka topic in the Database Migration Service User Guide.
- `"KinesisSettings"`: Settings in JSON format for the target endpoint for Amazon Kinesis
Data Streams. For more information about the available settings, see Using object mapping
to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
- `"MicrosoftSQLServerSettings"`: Settings in JSON format for the source and target
Microsoft SQL Server endpoint. For information about other available settings, see Extra
connection attributes when using SQL Server as a source for DMS and Extra connection
attributes when using SQL Server as a target for DMS in the Database Migration Service User
Guide.
- `"MongoDbSettings"`: Settings in JSON format for the source MongoDB endpoint. For more
information about the available settings, see the configuration properties section in
Endpoint configuration settings when using MongoDB as a source for Database Migration
Service in the Database Migration Service User Guide.
- `"MySQLSettings"`: Settings in JSON format for the source and target MySQL endpoint. For
information about other available settings, see Extra connection attributes when using
MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible
database as a target for DMS in the Database Migration Service User Guide.
- `"NeptuneSettings"`: Settings in JSON format for the target Amazon Neptune endpoint. For
more information about the available settings, see Specifying graph-mapping rules using
Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User
Guide.
- `"OracleSettings"`: Settings in JSON format for the source and target Oracle endpoint.
For information about other available settings, see Extra connection attributes when using
Oracle as a source for DMS and Extra connection attributes when using Oracle as a target
for DMS in the Database Migration Service User Guide.
- `"Password"`: The password to be used to login to the endpoint database.
- `"Port"`: The port used by the endpoint database.
- `"PostgreSQLSettings"`: Settings in JSON format for the source and target PostgreSQL
endpoint. For information about other available settings, see Extra connection attributes
when using PostgreSQL as a source for DMS and Extra connection attributes when using
PostgreSQL as a target for DMS in the Database Migration Service User Guide.
- `"RedisSettings"`: Settings in JSON format for the Redis target endpoint.
- `"RedshiftSettings"`:
- `"S3Settings"`: Settings in JSON format for the target Amazon S3 endpoint. For more
information about the available settings, see Extra Connection Attributes When Using Amazon
S3 as a Target for DMS in the Database Migration Service User Guide.
- `"ServerName"`: The name of the server where the endpoint database resides.
- `"ServiceAccessRoleArn"`: The Amazon Resource Name (ARN) for the IAM role you want to
use to modify the endpoint. The role must allow the iam:PassRole action.
- `"SslMode"`: The SSL mode used to connect to the endpoint. The default value is none.
- `"SybaseSettings"`: Settings in JSON format for the source and target SAP ASE endpoint.
For information about other available settings, see Extra connection attributes when using
SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target
for DMS in the Database Migration Service User Guide.
- `"TimestreamSettings"`: Settings in JSON format for the target Amazon Timestream endpoint.
- `"Username"`: The user name to be used to login to the endpoint database.
"""
function modify_endpoint(EndpointArn; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"ModifyEndpoint",
Dict{String,Any}("EndpointArn" => EndpointArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_endpoint(
EndpointArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointArn" => EndpointArn), 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 DMS event notification subscription.
# Arguments
- `subscription_name`: The name of the DMS event notification subscription to be modified.
# 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 source type that you want to
subscribe to. Use the DescribeEventCategories action to see a list of event categories.
- `"SnsTopicArn"`: The Amazon Resource Name (ARN) of the Amazon 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 DMS resource that generates the events you want to subscribe
to. Valid values: replication-instance | replication-task
"""
function modify_event_subscription(
SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"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 database_migration_service(
"ModifyEventSubscription",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubscriptionName" => SubscriptionName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_profile(instance_profile_identifier)
modify_instance_profile(instance_profile_identifier, params::Dict{String,<:Any})
Modifies the specified instance profile using the provided parameters. All migration
projects associated with the instance profile must be deleted or modified before you can
modify the instance profile.
# Arguments
- `instance_profile_identifier`: The identifier of the instance profile. Identifiers must
begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't
end with a hyphen, or contain two consecutive hyphens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZone"`: The Availability Zone where the instance profile runs.
- `"Description"`: A user-friendly description for the instance profile.
- `"InstanceProfileName"`: A user-friendly name for the instance profile.
- `"KmsKeyArn"`: The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the
connection parameters for the instance profile. If you don't specify a value for the
KmsKeyArn parameter, then DMS uses your default encryption key. KMS creates the default
encryption key for your Amazon Web Services account. Your Amazon Web Services account has a
different default encryption key for each Amazon Web Services Region.
- `"NetworkType"`: Specifies the network type for the instance profile. A value of IPV4
represents an instance profile with IPv4 network type and only supports IPv4 addressing. A
value of IPV6 represents an instance profile with IPv6 network type and only supports IPv6
addressing. A value of DUAL represents an instance profile with dual network type that
supports IPv4 and IPv6 addressing.
- `"PubliclyAccessible"`: Specifies the accessibility options for the instance profile. A
value of true represents an instance profile with a public IP address. A value of false
represents an instance profile with a private IP address. The default value is true.
- `"SubnetGroupIdentifier"`: A subnet group to associate with the instance profile.
- `"VpcSecurityGroups"`: Specifies the VPC security groups to be used with the instance
profile. The VPC security group must work with the VPC containing the instance profile.
"""
function modify_instance_profile(
InstanceProfileIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"ModifyInstanceProfile",
Dict{String,Any}("InstanceProfileIdentifier" => InstanceProfileIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_profile(
InstanceProfileIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyInstanceProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceProfileIdentifier" => InstanceProfileIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_migration_project(migration_project_identifier)
modify_migration_project(migration_project_identifier, params::Dict{String,<:Any})
Modifies the specified migration project using the provided parameters. The migration
project must be closed before you can modify it.
# Arguments
- `migration_project_identifier`: The identifier of the migration project. Identifiers must
begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't
end with a hyphen, or contain two consecutive hyphens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A user-friendly description of the migration project.
- `"InstanceProfileIdentifier"`: The name or Amazon Resource Name (ARN) for the instance
profile.
- `"MigrationProjectName"`: A user-friendly name for the migration project.
- `"SchemaConversionApplicationAttributes"`: The schema conversion application attributes,
including the Amazon S3 bucket name and Amazon S3 role ARN.
- `"SourceDataProviderDescriptors"`: Information about the source data provider, including
the name, ARN, and Amazon Web Services Secrets Manager parameters.
- `"TargetDataProviderDescriptors"`: Information about the target data provider, including
the name, ARN, and Amazon Web Services Secrets Manager parameters.
- `"TransformationRules"`: The settings in JSON format for migration rules. Migration rules
make it possible for you to change the object names according to the rules that you
specify. For example, you can change an object name to lowercase or uppercase, add or
remove a prefix or suffix, or rename objects.
"""
function modify_migration_project(
MigrationProjectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"ModifyMigrationProject",
Dict{String,Any}("MigrationProjectIdentifier" => MigrationProjectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_migration_project(
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyMigrationProject",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_replication_config(replication_config_arn)
modify_replication_config(replication_config_arn, params::Dict{String,<:Any})
Modifies an existing DMS Serverless replication configuration that you can use to start a
replication. This command includes input validation and logic to check the state of any
replication that uses this configuration. You can only modify a replication configuration
before any replication that uses it has started. As soon as you have initially started a
replication with a given configuiration, you can't modify that configuration, even if you
stop it. Other run statuses that allow you to run this command include FAILED and CREATED.
A provisioning state that allows you to run this command is FAILED_PROVISION.
# Arguments
- `replication_config_arn`: The Amazon Resource Name of the replication to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComputeConfig"`: Configuration parameters for provisioning an DMS Serverless
replication.
- `"ReplicationConfigIdentifier"`: The new replication config to apply to the replication.
- `"ReplicationSettings"`: The settings for the replication.
- `"ReplicationType"`: The type of replication.
- `"SourceEndpointArn"`: The Amazon Resource Name (ARN) of the source endpoint for this DMS
serverless replication configuration.
- `"SupplementalSettings"`: Additional settings for the replication.
- `"TableMappings"`: Table mappings specified in the replication.
- `"TargetEndpointArn"`: The Amazon Resource Name (ARN) of the target endpoint for this DMS
serverless replication configuration.
"""
function modify_replication_config(
ReplicationConfigArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"ModifyReplicationConfig",
Dict{String,Any}("ReplicationConfigArn" => ReplicationConfigArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_replication_config(
ReplicationConfigArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyReplicationConfig",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReplicationConfigArn" => ReplicationConfigArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_replication_instance(replication_instance_arn)
modify_replication_instance(replication_instance_arn, params::Dict{String,<:Any})
Modifies the replication instance to apply new settings. You can change one or more
parameters by specifying these parameters and the new values in the request. Some settings
are applied during the maintenance window.
# Arguments
- `replication_instance_arn`: The Amazon Resource Name (ARN) of the replication instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedStorage"`: The amount of storage (in gigabytes) to be allocated for the
replication instance.
- `"AllowMajorVersionUpgrade"`: Indicates that major version upgrades are allowed. Changing
this parameter does not result in an outage, and the change is asynchronously applied as
soon as possible. This parameter must be set to true when specifying a value for the
EngineVersion parameter that is a different major version than the replication instance's
current version.
- `"ApplyImmediately"`: Indicates whether the changes should be applied immediately or
during the next maintenance window.
- `"AutoMinorVersionUpgrade"`: A value that indicates that minor version upgrades are
applied automatically to the replication instance during the maintenance window. Changing
this parameter doesn't result in an outage, except in the case described following. The
change is asynchronously applied as soon as possible. An outage does result if these
factors apply: This parameter is set to true during the maintenance window. A newer
minor version is available. DMS has enabled automatic patching for the given engine
version.
- `"EngineVersion"`: The engine version number of the replication instance. When modifying
a major engine version of an instance, also set AllowMajorVersionUpgrade to true.
- `"MultiAZ"`: Specifies whether the replication instance is a Multi-AZ deployment. You
can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
- `"NetworkType"`: The type of IP address protocol used by a replication instance, such as
IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet
supported.
- `"PreferredMaintenanceWindow"`: The weekly time range (in UTC) during which system
maintenance can occur, which might result in an outage. Changing this parameter does not
result in an outage, except in the following situation, and the change is asynchronously
applied as soon as possible. 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
- `"ReplicationInstanceClass"`: The compute and memory capacity of the replication instance
as defined for the specified replication instance class. For example to specify the
instance class dms.c4.large, set this parameter to \"dms.c4.large\". For more information
on the settings and capacities for the available replication instance classes, see
Selecting the right DMS replication instance for your migration.
- `"ReplicationInstanceIdentifier"`: The replication instance identifier. This parameter is
stored as a lowercase string.
- `"VpcSecurityGroupIds"`: Specifies the VPC security group to be used with the
replication instance. The VPC security group must work with the VPC containing the
replication instance.
"""
function modify_replication_instance(
ReplicationInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"ModifyReplicationInstance",
Dict{String,Any}("ReplicationInstanceArn" => ReplicationInstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_replication_instance(
ReplicationInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyReplicationInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReplicationInstanceArn" => ReplicationInstanceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_replication_subnet_group(replication_subnet_group_identifier, subnet_ids)
modify_replication_subnet_group(replication_subnet_group_identifier, subnet_ids, params::Dict{String,<:Any})
Modifies the settings for the specified replication subnet group.
# Arguments
- `replication_subnet_group_identifier`: The name of the replication instance subnet group.
- `subnet_ids`: A list of subnet IDs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReplicationSubnetGroupDescription"`: A description for the replication instance subnet
group.
"""
function modify_replication_subnet_group(
ReplicationSubnetGroupIdentifier,
SubnetIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyReplicationSubnetGroup",
Dict{String,Any}(
"ReplicationSubnetGroupIdentifier" => ReplicationSubnetGroupIdentifier,
"SubnetIds" => SubnetIds,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_replication_subnet_group(
ReplicationSubnetGroupIdentifier,
SubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyReplicationSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationSubnetGroupIdentifier" => ReplicationSubnetGroupIdentifier,
"SubnetIds" => SubnetIds,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_replication_task(replication_task_arn)
modify_replication_task(replication_task_arn, params::Dict{String,<:Any})
Modifies the specified replication task. You can't modify the task endpoints. The task must
be stopped before you can modify it. For more information about DMS tasks, see Working
with Migration Tasks in the Database Migration Service User Guide.
# Arguments
- `replication_task_arn`: The Amazon Resource Name (ARN) of the replication task.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CdcStartPosition"`: Indicates when you want a change data capture (CDC) operation to
start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation
to start. Specifying both values results in an error. The value can be in date,
checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position
\"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changel
og.157832:1876#0#0#*#0#93\" LSN Example: --cdc-start-position
“mysql-bin-changelog.000024:373” When you use this task setting with a source
PostgreSQL database, a logical replication slot should already be created and associated
with the source endpoint. You can verify this by setting the slotName extra connection
attribute to the name of this logical replication slot. For more information, see Extra
Connection Attributes When Using PostgreSQL as a Source for DMS.
- `"CdcStartTime"`: Indicates the start time for a change data capture (CDC) operation. Use
either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.
Specifying both values results in an error. Timestamp Example: --cdc-start-time
“2018-03-08T12:12:12”
- `"CdcStopPosition"`: Indicates when you want a change data capture (CDC) operation to
stop. The value can be either server time or commit time. Server time example:
--cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example:
--cdc-stop-position “commit_time:2018-02-09T12:12:12“
- `"MigrationType"`: The migration type. Valid values: full-load | cdc | full-load-and-cdc
- `"ReplicationTaskIdentifier"`: The replication task identifier. Constraints: Must
contain 1-255 alphanumeric characters or hyphens. First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
- `"ReplicationTaskSettings"`: JSON file that contains settings for the task, such as task
metadata settings.
- `"TableMappings"`: When using the CLI or boto3, provide the path of the JSON file that
contains the table mappings. Precede the path with file://. For example, --table-mappings
file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter
value.
- `"TaskData"`: Supplemental information that the task requires to migrate the data for
certain source and target endpoints. For more information, see Specifying Supplemental Data
for Task Settings in the Database Migration Service User Guide.
"""
function modify_replication_task(
ReplicationTaskArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"ModifyReplicationTask",
Dict{String,Any}("ReplicationTaskArn" => ReplicationTaskArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_replication_task(
ReplicationTaskArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ModifyReplicationTask",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReplicationTaskArn" => ReplicationTaskArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
move_replication_task(replication_task_arn, target_replication_instance_arn)
move_replication_task(replication_task_arn, target_replication_instance_arn, params::Dict{String,<:Any})
Moves a replication task from its current replication instance to a different target
replication instance using the specified parameters. The target replication instance must
be created with the same or later DMS version as the current replication instance.
# Arguments
- `replication_task_arn`: The Amazon Resource Name (ARN) of the task that you want to move.
- `target_replication_instance_arn`: The ARN of the replication instance where you want to
move the task to.
"""
function move_replication_task(
ReplicationTaskArn,
TargetReplicationInstanceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"MoveReplicationTask",
Dict{String,Any}(
"ReplicationTaskArn" => ReplicationTaskArn,
"TargetReplicationInstanceArn" => TargetReplicationInstanceArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function move_replication_task(
ReplicationTaskArn,
TargetReplicationInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"MoveReplicationTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationTaskArn" => ReplicationTaskArn,
"TargetReplicationInstanceArn" => TargetReplicationInstanceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_replication_instance(replication_instance_arn)
reboot_replication_instance(replication_instance_arn, params::Dict{String,<:Any})
Reboots a replication instance. Rebooting results in a momentary outage, until the
replication instance becomes available again.
# Arguments
- `replication_instance_arn`: The Amazon Resource Name (ARN) of the replication instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceFailover"`: If this parameter is true, the reboot is conducted through a Multi-AZ
failover. If the instance isn't configured for Multi-AZ, then you can't specify true. (
--force-planned-failover and --force-failover can't both be set to true.)
- `"ForcePlannedFailover"`: If this parameter is true, the reboot is conducted through a
planned Multi-AZ failover where resources are released and cleaned up prior to conducting
the failover. If the instance isn''t configured for Multi-AZ, then you can't specify true.
( --force-planned-failover and --force-failover can't both be set to true.)
"""
function reboot_replication_instance(
ReplicationInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"RebootReplicationInstance",
Dict{String,Any}("ReplicationInstanceArn" => ReplicationInstanceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_replication_instance(
ReplicationInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"RebootReplicationInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReplicationInstanceArn" => ReplicationInstanceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
refresh_schemas(endpoint_arn, replication_instance_arn)
refresh_schemas(endpoint_arn, replication_instance_arn, params::Dict{String,<:Any})
Populates the schema for the specified endpoint. This is an asynchronous operation and can
take several minutes. You can check the status of this operation by calling the
DescribeRefreshSchemasStatus operation.
# Arguments
- `endpoint_arn`: The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
- `replication_instance_arn`: The Amazon Resource Name (ARN) of the replication instance.
"""
function refresh_schemas(
EndpointArn, ReplicationInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"RefreshSchemas",
Dict{String,Any}(
"EndpointArn" => EndpointArn, "ReplicationInstanceArn" => ReplicationInstanceArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function refresh_schemas(
EndpointArn,
ReplicationInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"RefreshSchemas",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointArn" => EndpointArn,
"ReplicationInstanceArn" => ReplicationInstanceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reload_replication_tables(replication_config_arn, tables_to_reload)
reload_replication_tables(replication_config_arn, tables_to_reload, params::Dict{String,<:Any})
Reloads the target database table with the source data for a given DMS Serverless
replication configuration. You can only use this operation with a task in the RUNNING
state, otherwise the service will throw an InvalidResourceStateFault exception.
# Arguments
- `replication_config_arn`: The Amazon Resource Name of the replication config for which to
reload tables.
- `tables_to_reload`: The list of tables to reload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReloadOption"`: Options for reload. Specify data-reload to reload the data and
re-validate it if validation is enabled. Specify validate-only to re-validate the table.
This option applies only when validation is enabled for the replication.
"""
function reload_replication_tables(
ReplicationConfigArn, TablesToReload; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"ReloadReplicationTables",
Dict{String,Any}(
"ReplicationConfigArn" => ReplicationConfigArn,
"TablesToReload" => TablesToReload,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reload_replication_tables(
ReplicationConfigArn,
TablesToReload,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ReloadReplicationTables",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationConfigArn" => ReplicationConfigArn,
"TablesToReload" => TablesToReload,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reload_tables(replication_task_arn, tables_to_reload)
reload_tables(replication_task_arn, tables_to_reload, params::Dict{String,<:Any})
Reloads the target database table with the source data. You can only use this operation
with a task in the RUNNING state, otherwise the service will throw an
InvalidResourceStateFault exception.
# Arguments
- `replication_task_arn`: The Amazon Resource Name (ARN) of the replication task.
- `tables_to_reload`: The name and schema of the table to be reloaded.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReloadOption"`: Options for reload. Specify data-reload to reload the data and
re-validate it if validation is enabled. Specify validate-only to re-validate the table.
This option applies only when validation is enabled for the task. Valid values:
data-reload, validate-only Default value is data-reload.
"""
function reload_tables(
ReplicationTaskArn, TablesToReload; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"ReloadTables",
Dict{String,Any}(
"ReplicationTaskArn" => ReplicationTaskArn, "TablesToReload" => TablesToReload
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reload_tables(
ReplicationTaskArn,
TablesToReload,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"ReloadTables",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationTaskArn" => ReplicationTaskArn,
"TablesToReload" => TablesToReload,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags_from_resource(resource_arn, tag_keys)
remove_tags_from_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes metadata tags from an DMS resource, including replication instance, endpoint,
subnet group, and migration task. For more information, see Tag data type description.
# Arguments
- `resource_arn`: An DMS resource from which you want to remove tag(s). The value for this
parameter is an Amazon Resource Name (ARN).
- `tag_keys`: The tag key (name) of the tag to be removed.
"""
function remove_tags_from_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"RemoveTagsFromResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags_from_resource(
ResourceArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"RemoveTagsFromResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
run_fleet_advisor_lsa_analysis()
run_fleet_advisor_lsa_analysis(params::Dict{String,<:Any})
Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
"""
function run_fleet_advisor_lsa_analysis(; aws_config::AbstractAWSConfig=global_aws_config())
return database_migration_service(
"RunFleetAdvisorLsaAnalysis"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function run_fleet_advisor_lsa_analysis(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"RunFleetAdvisorLsaAnalysis",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_extension_pack_association(migration_project_identifier)
start_extension_pack_association(migration_project_identifier, params::Dict{String,<:Any})
Applies the extension pack to your target database. An extension pack is an add-on module
that emulates functions present in a source database that are required when converting
objects to the target database.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
"""
function start_extension_pack_association(
MigrationProjectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"StartExtensionPackAssociation",
Dict{String,Any}("MigrationProjectIdentifier" => MigrationProjectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_extension_pack_association(
MigrationProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartExtensionPackAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_metadata_model_assessment(migration_project_identifier, selection_rules)
start_metadata_model_assessment(migration_project_identifier, selection_rules, params::Dict{String,<:Any})
Creates a database migration assessment report by assessing the migration complexity for
your source database. A database migration assessment report summarizes all of the schema
conversion tasks. It also details the action items for database objects that can't be
converted to the database engine of your target database instance.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
- `selection_rules`: A value that specifies the database objects to assess.
"""
function start_metadata_model_assessment(
MigrationProjectIdentifier,
SelectionRules;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartMetadataModelAssessment",
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"SelectionRules" => SelectionRules,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_metadata_model_assessment(
MigrationProjectIdentifier,
SelectionRules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartMetadataModelAssessment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"SelectionRules" => SelectionRules,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_metadata_model_conversion(migration_project_identifier, selection_rules)
start_metadata_model_conversion(migration_project_identifier, selection_rules, params::Dict{String,<:Any})
Converts your source database objects to a format compatible with the target database.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
- `selection_rules`: A value that specifies the database objects to convert.
"""
function start_metadata_model_conversion(
MigrationProjectIdentifier,
SelectionRules;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartMetadataModelConversion",
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"SelectionRules" => SelectionRules,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_metadata_model_conversion(
MigrationProjectIdentifier,
SelectionRules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartMetadataModelConversion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"SelectionRules" => SelectionRules,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_metadata_model_export_as_script(migration_project_identifier, origin, selection_rules)
start_metadata_model_export_as_script(migration_project_identifier, origin, selection_rules, params::Dict{String,<:Any})
Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3
bucket.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
- `origin`: Whether to export the metadata model from the source or the target.
- `selection_rules`: A value that specifies the database objects to export.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FileName"`: The name of the model file to create in the Amazon S3 bucket.
"""
function start_metadata_model_export_as_script(
MigrationProjectIdentifier,
Origin,
SelectionRules;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartMetadataModelExportAsScript",
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"Origin" => Origin,
"SelectionRules" => SelectionRules,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_metadata_model_export_as_script(
MigrationProjectIdentifier,
Origin,
SelectionRules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartMetadataModelExportAsScript",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"Origin" => Origin,
"SelectionRules" => SelectionRules,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_metadata_model_export_to_target(migration_project_identifier, selection_rules)
start_metadata_model_export_to_target(migration_project_identifier, selection_rules, params::Dict{String,<:Any})
Applies converted database objects to your target database.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
- `selection_rules`: A value that specifies the database objects to export.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OverwriteExtensionPack"`: Whether to overwrite the migration project extension pack. An
extension pack is an add-on module that emulates functions present in a source database
that are required when converting objects to the target database.
"""
function start_metadata_model_export_to_target(
MigrationProjectIdentifier,
SelectionRules;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartMetadataModelExportToTarget",
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"SelectionRules" => SelectionRules,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_metadata_model_export_to_target(
MigrationProjectIdentifier,
SelectionRules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartMetadataModelExportToTarget",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"SelectionRules" => SelectionRules,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_metadata_model_import(migration_project_identifier, origin, selection_rules)
start_metadata_model_import(migration_project_identifier, origin, selection_rules, params::Dict{String,<:Any})
Loads the metadata for all the dependent database objects of the parent object. This
operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.
# Arguments
- `migration_project_identifier`: The migration project name or Amazon Resource Name (ARN).
- `origin`: Whether to load metadata to the source or target database.
- `selection_rules`: A value that specifies the database objects to import.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Refresh"`: If true, DMS loads metadata for the specified objects from the source
database.
"""
function start_metadata_model_import(
MigrationProjectIdentifier,
Origin,
SelectionRules;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartMetadataModelImport",
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"Origin" => Origin,
"SelectionRules" => SelectionRules,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_metadata_model_import(
MigrationProjectIdentifier,
Origin,
SelectionRules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartMetadataModelImport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MigrationProjectIdentifier" => MigrationProjectIdentifier,
"Origin" => Origin,
"SelectionRules" => SelectionRules,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_recommendations(database_id, settings)
start_recommendations(database_id, settings, params::Dict{String,<:Any})
Starts the analysis of your source database to provide recommendations of target engines.
You can create recommendations for multiple source databases using
BatchStartRecommendations.
# Arguments
- `database_id`: The identifier of the source database to analyze and provide
recommendations for.
- `settings`: The settings in JSON format that Fleet Advisor uses to determine target
engine recommendations. These parameters include target instance sizing and availability
and durability settings. For target instance sizing, Fleet Advisor supports the following
two options: total capacity and resource utilization. For availability and durability,
Fleet Advisor supports the following two options: production (Multi-AZ deployments) and
Dev/Test (Single-AZ deployments).
"""
function start_recommendations(
DatabaseId, Settings; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"StartRecommendations",
Dict{String,Any}("DatabaseId" => DatabaseId, "Settings" => Settings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_recommendations(
DatabaseId,
Settings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartRecommendations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseId" => DatabaseId, "Settings" => Settings),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_replication(replication_config_arn, start_replication_type)
start_replication(replication_config_arn, start_replication_type, params::Dict{String,<:Any})
For a given DMS Serverless replication configuration, DMS connects to the source endpoint
and collects the metadata to analyze the replication workload. Using this metadata, DMS
then computes and provisions the required capacity and starts replicating to the target
endpoint using the server resources that DMS has provisioned for the DMS Serverless
replication.
# Arguments
- `replication_config_arn`: The Amazon Resource Name of the replication for which to start
replication.
- `start_replication_type`: The replication type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CdcStartPosition"`: Indicates when you want a change data capture (CDC) operation to
start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation
to start. Specifying both values results in an error. The value can be in date, checkpoint,
or LSN/SCN format.
- `"CdcStartTime"`: Indicates the start time for a change data capture (CDC) operation. Use
either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.
Specifying both values results in an error.
- `"CdcStopPosition"`: Indicates when you want a change data capture (CDC) operation to
stop. The value can be either server time or commit time.
"""
function start_replication(
ReplicationConfigArn,
StartReplicationType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartReplication",
Dict{String,Any}(
"ReplicationConfigArn" => ReplicationConfigArn,
"StartReplicationType" => StartReplicationType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_replication(
ReplicationConfigArn,
StartReplicationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartReplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationConfigArn" => ReplicationConfigArn,
"StartReplicationType" => StartReplicationType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_replication_task(replication_task_arn, start_replication_task_type)
start_replication_task(replication_task_arn, start_replication_task_type, params::Dict{String,<:Any})
Starts the replication task. For more information about DMS tasks, see Working with
Migration Tasks in the Database Migration Service User Guide.
# Arguments
- `replication_task_arn`: The Amazon Resource Name (ARN) of the replication task to be
started.
- `start_replication_task_type`: The type of replication task to start. When the migration
type is full-load or full-load-and-cdc, the only valid value for the first run of the task
is start-replication. This option will start the migration. You can also use ReloadTables
to reload specific tables that failed during migration instead of restarting the task. The
resume-processing option isn't applicable for a full-load task, because you can't resume
partially loaded tables during the full load phase. For a full-load-and-cdc task, DMS
migrates table data, and then applies data changes that occur on the source. To load all
the tables again, and start capturing source changes, use reload-target. Otherwise use
resume-processing, to replicate the changes from the last stop position.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CdcStartPosition"`: Indicates when you want a change data capture (CDC) operation to
start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation
to start. Specifying both values results in an error. The value can be in date,
checkpoint, or LSN/SCN format. Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position
\"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changel
og.157832:1876#0#0#*#0#93\" LSN Example: --cdc-start-position
“mysql-bin-changelog.000024:373” When you use this task setting with a source
PostgreSQL database, a logical replication slot should already be created and associated
with the source endpoint. You can verify this by setting the slotName extra connection
attribute to the name of this logical replication slot. For more information, see Extra
Connection Attributes When Using PostgreSQL as a Source for DMS.
- `"CdcStartTime"`: Indicates the start time for a change data capture (CDC) operation. Use
either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.
Specifying both values results in an error. Timestamp Example: --cdc-start-time
“2018-03-08T12:12:12”
- `"CdcStopPosition"`: Indicates when you want a change data capture (CDC) operation to
stop. The value can be either server time or commit time. Server time example:
--cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example:
--cdc-stop-position “commit_time:2018-02-09T12:12:12“
"""
function start_replication_task(
ReplicationTaskArn,
StartReplicationTaskType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartReplicationTask",
Dict{String,Any}(
"ReplicationTaskArn" => ReplicationTaskArn,
"StartReplicationTaskType" => StartReplicationTaskType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_replication_task(
ReplicationTaskArn,
StartReplicationTaskType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartReplicationTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationTaskArn" => ReplicationTaskArn,
"StartReplicationTaskType" => StartReplicationTaskType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_replication_task_assessment(replication_task_arn)
start_replication_task_assessment(replication_task_arn, params::Dict{String,<:Any})
Starts the replication task assessment for unsupported data types in the source database.
You can only use this operation for a task if the following conditions are true: The task
must be in the stopped state. The task must have successful connections to the source and
target. If either of these conditions are not met, an InvalidResourceStateFault error
will result. For information about DMS task assessments, see Creating a task assessment
report in the Database Migration Service User Guide.
# Arguments
- `replication_task_arn`: The Amazon Resource Name (ARN) of the replication task.
"""
function start_replication_task_assessment(
ReplicationTaskArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"StartReplicationTaskAssessment",
Dict{String,Any}("ReplicationTaskArn" => ReplicationTaskArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_replication_task_assessment(
ReplicationTaskArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartReplicationTaskAssessment",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReplicationTaskArn" => ReplicationTaskArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_replication_task_assessment_run(assessment_run_name, replication_task_arn, result_location_bucket, service_access_role_arn)
start_replication_task_assessment_run(assessment_run_name, replication_task_arn, result_location_bucket, service_access_role_arn, params::Dict{String,<:Any})
Starts a new premigration assessment run for one or more individual assessments of a
migration task. The assessments that you can specify depend on the source and target
database engine and the migration type defined for the given task. To run this operation,
your migration task must already be created. After you run this operation, you can review
the status of each individual assessment. You can also run the migration task manually
after the assessment run and its individual assessments complete.
# Arguments
- `assessment_run_name`: Unique name to identify the assessment run.
- `replication_task_arn`: Amazon Resource Name (ARN) of the migration task associated with
the premigration assessment run that you want to start.
- `result_location_bucket`: Amazon S3 bucket where you want DMS to store the results of
this assessment run.
- `service_access_role_arn`: ARN of the service role needed to start the assessment run.
The role must allow the iam:PassRole action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Exclude"`: Space-separated list of names for specific individual assessments that you
want to exclude. These names come from the default list of individual assessments that DMS
supports for the associated migration task. This task is specified by ReplicationTaskArn.
You can't set a value for Exclude if you also set a value for IncludeOnly in the API
operation. To identify the names of the default individual assessments that DMS supports
for the associated migration task, run the DescribeApplicableIndividualAssessments
operation using its own ReplicationTaskArn request parameter.
- `"IncludeOnly"`: Space-separated list of names for specific individual assessments that
you want to include. These names come from the default list of individual assessments that
DMS supports for the associated migration task. This task is specified by
ReplicationTaskArn. You can't set a value for IncludeOnly if you also set a value for
Exclude in the API operation. To identify the names of the default individual assessments
that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request
parameter.
- `"ResultEncryptionMode"`: Encryption mode that you can specify to encrypt the results of
this assessment run. If you don't specify this request parameter, DMS stores the assessment
run results without encryption. You can specify one of the options following: \"SSE_S3\"
– The server-side encryption provided as a default by Amazon S3. \"SSE_KMS\" – Key
Management Service (KMS) encryption. This encryption can use either a custom KMS encryption
key that you specify or the default KMS encryption key that DMS provides.
- `"ResultKmsKeyArn"`: ARN of a custom KMS encryption key that you specify when you set
ResultEncryptionMode to \"SSE_KMS\".
- `"ResultLocationFolder"`: Folder within an Amazon S3 bucket where you want DMS to store
the results of this assessment run.
"""
function start_replication_task_assessment_run(
AssessmentRunName,
ReplicationTaskArn,
ResultLocationBucket,
ServiceAccessRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartReplicationTaskAssessmentRun",
Dict{String,Any}(
"AssessmentRunName" => AssessmentRunName,
"ReplicationTaskArn" => ReplicationTaskArn,
"ResultLocationBucket" => ResultLocationBucket,
"ServiceAccessRoleArn" => ServiceAccessRoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_replication_task_assessment_run(
AssessmentRunName,
ReplicationTaskArn,
ResultLocationBucket,
ServiceAccessRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StartReplicationTaskAssessmentRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssessmentRunName" => AssessmentRunName,
"ReplicationTaskArn" => ReplicationTaskArn,
"ResultLocationBucket" => ResultLocationBucket,
"ServiceAccessRoleArn" => ServiceAccessRoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_replication(replication_config_arn)
stop_replication(replication_config_arn, params::Dict{String,<:Any})
For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS
Serverless replications. This command doesn't deprovision the stopped replications.
# Arguments
- `replication_config_arn`: The Amazon Resource Name of the replication to stop.
"""
function stop_replication(
ReplicationConfigArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"StopReplication",
Dict{String,Any}("ReplicationConfigArn" => ReplicationConfigArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_replication(
ReplicationConfigArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StopReplication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReplicationConfigArn" => ReplicationConfigArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_replication_task(replication_task_arn)
stop_replication_task(replication_task_arn, params::Dict{String,<:Any})
Stops the replication task.
# Arguments
- `replication_task_arn`: The Amazon Resource Name(ARN) of the replication task to be
stopped.
"""
function stop_replication_task(
ReplicationTaskArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"StopReplicationTask",
Dict{String,Any}("ReplicationTaskArn" => ReplicationTaskArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_replication_task(
ReplicationTaskArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"StopReplicationTask",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReplicationTaskArn" => ReplicationTaskArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_connection(endpoint_arn, replication_instance_arn)
test_connection(endpoint_arn, replication_instance_arn, params::Dict{String,<:Any})
Tests the connection between the replication instance and the endpoint.
# Arguments
- `endpoint_arn`: The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
- `replication_instance_arn`: The Amazon Resource Name (ARN) of the replication instance.
"""
function test_connection(
EndpointArn, ReplicationInstanceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"TestConnection",
Dict{String,Any}(
"EndpointArn" => EndpointArn, "ReplicationInstanceArn" => ReplicationInstanceArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_connection(
EndpointArn,
ReplicationInstanceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return database_migration_service(
"TestConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointArn" => EndpointArn,
"ReplicationInstanceArn" => ReplicationInstanceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_subscriptions_to_event_bridge()
update_subscriptions_to_event_bridge(params::Dict{String,<:Any})
Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to
corresponding Amazon EventBridge rules. By default, this operation migrates subscriptions
only when all your replication instance versions are 3.4.5 or higher. If any replication
instances are from versions earlier than 3.4.5, the operation raises an error and tells you
to upgrade these instances to version 3.4.5 or higher. To enable migration regardless of
version, set the Force option to true. However, if you don't upgrade instances earlier than
version 3.4.5, some types of events might not be available when you use Amazon EventBridge.
To call this operation, make sure that you have certain permissions added to your user
account. For more information, see Migrating event subscriptions to Amazon EventBridge in
the Amazon Web Services Database Migration Service User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForceMove"`: When set to true, this operation migrates DMS subscriptions for Amazon SNS
notifications no matter what your replication instance version is. If not set or set to
false, this operation runs only when all your replication instances are from DMS version
3.4.5 or higher.
"""
function update_subscriptions_to_event_bridge(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"UpdateSubscriptionsToEventBridge";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_subscriptions_to_event_bridge(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return database_migration_service(
"UpdateSubscriptionsToEventBridge",
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 | 53280 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: databrew
using AWS.Compat
using AWS.UUIDs
"""
batch_delete_recipe_version(recipe_versions, name)
batch_delete_recipe_version(recipe_versions, name, params::Dict{String,<:Any})
Deletes one or more versions of a recipe at a time. The entire request will be rejected if:
The recipe does not exist. There is an invalid version identifier in the list of
versions. The version list is empty. The version list size exceeds 50. The version
list contains duplicate entries. The request will complete successfully, but with partial
failures, if: A version does not exist. A version is being used by a job. You specify
LATEST_WORKING, but it's being used by a project. The version fails to be deleted. The
LATEST_WORKING version will only be deleted if the recipe has no other versions. If you try
to delete LATEST_WORKING while other versions exist (or if they can't be deleted), then
LATEST_WORKING will be listed as partial failure in the response.
# Arguments
- `recipe_versions`: An array of version identifiers, for the recipe versions to be
deleted. You can specify numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not
supported.
- `name`: The name of the recipe whose versions are to be deleted.
"""
function batch_delete_recipe_version(
RecipeVersions, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"POST",
"/recipes/$(name)/batchDeleteRecipeVersion",
Dict{String,Any}("RecipeVersions" => RecipeVersions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_recipe_version(
RecipeVersions,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/recipes/$(name)/batchDeleteRecipeVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RecipeVersions" => RecipeVersions), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset(input, name)
create_dataset(input, name, params::Dict{String,<:Any})
Creates a new DataBrew dataset.
# Arguments
- `input`:
- `name`: The name of the dataset to be created. Valid characters are alphanumeric (A-Z,
a-z, 0-9), hyphen (-), period (.), and space.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Format"`: The file format of a dataset that is created from an Amazon S3 file or folder.
- `"FormatOptions"`:
- `"PathOptions"`: A set of options that defines how DataBrew interprets an Amazon S3 path
of the dataset.
- `"Tags"`: Metadata tags to apply to this dataset.
"""
function create_dataset(Input, Name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"POST",
"/datasets",
Dict{String,Any}("Input" => Input, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset(
Input,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/datasets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Input" => Input, "Name" => Name), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_profile_job(dataset_name, name, output_location, role_arn)
create_profile_job(dataset_name, name, output_location, role_arn, params::Dict{String,<:Any})
Creates a new job to analyze a dataset and create its data profile.
# Arguments
- `dataset_name`: The name of the dataset that this job is to act upon.
- `name`: The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z,
0-9), hyphen (-), period (.), and space.
- `output_location`:
- `role_arn`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
role to be assumed when DataBrew runs the job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Configuration"`: Configuration for profile jobs. Used to select columns, do
evaluations, and override default parameters of evaluations. When configuration is null,
the profile job will run with default settings.
- `"EncryptionKeyArn"`: The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
- `"EncryptionMode"`: The encryption mode for the job, which can be one of the following:
SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys. SSE-S3 - Server-side
encryption with keys managed by Amazon S3.
- `"JobSample"`: Sample configuration for profile jobs only. Determines the number of rows
on which the profile job will be executed. If a JobSample value is not provided, the
default value will be used. The default value is CUSTOM_ROWS for the mode parameter and
20000 for the size parameter.
- `"LogSubscription"`: Enables or disables Amazon CloudWatch logging for the job. If
logging is enabled, CloudWatch writes one log stream for each job run.
- `"MaxCapacity"`: The maximum number of nodes that DataBrew can use when the job processes
data.
- `"MaxRetries"`: The maximum number of times to retry the job after a job run fails.
- `"Tags"`: Metadata tags to apply to this job.
- `"Timeout"`: The job's timeout in minutes. A job that attempts to run longer than this
timeout period ends with a status of TIMEOUT.
- `"ValidationConfigurations"`: List of validation configurations that are applied to the
profile job.
"""
function create_profile_job(
DatasetName,
Name,
OutputLocation,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/profileJobs",
Dict{String,Any}(
"DatasetName" => DatasetName,
"Name" => Name,
"OutputLocation" => OutputLocation,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_profile_job(
DatasetName,
Name,
OutputLocation,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/profileJobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatasetName" => DatasetName,
"Name" => Name,
"OutputLocation" => OutputLocation,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project(dataset_name, name, recipe_name, role_arn)
create_project(dataset_name, name, recipe_name, role_arn, params::Dict{String,<:Any})
Creates a new DataBrew project.
# Arguments
- `dataset_name`: The name of an existing dataset to associate this project with.
- `name`: A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z,
0-9), hyphen (-), period (.), and space.
- `recipe_name`: The name of an existing recipe to associate with the project.
- `role_arn`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
role to be assumed for this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Sample"`:
- `"Tags"`: Metadata tags to apply to this project.
"""
function create_project(
DatasetName,
Name,
RecipeName,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/projects",
Dict{String,Any}(
"DatasetName" => DatasetName,
"Name" => Name,
"RecipeName" => RecipeName,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project(
DatasetName,
Name,
RecipeName,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/projects",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatasetName" => DatasetName,
"Name" => Name,
"RecipeName" => RecipeName,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_recipe(name, steps)
create_recipe(name, steps, params::Dict{String,<:Any})
Creates a new DataBrew recipe.
# Arguments
- `name`: A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9),
hyphen (-), period (.), and space.
- `steps`: An array containing the steps to be performed by the recipe. Each recipe step
consists of one recipe action and (optionally) an array of condition expressions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the recipe.
- `"Tags"`: Metadata tags to apply to this recipe.
"""
function create_recipe(Name, Steps; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"POST",
"/recipes",
Dict{String,Any}("Name" => Name, "Steps" => Steps);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_recipe(
Name,
Steps,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/recipes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Name" => Name, "Steps" => Steps), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_recipe_job(name, role_arn)
create_recipe_job(name, role_arn, params::Dict{String,<:Any})
Creates a new job to transform input data, using steps defined in an existing Glue DataBrew
recipe
# Arguments
- `name`: A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9),
hyphen (-), period (.), and space.
- `role_arn`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
role to be assumed when DataBrew runs the job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataCatalogOutputs"`: One or more artifacts that represent the Glue Data Catalog output
from running the job.
- `"DatabaseOutputs"`: Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write to.
- `"DatasetName"`: The name of the dataset that this job processes.
- `"EncryptionKeyArn"`: The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
- `"EncryptionMode"`: The encryption mode for the job, which can be one of the following:
SSE-KMS - Server-side encryption with keys managed by KMS. SSE-S3 - Server-side
encryption with keys managed by Amazon S3.
- `"LogSubscription"`: Enables or disables Amazon CloudWatch logging for the job. If
logging is enabled, CloudWatch writes one log stream for each job run.
- `"MaxCapacity"`: The maximum number of nodes that DataBrew can consume when the job
processes data.
- `"MaxRetries"`: The maximum number of times to retry the job after a job run fails.
- `"Outputs"`: One or more artifacts that represent the output from running the job.
- `"ProjectName"`: Either the name of an existing project, or a combination of a recipe and
a dataset to associate with the recipe.
- `"RecipeReference"`:
- `"Tags"`: Metadata tags to apply to this job.
- `"Timeout"`: The job's timeout in minutes. A job that attempts to run longer than this
timeout period ends with a status of TIMEOUT.
"""
function create_recipe_job(Name, RoleArn; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"POST",
"/recipeJobs",
Dict{String,Any}("Name" => Name, "RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_recipe_job(
Name,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/recipeJobs",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Name" => Name, "RoleArn" => RoleArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ruleset(name, rules, target_arn)
create_ruleset(name, rules, target_arn, params::Dict{String,<:Any})
Creates a new ruleset that can be used in a profile job to validate the data quality of a
dataset.
# Arguments
- `name`: The name of the ruleset to be created. Valid characters are alphanumeric (A-Z,
a-z, 0-9), hyphen (-), period (.), and space.
- `rules`: A list of rules that are defined with the ruleset. A rule includes one or more
checks to be validated on a DataBrew dataset.
- `target_arn`: The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is
associated with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the ruleset.
- `"Tags"`: Metadata tags to apply to the ruleset.
"""
function create_ruleset(
Name, Rules, TargetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"POST",
"/rulesets",
Dict{String,Any}("Name" => Name, "Rules" => Rules, "TargetArn" => TargetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ruleset(
Name,
Rules,
TargetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/rulesets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "Rules" => Rules, "TargetArn" => TargetArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_schedule(cron_expression, name)
create_schedule(cron_expression, name, params::Dict{String,<:Any})
Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date
and time, or at regular intervals.
# Arguments
- `cron_expression`: The date or dates and time or times when the jobs are to be run. For
more information, see Cron expressions in the Glue DataBrew Developer Guide.
- `name`: A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z,
0-9), hyphen (-), period (.), and space.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobNames"`: The name or names of one or more jobs to be run.
- `"Tags"`: Metadata tags to apply to this schedule.
"""
function create_schedule(
CronExpression, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"POST",
"/schedules",
Dict{String,Any}("CronExpression" => CronExpression, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_schedule(
CronExpression,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/schedules",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CronExpression" => CronExpression, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset(name)
delete_dataset(name, params::Dict{String,<:Any})
Deletes a dataset from DataBrew.
# Arguments
- `name`: The name of the dataset to be deleted.
"""
function delete_dataset(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"DELETE",
"/datasets/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dataset(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"DELETE",
"/datasets/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_job(name)
delete_job(name, params::Dict{String,<:Any})
Deletes the specified DataBrew job.
# Arguments
- `name`: The name of the job to be deleted.
"""
function delete_job(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"DELETE", "/jobs/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_job(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"DELETE",
"/jobs/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project(name)
delete_project(name, params::Dict{String,<:Any})
Deletes an existing DataBrew project.
# Arguments
- `name`: The name of the project to be deleted.
"""
function delete_project(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"DELETE",
"/projects/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"DELETE",
"/projects/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_recipe_version(name, recipe_version)
delete_recipe_version(name, recipe_version, params::Dict{String,<:Any})
Deletes a single version of a DataBrew recipe.
# Arguments
- `name`: The name of the recipe.
- `recipe_version`: The version of the recipe to be deleted. You can specify a numeric
versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported.
"""
function delete_recipe_version(
name, recipeVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"DELETE",
"/recipes/$(name)/recipeVersion/$(recipeVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_recipe_version(
name,
recipeVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"DELETE",
"/recipes/$(name)/recipeVersion/$(recipeVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ruleset(name)
delete_ruleset(name, params::Dict{String,<:Any})
Deletes a ruleset.
# Arguments
- `name`: The name of the ruleset to be deleted.
"""
function delete_ruleset(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"DELETE",
"/rulesets/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ruleset(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"DELETE",
"/rulesets/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_schedule(name)
delete_schedule(name, params::Dict{String,<:Any})
Deletes the specified DataBrew schedule.
# Arguments
- `name`: The name of the schedule to be deleted.
"""
function delete_schedule(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"DELETE",
"/schedules/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_schedule(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"DELETE",
"/schedules/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset(name)
describe_dataset(name, params::Dict{String,<:Any})
Returns the definition of a specific DataBrew dataset.
# Arguments
- `name`: The name of the dataset to be described.
"""
function describe_dataset(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET", "/datasets/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dataset(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET",
"/datasets/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job(name)
describe_job(name, params::Dict{String,<:Any})
Returns the definition of a specific DataBrew job.
# Arguments
- `name`: The name of the job to be described.
"""
function describe_job(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET", "/jobs/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_job(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET",
"/jobs/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job_run(name, run_id)
describe_job_run(name, run_id, params::Dict{String,<:Any})
Represents one run of a DataBrew job.
# Arguments
- `name`: The name of the job being processed during this run.
- `run_id`: The unique identifier of the job run.
"""
function describe_job_run(name, runId; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET",
"/jobs/$(name)/jobRun/$(runId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_job_run(
name,
runId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"GET",
"/jobs/$(name)/jobRun/$(runId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_project(name)
describe_project(name, params::Dict{String,<:Any})
Returns the definition of a specific DataBrew project.
# Arguments
- `name`: The name of the project to be described.
"""
function describe_project(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET", "/projects/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_project(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET",
"/projects/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_recipe(name)
describe_recipe(name, params::Dict{String,<:Any})
Returns the definition of a specific DataBrew recipe corresponding to a particular version.
# Arguments
- `name`: The name of the recipe to be described.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"recipeVersion"`: The recipe version identifier. If this parameter isn't specified, then
the latest published version is returned.
"""
function describe_recipe(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET", "/recipes/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_recipe(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET",
"/recipes/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ruleset(name)
describe_ruleset(name, params::Dict{String,<:Any})
Retrieves detailed information about the ruleset.
# Arguments
- `name`: The name of the ruleset to be described.
"""
function describe_ruleset(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET", "/rulesets/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_ruleset(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET",
"/rulesets/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_schedule(name)
describe_schedule(name, params::Dict{String,<:Any})
Returns the definition of a specific DataBrew schedule.
# Arguments
- `name`: The name of the schedule to be described.
"""
function describe_schedule(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET", "/schedules/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_schedule(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET",
"/schedules/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_datasets()
list_datasets(params::Dict{String,<:Any})
Lists all of the DataBrew datasets.
# 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 this request.
- `"nextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_datasets(; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET", "/datasets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_datasets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET", "/datasets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_job_runs(name)
list_job_runs(name, params::Dict{String,<:Any})
Lists all of the previous runs of a particular DataBrew job.
# Arguments
- `name`: The name of the 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 in this request.
- `"nextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_job_runs(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET",
"/jobs/$(name)/jobRuns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_job_runs(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET",
"/jobs/$(name)/jobRuns",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs()
list_jobs(params::Dict{String,<:Any})
Lists all of the DataBrew jobs that are defined.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datasetName"`: The name of a dataset. Using this parameter indicates to return only
those jobs that act on the specified dataset.
- `"maxResults"`: The maximum number of results to return in this request.
- `"nextToken"`: A token generated by DataBrew that specifies where to continue pagination
if a previous request was truncated. To get the next set of pages, pass in the NextToken
value from the response object of the previous page call.
- `"projectName"`: The name of a project. Using this parameter indicates to return only
those jobs that are associated with the specified project.
"""
function list_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return databrew("GET", "/jobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET", "/jobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_projects()
list_projects(params::Dict{String,<:Any})
Lists all of the DataBrew projects that are defined.
# 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 this request.
- `"nextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"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 databrew(
"GET", "/projects", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_recipe_versions(name)
list_recipe_versions(name, params::Dict{String,<:Any})
Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING.
# Arguments
- `name`: The name of the recipe for which to return version information.
# 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 this request.
- `"nextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_recipe_versions(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET",
"/recipeVersions",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_recipe_versions(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET",
"/recipeVersions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recipes()
list_recipes(params::Dict{String,<:Any})
Lists all of the DataBrew recipes that are defined.
# 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 this request.
- `"nextToken"`: The token returned by a previous call to retrieve the next set of results.
- `"recipeVersion"`: Return only those recipes with a version identifier of LATEST_WORKING
or LATEST_PUBLISHED. If RecipeVersion is omitted, ListRecipes returns all of the
LATEST_PUBLISHED recipe versions. Valid values: LATEST_WORKING | LATEST_PUBLISHED
"""
function list_recipes(; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET", "/recipes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_recipes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET", "/recipes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_rulesets()
list_rulesets(params::Dict{String,<:Any})
List all rulesets available in the current account or rulesets associated with a specific
resource (dataset).
# 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 this request.
- `"nextToken"`: A token generated by DataBrew that specifies where to continue pagination
if a previous request was truncated. To get the next set of pages, pass in the NextToken
value from the response object of the previous page call.
- `"targetArn"`: The Amazon Resource Name (ARN) of a resource (dataset). Using this
parameter indicates to return only those rulesets that are associated with the specified
resource.
"""
function list_rulesets(; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET", "/rulesets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rulesets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET", "/rulesets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_schedules()
list_schedules(params::Dict{String,<:Any})
Lists the DataBrew schedules that are defined.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"jobName"`: The name of the job that these schedules apply to.
- `"maxResults"`: The maximum number of results to return in this request.
- `"nextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_schedules(; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"GET", "/schedules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_schedules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"GET", "/schedules", 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 DataBrew resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) string that uniquely identifies the
DataBrew resource.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"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 databrew(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
publish_recipe(name)
publish_recipe(name, params::Dict{String,<:Any})
Publishes a new version of a DataBrew recipe.
# Arguments
- `name`: The name of the recipe to be published.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the recipe to be published, for this version of the
recipe.
"""
function publish_recipe(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"POST",
"/recipes/$(name)/publishRecipe";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function publish_recipe(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"POST",
"/recipes/$(name)/publishRecipe",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_project_session_action(name)
send_project_session_action(name, params::Dict{String,<:Any})
Performs a recipe step within an interactive DataBrew session that's currently open.
# Arguments
- `name`: The name of the project to apply the action to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientSessionId"`: A unique identifier for an interactive session that's currently open
and ready for work. The action will be performed on this session.
- `"Preview"`: If true, the result of the recipe step will be returned, but not applied.
- `"RecipeStep"`:
- `"StepIndex"`: The index from which to preview a step. This index is used to preview the
result of steps that have already been applied, so that the resulting view frame is from
earlier in the view frame stack.
- `"ViewFrame"`:
"""
function send_project_session_action(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"PUT",
"/projects/$(name)/sendProjectSessionAction";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_project_session_action(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"PUT",
"/projects/$(name)/sendProjectSessionAction",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_job_run(name)
start_job_run(name, params::Dict{String,<:Any})
Runs a DataBrew job.
# Arguments
- `name`: The name of the job to be run.
"""
function start_job_run(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"POST",
"/jobs/$(name)/startJobRun";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_job_run(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"POST",
"/jobs/$(name)/startJobRun",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_project_session(name)
start_project_session(name, params::Dict{String,<:Any})
Creates an interactive session, enabling you to manipulate data in a DataBrew project.
# Arguments
- `name`: The name of the project to act upon.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssumeControl"`: A value that, if true, enables you to take control of a session, even
if a different client is currently accessing the project.
"""
function start_project_session(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"PUT",
"/projects/$(name)/startProjectSession";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_project_session(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"PUT",
"/projects/$(name)/startProjectSession",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_job_run(name, run_id)
stop_job_run(name, run_id, params::Dict{String,<:Any})
Stops a particular run of a job.
# Arguments
- `name`: The name of the job to be stopped.
- `run_id`: The ID of the job run to be stopped.
"""
function stop_job_run(name, runId; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"POST",
"/jobs/$(name)/jobRun/$(runId)/stopJobRun";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_job_run(
name,
runId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"POST",
"/jobs/$(name)/jobRun/$(runId)/stopJobRun",
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 metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or
schedule.
# Arguments
- `resource_arn`: The DataBrew resource to which tags should be added. The value for this
parameter is an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a
project, or a recipe.
- `tags`: One or more tags to be assigned to the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"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 databrew(
"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 metadata tags from a DataBrew resource.
# Arguments
- `resource_arn`: A DataBrew resource from which you want to remove a tag or tags. The
value for this parameter is an Amazon Resource Name (ARN).
- `tag_keys`: The tag keys (names) of one or more tags to be removed.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"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 databrew(
"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_dataset(input, name)
update_dataset(input, name, params::Dict{String,<:Any})
Modifies the definition of an existing DataBrew dataset.
# Arguments
- `input`:
- `name`: The name of the dataset to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Format"`: The file format of a dataset that is created from an Amazon S3 file or folder.
- `"FormatOptions"`:
- `"PathOptions"`: A set of options that defines how DataBrew interprets an Amazon S3 path
of the dataset.
"""
function update_dataset(Input, name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"PUT",
"/datasets/$(name)",
Dict{String,Any}("Input" => Input);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dataset(
Input,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"PUT",
"/datasets/$(name)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Input" => Input), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_profile_job(output_location, role_arn, name)
update_profile_job(output_location, role_arn, name, params::Dict{String,<:Any})
Modifies the definition of an existing profile job.
# Arguments
- `output_location`:
- `role_arn`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
role to be assumed when DataBrew runs the job.
- `name`: The name of the job to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Configuration"`: Configuration for profile jobs. Used to select columns, do
evaluations, and override default parameters of evaluations. When configuration is null,
the profile job will run with default settings.
- `"EncryptionKeyArn"`: The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
- `"EncryptionMode"`: The encryption mode for the job, which can be one of the following:
SSE-KMS - Server-side encryption with keys managed by KMS. SSE-S3 - Server-side
encryption with keys managed by Amazon S3.
- `"JobSample"`: Sample configuration for Profile Jobs only. Determines the number of rows
on which the Profile job will be executed. If a JobSample value is not provided for profile
jobs, the default value will be used. The default value is CUSTOM_ROWS for the mode
parameter and 20000 for the size parameter.
- `"LogSubscription"`: Enables or disables Amazon CloudWatch logging for the job. If
logging is enabled, CloudWatch writes one log stream for each job run.
- `"MaxCapacity"`: The maximum number of compute nodes that DataBrew can use when the job
processes data.
- `"MaxRetries"`: The maximum number of times to retry the job after a job run fails.
- `"Timeout"`: The job's timeout in minutes. A job that attempts to run longer than this
timeout period ends with a status of TIMEOUT.
- `"ValidationConfigurations"`: List of validation configurations that are applied to the
profile job.
"""
function update_profile_job(
OutputLocation, RoleArn, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"PUT",
"/profileJobs/$(name)",
Dict{String,Any}("OutputLocation" => OutputLocation, "RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_profile_job(
OutputLocation,
RoleArn,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"PUT",
"/profileJobs/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("OutputLocation" => OutputLocation, "RoleArn" => RoleArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_project(role_arn, name)
update_project(role_arn, name, params::Dict{String,<:Any})
Modifies the definition of an existing DataBrew project.
# Arguments
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role to be assumed for this request.
- `name`: The name of the project to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Sample"`:
"""
function update_project(RoleArn, name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"PUT",
"/projects/$(name)",
Dict{String,Any}("RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_project(
RoleArn,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"PUT",
"/projects/$(name)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RoleArn" => RoleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_recipe(name)
update_recipe(name, params::Dict{String,<:Any})
Modifies the definition of the LATEST_WORKING version of a DataBrew recipe.
# Arguments
- `name`: The name of the recipe to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the recipe.
- `"Steps"`: One or more steps to be performed by the recipe. Each step consists of an
action, and the conditions under which the action should succeed.
"""
function update_recipe(name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"PUT", "/recipes/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_recipe(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"PUT",
"/recipes/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_recipe_job(role_arn, name)
update_recipe_job(role_arn, name, params::Dict{String,<:Any})
Modifies the definition of an existing DataBrew recipe job.
# Arguments
- `role_arn`: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
role to be assumed when DataBrew runs the job.
- `name`: The name of the job to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataCatalogOutputs"`: One or more artifacts that represent the Glue Data Catalog output
from running the job.
- `"DatabaseOutputs"`: Represents a list of JDBC database output objects which defines the
output destination for a DataBrew recipe job to write into.
- `"EncryptionKeyArn"`: The Amazon Resource Name (ARN) of an encryption key that is used to
protect the job.
- `"EncryptionMode"`: The encryption mode for the job, which can be one of the following:
SSE-KMS - Server-side encryption with keys managed by KMS. SSE-S3 - Server-side
encryption with keys managed by Amazon S3.
- `"LogSubscription"`: Enables or disables Amazon CloudWatch logging for the job. If
logging is enabled, CloudWatch writes one log stream for each job run.
- `"MaxCapacity"`: The maximum number of nodes that DataBrew can consume when the job
processes data.
- `"MaxRetries"`: The maximum number of times to retry the job after a job run fails.
- `"Outputs"`: One or more artifacts that represent the output from running the job.
- `"Timeout"`: The job's timeout in minutes. A job that attempts to run longer than this
timeout period ends with a status of TIMEOUT.
"""
function update_recipe_job(RoleArn, name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"PUT",
"/recipeJobs/$(name)",
Dict{String,Any}("RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_recipe_job(
RoleArn,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"PUT",
"/recipeJobs/$(name)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RoleArn" => RoleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ruleset(rules, name)
update_ruleset(rules, name, params::Dict{String,<:Any})
Updates specified ruleset.
# Arguments
- `rules`: A list of rules that are defined with the ruleset. A rule includes one or more
checks to be validated on a DataBrew dataset.
- `name`: The name of the ruleset to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the ruleset.
"""
function update_ruleset(Rules, name; aws_config::AbstractAWSConfig=global_aws_config())
return databrew(
"PUT",
"/rulesets/$(name)",
Dict{String,Any}("Rules" => Rules);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ruleset(
Rules,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"PUT",
"/rulesets/$(name)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Rules" => Rules), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_schedule(cron_expression, name)
update_schedule(cron_expression, name, params::Dict{String,<:Any})
Modifies the definition of an existing DataBrew schedule.
# Arguments
- `cron_expression`: The date or dates and time or times when the jobs are to be run. For
more information, see Cron expressions in the Glue DataBrew Developer Guide.
- `name`: The name of the schedule to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobNames"`: The name or names of one or more jobs to be run for this schedule.
"""
function update_schedule(
CronExpression, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return databrew(
"PUT",
"/schedules/$(name)",
Dict{String,Any}("CronExpression" => CronExpression);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_schedule(
CronExpression,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return databrew(
"PUT",
"/schedules/$(name)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CronExpression" => CronExpression), 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 | 34146 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: dataexchange
using AWS.Compat
using AWS.UUIDs
"""
cancel_job(job_id)
cancel_job(job_id, params::Dict{String,<:Any})
This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
# Arguments
- `job_id`: The unique identifier for a job.
"""
function cancel_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"DELETE",
"/v1/jobs/$(JobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"DELETE",
"/v1/jobs/$(JobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_set(asset_type, description, name)
create_data_set(asset_type, description, name, params::Dict{String,<:Any})
This operation creates a data set.
# Arguments
- `asset_type`: The type of asset that is added to a data set.
- `description`: A description for the data set. This value can be up to 16,348 characters
long.
- `name`: The name of the data set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A data set tag is an optional label that you can assign to a data set when you
create it. Each tag consists of a key and an optional value, both of which you define. When
you use tagging, you can also use tag-based access control in IAM policies to control
access to these data sets and revisions.
"""
function create_data_set(
AssetType, Description, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"POST",
"/v1/data-sets",
Dict{String,Any}(
"AssetType" => AssetType, "Description" => Description, "Name" => Name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_set(
AssetType,
Description,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"POST",
"/v1/data-sets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssetType" => AssetType, "Description" => Description, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_event_action(action, event)
create_event_action(action, event, params::Dict{String,<:Any})
This operation creates an event action.
# Arguments
- `action`: What occurs after a certain event.
- `event`: What occurs to start an action.
"""
function create_event_action(
Action, Event; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"POST",
"/v1/event-actions",
Dict{String,Any}("Action" => Action, "Event" => Event);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_event_action(
Action,
Event,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"POST",
"/v1/event-actions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Action" => Action, "Event" => Event), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job(details, type)
create_job(details, type, params::Dict{String,<:Any})
This operation creates a job.
# Arguments
- `details`: The details for the CreateJob request.
- `type`: The type of job to be created.
"""
function create_job(Details, Type; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"POST",
"/v1/jobs",
Dict{String,Any}("Details" => Details, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job(
Details,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"POST",
"/v1/jobs",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Details" => Details, "Type" => Type), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_revision(data_set_id)
create_revision(data_set_id, params::Dict{String,<:Any})
This operation creates a revision for a data set.
# Arguments
- `data_set_id`: The unique identifier for a data set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Comment"`: An optional comment about the revision.
- `"Tags"`: A revision tag is an optional label that you can assign to a revision when you
create it. Each tag consists of a key and an optional value, both of which you define. When
you use tagging, you can also use tag-based access control in IAM policies to control
access to these data sets and revisions.
"""
function create_revision(DataSetId; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"POST",
"/v1/data-sets/$(DataSetId)/revisions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_revision(
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"POST",
"/v1/data-sets/$(DataSetId)/revisions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_asset(asset_id, data_set_id, revision_id)
delete_asset(asset_id, data_set_id, revision_id, params::Dict{String,<:Any})
This operation deletes an asset.
# Arguments
- `asset_id`: The unique identifier for an asset.
- `data_set_id`: The unique identifier for a data set.
- `revision_id`: The unique identifier for a revision.
"""
function delete_asset(
AssetId, DataSetId, RevisionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"DELETE",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)/assets/$(AssetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_asset(
AssetId,
DataSetId,
RevisionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"DELETE",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)/assets/$(AssetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_set(data_set_id)
delete_data_set(data_set_id, params::Dict{String,<:Any})
This operation deletes a data set.
# Arguments
- `data_set_id`: The unique identifier for a data set.
"""
function delete_data_set(DataSetId; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"DELETE",
"/v1/data-sets/$(DataSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_set(
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"DELETE",
"/v1/data-sets/$(DataSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_action(event_action_id)
delete_event_action(event_action_id, params::Dict{String,<:Any})
This operation deletes the event action.
# Arguments
- `event_action_id`: The unique identifier for the event action.
"""
function delete_event_action(
EventActionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"DELETE",
"/v1/event-actions/$(EventActionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_action(
EventActionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"DELETE",
"/v1/event-actions/$(EventActionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_revision(data_set_id, revision_id)
delete_revision(data_set_id, revision_id, params::Dict{String,<:Any})
This operation deletes a revision.
# Arguments
- `data_set_id`: The unique identifier for a data set.
- `revision_id`: The unique identifier for a revision.
"""
function delete_revision(
DataSetId, RevisionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"DELETE",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_revision(
DataSetId,
RevisionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"DELETE",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_asset(asset_id, data_set_id, revision_id)
get_asset(asset_id, data_set_id, revision_id, params::Dict{String,<:Any})
This operation returns information about an asset.
# Arguments
- `asset_id`: The unique identifier for an asset.
- `data_set_id`: The unique identifier for a data set.
- `revision_id`: The unique identifier for a revision.
"""
function get_asset(
AssetId, DataSetId, RevisionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"GET",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)/assets/$(AssetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_asset(
AssetId,
DataSetId,
RevisionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"GET",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)/assets/$(AssetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_set(data_set_id)
get_data_set(data_set_id, params::Dict{String,<:Any})
This operation returns information about a data set.
# Arguments
- `data_set_id`: The unique identifier for a data set.
"""
function get_data_set(DataSetId; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"GET",
"/v1/data-sets/$(DataSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_set(
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"GET",
"/v1/data-sets/$(DataSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_event_action(event_action_id)
get_event_action(event_action_id, params::Dict{String,<:Any})
This operation retrieves information about an event action.
# Arguments
- `event_action_id`: The unique identifier for the event action.
"""
function get_event_action(EventActionId; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"GET",
"/v1/event-actions/$(EventActionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_event_action(
EventActionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"GET",
"/v1/event-actions/$(EventActionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job(job_id)
get_job(job_id, params::Dict{String,<:Any})
This operation returns information about a job.
# Arguments
- `job_id`: The unique identifier for a job.
"""
function get_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"GET", "/v1/jobs/$(JobId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"GET",
"/v1/jobs/$(JobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_revision(data_set_id, revision_id)
get_revision(data_set_id, revision_id, params::Dict{String,<:Any})
This operation returns information about a revision.
# Arguments
- `data_set_id`: The unique identifier for a data set.
- `revision_id`: The unique identifier for a revision.
"""
function get_revision(
DataSetId, RevisionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"GET",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_revision(
DataSetId,
RevisionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"GET",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_set_revisions(data_set_id)
list_data_set_revisions(data_set_id, params::Dict{String,<:Any})
This operation lists a data set's revisions sorted by CreatedAt in descending order.
# Arguments
- `data_set_id`: The unique identifier for a data set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results returned by a single call.
- `"nextToken"`: The token value retrieved from a previous call to access the next page of
results.
"""
function list_data_set_revisions(
DataSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"GET",
"/v1/data-sets/$(DataSetId)/revisions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_set_revisions(
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"GET",
"/v1/data-sets/$(DataSetId)/revisions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_sets()
list_data_sets(params::Dict{String,<:Any})
This operation lists your data sets. When listing by origin OWNED, results are sorted by
CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the
maxResults parameter is ignored.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results returned by a single call.
- `"nextToken"`: The token value retrieved from a previous call to access the next page of
results.
- `"origin"`: A property that defines the data set as OWNED by the account (for providers)
or ENTITLED to the account (for subscribers).
"""
function list_data_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"GET", "/v1/data-sets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_data_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"GET",
"/v1/data-sets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_event_actions()
list_event_actions(params::Dict{String,<:Any})
This operation lists your event actions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"eventSourceId"`: The unique identifier for the event source.
- `"maxResults"`: The maximum number of results returned by a single call.
- `"nextToken"`: The token value retrieved from a previous call to access the next page of
results.
"""
function list_event_actions(; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"GET", "/v1/event-actions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_event_actions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"GET",
"/v1/event-actions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs()
list_jobs(params::Dict{String,<:Any})
This operation lists your jobs sorted by CreatedAt in descending order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSetId"`: The unique identifier for a data set.
- `"maxResults"`: The maximum number of results returned by a single call.
- `"nextToken"`: The token value retrieved from a previous call to access the next page of
results.
- `"revisionId"`: The unique identifier for a revision.
"""
function list_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"GET", "/v1/jobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"GET", "/v1/jobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_revision_assets(data_set_id, revision_id)
list_revision_assets(data_set_id, revision_id, params::Dict{String,<:Any})
This operation lists a revision's assets sorted alphabetically in descending order.
# Arguments
- `data_set_id`: The unique identifier for a data set.
- `revision_id`: The unique identifier for a revision.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results returned by a single call.
- `"nextToken"`: The token value retrieved from a previous call to access the next page of
results.
"""
function list_revision_assets(
DataSetId, RevisionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"GET",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)/assets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_revision_assets(
DataSetId,
RevisionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"GET",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)/assets",
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})
This operation lists the tags on the resource.
# Arguments
- `resource_arn`: An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"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 dataexchange(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_revision(data_set_id, revision_id, revocation_comment)
revoke_revision(data_set_id, revision_id, revocation_comment, params::Dict{String,<:Any})
This operation revokes subscribers' access to a revision.
# Arguments
- `data_set_id`: The unique identifier for a data set.
- `revision_id`: The unique identifier for a revision.
- `revocation_comment`: A required comment to inform subscribers of the reason their access
to the revision was revoked.
"""
function revoke_revision(
DataSetId,
RevisionId,
RevocationComment;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"POST",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)/revoke",
Dict{String,Any}("RevocationComment" => RevocationComment);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_revision(
DataSetId,
RevisionId,
RevocationComment,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"POST",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)/revoke",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RevocationComment" => RevocationComment), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_api_asset(x-amzn-dataexchange-asset-id, x-amzn-dataexchange-data-set-id, x-amzn-dataexchange-revision-id)
send_api_asset(x-amzn-dataexchange-asset-id, x-amzn-dataexchange-data-set-id, x-amzn-dataexchange-revision-id, params::Dict{String,<:Any})
This operation invokes an API Gateway API asset. The request is proxied to the provider’s
API Gateway API.
# Arguments
- `x-amzn-dataexchange-asset-id`: Asset ID value for the API request.
- `x-amzn-dataexchange-data-set-id`: Data set ID value for the API request.
- `x-amzn-dataexchange-revision-id`: Revision ID value for the API request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Body"`: The request body.
- `"QueryStringParameters"`: Attach query string parameters to the end of the URI (for
example, /v1/examplePath?exampleParam=exampleValue).
- `"x-amzn-dataexchange-header-"`: Any header value prefixed with
x-amzn-dataexchange-header- will have that stripped before sending the Asset API request.
Use this when you want to override a header that AWS Data Exchange uses. Alternatively, you
can use the header without a prefix to the HTTP request.
- `"x-amzn-dataexchange-http-method"`: HTTP method value for the API request.
Alternatively, you can use the appropriate verb in your request.
- `"x-amzn-dataexchange-path"`: URI path value for the API request. Alternatively, you can
set the URI path directly by invoking /v1/{pathValue}.
"""
function send_api_asset(
x_amzn_dataexchange_asset_id,
x_amzn_dataexchange_data_set_id,
x_amzn_dataexchange_revision_id;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"POST",
"/v1",
Dict{String,Any}(
"headers" => Dict{String,Any}(
"x-amzn-dataexchange-asset-id" => x_amzn_dataexchange_asset_id,
"x-amzn-dataexchange-data-set-id" => x_amzn_dataexchange_data_set_id,
"x-amzn-dataexchange-revision-id" => x_amzn_dataexchange_revision_id,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_api_asset(
x_amzn_dataexchange_asset_id,
x_amzn_dataexchange_data_set_id,
x_amzn_dataexchange_revision_id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"POST",
"/v1",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}(
"x-amzn-dataexchange-asset-id" => x_amzn_dataexchange_asset_id,
"x-amzn-dataexchange-data-set-id" =>
x_amzn_dataexchange_data_set_id,
"x-amzn-dataexchange-revision-id" =>
x_amzn_dataexchange_revision_id,
),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_data_set_notification(data_set_id, type)
send_data_set_notification(data_set_id, type, params::Dict{String,<:Any})
The type of event associated with the data set.
# Arguments
- `data_set_id`: Affected data set of the notification.
- `type`: The type of the notification. Describing the kind of event the notification is
alerting you to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Idempotency key for the notification, this key allows us to deduplicate
notifications that are sent in quick succession erroneously.
- `"Comment"`: Free-form text field for providers to add information about their
notifications.
- `"Details"`: Extra details specific to this notification type.
- `"Scope"`: Affected scope of this notification such as the underlying resources affected
by the notification event.
"""
function send_data_set_notification(
DataSetId, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"POST",
"/v1/data-sets/$(DataSetId)/notification",
Dict{String,Any}("Type" => Type, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_data_set_notification(
DataSetId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"POST",
"/v1/data-sets/$(DataSetId)/notification",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Type" => Type, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_job(job_id)
start_job(job_id, params::Dict{String,<:Any})
This operation starts a job.
# Arguments
- `job_id`: The unique identifier for a job.
"""
function start_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"PATCH", "/v1/jobs/$(JobId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function start_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"PATCH",
"/v1/jobs/$(JobId)",
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})
This operation tags a resource.
# Arguments
- `resource_arn`: An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
- `tags`: A label that consists of a customer-defined key and an optional value.
"""
function tag_resource(ResourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"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 dataexchange(
"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})
This operation removes one or more tags from a resource.
# Arguments
- `resource_arn`: An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
- `tag_keys`: The key tags.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"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 dataexchange(
"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_asset(asset_id, data_set_id, name, revision_id)
update_asset(asset_id, data_set_id, name, revision_id, params::Dict{String,<:Any})
This operation updates an asset.
# Arguments
- `asset_id`: The unique identifier for an asset.
- `data_set_id`: The unique identifier for a data set.
- `name`: The name of the asset. When importing from Amazon S3, the Amazon S3 object key is
used as the asset name. When exporting to Amazon S3, the asset name is used as default
target Amazon S3 object key. When importing from Amazon API Gateway API, the API name is
used as the asset name. When importing from Amazon Redshift, the datashare name is used as
the asset name. When importing from AWS Lake Formation, the static values of \"Database(s)
included in the LF-tag policy\" or \"Table(s) included in LF-tag policy\" are used as the
name.
- `revision_id`: The unique identifier for a revision.
"""
function update_asset(
AssetId, DataSetId, Name, RevisionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"PATCH",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)/assets/$(AssetId)",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_asset(
AssetId,
DataSetId,
Name,
RevisionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"PATCH",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)/assets/$(AssetId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_set(data_set_id)
update_data_set(data_set_id, params::Dict{String,<:Any})
This operation updates a data set.
# Arguments
- `data_set_id`: The unique identifier for a data set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description for the data set.
- `"Name"`: The name of the data set.
"""
function update_data_set(DataSetId; aws_config::AbstractAWSConfig=global_aws_config())
return dataexchange(
"PATCH",
"/v1/data-sets/$(DataSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_set(
DataSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"PATCH",
"/v1/data-sets/$(DataSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_event_action(event_action_id)
update_event_action(event_action_id, params::Dict{String,<:Any})
This operation updates the event action.
# Arguments
- `event_action_id`: The unique identifier for the event action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Action"`: What occurs after a certain event.
"""
function update_event_action(
EventActionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"PATCH",
"/v1/event-actions/$(EventActionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_event_action(
EventActionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"PATCH",
"/v1/event-actions/$(EventActionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_revision(data_set_id, revision_id)
update_revision(data_set_id, revision_id, params::Dict{String,<:Any})
This operation updates a revision.
# Arguments
- `data_set_id`: The unique identifier for a data set.
- `revision_id`: The unique identifier for a revision.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Comment"`: An optional comment about the revision.
- `"Finalized"`: Finalizing a revision tells AWS Data Exchange that your changes to the
assets in the revision are complete. After it's in this read-only state, you can publish
the revision to your products.
"""
function update_revision(
DataSetId, RevisionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dataexchange(
"PATCH",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_revision(
DataSetId,
RevisionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dataexchange(
"PATCH",
"/v1/data-sets/$(DataSetId)/revisions/$(RevisionId)",
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 | 113755 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: datasync
using AWS.Compat
using AWS.UUIDs
"""
add_storage_system(agent_arns, client_token, credentials, server_configuration, system_type)
add_storage_system(agent_arns, client_token, credentials, server_configuration, system_type, params::Dict{String,<:Any})
Creates an Amazon Web Services resource for an on-premises storage system that you want
DataSync Discovery to collect information about.
# Arguments
- `agent_arns`: Specifies the Amazon Resource Name (ARN) of the DataSync agent that
connects to and reads from your on-premises storage system's management interface. You can
only specify one ARN.
- `client_token`: Specifies a client token to make sure requests with this API operation
are idempotent. If you don't specify a client token, DataSync generates one for you
automatically.
- `credentials`: Specifies the user name and password for accessing your on-premises
storage system's management interface.
- `server_configuration`: Specifies the server name and network port required to connect
with the management interface of your on-premises storage system.
- `system_type`: Specifies the type of on-premises storage system that you want DataSync
Discovery to collect information about. DataSync Discovery currently supports NetApp
Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CloudWatchLogGroupArn"`: Specifies the ARN of the Amazon CloudWatch log group for
monitoring and logging discovery job events.
- `"Name"`: Specifies a familiar name for your on-premises storage system.
- `"Tags"`: Specifies labels that help you categorize, filter, and search for your Amazon
Web Services resources. We recommend creating at least a name tag for your on-premises
storage system.
"""
function add_storage_system(
AgentArns,
ClientToken,
Credentials,
ServerConfiguration,
SystemType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"AddStorageSystem",
Dict{String,Any}(
"AgentArns" => AgentArns,
"ClientToken" => ClientToken,
"Credentials" => Credentials,
"ServerConfiguration" => ServerConfiguration,
"SystemType" => SystemType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_storage_system(
AgentArns,
ClientToken,
Credentials,
ServerConfiguration,
SystemType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"AddStorageSystem",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AgentArns" => AgentArns,
"ClientToken" => ClientToken,
"Credentials" => Credentials,
"ServerConfiguration" => ServerConfiguration,
"SystemType" => SystemType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_task_execution(task_execution_arn)
cancel_task_execution(task_execution_arn, params::Dict{String,<:Any})
Stops an DataSync task execution that's in progress. The transfer of some files are
abruptly interrupted. File contents that're transferred to the destination might be
incomplete or inconsistent with the source files. However, if you start a new task
execution using the same task and allow it to finish, file content on the destination will
be complete and consistent. This applies to other unexpected failures that interrupt a task
execution. In all of these cases, DataSync successfully completes the transfer when you
start the next task execution.
# Arguments
- `task_execution_arn`: The Amazon Resource Name (ARN) of the task execution to stop.
"""
function cancel_task_execution(
TaskExecutionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"CancelTaskExecution",
Dict{String,Any}("TaskExecutionArn" => TaskExecutionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_task_execution(
TaskExecutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CancelTaskExecution",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TaskExecutionArn" => TaskExecutionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_agent(activation_key)
create_agent(activation_key, params::Dict{String,<:Any})
Activates an DataSync agent that you've deployed in your storage environment. The
activation process associates the agent with your Amazon Web Services account. If you
haven't deployed an agent yet, see the following topics to learn more: Agent
requirements Create an agent If you're transferring between Amazon Web Services
storage services, you don't need a DataSync agent.
# Arguments
- `activation_key`: Specifies your DataSync agent's activation key. If you don't have an
activation key, see Activate your agent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentName"`: Specifies a name for your agent. You can see this name in the DataSync
console.
- `"SecurityGroupArns"`: Specifies the Amazon Resource Name (ARN) of the security group
that protects your task's network interfaces when using a virtual private cloud (VPC)
endpoint. You can only specify one ARN.
- `"SubnetArns"`: Specifies the ARN of the subnet where you want to run your DataSync task
when using a VPC endpoint. This is the subnet where DataSync creates and manages the
network interfaces for your transfer. You can only specify one ARN.
- `"Tags"`: Specifies labels that help you categorize, filter, and search for your Amazon
Web Services resources. We recommend creating at least one tag for your agent.
- `"VpcEndpointId"`: Specifies the ID of the VPC endpoint that you want your agent to
connect to. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1. The VPC
endpoint you use must include the DataSync service name (for example,
com.amazonaws.us-east-2.datasync).
"""
function create_agent(ActivationKey; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"CreateAgent",
Dict{String,Any}("ActivationKey" => ActivationKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_agent(
ActivationKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateAgent",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ActivationKey" => ActivationKey), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_azure_blob(agent_arns, authentication_type, container_url)
create_location_azure_blob(agent_arns, authentication_type, container_url, params::Dict{String,<:Any})
Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use
this location as a transfer source or destination. Before you begin, make sure you know how
DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also
need a DataSync agent that can connect to your container.
# Arguments
- `agent_arns`: Specifies the Amazon Resource Name (ARN) of the DataSync agent that can
connect with your Azure Blob Storage container. You can specify more than one agent. For
more information, see Using multiple agents for your transfer.
- `authentication_type`: Specifies the authentication method DataSync uses to access your
Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
- `container_url`: Specifies the URL of the Azure Blob Storage container involved in your
transfer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessTier"`: Specifies the access tier that you want your objects or files transferred
into. This only applies when using the location as a transfer destination. For more
information, see Access tiers.
- `"BlobType"`: Specifies the type of blob that you want your objects or files to be when
transferring them into Azure Blob Storage. Currently, DataSync only supports moving data
into Azure Blob Storage as block blobs. For more information on blob types, see the Azure
Blob Storage documentation.
- `"SasConfiguration"`: Specifies the SAS configuration that allows DataSync to access your
Azure Blob Storage.
- `"Subdirectory"`: Specifies path segments if you want to limit your transfer to a virtual
directory in your container (for example, /my/images).
- `"Tags"`: Specifies labels that help you categorize, filter, and search for your Amazon
Web Services resources. We recommend creating at least a name tag for your transfer
location.
"""
function create_location_azure_blob(
AgentArns,
AuthenticationType,
ContainerUrl;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationAzureBlob",
Dict{String,Any}(
"AgentArns" => AgentArns,
"AuthenticationType" => AuthenticationType,
"ContainerUrl" => ContainerUrl,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_azure_blob(
AgentArns,
AuthenticationType,
ContainerUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationAzureBlob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AgentArns" => AgentArns,
"AuthenticationType" => AuthenticationType,
"ContainerUrl" => ContainerUrl,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_efs(ec2_config, efs_filesystem_arn)
create_location_efs(ec2_config, efs_filesystem_arn, params::Dict{String,<:Any})
Creates a transfer location for an Amazon EFS file system. DataSync can use this location
as a source or destination for transferring data. Before you begin, make sure that you
understand how DataSync accesses Amazon EFS file systems.
# Arguments
- `ec2_config`: Specifies the subnet and security groups DataSync uses to access your
Amazon EFS file system.
- `efs_filesystem_arn`: Specifies the ARN for the Amazon EFS file system.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessPointArn"`: Specifies the Amazon Resource Name (ARN) of the access point that
DataSync uses to access the Amazon EFS file system.
- `"FileSystemAccessRoleArn"`: Specifies an Identity and Access Management (IAM) role that
DataSync assumes when mounting the Amazon EFS file system.
- `"InTransitEncryption"`: Specifies whether you want DataSync to use Transport Layer
Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system. If
you specify an access point using AccessPointArn or an IAM role using
FileSystemAccessRoleArn, you must set this parameter to TLS1_2.
- `"Subdirectory"`: Specifies a mount path for your Amazon EFS file system. This is where
DataSync reads or writes data (depending on if this is a source or destination location).
By default, DataSync uses the root directory, but you can also include subdirectories. You
must specify a value with forward slashes (for example, /path/to/folder).
- `"Tags"`: Specifies the key-value pair that represents a tag that you want to add to the
resource. The value can be an empty string. This value helps you manage, filter, and search
for your resources. We recommend that you create a name tag for your location.
"""
function create_location_efs(
Ec2Config, EfsFilesystemArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"CreateLocationEfs",
Dict{String,Any}("Ec2Config" => Ec2Config, "EfsFilesystemArn" => EfsFilesystemArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_efs(
Ec2Config,
EfsFilesystemArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationEfs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Ec2Config" => Ec2Config, "EfsFilesystemArn" => EfsFilesystemArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_fsx_lustre(fsx_filesystem_arn, security_group_arns)
create_location_fsx_lustre(fsx_filesystem_arn, security_group_arns, params::Dict{String,<:Any})
Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this
location as a source or destination for transferring data. Before you begin, make sure that
you understand how DataSync accesses FSx for Lustre file systems.
# Arguments
- `fsx_filesystem_arn`: The Amazon Resource Name (ARN) for the FSx for Lustre file system.
- `security_group_arns`: The Amazon Resource Names (ARNs) of the security groups that are
used to configure the FSx for Lustre file system.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Subdirectory"`: A subdirectory in the location's path. This subdirectory in the FSx for
Lustre file system is used to read data from the FSx for Lustre source location or write
data to the FSx for Lustre destination.
- `"Tags"`: The key-value pair that represents a tag that you want to add to the resource.
The value can be an empty string. This value helps you manage, filter, and search for your
resources. We recommend that you create a name tag for your location.
"""
function create_location_fsx_lustre(
FsxFilesystemArn, SecurityGroupArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"CreateLocationFsxLustre",
Dict{String,Any}(
"FsxFilesystemArn" => FsxFilesystemArn, "SecurityGroupArns" => SecurityGroupArns
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_fsx_lustre(
FsxFilesystemArn,
SecurityGroupArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationFsxLustre",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FsxFilesystemArn" => FsxFilesystemArn,
"SecurityGroupArns" => SecurityGroupArns,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_fsx_ontap(protocol, security_group_arns, storage_virtual_machine_arn)
create_location_fsx_ontap(protocol, security_group_arns, storage_virtual_machine_arn, params::Dict{String,<:Any})
Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can
use this location as a source or destination for transferring data. Before you begin, make
sure that you understand how DataSync accesses FSx for ONTAP file systems.
# Arguments
- `protocol`:
- `security_group_arns`: Specifies the Amazon EC2 security groups that provide access to
your file system's preferred subnet. The security groups must allow outbound traffic on the
following ports (depending on the protocol you use): Network File System (NFS): TCP
ports 111, 635, and 2049 Server Message Block (SMB): TCP port 445 Your file system's
security groups must also allow inbound traffic on the same ports.
- `storage_virtual_machine_arn`: Specifies the ARN of the storage virtual machine (SVM) in
your file system where you want to copy data to or from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Subdirectory"`: Specifies a path to the file share in the SVM where you'll copy your
data. You can specify a junction path (also known as a mount point), qtree path (for NFS
file shares), or share name (for SMB file shares). For example, your mount path might be
/vol1, /vol1/tree1, or /share1. Don't specify a junction path in the SVM's root volume.
For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx
for NetApp ONTAP User Guide.
- `"Tags"`: Specifies labels that help you categorize, filter, and search for your Amazon
Web Services resources. We recommend creating at least a name tag for your location.
"""
function create_location_fsx_ontap(
Protocol,
SecurityGroupArns,
StorageVirtualMachineArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationFsxOntap",
Dict{String,Any}(
"Protocol" => Protocol,
"SecurityGroupArns" => SecurityGroupArns,
"StorageVirtualMachineArn" => StorageVirtualMachineArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_fsx_ontap(
Protocol,
SecurityGroupArns,
StorageVirtualMachineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationFsxOntap",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Protocol" => Protocol,
"SecurityGroupArns" => SecurityGroupArns,
"StorageVirtualMachineArn" => StorageVirtualMachineArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_fsx_open_zfs(fsx_filesystem_arn, protocol, security_group_arns)
create_location_fsx_open_zfs(fsx_filesystem_arn, protocol, security_group_arns, params::Dict{String,<:Any})
Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use
this location as a source or destination for transferring data. Before you begin, make sure
that you understand how DataSync accesses FSx for OpenZFS file systems. Request parameters
related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.
# Arguments
- `fsx_filesystem_arn`: The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
- `protocol`: The type of protocol that DataSync uses to access your file system.
- `security_group_arns`: The ARNs of the security groups that are used to configure the FSx
for OpenZFS file system.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Subdirectory"`: A subdirectory in the location's path that must begin with /fsx.
DataSync uses this subdirectory to read or write data (depending on whether the file system
is a source or destination location).
- `"Tags"`: The key-value pair that represents a tag that you want to add to the resource.
The value can be an empty string. This value helps you manage, filter, and search for your
resources. We recommend that you create a name tag for your location.
"""
function create_location_fsx_open_zfs(
FsxFilesystemArn,
Protocol,
SecurityGroupArns;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationFsxOpenZfs",
Dict{String,Any}(
"FsxFilesystemArn" => FsxFilesystemArn,
"Protocol" => Protocol,
"SecurityGroupArns" => SecurityGroupArns,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_fsx_open_zfs(
FsxFilesystemArn,
Protocol,
SecurityGroupArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationFsxOpenZfs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FsxFilesystemArn" => FsxFilesystemArn,
"Protocol" => Protocol,
"SecurityGroupArns" => SecurityGroupArns,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_fsx_windows(fsx_filesystem_arn, password, security_group_arns, user)
create_location_fsx_windows(fsx_filesystem_arn, password, security_group_arns, user, params::Dict{String,<:Any})
Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync
can use this location as a source or destination for transferring data. Before you begin,
make sure that you understand how DataSync accesses FSx for Windows File Server file
systems.
# Arguments
- `fsx_filesystem_arn`: Specifies the Amazon Resource Name (ARN) for the FSx for Windows
File Server file system.
- `password`: Specifies the password of the user with the permissions to mount and access
the files, folders, and file metadata in your FSx for Windows File Server file system.
- `security_group_arns`: Specifies the ARNs of the security groups that provide access to
your file system's preferred subnet. If you choose a security group that doesn't allow
connections from within itself, do one of the following: Configure the security group to
allow it to communicate within itself. Choose a different security group that can
communicate with the mount target's security group.
- `user`: Specifies the user with the permissions to mount and access the files, folders,
and file metadata in your FSx for Windows File Server file system. For information about
choosing a user with the right level of access for your transfer, see required permissions
for FSx for Windows File Server locations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Domain"`: Specifies the name of the Microsoft Active Directory domain that the FSx for
Windows File Server file system belongs to. If you have multiple Active Directory domains
in your environment, configuring this parameter makes sure that DataSync connects to the
right file system.
- `"Subdirectory"`: Specifies a mount path for your file system using forward slashes. This
is where DataSync reads or writes data (depending on if this is a source or destination
location).
- `"Tags"`: Specifies labels that help you categorize, filter, and search for your Amazon
Web Services resources. We recommend creating at least a name tag for your location.
"""
function create_location_fsx_windows(
FsxFilesystemArn,
Password,
SecurityGroupArns,
User;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationFsxWindows",
Dict{String,Any}(
"FsxFilesystemArn" => FsxFilesystemArn,
"Password" => Password,
"SecurityGroupArns" => SecurityGroupArns,
"User" => User,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_fsx_windows(
FsxFilesystemArn,
Password,
SecurityGroupArns,
User,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationFsxWindows",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FsxFilesystemArn" => FsxFilesystemArn,
"Password" => Password,
"SecurityGroupArns" => SecurityGroupArns,
"User" => User,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_hdfs(agent_arns, authentication_type, name_nodes)
create_location_hdfs(agent_arns, authentication_type, name_nodes, params::Dict{String,<:Any})
Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use
this location as a source or destination for transferring data. Before you begin, make sure
that you understand how DataSync accesses HDFS clusters.
# Arguments
- `agent_arns`: The Amazon Resource Names (ARNs) of the agents that are used to connect to
the HDFS cluster.
- `authentication_type`: The type of authentication used to determine the identity of the
user.
- `name_nodes`: The NameNode that manages the HDFS namespace. The NameNode performs
operations such as opening, closing, and renaming files and directories. The NameNode
contains the information to map blocks of data to the DataNodes. You can use only one
NameNode.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BlockSize"`: The size of data blocks to write into the HDFS cluster. The block size
must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).
- `"KerberosKeytab"`: The Kerberos key table (keytab) that contains mappings between the
defined Kerberos principal and the encrypted keys. You can load the keytab from a file by
providing the file's address. If you're using the CLI, it performs base64 encoding for you.
Otherwise, provide the base64-encoded text. If KERBEROS is specified for
AuthenticationType, this parameter is required.
- `"KerberosKrb5Conf"`: The krb5.conf file that contains the Kerberos configuration
information. You can load the krb5.conf file by providing the file's address. If you're
using the CLI, it performs the base64 encoding for you. Otherwise, provide the
base64-encoded text. If KERBEROS is specified for AuthenticationType, this parameter is
required.
- `"KerberosPrincipal"`: The Kerberos principal with access to the files and folders on the
HDFS cluster. If KERBEROS is specified for AuthenticationType, this parameter is
required.
- `"KmsKeyProviderUri"`: The URI of the HDFS cluster's Key Management Server (KMS).
- `"QopConfiguration"`: The Quality of Protection (QOP) configuration specifies the Remote
Procedure Call (RPC) and data transfer protection settings configured on the Hadoop
Distributed File System (HDFS) cluster. If QopConfiguration isn't specified, RpcProtection
and DataTransferProtection default to PRIVACY. If you set RpcProtection or
DataTransferProtection, the other parameter assumes the same value.
- `"ReplicationFactor"`: The number of DataNodes to replicate the data to when writing to
the HDFS cluster. By default, data is replicated to three DataNodes.
- `"SimpleUser"`: The user name used to identify the client on the host operating system.
If SIMPLE is specified for AuthenticationType, this parameter is required.
- `"Subdirectory"`: A subdirectory in the HDFS cluster. This subdirectory is used to read
data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will
default to /.
- `"Tags"`: The key-value pair that represents the tag that you want to add to the
location. The value can be an empty string. We recommend using tags to name your resources.
"""
function create_location_hdfs(
AgentArns,
AuthenticationType,
NameNodes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationHdfs",
Dict{String,Any}(
"AgentArns" => AgentArns,
"AuthenticationType" => AuthenticationType,
"NameNodes" => NameNodes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_hdfs(
AgentArns,
AuthenticationType,
NameNodes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationHdfs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AgentArns" => AgentArns,
"AuthenticationType" => AuthenticationType,
"NameNodes" => NameNodes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_nfs(on_prem_config, server_hostname, subdirectory)
create_location_nfs(on_prem_config, server_hostname, subdirectory, params::Dict{String,<:Any})
Creates a transfer location for a Network File System (NFS) file server. DataSync can use
this location as a source or destination for transferring data. Before you begin, make sure
that you understand how DataSync accesses NFS file servers. If you're copying data to or
from an Snowcone device, you can also use CreateLocationNfs to create your transfer
location. For more information, see Configuring transfers with Snowcone.
# Arguments
- `on_prem_config`: Specifies the Amazon Resource Name (ARN) of the DataSync agent that
want to connect to your NFS file server. You can specify more than one agent. For more
information, see Using multiple agents for transfers.
- `server_hostname`: Specifies the Domain Name System (DNS) name or IP version 4 address of
the NFS file server that your DataSync agent connects to.
- `subdirectory`: Specifies the export path in your NFS file server that you want DataSync
to mount. This path (or a subdirectory of the path) is where DataSync transfers data to or
from. For information on configuring an export for DataSync, see Accessing NFS file servers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MountOptions"`: Specifies the options that DataSync can use to mount your NFS file
server.
- `"Tags"`: Specifies labels that help you categorize, filter, and search for your Amazon
Web Services resources. We recommend creating at least a name tag for your location.
"""
function create_location_nfs(
OnPremConfig,
ServerHostname,
Subdirectory;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationNfs",
Dict{String,Any}(
"OnPremConfig" => OnPremConfig,
"ServerHostname" => ServerHostname,
"Subdirectory" => Subdirectory,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_nfs(
OnPremConfig,
ServerHostname,
Subdirectory,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationNfs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OnPremConfig" => OnPremConfig,
"ServerHostname" => ServerHostname,
"Subdirectory" => Subdirectory,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_object_storage(agent_arns, bucket_name, server_hostname)
create_location_object_storage(agent_arns, bucket_name, server_hostname, params::Dict{String,<:Any})
Creates a transfer location for an object storage system. DataSync can use this location as
a source or destination for transferring data. Before you begin, make sure that you
understand the prerequisites for DataSync to work with object storage systems.
# Arguments
- `agent_arns`: Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can
securely connect with your location.
- `bucket_name`: Specifies the name of the object storage bucket involved in the transfer.
- `server_hostname`: Specifies the domain name or IP address of the object storage server.
A DataSync agent uses this hostname to mount the object storage server in a network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessKey"`: Specifies the access key (for example, a user name) if credentials are
required to authenticate with the object storage server.
- `"SecretKey"`: Specifies the secret key (for example, a password) if credentials are
required to authenticate with the object storage server.
- `"ServerCertificate"`: Specifies a certificate chain for DataSync to authenticate with
your object storage system if the system uses a private or self-signed certificate
authority (CA). You must specify a single .pem file with a full certificate chain (for
example, file:///home/user/.ssh/object_storage_certificates.pem). The certificate chain
might include: The object storage system's certificate All intermediate certificates
(if there are any) The root certificate of the signing CA You can concatenate your
certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The
following example cat command creates an object_storage_certificates.pem file that includes
three certificates: cat object_server_certificate.pem intermediate_certificate.pem
ca_root_certificate.pem > object_storage_certificates.pem To use this parameter,
configure ServerProtocol to HTTPS.
- `"ServerPort"`: Specifies the port that your object storage server accepts inbound
network traffic on (for example, port 443).
- `"ServerProtocol"`: Specifies the protocol that your object storage server uses to
communicate.
- `"Subdirectory"`: Specifies the object prefix for your object storage server. If this is
a source location, DataSync only copies objects with this prefix. If this is a destination
location, DataSync writes all objects with this prefix.
- `"Tags"`: Specifies the key-value pair that represents a tag that you want to add to the
resource. Tags can help you manage, filter, and search for your resources. We recommend
creating a name tag for your location.
"""
function create_location_object_storage(
AgentArns, BucketName, ServerHostname; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"CreateLocationObjectStorage",
Dict{String,Any}(
"AgentArns" => AgentArns,
"BucketName" => BucketName,
"ServerHostname" => ServerHostname,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_object_storage(
AgentArns,
BucketName,
ServerHostname,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationObjectStorage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AgentArns" => AgentArns,
"BucketName" => BucketName,
"ServerHostname" => ServerHostname,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_s3(s3_bucket_arn, s3_config)
create_location_s3(s3_bucket_arn, s3_config, params::Dict{String,<:Any})
Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a
source or destination for transferring data. Before you begin, make sure that you read the
following topics: Storage class considerations with Amazon S3 locations Evaluating
S3 request costs when using DataSync For more information, see Configuring transfers
with Amazon S3.
# Arguments
- `s3_bucket_arn`: Specifies the ARN of the S3 bucket that you want to use as a location.
(When creating your DataSync task later, you specify whether this location is a transfer
source or destination.) If your S3 bucket is located on an Outposts resource, you must
specify an Amazon S3 access point. For more information, see Managing data access with
Amazon S3 access points in the Amazon S3 User Guide.
- `s3_config`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentArns"`: (Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of
the DataSync agent on your Outpost. For more information, see Deploy your DataSync agent on
Outposts.
- `"S3StorageClass"`: Specifies the storage class that you want your objects to use when
Amazon S3 is a transfer destination. For buckets in Amazon Web Services Regions, the
storage class defaults to STANDARD. For buckets on Outposts, the storage class defaults to
OUTPOSTS. For more information, see Storage class considerations with Amazon S3 transfers.
- `"Subdirectory"`: Specifies a prefix in the S3 bucket that DataSync reads from or writes
to (depending on whether the bucket is a source or destination location). DataSync can't
transfer objects with a prefix that begins with a slash (/) or includes //, /./, or /../
patterns. For example: /photos photos//2006/January photos/./2006/February
photos/../2006/March
- `"Tags"`: Specifies labels that help you categorize, filter, and search for your Amazon
Web Services resources. We recommend creating at least a name tag for your transfer
location.
"""
function create_location_s3(
S3BucketArn, S3Config; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"CreateLocationS3",
Dict{String,Any}("S3BucketArn" => S3BucketArn, "S3Config" => S3Config);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_s3(
S3BucketArn,
S3Config,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationS3",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("S3BucketArn" => S3BucketArn, "S3Config" => S3Config),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location_smb(agent_arns, password, server_hostname, subdirectory, user)
create_location_smb(agent_arns, password, server_hostname, subdirectory, user, params::Dict{String,<:Any})
Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use
this location as a source or destination for transferring data. Before you begin, make sure
that you understand how DataSync accesses SMB file servers.
# Arguments
- `agent_arns`: Specifies the DataSync agent (or agents) which you want to connect to your
SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
- `password`: Specifies the password of the user who can mount your SMB file server and has
permission to access the files and folders involved in your transfer. For more information,
see required permissions for SMB locations.
- `server_hostname`: Specifies the Domain Name Service (DNS) name or IP address of the SMB
file server that your DataSync agent will mount. You can't specify an IP version 6 (IPv6)
address.
- `subdirectory`: Specifies the name of the share exported by your SMB file server where
DataSync will read or write data. You can include a subdirectory in the share path (for
example, /path/to/subdirectory). Make sure that other SMB clients in your network can also
mount this path. To copy all data in the subdirectory, DataSync must be able to mount the
SMB share and access all of its data. For more information, see required permissions for
SMB locations.
- `user`: Specifies the user that can mount and access the files, folders, and file
metadata in your SMB file server. For information about choosing a user with the right
level of access for your transfer, see required permissions for SMB locations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Domain"`: Specifies the name of the Active Directory domain that your SMB file server
belongs to. If you have multiple Active Directory domains in your environment, configuring
this parameter makes sure that DataSync connects to the right file server.
- `"MountOptions"`: Specifies the version of the SMB protocol that DataSync uses to access
your SMB file server.
- `"Tags"`: Specifies labels that help you categorize, filter, and search for your Amazon
Web Services resources. We recommend creating at least a name tag for your location.
"""
function create_location_smb(
AgentArns,
Password,
ServerHostname,
Subdirectory,
User;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationSmb",
Dict{String,Any}(
"AgentArns" => AgentArns,
"Password" => Password,
"ServerHostname" => ServerHostname,
"Subdirectory" => Subdirectory,
"User" => User,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location_smb(
AgentArns,
Password,
ServerHostname,
Subdirectory,
User,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateLocationSmb",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AgentArns" => AgentArns,
"Password" => Password,
"ServerHostname" => ServerHostname,
"Subdirectory" => Subdirectory,
"User" => User,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_task(destination_location_arn, source_location_arn)
create_task(destination_location_arn, source_location_arn, params::Dict{String,<:Any})
Configures a task, which defines where and how DataSync transfers your data. A task
includes a source location, destination location, and transfer options (such as bandwidth
limits, scheduling, and more). If you're planning to transfer data to or from an Amazon S3
location, review how DataSync can affect your S3 request charges and the DataSync pricing
page before you begin.
# Arguments
- `destination_location_arn`: Specifies the ARN of your transfer's destination location.
- `source_location_arn`: Specifies the ARN of your transfer's source location.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CloudWatchLogGroupArn"`: Specifies the Amazon Resource Name (ARN) of an Amazon
CloudWatch log group for monitoring your task.
- `"Excludes"`: Specifies exclude filters that define the files, objects, and folders in
your source location that you don't want DataSync to transfer. For more information and
examples, see Specifying what DataSync transfers by using filters.
- `"Includes"`: Specifies include filters define the files, objects, and folders in your
source location that you want DataSync to transfer. For more information and examples, see
Specifying what DataSync transfers by using filters.
- `"ManifestConfig"`: Configures a manifest, which is a list of files or objects that you
want DataSync to transfer. For more information and configuration examples, see Specifying
what DataSync transfers by using a manifest. When using this parameter, your caller
identity (the role that you're using DataSync with) must have the iam:PassRole permission.
The AWSDataSyncFullAccess policy includes this permission.
- `"Name"`: Specifies the name of your task.
- `"Options"`: Specifies your task's settings, such as preserving file metadata, verifying
data integrity, among other options.
- `"Schedule"`: Specifies a schedule for when you want your task to run. For more
information, see Scheduling your task.
- `"Tags"`: Specifies the tags that you want to apply to your task. Tags are key-value
pairs that help you manage, filter, and search for your DataSync resources.
- `"TaskReportConfig"`: Specifies how you want to configure a task report, which provides
detailed information about your DataSync transfer. For more information, see Monitoring
your DataSync transfers with task reports. When using this parameter, your caller identity
(the role that you're using DataSync with) must have the iam:PassRole permission. The
AWSDataSyncFullAccess policy includes this permission.
"""
function create_task(
DestinationLocationArn,
SourceLocationArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateTask",
Dict{String,Any}(
"DestinationLocationArn" => DestinationLocationArn,
"SourceLocationArn" => SourceLocationArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_task(
DestinationLocationArn,
SourceLocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"CreateTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationLocationArn" => DestinationLocationArn,
"SourceLocationArn" => SourceLocationArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_agent(agent_arn)
delete_agent(agent_arn, params::Dict{String,<:Any})
Removes an DataSync agent resource from your Amazon Web Services account. Keep in mind that
this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or
Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or
instance from your storage environment or reuse it to activate a new agent.
# Arguments
- `agent_arn`: The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents
operation to return a list of agents for your account and Amazon Web Services Region.
"""
function delete_agent(AgentArn; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"DeleteAgent",
Dict{String,Any}("AgentArn" => AgentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_agent(
AgentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DeleteAgent",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AgentArn" => AgentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_location(location_arn)
delete_location(location_arn, params::Dict{String,<:Any})
Deletes a transfer location resource from DataSync.
# Arguments
- `location_arn`: The Amazon Resource Name (ARN) of the location to delete.
"""
function delete_location(LocationArn; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"DeleteLocation",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_location(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DeleteLocation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_task(task_arn)
delete_task(task_arn, params::Dict{String,<:Any})
Deletes a transfer task resource from DataSync.
# Arguments
- `task_arn`: Specifies the Amazon Resource Name (ARN) of the task that you want to delete.
"""
function delete_task(TaskArn; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"DeleteTask",
Dict{String,Any}("TaskArn" => TaskArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_task(
TaskArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DeleteTask",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TaskArn" => TaskArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_agent(agent_arn)
describe_agent(agent_arn, params::Dict{String,<:Any})
Returns information about an DataSync agent, such as its name, service endpoint type, and
status.
# Arguments
- `agent_arn`: Specifies the Amazon Resource Name (ARN) of the DataSync agent that you want
information about.
"""
function describe_agent(AgentArn; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"DescribeAgent",
Dict{String,Any}("AgentArn" => AgentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_agent(
AgentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeAgent",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AgentArn" => AgentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_discovery_job(discovery_job_arn)
describe_discovery_job(discovery_job_arn, params::Dict{String,<:Any})
Returns information about a DataSync discovery job.
# Arguments
- `discovery_job_arn`: Specifies the Amazon Resource Name (ARN) of the discovery job that
you want information about.
"""
function describe_discovery_job(
DiscoveryJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeDiscoveryJob",
Dict{String,Any}("DiscoveryJobArn" => DiscoveryJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_discovery_job(
DiscoveryJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeDiscoveryJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DiscoveryJobArn" => DiscoveryJobArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_azure_blob(location_arn)
describe_location_azure_blob(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage
is configured.
# Arguments
- `location_arn`: Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage
transfer location.
"""
function describe_location_azure_blob(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationAzureBlob",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_azure_blob(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationAzureBlob",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_efs(location_arn)
describe_location_efs(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for an Amazon EFS file system is
configured.
# Arguments
- `location_arn`: The Amazon Resource Name (ARN) of the Amazon EFS file system location
that you want information about.
"""
function describe_location_efs(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationEfs",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_efs(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationEfs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_fsx_lustre(location_arn)
describe_location_fsx_lustre(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file
system is configured.
# Arguments
- `location_arn`: The Amazon Resource Name (ARN) of the FSx for Lustre location to
describe.
"""
function describe_location_fsx_lustre(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationFsxLustre",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_fsx_lustre(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationFsxLustre",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_fsx_ontap(location_arn)
describe_location_fsx_ontap(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP
file system is configured. If your location uses SMB, the DescribeLocationFsxOntap
operation doesn't actually return a Password.
# Arguments
- `location_arn`: Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system
location that you want information about.
"""
function describe_location_fsx_ontap(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationFsxOntap",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_fsx_ontap(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationFsxOntap",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_fsx_open_zfs(location_arn)
describe_location_fsx_open_zfs(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file
system is configured. Response elements related to SMB aren't supported with the
DescribeLocationFsxOpenZfs operation.
# Arguments
- `location_arn`: The Amazon Resource Name (ARN) of the FSx for OpenZFS location to
describe.
"""
function describe_location_fsx_open_zfs(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationFsxOpenZfs",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_fsx_open_zfs(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationFsxOpenZfs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_fsx_windows(location_arn)
describe_location_fsx_windows(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for an Amazon FSx for Windows File
Server file system is configured.
# Arguments
- `location_arn`: Specifies the Amazon Resource Name (ARN) of the FSx for Windows File
Server location.
"""
function describe_location_fsx_windows(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationFsxWindows",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_fsx_windows(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationFsxWindows",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_hdfs(location_arn)
describe_location_hdfs(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for a Hadoop Distributed File
System (HDFS) is configured.
# Arguments
- `location_arn`: Specifies the Amazon Resource Name (ARN) of the HDFS location.
"""
function describe_location_hdfs(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationHdfs",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_hdfs(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationHdfs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_nfs(location_arn)
describe_location_nfs(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for a Network File System (NFS)
file server is configured.
# Arguments
- `location_arn`: Specifies the Amazon Resource Name (ARN) of the NFS location that you
want information about.
"""
function describe_location_nfs(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationNfs",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_nfs(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationNfs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_object_storage(location_arn)
describe_location_object_storage(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for an object storage system is
configured.
# Arguments
- `location_arn`: Specifies the Amazon Resource Name (ARN) of the object storage system
location.
"""
function describe_location_object_storage(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationObjectStorage",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_object_storage(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationObjectStorage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_s3(location_arn)
describe_location_s3(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for an S3 bucket is configured.
# Arguments
- `location_arn`: Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.
"""
function describe_location_s3(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationS3",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_s3(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationS3",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_location_smb(location_arn)
describe_location_smb(location_arn, params::Dict{String,<:Any})
Provides details about how an DataSync transfer location for a Server Message Block (SMB)
file server is configured.
# Arguments
- `location_arn`: Specifies the Amazon Resource Name (ARN) of the SMB location that you
want information about.
"""
function describe_location_smb(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeLocationSmb",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_location_smb(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeLocationSmb",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_storage_system(storage_system_arn)
describe_storage_system(storage_system_arn, params::Dict{String,<:Any})
Returns information about an on-premises storage system that you're using with DataSync
Discovery.
# Arguments
- `storage_system_arn`: Specifies the Amazon Resource Name (ARN) of an on-premises storage
system that you're using with DataSync Discovery.
"""
function describe_storage_system(
StorageSystemArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeStorageSystem",
Dict{String,Any}("StorageSystemArn" => StorageSystemArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_storage_system(
StorageSystemArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeStorageSystem",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("StorageSystemArn" => StorageSystemArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_storage_system_resource_metrics(discovery_job_arn, resource_id, resource_type)
describe_storage_system_resource_metrics(discovery_job_arn, resource_id, resource_type, params::Dict{String,<:Any})
Returns information, including performance data and capacity usage, which DataSync
Discovery collects about a specific resource in your-premises storage system.
# Arguments
- `discovery_job_arn`: Specifies the Amazon Resource Name (ARN) of the discovery job that
collects information about your on-premises storage system.
- `resource_id`: Specifies the universally unique identifier (UUID) of the storage system
resource that you want information about.
- `resource_type`: Specifies the kind of storage system resource that you want information
about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndTime"`: Specifies a time within the total duration that the discovery job ran. To
see information gathered during a certain time frame, use this parameter with StartTime.
- `"MaxResults"`: Specifies how many results that you want in the response.
- `"NextToken"`: Specifies an opaque string that indicates the position to begin the next
list of results in the response.
- `"StartTime"`: Specifies a time within the total duration that the discovery job ran. To
see information gathered during a certain time frame, use this parameter with EndTime.
"""
function describe_storage_system_resource_metrics(
DiscoveryJobArn,
ResourceId,
ResourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeStorageSystemResourceMetrics",
Dict{String,Any}(
"DiscoveryJobArn" => DiscoveryJobArn,
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_storage_system_resource_metrics(
DiscoveryJobArn,
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeStorageSystemResourceMetrics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DiscoveryJobArn" => DiscoveryJobArn,
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_storage_system_resources(discovery_job_arn, resource_type)
describe_storage_system_resources(discovery_job_arn, resource_type, params::Dict{String,<:Any})
Returns information that DataSync Discovery collects about resources in your on-premises
storage system.
# Arguments
- `discovery_job_arn`: Specifies the Amazon Resource Name (ARN) of the discovery job that's
collecting data from your on-premises storage system.
- `resource_type`: Specifies what kind of storage system resources that you want
information about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Filters the storage system resources that you want returned. For example,
this might be volumes associated with a specific storage virtual machine (SVM).
- `"MaxResults"`: Specifies the maximum number of storage system resources that you want to
list in a response.
- `"NextToken"`: Specifies an opaque string that indicates the position to begin the next
list of results in the response.
- `"ResourceIds"`: Specifies the universally unique identifiers (UUIDs) of the storage
system resources that you want information about. You can't use this parameter in
combination with the Filter parameter.
"""
function describe_storage_system_resources(
DiscoveryJobArn, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeStorageSystemResources",
Dict{String,Any}(
"DiscoveryJobArn" => DiscoveryJobArn, "ResourceType" => ResourceType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_storage_system_resources(
DiscoveryJobArn,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeStorageSystemResources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DiscoveryJobArn" => DiscoveryJobArn, "ResourceType" => ResourceType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_task(task_arn)
describe_task(task_arn, params::Dict{String,<:Any})
Provides information about a task, which defines where and how DataSync transfers your data.
# Arguments
- `task_arn`: Specifies the Amazon Resource Name (ARN) of the transfer task that you want
information about.
"""
function describe_task(TaskArn; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"DescribeTask",
Dict{String,Any}("TaskArn" => TaskArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_task(
TaskArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeTask",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TaskArn" => TaskArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_task_execution(task_execution_arn)
describe_task_execution(task_execution_arn, params::Dict{String,<:Any})
Provides information about an execution of your DataSync task. You can use this operation
to help monitor the progress of an ongoing transfer or check the results of the transfer.
# Arguments
- `task_execution_arn`: Specifies the Amazon Resource Name (ARN) of the task execution that
you want information about.
"""
function describe_task_execution(
TaskExecutionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"DescribeTaskExecution",
Dict{String,Any}("TaskExecutionArn" => TaskExecutionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_task_execution(
TaskExecutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"DescribeTaskExecution",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TaskExecutionArn" => TaskExecutionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_recommendations(discovery_job_arn, resource_ids, resource_type)
generate_recommendations(discovery_job_arn, resource_ids, resource_type, params::Dict{String,<:Any})
Creates recommendations about where to migrate your data to in Amazon Web Services.
Recommendations are generated based on information that DataSync Discovery collects about
your on-premises storage system's resources. For more information, see Recommendations
provided by DataSync Discovery. Once generated, you can view your recommendations by using
the DescribeStorageSystemResources operation.
# Arguments
- `discovery_job_arn`: Specifies the Amazon Resource Name (ARN) of the discovery job that
collects information about your on-premises storage system.
- `resource_ids`: Specifies the universally unique identifiers (UUIDs) of the resources in
your storage system that you want recommendations on.
- `resource_type`: Specifies the type of resource in your storage system that you want
recommendations on.
"""
function generate_recommendations(
DiscoveryJobArn,
ResourceIds,
ResourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"GenerateRecommendations",
Dict{String,Any}(
"DiscoveryJobArn" => DiscoveryJobArn,
"ResourceIds" => ResourceIds,
"ResourceType" => ResourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_recommendations(
DiscoveryJobArn,
ResourceIds,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"GenerateRecommendations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DiscoveryJobArn" => DiscoveryJobArn,
"ResourceIds" => ResourceIds,
"ResourceType" => ResourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_agents()
list_agents(params::Dict{String,<:Any})
Returns a list of DataSync agents that belong to an Amazon Web Services account in the
Amazon Web Services Region specified in the request. With pagination, you can reduce the
number of agents returned in a response. If you get a truncated list of agents in a
response, the response contains a marker that you can specify in your next request to fetch
the next page of agents. ListAgents is eventually consistent. This means the result of
running the operation might not reflect that you just created or deleted an agent. For
example, if you create an agent with CreateAgent and then immediately run ListAgents, that
agent might not show up in the list right away. In situations like this, you can always
confirm whether an agent has been created (or deleted) by using DescribeAgent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the maximum number of DataSync agents to list in a response. By
default, a response shows a maximum of 100 agents.
- `"NextToken"`: Specifies an opaque string that indicates the position to begin the next
list of results in the response.
"""
function list_agents(; aws_config::AbstractAWSConfig=global_aws_config())
return datasync("ListAgents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_agents(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"ListAgents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_discovery_jobs()
list_discovery_jobs(params::Dict{String,<:Any})
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon
Web Services account where you're using DataSync Discovery.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies how many results you want in the response.
- `"NextToken"`: Specifies an opaque string that indicates the position to begin the next
list of results in the response.
- `"StorageSystemArn"`: Specifies the Amazon Resource Name (ARN) of an on-premises storage
system. Use this parameter if you only want to list the discovery jobs that are associated
with a specific storage system.
"""
function list_discovery_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"ListDiscoveryJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_discovery_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"ListDiscoveryJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_locations()
list_locations(params::Dict{String,<:Any})
Returns a list of source and destination locations. If you have more locations than are
returned in a response (that is, the response returns only a truncated list of your
agents), the response contains a token that you can specify in your next request to fetch
the next page of locations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: You can use API filters to narrow down the list of resources returned by
ListLocations. For example, to retrieve all tasks on a specific source location, you can
use ListLocations with filter name LocationType S3 and Operator Equals.
- `"MaxResults"`: The maximum number of locations to return.
- `"NextToken"`: An opaque string that indicates the position at which to begin the next
list of locations.
"""
function list_locations(; aws_config::AbstractAWSConfig=global_aws_config())
return datasync("ListLocations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_locations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"ListLocations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_storage_systems()
list_storage_systems(params::Dict{String,<:Any})
Lists the on-premises storage systems that you're using with DataSync Discovery.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies how many results you want in the response.
- `"NextToken"`: Specifies an opaque string that indicates the position to begin the next
list of results in the response.
"""
function list_storage_systems(; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"ListStorageSystems"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_storage_systems(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"ListStorageSystems", 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 all the tags associated with an Amazon Web Services resource.
# Arguments
- `resource_arn`: Specifies the Amazon Resource Name (ARN) of the resource that you want
tag information on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies how many results that you want in the response.
- `"NextToken"`: Specifies an opaque string that indicates the position to begin the next
list of results in the response.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"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 datasync(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_task_executions()
list_task_executions(params::Dict{String,<:Any})
Returns a list of executions for an DataSync transfer task.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies how many results you want in the response.
- `"NextToken"`: Specifies an opaque string that indicates the position at which to begin
the next list of results in the response.
- `"TaskArn"`: Specifies the Amazon Resource Name (ARN) of the task that you want execution
information about.
"""
function list_task_executions(; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"ListTaskExecutions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_task_executions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"ListTaskExecutions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tasks()
list_tasks(params::Dict{String,<:Any})
Returns a list of the DataSync tasks you created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: You can use API filters to narrow down the list of resources returned by
ListTasks. For example, to retrieve all tasks on a specific source location, you can use
ListTasks with filter name LocationId and Operator Equals with the ARN for the location.
- `"MaxResults"`: The maximum number of tasks to return.
- `"NextToken"`: An opaque string that indicates the position at which to begin the next
list of tasks.
"""
function list_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return datasync("ListTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"ListTasks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
remove_storage_system(storage_system_arn)
remove_storage_system(storage_system_arn, params::Dict{String,<:Any})
Permanently removes a storage system resource from DataSync Discovery, including the
associated discovery jobs, collected data, and recommendations.
# Arguments
- `storage_system_arn`: Specifies the Amazon Resource Name (ARN) of the storage system that
you want to permanently remove from DataSync Discovery.
"""
function remove_storage_system(
StorageSystemArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"RemoveStorageSystem",
Dict{String,Any}("StorageSystemArn" => StorageSystemArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_storage_system(
StorageSystemArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"RemoveStorageSystem",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("StorageSystemArn" => StorageSystemArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_discovery_job(client_token, collection_duration_minutes, storage_system_arn)
start_discovery_job(client_token, collection_duration_minutes, storage_system_arn, params::Dict{String,<:Any})
Runs a DataSync discovery job on your on-premises storage system. If you haven't added the
storage system to DataSync Discovery yet, do this first by using the AddStorageSystem
operation.
# Arguments
- `client_token`: Specifies a client token to make sure requests with this API operation
are idempotent. If you don't specify a client token, DataSync generates one for you
automatically.
- `collection_duration_minutes`: Specifies in minutes how long you want the discovery job
to run. For more accurate recommendations, we recommend a duration of at least 14 days.
Longer durations allow time to collect a sufficient number of data points and provide a
realistic representation of storage performance and utilization.
- `storage_system_arn`: Specifies the Amazon Resource Name (ARN) of the on-premises storage
system that you want to run the discovery job on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: Specifies labels that help you categorize, filter, and search for your Amazon
Web Services resources.
"""
function start_discovery_job(
ClientToken,
CollectionDurationMinutes,
StorageSystemArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"StartDiscoveryJob",
Dict{String,Any}(
"ClientToken" => ClientToken,
"CollectionDurationMinutes" => CollectionDurationMinutes,
"StorageSystemArn" => StorageSystemArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_discovery_job(
ClientToken,
CollectionDurationMinutes,
StorageSystemArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"StartDiscoveryJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"CollectionDurationMinutes" => CollectionDurationMinutes,
"StorageSystemArn" => StorageSystemArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_task_execution(task_arn)
start_task_execution(task_arn, params::Dict{String,<:Any})
Starts an DataSync transfer task. For each task, you can only run one task execution at a
time. There are several phases to a task execution. For more information, see Task
execution statuses. If you're planning to transfer data to or from an Amazon S3 location,
review how DataSync can affect your S3 request charges and the DataSync pricing page before
you begin.
# Arguments
- `task_arn`: Specifies the Amazon Resource Name (ARN) of the task that you want to start.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Excludes"`: Specifies a list of filter rules that determines which files to exclude
from a task. The list contains a single filter string that consists of the patterns to
exclude. The patterns are delimited by \"|\" (that is, a pipe), for example,
\"/folder1|/folder2\".
- `"Includes"`: Specifies a list of filter rules that determines which files to include
when running a task. The pattern should contain a single filter string that consists of the
patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example,
\"/folder1|/folder2\".
- `"ManifestConfig"`: Configures a manifest, which is a list of files or objects that you
want DataSync to transfer. For more information and configuration examples, see Specifying
what DataSync transfers by using a manifest. When using this parameter, your caller
identity (the role that you're using DataSync with) must have the iam:PassRole permission.
The AWSDataSyncFullAccess policy includes this permission. To remove a manifest
configuration, specify this parameter with an empty value.
- `"OverrideOptions"`:
- `"Tags"`: Specifies the tags that you want to apply to the Amazon Resource Name (ARN)
representing the task execution. Tags are key-value pairs that help you manage, filter,
and search for your DataSync resources.
- `"TaskReportConfig"`: Specifies how you want to configure a task report, which provides
detailed information about your DataSync transfer. For more information, see Monitoring
your DataSync transfers with task reports. When using this parameter, your caller identity
(the role that you're using DataSync with) must have the iam:PassRole permission. The
AWSDataSyncFullAccess policy includes this permission. To remove a task report
configuration, specify this parameter as empty.
"""
function start_task_execution(TaskArn; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"StartTaskExecution",
Dict{String,Any}("TaskArn" => TaskArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_task_execution(
TaskArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"StartTaskExecution",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TaskArn" => TaskArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_discovery_job(discovery_job_arn)
stop_discovery_job(discovery_job_arn, params::Dict{String,<:Any})
Stops a running DataSync discovery job. You can stop a discovery job anytime. A job that's
stopped before it's scheduled to end likely will provide you some information about your
on-premises storage system resources. To get recommendations for a stopped job, you must
use the GenerateRecommendations operation.
# Arguments
- `discovery_job_arn`: Specifies the Amazon Resource Name (ARN) of the discovery job that
you want to stop.
"""
function stop_discovery_job(
DiscoveryJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"StopDiscoveryJob",
Dict{String,Any}("DiscoveryJobArn" => DiscoveryJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_discovery_job(
DiscoveryJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"StopDiscoveryJob",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DiscoveryJobArn" => DiscoveryJobArn), 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 a tag to an Amazon Web Services resource. Tags are key-value pairs that can help
you manage, filter, and search for your resources. These include DataSync resources, such
as locations, tasks, and task executions.
# Arguments
- `resource_arn`: Specifies the Amazon Resource Name (ARN) of the resource to apply the tag
to.
- `tags`: Specifies the tags that you want to apply to the resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"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 datasync(
"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(keys, resource_arn)
untag_resource(keys, resource_arn, params::Dict{String,<:Any})
Removes tags from an Amazon Web Services resource.
# Arguments
- `keys`: Specifies the keys in the tags that you want to remove.
- `resource_arn`: Specifies the Amazon Resource Name (ARN) of the resource to remove the
tags from.
"""
function untag_resource(
Keys, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"UntagResource",
Dict{String,Any}("Keys" => Keys, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
Keys,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Keys" => Keys, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_agent(agent_arn)
update_agent(agent_arn, params::Dict{String,<:Any})
Updates the name of an DataSync agent.
# Arguments
- `agent_arn`: The Amazon Resource Name (ARN) of the agent to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name that you want to use to configure the agent.
"""
function update_agent(AgentArn; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"UpdateAgent",
Dict{String,Any}("AgentArn" => AgentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_agent(
AgentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UpdateAgent",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AgentArn" => AgentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_discovery_job(collection_duration_minutes, discovery_job_arn)
update_discovery_job(collection_duration_minutes, discovery_job_arn, params::Dict{String,<:Any})
Edits a DataSync discovery job configuration.
# Arguments
- `collection_duration_minutes`: Specifies in minutes how long that you want the discovery
job to run. (You can't set this parameter to less than the number of minutes that the job
has already run for.)
- `discovery_job_arn`: Specifies the Amazon Resource Name (ARN) of the discovery job that
you want to update.
"""
function update_discovery_job(
CollectionDurationMinutes,
DiscoveryJobArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UpdateDiscoveryJob",
Dict{String,Any}(
"CollectionDurationMinutes" => CollectionDurationMinutes,
"DiscoveryJobArn" => DiscoveryJobArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_discovery_job(
CollectionDurationMinutes,
DiscoveryJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UpdateDiscoveryJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CollectionDurationMinutes" => CollectionDurationMinutes,
"DiscoveryJobArn" => DiscoveryJobArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_location_azure_blob(location_arn)
update_location_azure_blob(location_arn, params::Dict{String,<:Any})
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that
you're using with DataSync.
# Arguments
- `location_arn`: Specifies the ARN of the Azure Blob Storage transfer location that you're
updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessTier"`: Specifies the access tier that you want your objects or files transferred
into. This only applies when using the location as a transfer destination. For more
information, see Access tiers.
- `"AgentArns"`: Specifies the Amazon Resource Name (ARN) of the DataSync agent that can
connect with your Azure Blob Storage container. You can specify more than one agent. For
more information, see Using multiple agents for your transfer.
- `"AuthenticationType"`: Specifies the authentication method DataSync uses to access your
Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
- `"BlobType"`: Specifies the type of blob that you want your objects or files to be when
transferring them into Azure Blob Storage. Currently, DataSync only supports moving data
into Azure Blob Storage as block blobs. For more information on blob types, see the Azure
Blob Storage documentation.
- `"SasConfiguration"`: Specifies the SAS configuration that allows DataSync to access your
Azure Blob Storage.
- `"Subdirectory"`: Specifies path segments if you want to limit your transfer to a virtual
directory in your container (for example, /my/images).
"""
function update_location_azure_blob(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"UpdateLocationAzureBlob",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_location_azure_blob(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UpdateLocationAzureBlob",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_location_hdfs(location_arn)
update_location_hdfs(location_arn, params::Dict{String,<:Any})
Updates some parameters of a previously created location for a Hadoop Distributed File
System cluster.
# Arguments
- `location_arn`: The Amazon Resource Name (ARN) of the source HDFS cluster location.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentArns"`: The ARNs of the agents that are used to connect to the HDFS cluster.
- `"AuthenticationType"`: The type of authentication used to determine the identity of the
user.
- `"BlockSize"`: The size of the data blocks to write into the HDFS cluster.
- `"KerberosKeytab"`: The Kerberos key table (keytab) that contains mappings between the
defined Kerberos principal and the encrypted keys. You can load the keytab from a file by
providing the file's address. If you use the CLI, it performs base64 encoding for you.
Otherwise, provide the base64-encoded text.
- `"KerberosKrb5Conf"`: The krb5.conf file that contains the Kerberos configuration
information. You can load the krb5.conf file by providing the file's address. If you're
using the CLI, it performs the base64 encoding for you. Otherwise, provide the
base64-encoded text.
- `"KerberosPrincipal"`: The Kerberos principal with access to the files and folders on the
HDFS cluster.
- `"KmsKeyProviderUri"`: The URI of the HDFS cluster's Key Management Server (KMS).
- `"NameNodes"`: The NameNode that manages the HDFS namespace. The NameNode performs
operations such as opening, closing, and renaming files and directories. The NameNode
contains the information to map blocks of data to the DataNodes. You can use only one
NameNode.
- `"QopConfiguration"`: The Quality of Protection (QOP) configuration specifies the Remote
Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop
Distributed File System (HDFS) cluster.
- `"ReplicationFactor"`: The number of DataNodes to replicate the data to when writing to
the HDFS cluster.
- `"SimpleUser"`: The user name used to identify the client on the host operating system.
- `"Subdirectory"`: A subdirectory in the HDFS cluster. This subdirectory is used to read
data from or write data to the HDFS cluster.
"""
function update_location_hdfs(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"UpdateLocationHdfs",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_location_hdfs(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UpdateLocationHdfs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_location_nfs(location_arn)
update_location_nfs(location_arn, params::Dict{String,<:Any})
Modifies some configurations of the Network File System (NFS) transfer location that you're
using with DataSync. For more information, see Configuring transfers to or from an NFS file
server.
# Arguments
- `location_arn`: Specifies the Amazon Resource Name (ARN) of the NFS transfer location
that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MountOptions"`:
- `"OnPremConfig"`:
- `"Subdirectory"`: Specifies the export path in your NFS file server that you want
DataSync to mount. This path (or a subdirectory of the path) is where DataSync transfers
data to or from. For information on configuring an export for DataSync, see Accessing NFS
file servers.
"""
function update_location_nfs(LocationArn; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"UpdateLocationNfs",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_location_nfs(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UpdateLocationNfs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_location_object_storage(location_arn)
update_location_object_storage(location_arn, params::Dict{String,<:Any})
Updates some parameters of an existing DataSync location for an object storage system.
# Arguments
- `location_arn`: Specifies the ARN of the object storage system location that you're
updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessKey"`: Specifies the access key (for example, a user name) if credentials are
required to authenticate with the object storage server.
- `"AgentArns"`: Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can
securely connect with your location.
- `"SecretKey"`: Specifies the secret key (for example, a password) if credentials are
required to authenticate with the object storage server.
- `"ServerCertificate"`: Specifies a certificate chain for DataSync to authenticate with
your object storage system if the system uses a private or self-signed certificate
authority (CA). You must specify a single .pem file with a full certificate chain (for
example, file:///home/user/.ssh/object_storage_certificates.pem). The certificate chain
might include: The object storage system's certificate All intermediate certificates
(if there are any) The root certificate of the signing CA You can concatenate your
certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The
following example cat command creates an object_storage_certificates.pem file that includes
three certificates: cat object_server_certificate.pem intermediate_certificate.pem
ca_root_certificate.pem > object_storage_certificates.pem To use this parameter,
configure ServerProtocol to HTTPS. Updating this parameter doesn't interfere with tasks
that you have in progress.
- `"ServerPort"`: Specifies the port that your object storage server accepts inbound
network traffic on (for example, port 443).
- `"ServerProtocol"`: Specifies the protocol that your object storage server uses to
communicate.
- `"Subdirectory"`: Specifies the object prefix for your object storage server. If this is
a source location, DataSync only copies objects with this prefix. If this is a destination
location, DataSync writes all objects with this prefix.
"""
function update_location_object_storage(
LocationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"UpdateLocationObjectStorage",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_location_object_storage(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UpdateLocationObjectStorage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_location_smb(location_arn)
update_location_smb(location_arn, params::Dict{String,<:Any})
Updates some of the parameters of a Server Message Block (SMB) file server location that
you can use for DataSync transfers.
# Arguments
- `location_arn`: Specifies the ARN of the SMB location that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentArns"`: Specifies the DataSync agent (or agents) which you want to connect to your
SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
- `"Domain"`: Specifies the Windows domain name that your SMB file server belongs to. If
you have multiple domains in your environment, configuring this parameter makes sure that
DataSync connects to the right file server. For more information, see required permissions
for SMB locations.
- `"MountOptions"`:
- `"Password"`: Specifies the password of the user who can mount your SMB file server and
has permission to access the files and folders involved in your transfer. For more
information, see required permissions for SMB locations.
- `"Subdirectory"`: Specifies the name of the share exported by your SMB file server where
DataSync will read or write data. You can include a subdirectory in the share path (for
example, /path/to/subdirectory). Make sure that other SMB clients in your network can also
mount this path. To copy all data in the specified subdirectory, DataSync must be able to
mount the SMB share and access all of its data. For more information, see required
permissions for SMB locations.
- `"User"`: Specifies the user name that can mount your SMB file server and has permission
to access the files and folders involved in your transfer. For information about choosing a
user with the right level of access for your transfer, see required permissions for SMB
locations.
"""
function update_location_smb(LocationArn; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"UpdateLocationSmb",
Dict{String,Any}("LocationArn" => LocationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_location_smb(
LocationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UpdateLocationSmb",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationArn" => LocationArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_storage_system(storage_system_arn)
update_storage_system(storage_system_arn, params::Dict{String,<:Any})
Modifies some configurations of an on-premises storage system resource that you're using
with DataSync Discovery.
# Arguments
- `storage_system_arn`: Specifies the ARN of the on-premises storage system that you want
reconfigure.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AgentArns"`: Specifies the Amazon Resource Name (ARN) of the DataSync agent that
connects to and reads your on-premises storage system. You can only specify one ARN.
- `"CloudWatchLogGroupArn"`: Specifies the ARN of the Amazon CloudWatch log group for
monitoring and logging discovery job events.
- `"Credentials"`: Specifies the user name and password for accessing your on-premises
storage system's management interface.
- `"Name"`: Specifies a familiar name for your on-premises storage system.
- `"ServerConfiguration"`: Specifies the server name and network port required to connect
with your on-premises storage system's management interface.
"""
function update_storage_system(
StorageSystemArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"UpdateStorageSystem",
Dict{String,Any}("StorageSystemArn" => StorageSystemArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_storage_system(
StorageSystemArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UpdateStorageSystem",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("StorageSystemArn" => StorageSystemArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_task(task_arn)
update_task(task_arn, params::Dict{String,<:Any})
Updates the configuration of a task, which defines where and how DataSync transfers your
data.
# Arguments
- `task_arn`: Specifies the ARN of the task that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CloudWatchLogGroupArn"`: Specifies the Amazon Resource Name (ARN) of an Amazon
CloudWatch log group for monitoring your task.
- `"Excludes"`: Specifies exclude filters that define the files, objects, and folders in
your source location that you don't want DataSync to transfer. For more information and
examples, see Specifying what DataSync transfers by using filters.
- `"Includes"`: Specifies include filters define the files, objects, and folders in your
source location that you want DataSync to transfer. For more information and examples, see
Specifying what DataSync transfers by using filters.
- `"ManifestConfig"`: Configures a manifest, which is a list of files or objects that you
want DataSync to transfer. For more information and configuration examples, see Specifying
what DataSync transfers by using a manifest. When using this parameter, your caller
identity (the IAM role that you're using DataSync with) must have the iam:PassRole
permission. The AWSDataSyncFullAccess policy includes this permission. To remove a manifest
configuration, specify this parameter as empty.
- `"Name"`: Specifies the name of your task.
- `"Options"`:
- `"Schedule"`: Specifies a schedule for when you want your task to run. For more
information, see Scheduling your task.
- `"TaskReportConfig"`: Specifies how you want to configure a task report, which provides
detailed information about your DataSync transfer. For more information, see Monitoring
your DataSync transfers with task reports. When using this parameter, your caller identity
(the IAM role that you're using DataSync with) must have the iam:PassRole permission. The
AWSDataSyncFullAccess policy includes this permission. To remove a task report
configuration, specify this parameter as empty.
"""
function update_task(TaskArn; aws_config::AbstractAWSConfig=global_aws_config())
return datasync(
"UpdateTask",
Dict{String,Any}("TaskArn" => TaskArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_task(
TaskArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"UpdateTask",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TaskArn" => TaskArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_task_execution(options, task_execution_arn)
update_task_execution(options, task_execution_arn, params::Dict{String,<:Any})
Updates the configuration of a running DataSync task execution. Currently, the only Option
that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth
for a running or queued task execution.
# Arguments
- `options`:
- `task_execution_arn`: Specifies the Amazon Resource Name (ARN) of the task execution that
you're updating.
"""
function update_task_execution(
Options, TaskExecutionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datasync(
"UpdateTaskExecution",
Dict{String,Any}("Options" => Options, "TaskExecutionArn" => TaskExecutionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_task_execution(
Options,
TaskExecutionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datasync(
"UpdateTaskExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Options" => Options, "TaskExecutionArn" => TaskExecutionArn
),
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 | 186337 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: datazone
using AWS.Compat
using AWS.UUIDs
"""
accept_predictions(domain_identifier, identifier)
accept_predictions(domain_identifier, identifier, params::Dict{String,<:Any})
Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
- `identifier`: The identifier of the asset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"acceptChoices"`: Specifies the prediction (aka, the automatically generated piece of
metadata) and the target (for example, a column name) that can be accepted.
- `"acceptRule"`: Specifies the rule (or the conditions) under which a prediction can be
accepted.
- `"clientToken"`: A unique, case-sensitive identifier to ensure idempotency of the
request. This field is automatically populated if not provided.
- `"revision"`: The revision that is to be made to the asset.
"""
function accept_predictions(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)/accept-predictions",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_predictions(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)/accept-predictions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
accept_subscription_request(domain_identifier, identifier)
accept_subscription_request(domain_identifier, identifier, params::Dict{String,<:Any})
Accepts a subscription request to a specific asset.
# Arguments
- `domain_identifier`: The Amazon DataZone domain where the specified subscription request
is being accepted.
- `identifier`: The unique identifier of the subscription request that is to be accepted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"decisionComment"`: A description that specifies the reason for accepting the specified
subscription request.
"""
function accept_subscription_request(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/subscription-requests/$(identifier)/accept";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_subscription_request(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/subscription-requests/$(identifier)/accept",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_environment_role(domain_identifier, environment_identifier, environment_role_arn)
associate_environment_role(domain_identifier, environment_identifier, environment_role_arn, params::Dict{String,<:Any})
Associates the environment role in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the environment role
is associated.
- `environment_identifier`: The ID of the Amazon DataZone environment.
- `environment_role_arn`: The ARN of the environment role.
"""
function associate_environment_role(
domainIdentifier,
environmentIdentifier,
environmentRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/roles/$(environmentRoleArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_environment_role(
domainIdentifier,
environmentIdentifier,
environmentRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/roles/$(environmentRoleArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_metadata_generation_run(domain_identifier, identifier)
cancel_metadata_generation_run(domain_identifier, identifier, params::Dict{String,<:Any})
Cancels the metadata generation run.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the metadata
generation run is to be cancelled.
- `identifier`: The ID of the metadata generation run.
"""
function cancel_metadata_generation_run(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/metadata-generation-runs/$(identifier)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_metadata_generation_run(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/metadata-generation-runs/$(identifier)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_subscription(domain_identifier, identifier)
cancel_subscription(domain_identifier, identifier, params::Dict{String,<:Any})
Cancels the subscription to the specified asset.
# Arguments
- `domain_identifier`: The unique identifier of the Amazon DataZone domain where the
subscription request is being cancelled.
- `identifier`: The unique identifier of the subscription that is being cancelled.
"""
function cancel_subscription(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/subscriptions/$(identifier)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_subscription(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/subscriptions/$(identifier)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_asset(domain_identifier, name, owning_project_identifier, type_identifier)
create_asset(domain_identifier, name, owning_project_identifier, type_identifier, params::Dict{String,<:Any})
Creates an asset in Amazon DataZone catalog.
# Arguments
- `domain_identifier`: Amazon DataZone domain where the asset is created.
- `name`: Asset name.
- `owning_project_identifier`: The unique identifier of the project that owns this asset.
- `type_identifier`: The unique identifier of this asset's type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"description"`: Asset description.
- `"externalIdentifier"`: The external identifier of the asset.
- `"formsInput"`: Metadata forms attached to the asset.
- `"glossaryTerms"`: Glossary terms attached to the asset.
- `"predictionConfiguration"`: The configuration of the automatically generated
business-friendly metadata for the asset.
- `"typeRevision"`: The revision of this asset's type.
"""
function create_asset(
domainIdentifier,
name,
owningProjectIdentifier,
typeIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/assets",
Dict{String,Any}(
"name" => name,
"owningProjectIdentifier" => owningProjectIdentifier,
"typeIdentifier" => typeIdentifier,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_asset(
domainIdentifier,
name,
owningProjectIdentifier,
typeIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/assets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"owningProjectIdentifier" => owningProjectIdentifier,
"typeIdentifier" => typeIdentifier,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_asset_revision(domain_identifier, identifier, name)
create_asset_revision(domain_identifier, identifier, name, params::Dict{String,<:Any})
Creates a revision of the asset.
# Arguments
- `domain_identifier`: The unique identifier of the domain where the asset is being revised.
- `identifier`: The identifier of the asset.
- `name`: Te revised name of the asset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"description"`: The revised description of the asset.
- `"formsInput"`: The metadata forms to be attached to the asset as part of asset revision.
- `"glossaryTerms"`: The glossary terms to be attached to the asset as part of asset
revision.
- `"predictionConfiguration"`: The configuration of the automatically generated
business-friendly metadata for the asset.
- `"typeRevision"`: The revision type of the asset.
"""
function create_asset_revision(
domainIdentifier, identifier, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)/revisions",
Dict{String,Any}("name" => name, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_asset_revision(
domainIdentifier,
identifier,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)/revisions",
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_asset_type(domain_identifier, forms_input, name, owning_project_identifier)
create_asset_type(domain_identifier, forms_input, name, owning_project_identifier, params::Dict{String,<:Any})
Creates a custom asset type.
# Arguments
- `domain_identifier`: The unique identifier of the Amazon DataZone domain where the custom
asset type is being created.
- `forms_input`: The metadata forms that are to be attached to the custom asset type.
- `name`: The name of the custom asset type.
- `owning_project_identifier`: The identifier of the Amazon DataZone project that is to own
the custom asset type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The descripton of the custom asset type.
"""
function create_asset_type(
domainIdentifier,
formsInput,
name,
owningProjectIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/asset-types",
Dict{String,Any}(
"formsInput" => formsInput,
"name" => name,
"owningProjectIdentifier" => owningProjectIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_asset_type(
domainIdentifier,
formsInput,
name,
owningProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/asset-types",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"formsInput" => formsInput,
"name" => name,
"owningProjectIdentifier" => owningProjectIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_source(domain_identifier, environment_identifier, name, project_identifier, type)
create_data_source(domain_identifier, environment_identifier, name, project_identifier, type, params::Dict{String,<:Any})
Creates an Amazon DataZone data source.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain where the data source is
created.
- `environment_identifier`: The unique identifier of the Amazon DataZone environment to
which the data source publishes assets.
- `name`: The name of the data source.
- `project_identifier`: The identifier of the Amazon DataZone project in which you want to
add this data source.
- `type`: The type of the data source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetFormsInput"`: The metadata forms that are to be attached to the assets that this
data source works with.
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"configuration"`: Specifies the configuration of the data source. It can be set to
either glueRunConfiguration or redshiftRunConfiguration.
- `"description"`: The description of the data source.
- `"enableSetting"`: Specifies whether the data source is enabled.
- `"publishOnImport"`: Specifies whether the assets that this data source creates in the
inventory are to be also automatically published to the catalog.
- `"recommendation"`: Specifies whether the business name generation is to be enabled for
this data source.
- `"schedule"`: The schedule of the data source runs.
"""
function create_data_source(
domainIdentifier,
environmentIdentifier,
name,
projectIdentifier,
type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/data-sources",
Dict{String,Any}(
"environmentIdentifier" => environmentIdentifier,
"name" => name,
"projectIdentifier" => projectIdentifier,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_source(
domainIdentifier,
environmentIdentifier,
name,
projectIdentifier,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/data-sources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"environmentIdentifier" => environmentIdentifier,
"name" => name,
"projectIdentifier" => projectIdentifier,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain(domain_execution_role, name)
create_domain(domain_execution_role, name, params::Dict{String,<:Any})
Creates an Amazon DataZone domain.
# Arguments
- `domain_execution_role`: The domain execution role that is created when an Amazon
DataZone domain is created. The domain execution role is created in the Amazon Web Services
account that houses the Amazon DataZone domain.
- `name`: The name of the Amazon DataZone domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"description"`: The description of the Amazon DataZone domain.
- `"kmsKeyIdentifier"`: The identifier of the Amazon Web Services Key Management Service
(KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
- `"singleSignOn"`: The single-sign on configuration of the Amazon DataZone domain.
- `"tags"`: The tags specified for the Amazon DataZone domain.
"""
function create_domain(
domainExecutionRole, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains",
Dict{String,Any}(
"domainExecutionRole" => domainExecutionRole,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain(
domainExecutionRole,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"domainExecutionRole" => domainExecutionRole,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment(domain_identifier, environment_profile_identifier, name, project_identifier)
create_environment(domain_identifier, environment_profile_identifier, name, project_identifier, params::Dict{String,<:Any})
Create an Amazon DataZone environment.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which the
environment is created.
- `environment_profile_identifier`: The identifier of the environment profile that is used
to create this Amazon DataZone environment.
- `name`: The name of the Amazon DataZone environment.
- `project_identifier`: The identifier of the Amazon DataZone project in which this
environment is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the Amazon DataZone environment.
- `"environmentAccountIdentifier"`: The ID of the account in which the environment is being
created.
- `"environmentAccountRegion"`: The region of the account in which the environment is being
created.
- `"environmentBlueprintIdentifier"`: The ID of the blueprint with which the environment is
being created.
- `"glossaryTerms"`: The glossary terms that can be used in this Amazon DataZone
environment.
- `"userParameters"`: The user parameters of this Amazon DataZone environment.
"""
function create_environment(
domainIdentifier,
environmentProfileIdentifier,
name,
projectIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/environments",
Dict{String,Any}(
"environmentProfileIdentifier" => environmentProfileIdentifier,
"name" => name,
"projectIdentifier" => projectIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment(
domainIdentifier,
environmentProfileIdentifier,
name,
projectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/environments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"environmentProfileIdentifier" => environmentProfileIdentifier,
"name" => name,
"projectIdentifier" => projectIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment_action(domain_identifier, environment_identifier, name, parameters)
create_environment_action(domain_identifier, environment_identifier, name, parameters, params::Dict{String,<:Any})
Creates an action for the environment, for example, creates a console link for an analytics
tool that is available in this environment.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the environment action
is created.
- `environment_identifier`: The ID of the environment in which the environment action is
created.
- `name`: The name of the environment action.
- `parameters`: The parameters of the environment action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the environment action that is being created in the
environment.
"""
function create_environment_action(
domainIdentifier,
environmentIdentifier,
name,
parameters;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/actions",
Dict{String,Any}("name" => name, "parameters" => parameters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment_action(
domainIdentifier,
environmentIdentifier,
name,
parameters,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/actions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "parameters" => parameters), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment_profile(domain_identifier, environment_blueprint_identifier, name, project_identifier)
create_environment_profile(domain_identifier, environment_blueprint_identifier, name, project_identifier, params::Dict{String,<:Any})
Creates an Amazon DataZone environment profile.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which this environment
profile is created.
- `environment_blueprint_identifier`: The ID of the blueprint with which this environment
profile is created.
- `name`: The name of this Amazon DataZone environment profile.
- `project_identifier`: The identifier of the project in which to create the environment
profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"awsAccountId"`: The Amazon Web Services account in which the Amazon DataZone
environment is created.
- `"awsAccountRegion"`: The Amazon Web Services region in which this environment profile is
created.
- `"description"`: The description of this Amazon DataZone environment profile.
- `"userParameters"`: The user parameters of this Amazon DataZone environment profile.
"""
function create_environment_profile(
domainIdentifier,
environmentBlueprintIdentifier,
name,
projectIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/environment-profiles",
Dict{String,Any}(
"environmentBlueprintIdentifier" => environmentBlueprintIdentifier,
"name" => name,
"projectIdentifier" => projectIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment_profile(
domainIdentifier,
environmentBlueprintIdentifier,
name,
projectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/environment-profiles",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"environmentBlueprintIdentifier" => environmentBlueprintIdentifier,
"name" => name,
"projectIdentifier" => projectIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_form_type(domain_identifier, model, name, owning_project_identifier)
create_form_type(domain_identifier, model, name, owning_project_identifier, params::Dict{String,<:Any})
Creates a metadata form type.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which this metadata form
type is created.
- `model`: The model of this Amazon DataZone metadata form type.
- `name`: The name of this Amazon DataZone metadata form type.
- `owning_project_identifier`: The ID of the Amazon DataZone project that owns this
metadata form type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of this Amazon DataZone metadata form type.
- `"status"`: The status of this Amazon DataZone metadata form type.
"""
function create_form_type(
domainIdentifier,
model,
name,
owningProjectIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/form-types",
Dict{String,Any}(
"model" => model,
"name" => name,
"owningProjectIdentifier" => owningProjectIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_form_type(
domainIdentifier,
model,
name,
owningProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/form-types",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"model" => model,
"name" => name,
"owningProjectIdentifier" => owningProjectIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_glossary(domain_identifier, name, owning_project_identifier)
create_glossary(domain_identifier, name, owning_project_identifier, params::Dict{String,<:Any})
Creates an Amazon DataZone business glossary.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which this business glossary
is created.
- `name`: The name of this business glossary.
- `owning_project_identifier`: The ID of the project that currently owns business glossary.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"description"`: The description of this business glossary.
- `"status"`: The status of this business glossary.
"""
function create_glossary(
domainIdentifier,
name,
owningProjectIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/glossaries",
Dict{String,Any}(
"name" => name,
"owningProjectIdentifier" => owningProjectIdentifier,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_glossary(
domainIdentifier,
name,
owningProjectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/glossaries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"owningProjectIdentifier" => owningProjectIdentifier,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_glossary_term(domain_identifier, glossary_identifier, name)
create_glossary_term(domain_identifier, glossary_identifier, name, params::Dict{String,<:Any})
Creates a business glossary term.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which this business glossary
term is created.
- `glossary_identifier`: The ID of the business glossary in which this term is created.
- `name`: The name of this business glossary term.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"longDescription"`: The long description of this business glossary term.
- `"shortDescription"`: The short description of this business glossary term.
- `"status"`: The status of this business glossary term.
- `"termRelations"`: The term relations of this business glossary term.
"""
function create_glossary_term(
domainIdentifier,
glossaryIdentifier,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/glossary-terms",
Dict{String,Any}(
"glossaryIdentifier" => glossaryIdentifier,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_glossary_term(
domainIdentifier,
glossaryIdentifier,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/glossary-terms",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"glossaryIdentifier" => glossaryIdentifier,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group_profile(domain_identifier, group_identifier)
create_group_profile(domain_identifier, group_identifier, params::Dict{String,<:Any})
Creates a group profile in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which the group
profile is created.
- `group_identifier`: The identifier of the group for which the group profile is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
"""
function create_group_profile(
domainIdentifier, groupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/group-profiles",
Dict{String,Any}(
"groupIdentifier" => groupIdentifier, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group_profile(
domainIdentifier,
groupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/group-profiles",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"groupIdentifier" => groupIdentifier, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_listing_change_set(action, domain_identifier, entity_identifier, entity_type)
create_listing_change_set(action, domain_identifier, entity_identifier, entity_type, params::Dict{String,<:Any})
Publishes a listing (a record of an asset at a given time) or removes a listing from the
catalog.
# Arguments
- `action`: Specifies whether to publish or unpublish a listing.
- `domain_identifier`: The ID of the Amazon DataZone domain.
- `entity_identifier`: The ID of the asset.
- `entity_type`: The type of an entity.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"entityRevision"`: The revision of an asset.
"""
function create_listing_change_set(
action,
domainIdentifier,
entityIdentifier,
entityType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/listings/change-set",
Dict{String,Any}(
"action" => action,
"entityIdentifier" => entityIdentifier,
"entityType" => entityType,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_listing_change_set(
action,
domainIdentifier,
entityIdentifier,
entityType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/listings/change-set",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"action" => action,
"entityIdentifier" => entityIdentifier,
"entityType" => entityType,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project(domain_identifier, name)
create_project(domain_identifier, name, params::Dict{String,<:Any})
Creates an Amazon DataZone project.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which this project is
created.
- `name`: The name of the Amazon DataZone project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the Amazon DataZone project.
- `"glossaryTerms"`: The glossary terms that can be used in this Amazon DataZone project.
"""
function create_project(
domainIdentifier, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/projects",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project(
domainIdentifier,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/projects",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project_membership(designation, domain_identifier, member, project_identifier)
create_project_membership(designation, domain_identifier, member, project_identifier, params::Dict{String,<:Any})
Creates a project membership in Amazon DataZone.
# Arguments
- `designation`: The designation of the project membership.
- `domain_identifier`: The ID of the Amazon DataZone domain in which project membership is
created.
- `member`: The project member whose project membership was created.
- `project_identifier`: The ID of the project for which this project membership was created.
"""
function create_project_membership(
designation,
domainIdentifier,
member,
projectIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/projects/$(projectIdentifier)/createMembership",
Dict{String,Any}("designation" => designation, "member" => member);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project_membership(
designation,
domainIdentifier,
member,
projectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/projects/$(projectIdentifier)/createMembership",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("designation" => designation, "member" => member),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subscription_grant(domain_identifier, environment_identifier, granted_entity, subscription_target_identifier)
create_subscription_grant(domain_identifier, environment_identifier, granted_entity, subscription_target_identifier, params::Dict{String,<:Any})
Creates a subsscription grant in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the subscription grant
is created.
- `environment_identifier`: The ID of the environment in which the subscription grant is
created.
- `granted_entity`: The entity to which the subscription is to be granted.
- `subscription_target_identifier`: The ID of the subscription target for which the
subscription grant is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetTargetNames"`: The names of the assets for which the subscription grant is created.
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
"""
function create_subscription_grant(
domainIdentifier,
environmentIdentifier,
grantedEntity,
subscriptionTargetIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/subscription-grants",
Dict{String,Any}(
"environmentIdentifier" => environmentIdentifier,
"grantedEntity" => grantedEntity,
"subscriptionTargetIdentifier" => subscriptionTargetIdentifier,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subscription_grant(
domainIdentifier,
environmentIdentifier,
grantedEntity,
subscriptionTargetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/subscription-grants",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"environmentIdentifier" => environmentIdentifier,
"grantedEntity" => grantedEntity,
"subscriptionTargetIdentifier" => subscriptionTargetIdentifier,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subscription_request(domain_identifier, request_reason, subscribed_listings, subscribed_principals)
create_subscription_request(domain_identifier, request_reason, subscribed_listings, subscribed_principals, params::Dict{String,<:Any})
Creates a subscription request in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the subscription
request is created.
- `request_reason`: The reason for the subscription request.
- `subscribed_listings`: The published asset for which the subscription grant is to be
created.
- `subscribed_principals`: The Amazon DataZone principals for whom the subscription request
is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
"""
function create_subscription_request(
domainIdentifier,
requestReason,
subscribedListings,
subscribedPrincipals;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/subscription-requests",
Dict{String,Any}(
"requestReason" => requestReason,
"subscribedListings" => subscribedListings,
"subscribedPrincipals" => subscribedPrincipals,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subscription_request(
domainIdentifier,
requestReason,
subscribedListings,
subscribedPrincipals,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/subscription-requests",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"requestReason" => requestReason,
"subscribedListings" => subscribedListings,
"subscribedPrincipals" => subscribedPrincipals,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subscription_target(applicable_asset_types, authorized_principals, domain_identifier, environment_identifier, manage_access_role, name, subscription_target_config, type)
create_subscription_target(applicable_asset_types, authorized_principals, domain_identifier, environment_identifier, manage_access_role, name, subscription_target_config, type, params::Dict{String,<:Any})
Creates a subscription target in Amazon DataZone.
# Arguments
- `applicable_asset_types`: The asset types that can be included in the subscription target.
- `authorized_principals`: The authorized principals of the subscription target.
- `domain_identifier`: The ID of the Amazon DataZone domain in which subscription target is
created.
- `environment_identifier`: The ID of the environment in which subscription target is
created.
- `manage_access_role`: The manage access role that is used to create the subscription
target.
- `name`: The name of the subscription target.
- `subscription_target_config`: The configuration of the subscription target.
- `type`: The type of the subscription target.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"provider"`: The provider of the subscription target.
"""
function create_subscription_target(
applicableAssetTypes,
authorizedPrincipals,
domainIdentifier,
environmentIdentifier,
manageAccessRole,
name,
subscriptionTargetConfig,
type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/subscription-targets",
Dict{String,Any}(
"applicableAssetTypes" => applicableAssetTypes,
"authorizedPrincipals" => authorizedPrincipals,
"manageAccessRole" => manageAccessRole,
"name" => name,
"subscriptionTargetConfig" => subscriptionTargetConfig,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subscription_target(
applicableAssetTypes,
authorizedPrincipals,
domainIdentifier,
environmentIdentifier,
manageAccessRole,
name,
subscriptionTargetConfig,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/subscription-targets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"applicableAssetTypes" => applicableAssetTypes,
"authorizedPrincipals" => authorizedPrincipals,
"manageAccessRole" => manageAccessRole,
"name" => name,
"subscriptionTargetConfig" => subscriptionTargetConfig,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_profile(domain_identifier, user_identifier)
create_user_profile(domain_identifier, user_identifier, params::Dict{String,<:Any})
Creates a user profile in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which a user profile
is created.
- `user_identifier`: The identifier of the user for which the user profile is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"userType"`: The user type of the user for which the user profile is created.
"""
function create_user_profile(
domainIdentifier, userIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/user-profiles",
Dict{String,Any}(
"userIdentifier" => userIdentifier, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_profile(
domainIdentifier,
userIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/user-profiles",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"userIdentifier" => userIdentifier, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_asset(domain_identifier, identifier)
delete_asset(domain_identifier, identifier, params::Dict{String,<:Any})
Delets an asset in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the asset is deleted.
- `identifier`: The identifier of the asset that is deleted.
"""
function delete_asset(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_asset(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_asset_type(domain_identifier, identifier)
delete_asset_type(domain_identifier, identifier, params::Dict{String,<:Any})
Deletes an asset type in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the asset type is
deleted.
- `identifier`: The identifier of the asset type that is deleted.
"""
function delete_asset_type(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/asset-types/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_asset_type(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/asset-types/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_source(domain_identifier, identifier)
delete_data_source(domain_identifier, identifier, params::Dict{String,<:Any})
Deletes a data source in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the data source is
deleted.
- `identifier`: The identifier of the data source that is deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"retainPermissionsOnRevokeFailure"`: Specifies that the granted permissions are retained
in case of a self-subscribe functionality failure for a data source.
"""
function delete_data_source(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/data-sources/$(identifier)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_source(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/data-sources/$(identifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain(identifier)
delete_domain(identifier, params::Dict{String,<:Any})
Deletes a Amazon DataZone domain.
# Arguments
- `identifier`: The identifier of the Amazon Web Services domain that is 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 is provided to ensure the
idempotency of the request.
- `"skipDeletionCheck"`: Specifies the optional flag to delete all child entities within
the domain.
"""
function delete_domain(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return datazone(
"DELETE",
"/v2/domains/$(identifier)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_domain(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(identifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment(domain_identifier, identifier)
delete_environment(domain_identifier, identifier, params::Dict{String,<:Any})
Deletes an environment in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the environment is
deleted.
- `identifier`: The identifier of the environment that is to be deleted.
"""
function delete_environment(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environments/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environments/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment_action(domain_identifier, environment_identifier, identifier)
delete_environment_action(domain_identifier, environment_identifier, identifier, params::Dict{String,<:Any})
Deletes an action for the environment, for example, deletes a console link for an analytics
tool that is available in this environment.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which an environment action
is deleted.
- `environment_identifier`: The ID of the environment where an environment action is
deleted.
- `identifier`: The ID of the environment action that is deleted.
"""
function delete_environment_action(
domainIdentifier,
environmentIdentifier,
identifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/actions/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment_action(
domainIdentifier,
environmentIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/actions/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment_blueprint_configuration(domain_identifier, environment_blueprint_identifier)
delete_environment_blueprint_configuration(domain_identifier, environment_blueprint_identifier, params::Dict{String,<:Any})
Deletes the blueprint configuration in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the blueprint
configuration is deleted.
- `environment_blueprint_identifier`: The ID of the blueprint the configuration of which is
deleted.
"""
function delete_environment_blueprint_configuration(
domainIdentifier,
environmentBlueprintIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environment-blueprint-configurations/$(environmentBlueprintIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment_blueprint_configuration(
domainIdentifier,
environmentBlueprintIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environment-blueprint-configurations/$(environmentBlueprintIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment_profile(domain_identifier, identifier)
delete_environment_profile(domain_identifier, identifier, params::Dict{String,<:Any})
Deletes an environment profile in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the environment
profile is deleted.
- `identifier`: The ID of the environment profile that is deleted.
"""
function delete_environment_profile(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environment-profiles/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment_profile(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environment-profiles/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_form_type(domain_identifier, form_type_identifier)
delete_form_type(domain_identifier, form_type_identifier, params::Dict{String,<:Any})
Delets and metadata form type in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the metadata form type
is deleted.
- `form_type_identifier`: The ID of the metadata form type that is deleted.
"""
function delete_form_type(
domainIdentifier, formTypeIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/form-types/$(formTypeIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_form_type(
domainIdentifier,
formTypeIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/form-types/$(formTypeIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_glossary(domain_identifier, identifier)
delete_glossary(domain_identifier, identifier, params::Dict{String,<:Any})
Deletes a business glossary in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the business glossary
is deleted.
- `identifier`: The ID of the business glossary that is deleted.
"""
function delete_glossary(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/glossaries/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_glossary(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/glossaries/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_glossary_term(domain_identifier, identifier)
delete_glossary_term(domain_identifier, identifier, params::Dict{String,<:Any})
Deletes a business glossary term in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the business glossary
term is deleted.
- `identifier`: The ID of the business glossary term that is deleted.
"""
function delete_glossary_term(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/glossary-terms/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_glossary_term(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/glossary-terms/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_listing(domain_identifier, identifier)
delete_listing(domain_identifier, identifier, params::Dict{String,<:Any})
Deletes a listing (a record of an asset at a given time).
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain.
- `identifier`: The ID of the listing to be deleted.
"""
function delete_listing(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/listings/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_listing(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/listings/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project(domain_identifier, identifier)
delete_project(domain_identifier, identifier, params::Dict{String,<:Any})
Deletes a project in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the project is deleted.
- `identifier`: The identifier of the project that is to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"skipDeletionCheck"`: Specifies the optional flag to delete all child entities within
the project.
"""
function delete_project(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/projects/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/projects/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project_membership(domain_identifier, member, project_identifier)
delete_project_membership(domain_identifier, member, project_identifier, params::Dict{String,<:Any})
Deletes project membership in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain where project membership is
deleted.
- `member`: The project member whose project membership is deleted.
- `project_identifier`: The ID of the Amazon DataZone project the membership to which is
deleted.
"""
function delete_project_membership(
domainIdentifier,
member,
projectIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/projects/$(projectIdentifier)/deleteMembership",
Dict{String,Any}("member" => member);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project_membership(
domainIdentifier,
member,
projectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/projects/$(projectIdentifier)/deleteMembership",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("member" => member), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subscription_grant(domain_identifier, identifier)
delete_subscription_grant(domain_identifier, identifier, params::Dict{String,<:Any})
Deletes and subscription grant in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain where the subscription grant is
deleted.
- `identifier`: The ID of the subscription grant that is deleted.
"""
function delete_subscription_grant(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/subscription-grants/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_subscription_grant(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/subscription-grants/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subscription_request(domain_identifier, identifier)
delete_subscription_request(domain_identifier, identifier, params::Dict{String,<:Any})
Deletes a subscription request in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the subscription
request is deleted.
- `identifier`: The ID of the subscription request that is deleted.
"""
function delete_subscription_request(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/subscription-requests/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_subscription_request(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/subscription-requests/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subscription_target(domain_identifier, environment_identifier, identifier)
delete_subscription_target(domain_identifier, environment_identifier, identifier, params::Dict{String,<:Any})
Deletes a subscription target in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the subscription
target is deleted.
- `environment_identifier`: The ID of the Amazon DataZone environment in which the
subscription target is deleted.
- `identifier`: The ID of the subscription target that is deleted.
"""
function delete_subscription_target(
domainIdentifier,
environmentIdentifier,
identifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/subscription-targets/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_subscription_target(
domainIdentifier,
environmentIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/subscription-targets/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_time_series_data_points(domain_identifier, entity_identifier, entity_type, form_name)
delete_time_series_data_points(domain_identifier, entity_identifier, entity_type, form_name, params::Dict{String,<:Any})
Deletes the specified time series form for the specified asset.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain that houses the asset for which
you want to delete a time series form.
- `entity_identifier`: The ID of the asset for which you want to delete a time series form.
- `entity_type`: The type of the asset for which you want to delete a time series form.
- `form_name`: The name of the time series form that you want to delete.
# 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. This field is automatically populated if not provided.
"""
function delete_time_series_data_points(
domainIdentifier,
entityIdentifier,
entityType,
formName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/entities/$(entityType)/$(entityIdentifier)/time-series-data-points",
Dict{String,Any}("formName" => formName, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_time_series_data_points(
domainIdentifier,
entityIdentifier,
entityType,
formName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/entities/$(entityType)/$(entityIdentifier)/time-series-data-points",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("formName" => formName, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_environment_role(domain_identifier, environment_identifier, environment_role_arn)
disassociate_environment_role(domain_identifier, environment_identifier, environment_role_arn, params::Dict{String,<:Any})
Disassociates the environment role in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which an environment role is
disassociated.
- `environment_identifier`: The ID of the environment.
- `environment_role_arn`: The ARN of the environment role.
"""
function disassociate_environment_role(
domainIdentifier,
environmentIdentifier,
environmentRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/roles/$(environmentRoleArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_environment_role(
domainIdentifier,
environmentIdentifier,
environmentRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"DELETE",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/roles/$(environmentRoleArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_asset(domain_identifier, identifier)
get_asset(domain_identifier, identifier, params::Dict{String,<:Any})
Gets an Amazon DataZone asset.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain to which the asset belongs.
- `identifier`: The ID of the Amazon DataZone asset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"revision"`: The revision of the Amazon DataZone asset.
"""
function get_asset(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_asset(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_asset_type(domain_identifier, identifier)
get_asset_type(domain_identifier, identifier, params::Dict{String,<:Any})
Gets an Amazon DataZone asset type.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the asset type exists.
- `identifier`: The ID of the asset type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"revision"`: The revision of the asset type.
"""
function get_asset_type(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/asset-types/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_asset_type(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/asset-types/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_source(domain_identifier, identifier)
get_data_source(domain_identifier, identifier, params::Dict{String,<:Any})
Gets an Amazon DataZone data source.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the data source exists.
- `identifier`: The ID of the Amazon DataZone data source.
"""
function get_data_source(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/data-sources/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_source(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/data-sources/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_source_run(domain_identifier, identifier)
get_data_source_run(domain_identifier, identifier, params::Dict{String,<:Any})
Gets an Amazon DataZone data source run.
# Arguments
- `domain_identifier`: The ID of the domain in which this data source run was performed.
- `identifier`: The ID of the data source run.
"""
function get_data_source_run(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/data-source-runs/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_source_run(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/data-source-runs/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain(identifier)
get_domain(identifier, params::Dict{String,<:Any})
Gets an Amazon DataZone domain.
# Arguments
- `identifier`: The identifier of the specified Amazon DataZone domain.
"""
function get_domain(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return datazone(
"GET",
"/v2/domains/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment(domain_identifier, identifier)
get_environment(domain_identifier, identifier, params::Dict{String,<:Any})
Gets an Amazon DataZone environment.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain where the environment exists.
- `identifier`: The ID of the Amazon DataZone environment.
"""
function get_environment(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment_action(domain_identifier, environment_identifier, identifier)
get_environment_action(domain_identifier, environment_identifier, identifier, params::Dict{String,<:Any})
Gets the specified environment action.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the
GetEnvironmentAction API is invoked.
- `environment_identifier`: The environment ID of the environment action.
- `identifier`: The ID of the environment action
"""
function get_environment_action(
domainIdentifier,
environmentIdentifier,
identifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/actions/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment_action(
domainIdentifier,
environmentIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/actions/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment_blueprint(domain_identifier, identifier)
get_environment_blueprint(domain_identifier, identifier, params::Dict{String,<:Any})
Gets an Amazon DataZone blueprint.
# Arguments
- `domain_identifier`: The identifier of the domain in which this blueprint exists.
- `identifier`: The ID of this Amazon DataZone blueprint.
"""
function get_environment_blueprint(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-blueprints/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment_blueprint(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-blueprints/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment_blueprint_configuration(domain_identifier, environment_blueprint_identifier)
get_environment_blueprint_configuration(domain_identifier, environment_blueprint_identifier, params::Dict{String,<:Any})
Gets the blueprint configuration in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain where this blueprint exists.
- `environment_blueprint_identifier`: He ID of the blueprint.
"""
function get_environment_blueprint_configuration(
domainIdentifier,
environmentBlueprintIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-blueprint-configurations/$(environmentBlueprintIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment_blueprint_configuration(
domainIdentifier,
environmentBlueprintIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-blueprint-configurations/$(environmentBlueprintIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment_profile(domain_identifier, identifier)
get_environment_profile(domain_identifier, identifier, params::Dict{String,<:Any})
Gets an evinronment profile in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which this environment
profile exists.
- `identifier`: The ID of the environment profile.
"""
function get_environment_profile(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-profiles/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_environment_profile(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-profiles/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_form_type(domain_identifier, form_type_identifier)
get_form_type(domain_identifier, form_type_identifier, params::Dict{String,<:Any})
Gets a metadata form type in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which this metadata form
type exists.
- `form_type_identifier`: The ID of the metadata form type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"revision"`: The revision of this metadata form type.
"""
function get_form_type(
domainIdentifier, formTypeIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/form-types/$(formTypeIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_form_type(
domainIdentifier,
formTypeIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/form-types/$(formTypeIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_glossary(domain_identifier, identifier)
get_glossary(domain_identifier, identifier, params::Dict{String,<:Any})
Gets a business glossary in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which this business glossary
exists.
- `identifier`: The ID of the business glossary.
"""
function get_glossary(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/glossaries/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_glossary(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/glossaries/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_glossary_term(domain_identifier, identifier)
get_glossary_term(domain_identifier, identifier, params::Dict{String,<:Any})
Gets a business glossary term in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which this business glossary
term exists.
- `identifier`: The ID of the business glossary term.
"""
function get_glossary_term(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/glossary-terms/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_glossary_term(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/glossary-terms/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group_profile(domain_identifier, group_identifier)
get_group_profile(domain_identifier, group_identifier, params::Dict{String,<:Any})
Gets a group profile in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which the group
profile exists.
- `group_identifier`: The identifier of the group profile.
"""
function get_group_profile(
domainIdentifier, groupIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/group-profiles/$(groupIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group_profile(
domainIdentifier,
groupIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/group-profiles/$(groupIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_iam_portal_login_url(domain_identifier)
get_iam_portal_login_url(domain_identifier, params::Dict{String,<:Any})
Gets the data portal URL for the specified Amazon DataZone domain.
# Arguments
- `domain_identifier`: the ID of the Amazon DataZone domain the data portal of which you
want to get.
"""
function get_iam_portal_login_url(
domainIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/get-portal-login-url";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_iam_portal_login_url(
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/get-portal-login-url",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_listing(domain_identifier, identifier)
get_listing(domain_identifier, identifier, params::Dict{String,<:Any})
Gets a listing (a record of an asset at a given time).
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain.
- `identifier`: The ID of the listing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"listingRevision"`: The revision of the listing.
"""
function get_listing(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/listings/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_listing(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/listings/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_metadata_generation_run(domain_identifier, identifier)
get_metadata_generation_run(domain_identifier, identifier, params::Dict{String,<:Any})
Gets a metadata generation run in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain the metadata generation run of
which you want to get.
- `identifier`: The identifier of the metadata generation run.
"""
function get_metadata_generation_run(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/metadata-generation-runs/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_metadata_generation_run(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/metadata-generation-runs/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_project(domain_identifier, identifier)
get_project(domain_identifier, identifier, params::Dict{String,<:Any})
Gets a project in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the project exists.
- `identifier`: The ID of the project.
"""
function get_project(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/projects/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_project(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/projects/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subscription(domain_identifier, identifier)
get_subscription(domain_identifier, identifier, params::Dict{String,<:Any})
Gets a subscription in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the subscription
exists.
- `identifier`: The ID of the subscription.
"""
function get_subscription(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscriptions/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_subscription(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscriptions/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subscription_grant(domain_identifier, identifier)
get_subscription_grant(domain_identifier, identifier, params::Dict{String,<:Any})
Gets the subscription grant in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the subscription grant
exists.
- `identifier`: The ID of the subscription grant.
"""
function get_subscription_grant(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscription-grants/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_subscription_grant(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscription-grants/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subscription_request_details(domain_identifier, identifier)
get_subscription_request_details(domain_identifier, identifier, params::Dict{String,<:Any})
Gets the details of the specified subscription request.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which to get the
subscription request details.
- `identifier`: The identifier of the subscription request the details of which to get.
"""
function get_subscription_request_details(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscription-requests/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_subscription_request_details(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscription-requests/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subscription_target(domain_identifier, environment_identifier, identifier)
get_subscription_target(domain_identifier, environment_identifier, identifier, params::Dict{String,<:Any})
Gets the subscription target in Amazon DataZone.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the subscription
target exists.
- `environment_identifier`: The ID of the environment associated with the subscription
target.
- `identifier`: The ID of the subscription target.
"""
function get_subscription_target(
domainIdentifier,
environmentIdentifier,
identifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/subscription-targets/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_subscription_target(
domainIdentifier,
environmentIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/subscription-targets/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_time_series_data_point(domain_identifier, entity_identifier, entity_type, form_name, identifier)
get_time_series_data_point(domain_identifier, entity_identifier, entity_type, form_name, identifier, params::Dict{String,<:Any})
Gets the existing data point for the asset.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain that houses the asset for which
you want to get the data point.
- `entity_identifier`: The ID of the asset for which you want to get the data point.
- `entity_type`: The type of the asset for which you want to get the data point.
- `form_name`: The name of the time series form that houses the data point that you want to
get.
- `identifier`: The ID of the data point that you want to get.
"""
function get_time_series_data_point(
domainIdentifier,
entityIdentifier,
entityType,
formName,
identifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/entities/$(entityType)/$(entityIdentifier)/time-series-data-points/$(identifier)",
Dict{String,Any}("formName" => formName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_time_series_data_point(
domainIdentifier,
entityIdentifier,
entityType,
formName,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/entities/$(entityType)/$(entityIdentifier)/time-series-data-points/$(identifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("formName" => formName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user_profile(domain_identifier, user_identifier)
get_user_profile(domain_identifier, user_identifier, params::Dict{String,<:Any})
Gets a user profile in Amazon DataZone.
# Arguments
- `domain_identifier`: the ID of the Amazon DataZone domain the data portal of which you
want to get.
- `user_identifier`: The identifier of the user for which you want to get the user profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"type"`: The type of the user profile.
"""
function get_user_profile(
domainIdentifier, userIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/user-profiles/$(userIdentifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_user_profile(
domainIdentifier,
userIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/user-profiles/$(userIdentifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_asset_revisions(domain_identifier, identifier)
list_asset_revisions(domain_identifier, identifier, params::Dict{String,<:Any})
Lists the revisions for the asset.
# Arguments
- `domain_identifier`: The identifier of the domain.
- `identifier`: The identifier of the asset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of revisions to return in a single call to
ListAssetRevisions. When the number of revisions 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 ListAssetRevisions to list the next set of revisions.
- `"nextToken"`: When the number of revisions 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 revisions, the response includes a pagination token named NextToken. You can
specify this NextToken value in a subsequent call to ListAssetRevisions to list the next
set of revisions.
"""
function list_asset_revisions(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)/revisions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_asset_revisions(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)/revisions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_source_run_activities(domain_identifier, identifier)
list_data_source_run_activities(domain_identifier, identifier, params::Dict{String,<:Any})
Lists data source run activities.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which to list data
source run activities.
- `identifier`: The identifier of the data source run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of activities to return in a single call to
ListDataSourceRunActivities. When the number of activities 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 ListDataSourceRunActivities to list the next set of activities.
- `"nextToken"`: When the number of activities 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 activities, the response includes a pagination token named NextToken. You can
specify this NextToken value in a subsequent call to ListDataSourceRunActivities to list
the next set of activities.
- `"status"`: The status of the data source run.
"""
function list_data_source_run_activities(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/data-source-runs/$(identifier)/activities";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_source_run_activities(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/data-source-runs/$(identifier)/activities",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_source_runs(data_source_identifier, domain_identifier)
list_data_source_runs(data_source_identifier, domain_identifier, params::Dict{String,<:Any})
Lists data source runs in Amazon DataZone.
# Arguments
- `data_source_identifier`: The identifier of the data source.
- `domain_identifier`: The identifier of the Amazon DataZone domain in which to invoke the
ListDataSourceRuns action.
# 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 a single call to
ListDataSourceRuns. When the number of runs 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 ListDataSourceRuns to list the next set of runs.
- `"nextToken"`: When the number of runs 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 runs, the response includes a pagination token named NextToken. You can
specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next
set of runs.
- `"status"`: The status of the data source.
"""
function list_data_source_runs(
dataSourceIdentifier,
domainIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/data-sources/$(dataSourceIdentifier)/runs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_source_runs(
dataSourceIdentifier,
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/data-sources/$(dataSourceIdentifier)/runs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_sources(domain_identifier, project_identifier)
list_data_sources(domain_identifier, project_identifier, params::Dict{String,<:Any})
Lists data sources in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which to list the
data sources.
- `project_identifier`: The identifier of the project in which to list data sources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"environmentIdentifier"`: The identifier of the environment in which to list the data
sources.
- `"maxResults"`: The maximum number of data sources to return in a single call to
ListDataSources. When the number of data sources 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 ListDataSources to list the next set of data sources.
- `"name"`: The name of the data source.
- `"nextToken"`: When the number of data sources 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 data sources, the response includes a pagination token named NextToken. You
can specify this NextToken value in a subsequent call to ListDataSources to list the next
set of data sources.
- `"status"`: The status of the data source.
- `"type"`: The type of the data source.
"""
function list_data_sources(
domainIdentifier, projectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/data-sources",
Dict{String,Any}("projectIdentifier" => projectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_sources(
domainIdentifier,
projectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/data-sources",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("projectIdentifier" => projectIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains()
list_domains(params::Dict{String,<:Any})
Lists Amazon DataZone domains.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of domains to return in a single call to ListDomains.
When the number of domains 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 ListDomains to
list the next set of domains.
- `"nextToken"`: When the number of domains 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 domains, the response includes a pagination token named NextToken. You can
specify this NextToken value in a subsequent call to ListDomains to list the next set of
domains.
- `"status"`: The status of the data source.
"""
function list_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return datazone(
"GET", "/v2/domains"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET", "/v2/domains", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_environment_actions(domain_identifier, environment_identifier)
list_environment_actions(domain_identifier, environment_identifier, params::Dict{String,<:Any})
Lists existing environment actions.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which the environment
actions are listed.
- `environment_identifier`: The ID of the envrironment whose environment actions are listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of environment actions to return in a single call to
ListEnvironmentActions. When the number of environment actions 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 ListEnvironmentActions to list the next set of environment actions.
- `"nextToken"`: When the number of environment actions 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 environment actions, the response includes a pagination token named
NextToken. You can specify this NextToken value in a subsequent call to
ListEnvironmentActions to list the next set of environment actions.
"""
function list_environment_actions(
domainIdentifier,
environmentIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/actions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_environment_actions(
domainIdentifier,
environmentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/actions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environment_blueprint_configurations(domain_identifier)
list_environment_blueprint_configurations(domain_identifier, params::Dict{String,<:Any})
Lists blueprint configurations for a Amazon DataZone environment.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of blueprint configurations to return in a single call
to ListEnvironmentBlueprintConfigurations. When the number of configurations 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 ListEnvironmentBlueprintConfigurations to list the next set
of configurations.
- `"nextToken"`: When the number of blueprint configurations 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 configurations, the response includes a pagination token
named NextToken. You can specify this NextToken value in a subsequent call to
ListEnvironmentBlueprintConfigurations to list the next set of configurations.
"""
function list_environment_blueprint_configurations(
domainIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-blueprint-configurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_environment_blueprint_configurations(
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-blueprint-configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environment_blueprints(domain_identifier)
list_environment_blueprints(domain_identifier, params::Dict{String,<:Any})
Lists blueprints in an Amazon DataZone environment.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"managed"`: Specifies whether the environment blueprint is managed by Amazon DataZone.
- `"maxResults"`: The maximum number of blueprints to return in a single call to
ListEnvironmentBlueprints. When the number of blueprints 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 ListEnvironmentBlueprints to list the next set of blueprints.
- `"name"`: The name of the Amazon DataZone environment.
- `"nextToken"`: When the number of blueprints in the environment 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 blueprints in the environment, the response
includes a pagination token named NextToken. You can specify this NextToken value in a
subsequent call to ListEnvironmentBlueprintsto list the next set of blueprints.
"""
function list_environment_blueprints(
domainIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-blueprints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_environment_blueprints(
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-blueprints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environment_profiles(domain_identifier)
list_environment_profiles(domain_identifier, params::Dict{String,<:Any})
Lists Amazon DataZone environment profiles.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"awsAccountId"`: The identifier of the Amazon Web Services account where you want to
list environment profiles.
- `"awsAccountRegion"`: The Amazon Web Services region where you want to list environment
profiles.
- `"environmentBlueprintIdentifier"`: The identifier of the blueprint that was used to
create the environment profiles that you want to list.
- `"maxResults"`: The maximum number of environment profiles to return in a single call to
ListEnvironmentProfiles. When the number of environment profiles 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 ListEnvironmentProfiles to list the next set of environment profiles.
- `"name"`:
- `"nextToken"`: When the number of environment profiles 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 environment profiles, the response includes a pagination token
named NextToken. You can specify this NextToken value in a subsequent call to
ListEnvironmentProfiles to list the next set of environment profiles.
- `"projectIdentifier"`: The identifier of the Amazon DataZone project.
"""
function list_environment_profiles(
domainIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-profiles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_environment_profiles(
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environment-profiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environments(domain_identifier, project_identifier)
list_environments(domain_identifier, project_identifier, params::Dict{String,<:Any})
Lists Amazon DataZone environments.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
- `project_identifier`: The identifier of the Amazon DataZone project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"awsAccountId"`: The identifier of the Amazon Web Services account where you want to
list environments.
- `"awsAccountRegion"`: The Amazon Web Services region where you want to list environments.
- `"environmentBlueprintIdentifier"`: The identifier of the Amazon DataZone blueprint.
- `"environmentProfileIdentifier"`: The identifier of the environment profile.
- `"maxResults"`: The maximum number of environments to return in a single call to
ListEnvironments. When the number of environments 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 ListEnvironments to list the next set of environments.
- `"name"`: The name of the environment.
- `"nextToken"`: When the number of environments 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 environments, the response includes a pagination token named NextToken. You
can specify this NextToken value in a subsequent call to ListEnvironments to list the next
set of environments.
- `"provider"`: The provider of the environment.
- `"status"`: The status of the environments that you want to list.
"""
function list_environments(
domainIdentifier, projectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments",
Dict{String,Any}("projectIdentifier" => projectIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_environments(
domainIdentifier,
projectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("projectIdentifier" => projectIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_metadata_generation_runs(domain_identifier)
list_metadata_generation_runs(domain_identifier, params::Dict{String,<:Any})
Lists all metadata generation runs.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain where you want to list metadata
generation runs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of metadata generation runs to return in a single call
to ListMetadataGenerationRuns. When the number of metadata generation runs 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 ListMetadataGenerationRuns to list the next set of revisions.
- `"nextToken"`: When the number of metadata generation runs 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 metadata generation runs, the response includes a
pagination token named NextToken. You can specify this NextToken value in a subsequent call
to ListMetadataGenerationRuns to list the next set of revisions.
- `"status"`: The status of the metadata generation runs.
- `"type"`: The type of the metadata generation runs.
"""
function list_metadata_generation_runs(
domainIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/metadata-generation-runs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_metadata_generation_runs(
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/metadata-generation-runs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_notifications(domain_identifier, type)
list_notifications(domain_identifier, type, params::Dict{String,<:Any})
Lists all Amazon DataZone notifications.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
- `type`: The type of notifications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"afterTimestamp"`: The time after which you want to list notifications.
- `"beforeTimestamp"`: The time before which you want to list notifications.
- `"maxResults"`: The maximum number of notifications to return in a single call to
ListNotifications. When the number of notifications 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 ListNotifications to list the next set of notifications.
- `"nextToken"`: When the number of notifications 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 notifications, the response includes a pagination token named NextToken. You
can specify this NextToken value in a subsequent call to ListNotifications to list the next
set of notifications.
- `"subjects"`: The subjects of notifications.
- `"taskStatus"`: The task status of notifications.
"""
function list_notifications(
domainIdentifier, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/notifications",
Dict{String,Any}("type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_notifications(
domainIdentifier,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/notifications",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("type" => type), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_project_memberships(domain_identifier, project_identifier)
list_project_memberships(domain_identifier, project_identifier, params::Dict{String,<:Any})
Lists all members of the specified project.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which you want to
list project memberships.
- `project_identifier`: The identifier of the project whose memberships 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 memberships to return in a single call to
ListProjectMemberships. When the number of memberships 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 ListProjectMemberships to list the next set of memberships.
- `"nextToken"`: When the number of memberships 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 memberships, the response includes a pagination token named NextToken. You
can specify this NextToken value in a subsequent call to ListProjectMemberships to list the
next set of memberships.
- `"sortBy"`: The method by which you want to sort the project memberships.
- `"sortOrder"`: The sort order of the project memberships.
"""
function list_project_memberships(
domainIdentifier, projectIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/projects/$(projectIdentifier)/memberships";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_project_memberships(
domainIdentifier,
projectIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/projects/$(projectIdentifier)/memberships",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_projects(domain_identifier)
list_projects(domain_identifier, params::Dict{String,<:Any})
Lists Amazon DataZone projects.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"groupIdentifier"`: The identifier of a group.
- `"maxResults"`: The maximum number of projects to return in a single call to
ListProjects. When the number of projects 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 ListProjects to list the next set of projects.
- `"name"`: The name of the project.
- `"nextToken"`: When the number of projects 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 projects, the response includes a pagination token named NextToken. You can
specify this NextToken value in a subsequent call to ListProjects to list the next set of
projects.
- `"userIdentifier"`: The identifier of the Amazon DataZone user.
"""
function list_projects(domainIdentifier; aws_config::AbstractAWSConfig=global_aws_config())
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/projects";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_projects(
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/projects",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscription_grants(domain_identifier)
list_subscription_grants(domain_identifier, params::Dict{String,<:Any})
Lists subscription grants.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"environmentId"`: The identifier of the Amazon DataZone environment.
- `"maxResults"`: The maximum number of subscription grants to return in a single call to
ListSubscriptionGrants. When the number of subscription grants 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 ListSubscriptionGrants to list the next set of subscription grants.
- `"nextToken"`: When the number of subscription grants 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 subscription grants, the response includes a pagination token named
NextToken. You can specify this NextToken value in a subsequent call to
ListSubscriptionGrants to list the next set of subscription grants.
- `"sortBy"`: Specifies the way of sorting the results of this action.
- `"sortOrder"`: Specifies the sort order of this action.
- `"subscribedListingId"`: The identifier of the subscribed listing.
- `"subscriptionId"`: The identifier of the subscription.
- `"subscriptionTargetId"`: The identifier of the subscription target.
"""
function list_subscription_grants(
domainIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscription-grants";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_subscription_grants(
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscription-grants",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscription_requests(domain_identifier)
list_subscription_requests(domain_identifier, params::Dict{String,<:Any})
Lists Amazon DataZone subscription requests.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"approverProjectId"`: The identifier of the subscription request approver's project.
- `"maxResults"`: The maximum number of subscription requests to return in a single call to
ListSubscriptionRequests. When the number of subscription requests 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 ListSubscriptionRequests to list the next set of subscription requests.
- `"nextToken"`: When the number of subscription requests 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 subscription requests, the response includes a pagination token
named NextToken. You can specify this NextToken value in a subsequent call to
ListSubscriptionRequests to list the next set of subscription requests.
- `"owningProjectId"`: The identifier of the project for the subscription requests.
- `"sortBy"`: Specifies the way to sort the results of this action.
- `"sortOrder"`: Specifies the sort order for the results of this action.
- `"status"`: Specifies the status of the subscription requests.
- `"subscribedListingId"`: The identifier of the subscribed listing.
"""
function list_subscription_requests(
domainIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscription-requests";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_subscription_requests(
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscription-requests",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscription_targets(domain_identifier, environment_identifier)
list_subscription_targets(domain_identifier, environment_identifier, params::Dict{String,<:Any})
Lists subscription targets in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain where you want to list
subscription targets.
- `environment_identifier`: The identifier of the environment where you want to list
subscription targets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of subscription targets to return in a single call to
ListSubscriptionTargets. When the number of subscription targets 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 ListSubscriptionTargets to list the next set of subscription targets.
- `"nextToken"`: When the number of subscription targets 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 subscription targets, the response includes a pagination token
named NextToken. You can specify this NextToken value in a subsequent call to
ListSubscriptionTargets to list the next set of subscription targets.
- `"sortBy"`: Specifies the way in which the results of this action are to be sorted.
- `"sortOrder"`: Specifies the sort order for the results of this action.
"""
function list_subscription_targets(
domainIdentifier,
environmentIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/subscription-targets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_subscription_targets(
domainIdentifier,
environmentIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/subscription-targets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscriptions(domain_identifier)
list_subscriptions(domain_identifier, params::Dict{String,<:Any})
Lists subscriptions in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"approverProjectId"`: The identifier of the project for the subscription's approver.
- `"maxResults"`: The maximum number of subscriptions to return in a single call to
ListSubscriptions. When the number of subscriptions 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 ListSubscriptions to list the next set of Subscriptions.
- `"nextToken"`: When the number of subscriptions 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 subscriptions, the response includes a pagination token named NextToken. You
can specify this NextToken value in a subsequent call to ListSubscriptions to list the next
set of subscriptions.
- `"owningProjectId"`: The identifier of the owning project.
- `"sortBy"`: Specifies the way in which the results of this action are to be sorted.
- `"sortOrder"`: Specifies the sort order for the results of this action.
- `"status"`: The status of the subscriptions that you want to list.
- `"subscribedListingId"`: The identifier of the subscribed listing for the subscriptions
that you want to list.
- `"subscriptionRequestIdentifier"`: The identifier of the subscription request for the
subscriptions that you want to list.
"""
function list_subscriptions(
domainIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscriptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_subscriptions(
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/subscriptions",
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 tags for the specified resource in Amazon DataZone.
# Arguments
- `resource_arn`: The ARN of the resource whose tags you want to list.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"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 datazone(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_time_series_data_points(domain_identifier, entity_identifier, entity_type, form_name)
list_time_series_data_points(domain_identifier, entity_identifier, entity_type, form_name, params::Dict{String,<:Any})
Lists time series data points.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain that houses the assets for
which you want to list time series data points.
- `entity_identifier`: The ID of the asset for which you want to list data points.
- `entity_type`: The type of the asset for which you want to list data points.
- `form_name`: The name of the time series data points form.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endedAt"`: The timestamp at which the data points that you wanted to list ended.
- `"maxResults"`: The maximum number of data points to return in a single call to
ListTimeSeriesDataPoints. When the number of data points 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 ListTimeSeriesDataPoints to list the next set of data points.
- `"nextToken"`: When the number of data points 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 data points, the response includes a pagination token named NextToken. You
can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list
the next set of data points.
- `"startedAt"`: The timestamp at which the data points that you want to list started.
"""
function list_time_series_data_points(
domainIdentifier,
entityIdentifier,
entityType,
formName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/entities/$(entityType)/$(entityIdentifier)/time-series-data-points",
Dict{String,Any}("formName" => formName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_time_series_data_points(
domainIdentifier,
entityIdentifier,
entityType,
formName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"GET",
"/v2/domains/$(domainIdentifier)/entities/$(entityType)/$(entityIdentifier)/time-series-data-points",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("formName" => formName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
post_time_series_data_points(domain_identifier, entity_identifier, entity_type, forms)
post_time_series_data_points(domain_identifier, entity_identifier, entity_type, forms, params::Dict{String,<:Any})
Posts time series data points to Amazon DataZone for the specified asset.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain in which you want to post time
series data points.
- `entity_identifier`: The ID of the asset for which you want to post time series data
points.
- `entity_type`: The type of the asset for which you want to post data points.
- `forms`: The forms that contain the data points that you want to post.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
"""
function post_time_series_data_points(
domainIdentifier,
entityIdentifier,
entityType,
forms;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/entities/$(entityType)/$(entityIdentifier)/time-series-data-points",
Dict{String,Any}("forms" => forms, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function post_time_series_data_points(
domainIdentifier,
entityIdentifier,
entityType,
forms,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/entities/$(entityType)/$(entityIdentifier)/time-series-data-points",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("forms" => forms, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_environment_blueprint_configuration(domain_identifier, enabled_regions, environment_blueprint_identifier)
put_environment_blueprint_configuration(domain_identifier, enabled_regions, environment_blueprint_identifier, params::Dict{String,<:Any})
Writes the configuration for the specified environment blueprint in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
- `enabled_regions`: Specifies the enabled Amazon Web Services Regions.
- `environment_blueprint_identifier`: The identifier of the environment blueprint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"manageAccessRoleArn"`: The ARN of the manage access role.
- `"provisioningRoleArn"`: The ARN of the provisioning role.
- `"regionalParameters"`: The regional parameters in the environment blueprint.
"""
function put_environment_blueprint_configuration(
domainIdentifier,
enabledRegions,
environmentBlueprintIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/environment-blueprint-configurations/$(environmentBlueprintIdentifier)",
Dict{String,Any}("enabledRegions" => enabledRegions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_environment_blueprint_configuration(
domainIdentifier,
enabledRegions,
environmentBlueprintIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/environment-blueprint-configurations/$(environmentBlueprintIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("enabledRegions" => enabledRegions), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_predictions(domain_identifier, identifier)
reject_predictions(domain_identifier, identifier, params::Dict{String,<:Any})
Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
- `identifier`: The identifier of the prediction.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"rejectChoices"`: Specifies the prediction (aka, the automatically generated piece of
metadata) and the target (for example, a column name) that can be rejected.
- `"rejectRule"`: Specifies the rule (or the conditions) under which a prediction can be
rejected.
- `"revision"`: The revision that is to be made to the asset.
"""
function reject_predictions(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)/reject-predictions",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_predictions(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/assets/$(identifier)/reject-predictions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_subscription_request(domain_identifier, identifier)
reject_subscription_request(domain_identifier, identifier, params::Dict{String,<:Any})
Rejects the specified subscription request.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which the
subscription request was rejected.
- `identifier`: The identifier of the subscription request that was rejected.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"decisionComment"`: The decision comment of the rejected subscription request.
"""
function reject_subscription_request(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/subscription-requests/$(identifier)/reject";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_subscription_request(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/subscription-requests/$(identifier)/reject",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_subscription(domain_identifier, identifier)
revoke_subscription(domain_identifier, identifier, params::Dict{String,<:Any})
Revokes a specified subscription in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain where you want to
revoke a subscription.
- `identifier`: The identifier of the revoked subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"retainPermissions"`: Specifies whether permissions are retained when the subscription
is revoked.
"""
function revoke_subscription(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/subscriptions/$(identifier)/revoke";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_subscription(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/subscriptions/$(identifier)/revoke",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search(domain_identifier, search_scope)
search(domain_identifier, search_scope, params::Dict{String,<:Any})
Searches for assets in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain.
- `search_scope`: The scope of the search.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalAttributes"`: Specifies additional attributes for the Search action.
- `"filters"`: Specifies the search filters.
- `"maxResults"`: The maximum number of results to return in a single call to Search. When
the number of results 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 Search to list the next
set of results.
- `"nextToken"`: When the number of results 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 results, the response includes a pagination token named NextToken. You can
specify this NextToken value in a subsequent call to Search to list the next set of results.
- `"owningProjectIdentifier"`: The identifier of the owning project specified for the
search.
- `"searchIn"`: The details of the search.
- `"searchText"`: Specifies the text for which to search.
- `"sort"`: Specifies the way in which the search results are to be sorted.
"""
function search(
domainIdentifier, searchScope; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/search",
Dict{String,Any}("searchScope" => searchScope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search(
domainIdentifier,
searchScope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/search",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("searchScope" => searchScope), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_group_profiles(domain_identifier, group_type)
search_group_profiles(domain_identifier, group_type, params::Dict{String,<:Any})
Searches group profiles in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which you want to
search group profiles.
- `group_type`: The group type for which to search.
# 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 to
SearchGroupProfiles. When the number of results 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 SearchGroupProfiles to list the next set of results.
- `"nextToken"`: When the number of results 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 results, the response includes a pagination token named NextToken. You can
specify this NextToken value in a subsequent call to SearchGroupProfiles to list the next
set of results.
- `"searchText"`: Specifies the text for which to search.
"""
function search_group_profiles(
domainIdentifier, groupType; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/search-group-profiles",
Dict{String,Any}("groupType" => groupType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_group_profiles(
domainIdentifier,
groupType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/search-group-profiles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("groupType" => groupType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_listings(domain_identifier)
search_listings(domain_identifier, params::Dict{String,<:Any})
Searches listings (records of an asset at a given time) in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the domain in which to search listings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalAttributes"`: Specifies additional attributes for the search.
- `"filters"`: Specifies the filters for the search of listings.
- `"maxResults"`: The maximum number of results to return in a single call to
SearchListings. When the number of results 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 SearchListings to list the next set of results.
- `"nextToken"`: When the number of results 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 results, the response includes a pagination token named NextToken. You can
specify this NextToken value in a subsequent call to SearchListings to list the next set of
results.
- `"searchIn"`: The details of the search.
- `"searchText"`: Specifies the text for which to search.
- `"sort"`: Specifies the way for sorting the search results.
"""
function search_listings(
domainIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/listings/search";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_listings(
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/listings/search",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_types(domain_identifier, managed, search_scope)
search_types(domain_identifier, managed, search_scope, params::Dict{String,<:Any})
Searches for types in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which to invoke the
SearchTypes action.
- `managed`: Specifies whether the search is managed.
- `search_scope`: Specifies the scope of the search for types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: The filters for the SearchTypes action.
- `"maxResults"`: The maximum number of results to return in a single call to SearchTypes.
When the number of results 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 SearchTypes to
list the next set of results.
- `"nextToken"`: When the number of results 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 results, the response includes a pagination token named NextToken. You can
specify this NextToken value in a subsequent call to SearchTypes to list the next set of
results.
- `"searchIn"`: The details of the search.
- `"searchText"`: Specifies the text for which to search.
- `"sort"`: The specifies the way to sort the SearchTypes results.
"""
function search_types(
domainIdentifier,
managed,
searchScope;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/types-search",
Dict{String,Any}("managed" => managed, "searchScope" => searchScope);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_types(
domainIdentifier,
managed,
searchScope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/types-search",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("managed" => managed, "searchScope" => searchScope),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_user_profiles(domain_identifier, user_type)
search_user_profiles(domain_identifier, user_type, params::Dict{String,<:Any})
Searches user profiles in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which you want to
search user profiles.
- `user_type`: Specifies the user type for the SearchUserProfiles 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 in a single call to
SearchUserProfiles. When the number of results 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 SearchUserProfiles to list the next set of results.
- `"nextToken"`: When the number of results 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 results, the response includes a pagination token named NextToken. You can
specify this NextToken value in a subsequent call to SearchUserProfiles to list the next
set of results.
- `"searchText"`: Specifies the text for which to search.
"""
function search_user_profiles(
domainIdentifier, userType; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/search-user-profiles",
Dict{String,Any}("userType" => userType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_user_profiles(
domainIdentifier,
userType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/search-user-profiles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("userType" => userType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_data_source_run(data_source_identifier, domain_identifier)
start_data_source_run(data_source_identifier, domain_identifier, params::Dict{String,<:Any})
Start the run of the specified data source in Amazon DataZone.
# Arguments
- `data_source_identifier`: The identifier of the data source.
- `domain_identifier`: The identifier of the Amazon DataZone domain in which to start a
data source run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
"""
function start_data_source_run(
dataSourceIdentifier,
domainIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/data-sources/$(dataSourceIdentifier)/runs",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_data_source_run(
dataSourceIdentifier,
domainIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/data-sources/$(dataSourceIdentifier)/runs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_metadata_generation_run(domain_identifier, owning_project_identifier, target, type)
start_metadata_generation_run(domain_identifier, owning_project_identifier, target, type, params::Dict{String,<:Any})
Starts the metadata generation run.
# Arguments
- `domain_identifier`: The ID of the Amazon DataZone domain where you want to start a
metadata generation run.
- `owning_project_identifier`: The ID of the project that owns the asset for which you want
to start a metadata generation run.
- `target`: The asset for which you want to start a metadata generation run.
- `type`: The type of the metadata generation run.
# 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. This field is automatically populated if not provided.
"""
function start_metadata_generation_run(
domainIdentifier,
owningProjectIdentifier,
target,
type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/metadata-generation-runs",
Dict{String,Any}(
"owningProjectIdentifier" => owningProjectIdentifier,
"target" => target,
"type" => type,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_metadata_generation_run(
domainIdentifier,
owningProjectIdentifier,
target,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"POST",
"/v2/domains/$(domainIdentifier)/metadata-generation-runs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"owningProjectIdentifier" => owningProjectIdentifier,
"target" => target,
"type" => type,
"clientToken" => 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 in Amazon DataZone.
# Arguments
- `resource_arn`: The ARN of the resource to be tagged in Amazon DataZone.
- `tags`: Specifies the tags for the TagResource action.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return datazone(
"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 datazone(
"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})
Untags a resource in Amazon DataZone.
# Arguments
- `resource_arn`: The ARN of the resource to be untagged in Amazon DataZone.
- `tag_keys`: Specifies the tag keys for the UntagResource action.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"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 datazone(
"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_data_source(domain_identifier, identifier)
update_data_source(domain_identifier, identifier, params::Dict{String,<:Any})
Updates the specified data source in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the domain in which to update a data source.
- `identifier`: The identifier of the data source to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assetFormsInput"`: The asset forms to be updated as part of the UpdateDataSource action.
- `"configuration"`: The configuration to be updated as part of the UpdateDataSource action.
- `"description"`: The description to be updated as part of the UpdateDataSource action.
- `"enableSetting"`: The enable setting to be updated as part of the UpdateDataSource
action.
- `"name"`: The name to be updated as part of the UpdateDataSource action.
- `"publishOnImport"`: The publish on import setting to be updated as part of the
UpdateDataSource action.
- `"recommendation"`: The recommendation to be updated as part of the UpdateDataSource
action.
- `"retainPermissionsOnRevokeFailure"`: Specifies that the granted permissions are retained
in case of a self-subscribe functionality failure for a data source.
- `"schedule"`: The schedule to be updated as part of the UpdateDataSource action.
"""
function update_data_source(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/data-sources/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_source(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/data-sources/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_domain(identifier)
update_domain(identifier, params::Dict{String,<:Any})
Updates a Amazon DataZone domain.
# Arguments
- `identifier`: The ID of the Amazon Web Services domain that is to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"description"`: The description to be updated as part of the UpdateDomain action.
- `"domainExecutionRole"`: The domain execution role to be updated as part of the
UpdateDomain action.
- `"name"`: The name to be updated as part of the UpdateDomain action.
- `"singleSignOn"`: The single sign-on option to be updated as part of the UpdateDomain
action.
"""
function update_domain(identifier; aws_config::AbstractAWSConfig=global_aws_config())
return datazone(
"PUT",
"/v2/domains/$(identifier)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_domain(
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(identifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_environment(domain_identifier, identifier)
update_environment(domain_identifier, identifier, params::Dict{String,<:Any})
Updates the specified environment in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the domain in which the environment is to be
updated.
- `identifier`: The identifier of the environment that is to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description to be updated as part of the UpdateEnvironment action.
- `"glossaryTerms"`: The glossary terms to be updated as part of the UpdateEnvironment
action.
- `"name"`: The name to be updated as part of the UpdateEnvironment action.
"""
function update_environment(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/environments/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_environment(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/environments/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_environment_action(domain_identifier, environment_identifier, identifier)
update_environment_action(domain_identifier, environment_identifier, identifier, params::Dict{String,<:Any})
Updates an environment action.
# Arguments
- `domain_identifier`: The domain ID of the environment action.
- `environment_identifier`: The environment ID of the environment action.
- `identifier`: The ID of the environment action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the environment action.
- `"name"`: The name of the environment action.
- `"parameters"`: The parameters of the environment action.
"""
function update_environment_action(
domainIdentifier,
environmentIdentifier,
identifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/actions/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_environment_action(
domainIdentifier,
environmentIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/actions/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_environment_profile(domain_identifier, identifier)
update_environment_profile(domain_identifier, identifier, params::Dict{String,<:Any})
Updates the specified environment profile in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which an environment
profile is to be updated.
- `identifier`: The identifier of the environment profile that is to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"awsAccountId"`: The Amazon Web Services account in which a specified environment
profile is to be udpated.
- `"awsAccountRegion"`: The Amazon Web Services Region in which a specified environment
profile is to be updated.
- `"description"`: The description to be updated as part of the UpdateEnvironmentProfile
action.
- `"name"`: The name to be updated as part of the UpdateEnvironmentProfile action.
- `"userParameters"`: The user parameters to be updated as part of the
UpdateEnvironmentProfile action.
"""
function update_environment_profile(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/environment-profiles/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_environment_profile(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/environment-profiles/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_glossary(domain_identifier, identifier)
update_glossary(domain_identifier, identifier, params::Dict{String,<:Any})
Updates the business glossary in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which a business
glossary is to be updated.
- `identifier`: The identifier of the business glossary to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive identifier that is provided to ensure the
idempotency of the request.
- `"description"`: The description to be updated as part of the UpdateGlossary action.
- `"name"`: The name to be updated as part of the UpdateGlossary action.
- `"status"`: The status to be updated as part of the UpdateGlossary action.
"""
function update_glossary(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/glossaries/$(identifier)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_glossary(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/glossaries/$(identifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_glossary_term(domain_identifier, identifier)
update_glossary_term(domain_identifier, identifier, params::Dict{String,<:Any})
Updates a business glossary term in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which a business
glossary term is to be updated.
- `identifier`: The identifier of the business glossary term that is to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"glossaryIdentifier"`: The identifier of the business glossary in which a term is to be
updated.
- `"longDescription"`: The long description to be updated as part of the UpdateGlossaryTerm
action.
- `"name"`: The name to be updated as part of the UpdateGlossaryTerm action.
- `"shortDescription"`: The short description to be updated as part of the
UpdateGlossaryTerm action.
- `"status"`: The status to be updated as part of the UpdateGlossaryTerm action.
- `"termRelations"`: The term relations to be updated as part of the UpdateGlossaryTerm
action.
"""
function update_glossary_term(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/glossary-terms/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_glossary_term(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/glossary-terms/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_group_profile(domain_identifier, group_identifier, status)
update_group_profile(domain_identifier, group_identifier, status, params::Dict{String,<:Any})
Updates the specified group profile in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which a group
profile is updated.
- `group_identifier`: The identifier of the group profile that is updated.
- `status`: The status of the group profile that is updated.
"""
function update_group_profile(
domainIdentifier,
groupIdentifier,
status;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/group-profiles/$(groupIdentifier)",
Dict{String,Any}("status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_group_profile(
domainIdentifier,
groupIdentifier,
status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/group-profiles/$(groupIdentifier)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("status" => status), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_project(domain_identifier, identifier)
update_project(domain_identifier, identifier, params::Dict{String,<:Any})
Updates the specified project in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which a project is
to be updated.
- `identifier`: The identifier of the project that is to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description to be updated as part of the UpdateProject action.
- `"glossaryTerms"`: The glossary terms to be updated as part of the UpdateProject action.
- `"name"`: The name to be updated as part of the UpdateProject action.
"""
function update_project(
domainIdentifier, identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/projects/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_project(
domainIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/projects/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_subscription_grant_status(asset_identifier, domain_identifier, identifier, status)
update_subscription_grant_status(asset_identifier, domain_identifier, identifier, status, params::Dict{String,<:Any})
Updates the status of the specified subscription grant status in Amazon DataZone.
# Arguments
- `asset_identifier`: The identifier of the asset the subscription grant status of which is
to be updated.
- `domain_identifier`: The identifier of the Amazon DataZone domain in which a subscription
grant status is to be updated.
- `identifier`: The identifier of the subscription grant the status of which is to be
updated.
- `status`: The status to be updated as part of the UpdateSubscriptionGrantStatus action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"failureCause"`: Specifies the error message that is returned if the operation cannot be
successfully completed.
- `"targetName"`: The target name to be updated as part of the
UpdateSubscriptionGrantStatus action.
"""
function update_subscription_grant_status(
assetIdentifier,
domainIdentifier,
identifier,
status;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/subscription-grants/$(identifier)/status/$(assetIdentifier)",
Dict{String,Any}("status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_subscription_grant_status(
assetIdentifier,
domainIdentifier,
identifier,
status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/subscription-grants/$(identifier)/status/$(assetIdentifier)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("status" => status), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_subscription_request(domain_identifier, identifier, request_reason)
update_subscription_request(domain_identifier, identifier, request_reason, params::Dict{String,<:Any})
Updates a specified subscription request in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which a subscription
request is to be updated.
- `identifier`: The identifier of the subscription request that is to be updated.
- `request_reason`: The reason for the UpdateSubscriptionRequest action.
"""
function update_subscription_request(
domainIdentifier,
identifier,
requestReason;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/subscription-requests/$(identifier)",
Dict{String,Any}("requestReason" => requestReason);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_subscription_request(
domainIdentifier,
identifier,
requestReason,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/subscription-requests/$(identifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("requestReason" => requestReason), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_subscription_target(domain_identifier, environment_identifier, identifier)
update_subscription_target(domain_identifier, environment_identifier, identifier, params::Dict{String,<:Any})
Updates the specified subscription target in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which a subscription
target is to be updated.
- `environment_identifier`: The identifier of the environment in which a subscription
target is to be updated.
- `identifier`: Identifier of the subscription target that is to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicableAssetTypes"`: The applicable asset types to be updated as part of the
UpdateSubscriptionTarget action.
- `"authorizedPrincipals"`: The authorized principals to be updated as part of the
UpdateSubscriptionTarget action.
- `"manageAccessRole"`: The manage access role to be updated as part of the
UpdateSubscriptionTarget action.
- `"name"`: The name to be updated as part of the UpdateSubscriptionTarget action.
- `"provider"`: The provider to be updated as part of the UpdateSubscriptionTarget action.
- `"subscriptionTargetConfig"`: The configuration to be updated as part of the
UpdateSubscriptionTarget action.
"""
function update_subscription_target(
domainIdentifier,
environmentIdentifier,
identifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/subscription-targets/$(identifier)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_subscription_target(
domainIdentifier,
environmentIdentifier,
identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PATCH",
"/v2/domains/$(domainIdentifier)/environments/$(environmentIdentifier)/subscription-targets/$(identifier)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_profile(domain_identifier, status, user_identifier)
update_user_profile(domain_identifier, status, user_identifier, params::Dict{String,<:Any})
Updates the specified user profile in Amazon DataZone.
# Arguments
- `domain_identifier`: The identifier of the Amazon DataZone domain in which a user profile
is updated.
- `status`: The status of the user profile that are to be updated.
- `user_identifier`: The identifier of the user whose user profile is to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"type"`: The type of the user profile that are to be updated.
"""
function update_user_profile(
domainIdentifier,
status,
userIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/user-profiles/$(userIdentifier)",
Dict{String,Any}("status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_profile(
domainIdentifier,
status,
userIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return datazone(
"PUT",
"/v2/domains/$(domainIdentifier)/user-profiles/$(userIdentifier)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("status" => status), 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 | 33980 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: dax
using AWS.Compat
using AWS.UUIDs
"""
create_cluster(cluster_name, iam_role_arn, node_type, replication_factor)
create_cluster(cluster_name, iam_role_arn, node_type, replication_factor, params::Dict{String,<:Any})
Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
# Arguments
- `cluster_name`: The cluster identifier. This parameter is stored as a lowercase string.
Constraints: A name must contain from 1 to 20 alphanumeric characters or hyphens. The
first character must be a letter. A name cannot end with a hyphen or contain two
consecutive hyphens.
- `iam_role_arn`: A valid Amazon Resource Name (ARN) that identifies an IAM role. At
runtime, DAX will assume this role and use the role's permissions to access DynamoDB on
your behalf.
- `node_type`: The compute and memory capacity of the nodes in the cluster.
- `replication_factor`: The number of nodes in the DAX cluster. A replication factor of 1
will create a single-node cluster, without any read replicas. For additional fault
tolerance, you can create a multiple node cluster with one or more read replicas. To do
this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and
10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided,
its length must equal the ReplicationFactor. AWS recommends that you have at least two
read replicas per cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZones"`: The Availability Zones (AZs) in which the cluster nodes will
reside after the cluster has been created or updated. If provided, the length of this list
must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the
nodes across Availability Zones for the highest availability.
- `"ClusterEndpointEncryptionType"`: The type of encryption the cluster's endpoint should
support. Values are: NONE for no encryption TLS for Transport Layer Security
- `"Description"`: A description of the cluster.
- `"NotificationTopicArn"`: The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent. The Amazon SNS topic owner must be same as the DAX cluster
owner.
- `"ParameterGroupName"`: The parameter group to be associated with the DAX cluster.
- `"PreferredMaintenanceWindow"`: Specifies the weekly time range during which maintenance
on the DAX 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:05:00-sun:09:00 If you don't specify a preferred maintenance window when you
create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly
selected day of the week.
- `"SSESpecification"`: Represents the settings used to enable server-side encryption on
the cluster.
- `"SecurityGroupIds"`: A list of security group IDs to be assigned to each node in the DAX
cluster. (Each of the security group ID is system-generated.) If this parameter is not
specified, DAX assigns the default VPC security group to each node.
- `"SubnetGroupName"`: The name of the subnet group to be used for the replication group.
DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify
in a subnet group must exist in the same VPC.
- `"Tags"`: A set of tags to associate with the DAX cluster.
"""
function create_cluster(
ClusterName,
IamRoleArn,
NodeType,
ReplicationFactor;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dax(
"CreateCluster",
Dict{String,Any}(
"ClusterName" => ClusterName,
"IamRoleArn" => IamRoleArn,
"NodeType" => NodeType,
"ReplicationFactor" => ReplicationFactor,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster(
ClusterName,
IamRoleArn,
NodeType,
ReplicationFactor,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dax(
"CreateCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterName" => ClusterName,
"IamRoleArn" => IamRoleArn,
"NodeType" => NodeType,
"ReplicationFactor" => ReplicationFactor,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_parameter_group(parameter_group_name)
create_parameter_group(parameter_group_name, params::Dict{String,<:Any})
Creates a new parameter group. A parameter group is a collection of parameters that you
apply to all of the nodes in a DAX cluster.
# Arguments
- `parameter_group_name`: The name of the parameter group to apply to all of the clusters
in this replication group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the parameter group.
"""
function create_parameter_group(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"CreateParameterGroup",
Dict{String,Any}("ParameterGroupName" => ParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_parameter_group(
ParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dax(
"CreateParameterGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), 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 new subnet group.
# Arguments
- `subnet_group_name`: A name for the subnet group. This value is stored as a lowercase
string.
- `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
"""
function create_subnet_group(
SubnetGroupName, SubnetIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"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 dax(
"CreateSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SubnetGroupName" => SubnetGroupName, "SubnetIds" => SubnetIds
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
decrease_replication_factor(cluster_name, new_replication_factor)
decrease_replication_factor(cluster_name, new_replication_factor, params::Dict{String,<:Any})
Removes one or more nodes from a DAX cluster. You cannot use DecreaseReplicationFactor to
remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.
# Arguments
- `cluster_name`: The name of the DAX cluster from which you want to remove nodes.
- `new_replication_factor`: The new number of nodes for the DAX cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZones"`: The Availability Zone(s) from which to remove nodes.
- `"NodeIdsToRemove"`: The unique identifiers of the nodes to be removed from the cluster.
"""
function decrease_replication_factor(
ClusterName, NewReplicationFactor; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"DecreaseReplicationFactor",
Dict{String,Any}(
"ClusterName" => ClusterName, "NewReplicationFactor" => NewReplicationFactor
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function decrease_replication_factor(
ClusterName,
NewReplicationFactor,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dax(
"DecreaseReplicationFactor",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterName" => ClusterName,
"NewReplicationFactor" => NewReplicationFactor,
),
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 previously provisioned DAX cluster. DeleteCluster deletes all associated nodes,
node endpoints and the DAX cluster itself. When you receive a successful response from this
action, DAX immediately begins deleting the cluster; you cannot cancel or revert this
action.
# Arguments
- `cluster_name`: The name of the cluster to be deleted.
"""
function delete_cluster(ClusterName; aws_config::AbstractAWSConfig=global_aws_config())
return dax(
"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 dax(
"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 DAX clusters.
# Arguments
- `parameter_group_name`: The name of the parameter group to delete.
"""
function delete_parameter_group(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"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 dax(
"DeleteParameterGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), 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 subnet group if it is associated with any DAX
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 dax(
"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 dax(
"DeleteSubnetGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubnetGroupName" => SubnetGroupName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_clusters()
describe_clusters(params::Dict{String,<:Any})
Returns information about all provisioned DAX clusters if no cluster identifier is
specified, or about a specific DAX cluster if a cluster identifier is supplied. If the
cluster is in the CREATING state, only cluster level information will be displayed until
all of the nodes are successfully provisioned. If the cluster is in the DELETING state,
only cluster level information will be displayed. If nodes are currently being added to the
DAX cluster, node endpoint information and creation time for the additional nodes will not
be displayed until they are completely provisioned. When the DAX cluster state is
available, the cluster is ready for use. If nodes are currently being removed from the DAX
cluster, no endpoint information for the removed nodes is displayed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterNames"`: The names of the DAX clusters being described.
- `"MaxResults"`: The maximum number of results to include in the response. If more results
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved. The value for MaxResults must be between 20 and 100.
- `"NextToken"`: An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified, the response
includes only results beyond the token, up to the value specified by MaxResults.
"""
function describe_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return dax("DescribeClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"DescribeClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_default_parameters()
describe_default_parameters(params::Dict{String,<:Any})
Returns the default system parameter information for the DAX caching software.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to include in the response. If more results
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved. The value for MaxResults must be between 20 and 100.
- `"NextToken"`: An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified, the response
includes only results beyond the token, up to the value specified by MaxResults.
"""
function describe_default_parameters(; aws_config::AbstractAWSConfig=global_aws_config())
return dax(
"DescribeDefaultParameters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_default_parameters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"DescribeDefaultParameters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Returns events related to DAX clusters and parameter groups. You can obtain events specific
to a particular DAX cluster or parameter group by providing the name as a parameter. By
default, only the events occurring within the last 24 hours 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.
- `"MaxResults"`: The maximum number of results to include in the response. If more results
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved. The value for MaxResults must be between 20 and 100.
- `"NextToken"`: An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified, the response
includes only results beyond the token, up to the value specified by MaxResults.
- `"SourceName"`: The identifier of the event source for which events will be returned. If
not specified, then 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.
"""
function describe_events(; aws_config::AbstractAWSConfig=global_aws_config())
return dax("DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"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 will contain 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 results to include in the response. If more results
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved. The value for MaxResults must be between 20 and 100.
- `"NextToken"`: An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified, the response
includes only results beyond the token, up to the value specified by MaxResults.
- `"ParameterGroupNames"`: The names of the parameter groups.
"""
function describe_parameter_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return dax(
"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 dax(
"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`: The name of the parameter group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to include in the response. If more results
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved. The value for MaxResults must be between 20 and 100.
- `"NextToken"`: An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified, the response
includes only results beyond the token, up to the value specified by MaxResults.
- `"Source"`: How the parameter is defined. For example, system denotes a system-defined
parameter.
"""
function describe_parameters(
ParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"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 dax(
"DescribeParameters",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ParameterGroupName" => ParameterGroupName), 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
will contain 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 results to include in the response. If more results
exist than the specified MaxResults value, a token is included in the response so that the
remaining results can be retrieved. The value for MaxResults must be between 20 and 100.
- `"NextToken"`: An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified, the response
includes only results beyond the token, up to the value specified by MaxResults.
- `"SubnetGroupNames"`: The name of the subnet group.
"""
function describe_subnet_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return dax(
"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 dax(
"DescribeSubnetGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
increase_replication_factor(cluster_name, new_replication_factor)
increase_replication_factor(cluster_name, new_replication_factor, params::Dict{String,<:Any})
Adds one or more nodes to a DAX cluster.
# Arguments
- `cluster_name`: The name of the DAX cluster that will receive additional nodes.
- `new_replication_factor`: The new number of nodes for the DAX cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZones"`: The Availability Zones (AZs) in which the cluster nodes will be
created. All nodes belonging to the cluster are placed in these Availability Zones. Use
this parameter if you want to distribute the nodes across multiple AZs.
"""
function increase_replication_factor(
ClusterName, NewReplicationFactor; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"IncreaseReplicationFactor",
Dict{String,Any}(
"ClusterName" => ClusterName, "NewReplicationFactor" => NewReplicationFactor
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function increase_replication_factor(
ClusterName,
NewReplicationFactor,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dax(
"IncreaseReplicationFactor",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterName" => ClusterName,
"NewReplicationFactor" => NewReplicationFactor,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags(resource_name)
list_tags(resource_name, params::Dict{String,<:Any})
List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second,
per account.
# Arguments
- `resource_name`: The name of the DAX resource to which the tags belong.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified, the response
includes only results beyond the token.
"""
function list_tags(ResourceName; aws_config::AbstractAWSConfig=global_aws_config())
return dax(
"ListTags",
Dict{String,Any}("ResourceName" => ResourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags(
ResourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dax(
"ListTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceName" => ResourceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_node(cluster_name, node_id)
reboot_node(cluster_name, node_id, params::Dict{String,<:Any})
Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible.
During the reboot, the node status is set to REBOOTING. RebootNode restarts the DAX
engine process and does not remove the contents of the cache.
# Arguments
- `cluster_name`: The name of the DAX cluster containing the node to be rebooted.
- `node_id`: The system-assigned ID of the node to be rebooted.
"""
function reboot_node(ClusterName, NodeId; aws_config::AbstractAWSConfig=global_aws_config())
return dax(
"RebootNode",
Dict{String,Any}("ClusterName" => ClusterName, "NodeId" => NodeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_node(
ClusterName,
NodeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dax(
"RebootNode",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClusterName" => ClusterName, "NodeId" => NodeId),
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})
Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per
second, per account.
# Arguments
- `resource_name`: The name of the DAX resource to which tags should be added.
- `tags`: The tags to be assigned to the DAX resource.
"""
function tag_resource(ResourceName, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return dax(
"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 dax(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "Tags" => Tags),
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})
Removes the association of tags from a DAX resource. You can call UntagResource up to 5
times per second, per account.
# Arguments
- `resource_name`: The name of the DAX resource from which the tags should be removed.
- `tag_keys`: A list of tag keys. If the DAX cluster has any tags with these keys, then the
tags are removed from the cluster.
"""
function untag_resource(
ResourceName, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"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 dax(
"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_cluster(cluster_name)
update_cluster(cluster_name, params::Dict{String,<:Any})
Modifies the settings for a DAX cluster. You can use this action to change one or more
cluster configuration parameters by specifying the parameters and the new values.
# Arguments
- `cluster_name`: The name of the DAX cluster to be modified.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the changes being made to the cluster.
- `"NotificationTopicArn"`: The Amazon Resource Name (ARN) that identifies the topic.
- `"NotificationTopicStatus"`: The current state of the topic. A value of “active”
means that notifications will be sent to the topic. A value of “inactive” means that
notifications will not be sent to the topic.
- `"ParameterGroupName"`: The name of a parameter group for this cluster.
- `"PreferredMaintenanceWindow"`: A range of time when maintenance of DAX cluster software
will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes
less than 30 minutes, and is performed automatically within the maintenance window.
- `"SecurityGroupIds"`: A list of user-specified security group IDs to be assigned to each
node in the DAX cluster. If this parameter is not specified, DAX assigns the default VPC
security group to each node.
"""
function update_cluster(ClusterName; aws_config::AbstractAWSConfig=global_aws_config())
return dax(
"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 dax(
"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})
Modifies 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.
- `parameter_name_values`: An array of name-value pairs for the parameters in the group.
Each element in the array represents a single parameter. record-ttl-millis and
query-ttl-millis are the only supported parameter names. For more details, see Configuring
TTL Settings.
"""
function update_parameter_group(
ParameterGroupName,
ParameterNameValues;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dax(
"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 dax(
"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})
Modifies an existing 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"`: A list of subnet IDs in the subnet group.
"""
function update_subnet_group(
SubnetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dax(
"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 dax(
"UpdateSubnetGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SubnetGroupName" => SubnetGroupName), 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 | 141083 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: deadline
using AWS.Compat
using AWS.UUIDs
"""
associate_member_to_farm(farm_id, identity_store_id, membership_level, principal_id, principal_type)
associate_member_to_farm(farm_id, identity_store_id, membership_level, principal_id, principal_type, params::Dict{String,<:Any})
Assigns a farm membership level to a member.
# Arguments
- `farm_id`: The ID of the farm to associate with the member.
- `identity_store_id`: The identity store ID of the member to associate with the farm.
- `membership_level`: The principal's membership level for the associated farm.
- `principal_id`: The member's principal ID to associate with the farm.
- `principal_type`: The principal type of the member to associate with the farm.
"""
function associate_member_to_farm(
farmId,
identityStoreId,
membershipLevel,
principalId,
principalType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PUT",
"/2023-10-12/farms/$(farmId)/members/$(principalId)",
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"membershipLevel" => membershipLevel,
"principalType" => principalType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_member_to_farm(
farmId,
identityStoreId,
membershipLevel,
principalId,
principalType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PUT",
"/2023-10-12/farms/$(farmId)/members/$(principalId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"membershipLevel" => membershipLevel,
"principalType" => principalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_member_to_fleet(farm_id, fleet_id, identity_store_id, membership_level, principal_id, principal_type)
associate_member_to_fleet(farm_id, fleet_id, identity_store_id, membership_level, principal_id, principal_type, params::Dict{String,<:Any})
Assigns a fleet membership level to a member.
# Arguments
- `farm_id`: The farm ID of the fleet to associate with the member.
- `fleet_id`: The ID of the fleet to associate with a member.
- `identity_store_id`: The member's identity store ID to associate with the fleet.
- `membership_level`: The principal's membership level for the associated fleet.
- `principal_id`: The member's principal ID to associate with a fleet.
- `principal_type`: The member's principal type to associate with the fleet.
"""
function associate_member_to_fleet(
farmId,
fleetId,
identityStoreId,
membershipLevel,
principalId,
principalType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PUT",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/members/$(principalId)",
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"membershipLevel" => membershipLevel,
"principalType" => principalType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_member_to_fleet(
farmId,
fleetId,
identityStoreId,
membershipLevel,
principalId,
principalType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PUT",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/members/$(principalId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"membershipLevel" => membershipLevel,
"principalType" => principalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_member_to_job(farm_id, identity_store_id, job_id, membership_level, principal_id, principal_type, queue_id)
associate_member_to_job(farm_id, identity_store_id, job_id, membership_level, principal_id, principal_type, queue_id, params::Dict{String,<:Any})
Assigns a job membership level to a member
# Arguments
- `farm_id`: The farm ID of the job to associate with the member.
- `identity_store_id`: The member's identity store ID to associate with the job.
- `job_id`: The job ID to associate with the member.
- `membership_level`: The principal's membership level for the associated job.
- `principal_id`: The member's principal ID to associate with the job.
- `principal_type`: The member's principal type to associate with the job.
- `queue_id`: The queue ID to associate to the member.
"""
function associate_member_to_job(
farmId,
identityStoreId,
jobId,
membershipLevel,
principalId,
principalType,
queueId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PUT",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/members/$(principalId)",
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"membershipLevel" => membershipLevel,
"principalType" => principalType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_member_to_job(
farmId,
identityStoreId,
jobId,
membershipLevel,
principalId,
principalType,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PUT",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/members/$(principalId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"membershipLevel" => membershipLevel,
"principalType" => principalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_member_to_queue(farm_id, identity_store_id, membership_level, principal_id, principal_type, queue_id)
associate_member_to_queue(farm_id, identity_store_id, membership_level, principal_id, principal_type, queue_id, params::Dict{String,<:Any})
Assigns a queue membership level to a member
# Arguments
- `farm_id`: The farm ID of the queue to associate with the member.
- `identity_store_id`: The member's identity store ID to associate with the queue.
- `membership_level`: The principal's membership level for the associated queue.
- `principal_id`: The member's principal ID to associate with the queue.
- `principal_type`: The member's principal type to associate with the queue.
- `queue_id`: The ID of the queue to associate to the member.
"""
function associate_member_to_queue(
farmId,
identityStoreId,
membershipLevel,
principalId,
principalType,
queueId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PUT",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/members/$(principalId)",
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"membershipLevel" => membershipLevel,
"principalType" => principalType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_member_to_queue(
farmId,
identityStoreId,
membershipLevel,
principalId,
principalType,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PUT",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/members/$(principalId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"identityStoreId" => identityStoreId,
"membershipLevel" => membershipLevel,
"principalType" => principalType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assume_fleet_role_for_read(farm_id, fleet_id)
assume_fleet_role_for_read(farm_id, fleet_id, params::Dict{String,<:Any})
Get Amazon Web Services credentials from the fleet role. The IAM permissions of the
credentials are scoped down to have read-only access.
# Arguments
- `farm_id`: The farm ID for the fleet's farm.
- `fleet_id`: The fleet ID.
"""
function assume_fleet_role_for_read(
farmId, fleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/read-roles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assume_fleet_role_for_read(
farmId,
fleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/read-roles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assume_fleet_role_for_worker(farm_id, fleet_id, worker_id)
assume_fleet_role_for_worker(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})
Get credentials from the fleet role for a worker.
# Arguments
- `farm_id`: The farm ID for the fleet's farm.
- `fleet_id`: The fleet ID that contains the worker.
- `worker_id`: The ID of the worker assuming the fleet role.
"""
function assume_fleet_role_for_worker(
farmId, fleetId, workerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)/fleet-roles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assume_fleet_role_for_worker(
farmId,
fleetId,
workerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)/fleet-roles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assume_queue_role_for_read(farm_id, queue_id)
assume_queue_role_for_read(farm_id, queue_id, params::Dict{String,<:Any})
Gets Amazon Web Services credentials from the queue role. The IAM permissions of the
credentials are scoped down to have read-only access.
# Arguments
- `farm_id`: The farm ID of the farm containing the queue.
- `queue_id`: The queue ID.
"""
function assume_queue_role_for_read(
farmId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/read-roles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assume_queue_role_for_read(
farmId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/read-roles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assume_queue_role_for_user(farm_id, queue_id)
assume_queue_role_for_user(farm_id, queue_id, params::Dict{String,<:Any})
Allows a user to assume a role for a queue.
# Arguments
- `farm_id`: The farm ID of the queue that the user assumes the role for.
- `queue_id`: The queue ID of the queue that the user assumes the role for.
"""
function assume_queue_role_for_user(
farmId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/user-roles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assume_queue_role_for_user(
farmId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/user-roles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assume_queue_role_for_worker(farm_id, fleet_id, queue_id, worker_id)
assume_queue_role_for_worker(farm_id, fleet_id, queue_id, worker_id, params::Dict{String,<:Any})
Allows a worker to assume a queue role.
# Arguments
- `farm_id`: The farm ID of the worker assuming the queue role.
- `fleet_id`: The fleet ID of the worker assuming the queue role.
- `queue_id`: The queue ID of the worker assuming the queue role.
- `worker_id`: The worker ID of the worker assuming the queue role.
"""
function assume_queue_role_for_worker(
farmId, fleetId, queueId, workerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)/queue-roles",
Dict{String,Any}("queueId" => queueId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assume_queue_role_for_worker(
farmId,
fleetId,
queueId,
workerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)/queue-roles",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("queueId" => queueId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_job_entity(farm_id, fleet_id, identifiers, worker_id)
batch_get_job_entity(farm_id, fleet_id, identifiers, worker_id, params::Dict{String,<:Any})
Get batched job details for a worker.
# Arguments
- `farm_id`: The farm ID of the worker that's fetching job details. The worker must have an
assignment on a job to fetch job details.
- `fleet_id`: The fleet ID of the worker that's fetching job details. The worker must have
an assignment on a job to fetch job details.
- `identifiers`: The job identifiers to include within the job entity batch details.
- `worker_id`: The worker ID of the worker containing the job details to get.
"""
function batch_get_job_entity(
farmId,
fleetId,
identifiers,
workerId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)/batchGetJobEntity",
Dict{String,Any}("identifiers" => identifiers);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_job_entity(
farmId,
fleetId,
identifiers,
workerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)/batchGetJobEntity",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifiers" => identifiers), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_job_template(farm_id, job_id, queue_id, target_s3_location)
copy_job_template(farm_id, job_id, queue_id, target_s3_location, params::Dict{String,<:Any})
Copies a job template to an Amazon S3 bucket.
# Arguments
- `farm_id`: The farm ID to copy.
- `job_id`: The job ID to copy.
- `queue_id`: The queue ID to copy.
- `target_s3_location`: The Amazon S3 bucket name and key where you would like to add a
copy of the job template.
"""
function copy_job_template(
farmId,
jobId,
queueId,
targetS3Location;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/template",
Dict{String,Any}("targetS3Location" => targetS3Location);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_job_template(
farmId,
jobId,
queueId,
targetS3Location,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/template",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("targetS3Location" => targetS3Location), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_budget(actions, approximate_dollar_limit, display_name, farm_id, schedule, usage_tracking_resource)
create_budget(actions, approximate_dollar_limit, display_name, farm_id, schedule, usage_tracking_resource, params::Dict{String,<:Any})
Creates a budget to set spending thresholds for your rendering activity.
# Arguments
- `actions`: The budget actions to specify what happens when the budget runs out.
- `approximate_dollar_limit`: The dollar limit based on consumed usage.
- `display_name`: The display name of the budget.
- `farm_id`: The farm ID to include in this budget.
- `schedule`: The schedule to associate with this budget.
- `usage_tracking_resource`: The queue ID provided to this budget to track usage.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"description"`: The description of the budget.
"""
function create_budget(
actions,
approximateDollarLimit,
displayName,
farmId,
schedule,
usageTrackingResource;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/budgets",
Dict{String,Any}(
"actions" => actions,
"approximateDollarLimit" => approximateDollarLimit,
"displayName" => displayName,
"schedule" => schedule,
"usageTrackingResource" => usageTrackingResource,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_budget(
actions,
approximateDollarLimit,
displayName,
farmId,
schedule,
usageTrackingResource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/budgets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actions" => actions,
"approximateDollarLimit" => approximateDollarLimit,
"displayName" => displayName,
"schedule" => schedule,
"usageTrackingResource" => usageTrackingResource,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_farm(display_name)
create_farm(display_name, params::Dict{String,<:Any})
Creates a farm to allow space for queues and fleets. Farms are the space where the
components of your renders gather and are pieced together in the cloud. Farms contain
budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container
for large projects.
# Arguments
- `display_name`: The display name of the farm.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"description"`: The description of the farm.
- `"kmsKeyArn"`: The ARN of the KMS key to use on the farm.
- `"tags"`: The tags to add to your farm. Each tag consists of a tag key and a tag value.
Tag keys and values are both required, but tag values can be empty strings.
"""
function create_farm(displayName; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"POST",
"/2023-10-12/farms",
Dict{String,Any}(
"displayName" => displayName, "X-Amz-Client-Token" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_farm(
displayName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"displayName" => displayName, "X-Amz-Client-Token" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_fleet(configuration, display_name, farm_id, max_worker_count, role_arn)
create_fleet(configuration, display_name, farm_id, max_worker_count, role_arn, params::Dict{String,<:Any})
Creates a fleet. Fleets gather information relating to compute, or capacity, for renders
within your farms. You can choose to manage your own capacity or opt to have fleets fully
managed by Deadline Cloud.
# Arguments
- `configuration`: The configuration settings for the fleet. Customer managed fleets are
self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
- `display_name`: The display name of the fleet.
- `farm_id`: The farm ID of the farm to connect to the fleet.
- `max_worker_count`: The maximum number of workers for the fleet.
- `role_arn`: The IAM role ARN for the role that the fleet's workers will use.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"description"`: The description of the fleet.
- `"minWorkerCount"`: The minimum number of workers for the fleet.
- `"tags"`: Each tag consists of a tag key and a tag value. Tag keys and values are both
required, but tag values can be empty strings.
"""
function create_fleet(
configuration,
displayName,
farmId,
maxWorkerCount,
roleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/fleets",
Dict{String,Any}(
"configuration" => configuration,
"displayName" => displayName,
"maxWorkerCount" => maxWorkerCount,
"roleArn" => roleArn,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fleet(
configuration,
displayName,
farmId,
maxWorkerCount,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/fleets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"configuration" => configuration,
"displayName" => displayName,
"maxWorkerCount" => maxWorkerCount,
"roleArn" => roleArn,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job(farm_id, priority, queue_id, template, template_type)
create_job(farm_id, priority, queue_id, template, template_type, params::Dict{String,<:Any})
Creates a job. A job is a render submission submitted by a user. It contains specific job
properties outlined as steps and tasks.
# Arguments
- `farm_id`: The farm ID of the farm to connect to the job.
- `priority`: The priority of the job on a scale of 1 to 100. The highest priority is 1.
- `queue_id`: The ID of the queue that the job is submitted to.
- `template`: The job template to use for this job.
- `template_type`: The file type for the job template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"attachments"`: The attachments for the job. Attach files required for the job to run to
a render job.
- `"maxFailedTasksCount"`: The number of task failures before the job stops running and is
marked as FAILED.
- `"maxRetriesPerTask"`: The maximum number of retries for a job.
- `"parameters"`: The parameters for the job.
- `"storageProfileId"`: The storage profile ID for the storage profile to connect to the
job.
- `"targetTaskRunStatus"`: The initial status of the job's tasks when they are created.
Tasks that are created with a SUSPENDED status will not run until you update their status.
"""
function create_job(
farmId,
priority,
queueId,
template,
templateType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs",
Dict{String,Any}(
"priority" => priority,
"template" => template,
"templateType" => templateType,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job(
farmId,
priority,
queueId,
template,
templateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"priority" => priority,
"template" => template,
"templateType" => templateType,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_license_endpoint(security_group_ids, subnet_ids, vpc_id)
create_license_endpoint(security_group_ids, subnet_ids, vpc_id, params::Dict{String,<:Any})
Creates a license endpoint to integrate your various licensed software used for rendering
on Deadline Cloud.
# Arguments
- `security_group_ids`: The security group IDs.
- `subnet_ids`: The subnet IDs.
- `vpc_id`: The VPC (virtual private cloud) ID to use with the license endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"tags"`: Each tag consists of a tag key and a tag value. Tag keys and values are both
required, but tag values can be empty strings.
"""
function create_license_endpoint(
securityGroupIds, subnetIds, vpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"POST",
"/2023-10-12/license-endpoints",
Dict{String,Any}(
"securityGroupIds" => securityGroupIds,
"subnetIds" => subnetIds,
"vpcId" => vpcId,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_license_endpoint(
securityGroupIds,
subnetIds,
vpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/license-endpoints",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"securityGroupIds" => securityGroupIds,
"subnetIds" => subnetIds,
"vpcId" => vpcId,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_monitor(display_name, identity_center_instance_arn, role_arn, subdomain)
create_monitor(display_name, identity_center_instance_arn, role_arn, subdomain, params::Dict{String,<:Any})
Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms,
queues, and fleets. After you submit a job, you can track the progress of the tasks and
steps that make up the job, and then download the job's results.
# Arguments
- `display_name`: The name that you give the monitor that is displayed in the Deadline
Cloud console.
- `identity_center_instance_arn`: The Amazon Resource Name (ARN) of the IAM Identity Center
instance that authenticates monitor users.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role that the monitor uses to
connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity
Center uses this role to access Deadline Cloud resources.
- `subdomain`: The subdomain to use when creating the monitor URL. The full URL of the
monitor is subdomain.Region.deadlinecloud.amazonaws.com.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
"""
function create_monitor(
displayName,
identityCenterInstanceArn,
roleArn,
subdomain;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/monitors",
Dict{String,Any}(
"displayName" => displayName,
"identityCenterInstanceArn" => identityCenterInstanceArn,
"roleArn" => roleArn,
"subdomain" => subdomain,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_monitor(
displayName,
identityCenterInstanceArn,
roleArn,
subdomain,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/monitors",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"displayName" => displayName,
"identityCenterInstanceArn" => identityCenterInstanceArn,
"roleArn" => roleArn,
"subdomain" => subdomain,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_queue(display_name, farm_id)
create_queue(display_name, farm_id, params::Dict{String,<:Any})
Creates a queue to coordinate the order in which jobs run on a farm. A queue can also
specify where to pull resources and indicate where to output completed jobs.
# Arguments
- `display_name`: The display name of the queue.
- `farm_id`: The farm ID of the farm to connect to the queue.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"allowedStorageProfileIds"`: The storage profile IDs to include in the queue.
- `"defaultBudgetAction"`: The default action to take on a queue if a budget isn't
configured.
- `"description"`: The description of the queue.
- `"jobAttachmentSettings"`: The job attachment settings for the queue. These are the
Amazon S3 bucket name and the Amazon S3 prefix.
- `"jobRunAsUser"`: The jobs in the queue run as the specified POSIX user.
- `"requiredFileSystemLocationNames"`: The file system location name to include in the
queue.
- `"roleArn"`: The IAM role ARN that workers will use while running jobs for this queue.
- `"tags"`: Each tag consists of a tag key and a tag value. Tag keys and values are both
required, but tag values can be empty strings.
"""
function create_queue(
displayName, farmId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/queues",
Dict{String,Any}(
"displayName" => displayName, "X-Amz-Client-Token" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_queue(
displayName,
farmId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/queues",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"displayName" => displayName, "X-Amz-Client-Token" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_queue_environment(farm_id, priority, queue_id, template, template_type)
create_queue_environment(farm_id, priority, queue_id, template, template_type, params::Dict{String,<:Any})
Creates an environment for a queue that defines how jobs in the queue run.
# Arguments
- `farm_id`: The farm ID of the farm to connect to the environment.
- `priority`: Sets the priority of the environments in the queue from 0 to 10,000, where 0
is the highest priority. If two environments share the same priority value, the environment
created first takes higher priority.
- `queue_id`: The queue ID to connect the queue and environment.
- `template`: The environment template to use in the queue.
- `template_type`: The template's file type, JSON or YAML.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
"""
function create_queue_environment(
farmId,
priority,
queueId,
template,
templateType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/environments",
Dict{String,Any}(
"priority" => priority,
"template" => template,
"templateType" => templateType,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_queue_environment(
farmId,
priority,
queueId,
template,
templateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/environments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"priority" => priority,
"template" => template,
"templateType" => templateType,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_queue_fleet_association(farm_id, fleet_id, queue_id)
create_queue_fleet_association(farm_id, fleet_id, queue_id, params::Dict{String,<:Any})
Creates an association between a queue and a fleet.
# Arguments
- `farm_id`: The ID of the farm that the queue and fleet belong to.
- `fleet_id`: The fleet ID.
- `queue_id`: The queue ID.
"""
function create_queue_fleet_association(
farmId, fleetId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"PUT",
"/2023-10-12/farms/$(farmId)/queue-fleet-associations",
Dict{String,Any}("fleetId" => fleetId, "queueId" => queueId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_queue_fleet_association(
farmId,
fleetId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PUT",
"/2023-10-12/farms/$(farmId)/queue-fleet-associations",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("fleetId" => fleetId, "queueId" => queueId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_storage_profile(display_name, farm_id, os_family)
create_storage_profile(display_name, farm_id, os_family, params::Dict{String,<:Any})
Creates a storage profile that specifies the operating system, file type, and file location
of resources used on a farm.
# Arguments
- `display_name`: The display name of the storage profile.
- `farm_id`: The farm ID of the farm to connect to the storage profile.
- `os_family`: The type of operating system (OS) for the storage profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"fileSystemLocations"`: File system paths to include in the storage profile.
"""
function create_storage_profile(
displayName, farmId, osFamily; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/storage-profiles",
Dict{String,Any}(
"displayName" => displayName,
"osFamily" => osFamily,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_storage_profile(
displayName,
farmId,
osFamily,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/storage-profiles",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"displayName" => displayName,
"osFamily" => osFamily,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_worker(farm_id, fleet_id)
create_worker(farm_id, fleet_id, params::Dict{String,<:Any})
Creates a worker. A worker tells your instance how much processing power (vCPU), and memory
(GiB) you’ll need to assemble the digital assets held within a particular instance. You
can specify certain instance types to use, or let the worker know which instances types to
exclude.
# Arguments
- `farm_id`: The farm ID of the farm to connect to the worker.
- `fleet_id`: The fleet ID to connect to the worker.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"hostProperties"`: The IP address and host name of the worker.
"""
function create_worker(farmId, fleetId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_worker(
farmId,
fleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers",
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_budget(budget_id, farm_id)
delete_budget(budget_id, farm_id, params::Dict{String,<:Any})
Deletes a budget.
# Arguments
- `budget_id`: The budget ID of the budget to delete.
- `farm_id`: The farm ID of the farm to remove from the budget.
"""
function delete_budget(budgetId, farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/budgets/$(budgetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_budget(
budgetId,
farmId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/budgets/$(budgetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_farm(farm_id)
delete_farm(farm_id, params::Dict{String,<:Any})
Deletes a farm.
# Arguments
- `farm_id`: The farm ID of the farm to delete.
"""
function delete_farm(farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_farm(
farmId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fleet(farm_id, fleet_id)
delete_fleet(farm_id, fleet_id, params::Dict{String,<:Any})
Deletes a fleet.
# Arguments
- `farm_id`: The farm ID of the farm to remove from the fleet.
- `fleet_id`: The fleet ID of the fleet to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
"""
function delete_fleet(farmId, fleetId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fleet(
farmId,
fleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)",
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_license_endpoint(license_endpoint_id)
delete_license_endpoint(license_endpoint_id, params::Dict{String,<:Any})
Deletes a license endpoint.
# Arguments
- `license_endpoint_id`: The license endpoint ID of the license endpoint to delete.
"""
function delete_license_endpoint(
licenseEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/license-endpoints/$(licenseEndpointId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_license_endpoint(
licenseEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/license-endpoints/$(licenseEndpointId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_metered_product(license_endpoint_id, product_id)
delete_metered_product(license_endpoint_id, product_id, params::Dict{String,<:Any})
Deletes a metered product.
# Arguments
- `license_endpoint_id`: The ID of the license endpoint from which to remove the metered
product.
- `product_id`: The product ID to remove from the license endpoint.
"""
function delete_metered_product(
licenseEndpointId, productId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/license-endpoints/$(licenseEndpointId)/metered-products/$(productId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_metered_product(
licenseEndpointId,
productId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/license-endpoints/$(licenseEndpointId)/metered-products/$(productId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_monitor(monitor_id)
delete_monitor(monitor_id, params::Dict{String,<:Any})
Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and
attach farms to the monitor.
# Arguments
- `monitor_id`: The unique identifier of the monitor to delete. This ID is returned by the
CreateMonitor operation, and is included in the response to the GetMonitor operation.
"""
function delete_monitor(monitorId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"DELETE",
"/2023-10-12/monitors/$(monitorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_monitor(
monitorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/monitors/$(monitorId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_queue(farm_id, queue_id)
delete_queue(farm_id, queue_id, params::Dict{String,<:Any})
Deletes a queue.
# Arguments
- `farm_id`: The ID of the farm from which to remove the queue.
- `queue_id`: The queue ID of the queue to delete.
"""
function delete_queue(farmId, queueId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_queue(
farmId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_queue_environment(farm_id, queue_environment_id, queue_id)
delete_queue_environment(farm_id, queue_environment_id, queue_id, params::Dict{String,<:Any})
Deletes a queue environment.
# Arguments
- `farm_id`: The farm ID of the farm from which to remove the queue environment.
- `queue_environment_id`: The queue environment ID of the queue environment to delete.
- `queue_id`: The queue ID of the queue environment to delete.
"""
function delete_queue_environment(
farmId, queueEnvironmentId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/environments/$(queueEnvironmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_queue_environment(
farmId,
queueEnvironmentId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/environments/$(queueEnvironmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_queue_fleet_association(farm_id, fleet_id, queue_id)
delete_queue_fleet_association(farm_id, fleet_id, queue_id, params::Dict{String,<:Any})
Deletes a queue-fleet association.
# Arguments
- `farm_id`: The farm ID of the farm that holds the queue-fleet association.
- `fleet_id`: The fleet ID of the queue-fleet association.
- `queue_id`: The queue ID of the queue-fleet association.
"""
function delete_queue_fleet_association(
farmId, fleetId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/queue-fleet-associations/$(queueId)/$(fleetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_queue_fleet_association(
farmId,
fleetId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/queue-fleet-associations/$(queueId)/$(fleetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_storage_profile(farm_id, storage_profile_id)
delete_storage_profile(farm_id, storage_profile_id, params::Dict{String,<:Any})
Deletes a storage profile.
# Arguments
- `farm_id`: The farm ID of the farm from which to remove the storage profile.
- `storage_profile_id`: The storage profile ID of the storage profile to delete.
"""
function delete_storage_profile(
farmId, storageProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/storage-profiles/$(storageProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_storage_profile(
farmId,
storageProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/storage-profiles/$(storageProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_worker(farm_id, fleet_id, worker_id)
delete_worker(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})
Deletes a worker.
# Arguments
- `farm_id`: The farm ID of the worker to delete.
- `fleet_id`: The fleet ID of the worker to delete.
- `worker_id`: The worker ID of the worker to delete.
"""
function delete_worker(
farmId, fleetId, workerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_worker(
farmId,
fleetId,
workerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_member_from_farm(farm_id, principal_id)
disassociate_member_from_farm(farm_id, principal_id, params::Dict{String,<:Any})
Disassociates a member from a farm.
# Arguments
- `farm_id`: The farm ID of the farm to disassociate from the member.
- `principal_id`: A member's principal ID to disassociate from a farm.
"""
function disassociate_member_from_farm(
farmId, principalId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/members/$(principalId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_member_from_farm(
farmId,
principalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/members/$(principalId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_member_from_fleet(farm_id, fleet_id, principal_id)
disassociate_member_from_fleet(farm_id, fleet_id, principal_id, params::Dict{String,<:Any})
Disassociates a member from a fleet.
# Arguments
- `farm_id`: The farm ID of the fleet to disassociate a member from.
- `fleet_id`: The fleet ID of the fleet to from which to disassociate a member.
- `principal_id`: A member's principal ID to disassociate from a fleet.
"""
function disassociate_member_from_fleet(
farmId, fleetId, principalId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/members/$(principalId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_member_from_fleet(
farmId,
fleetId,
principalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/members/$(principalId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_member_from_job(farm_id, job_id, principal_id, queue_id)
disassociate_member_from_job(farm_id, job_id, principal_id, queue_id, params::Dict{String,<:Any})
Disassociates a member from a job.
# Arguments
- `farm_id`: The farm ID for the job to disassociate from the member.
- `job_id`: The job ID to disassociate from a member in a job.
- `principal_id`: A member's principal ID to disassociate from a job.
- `queue_id`: The queue ID connected to a job for which you're disassociating a member.
"""
function disassociate_member_from_job(
farmId, jobId, principalId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/members/$(principalId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_member_from_job(
farmId,
jobId,
principalId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/members/$(principalId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_member_from_queue(farm_id, principal_id, queue_id)
disassociate_member_from_queue(farm_id, principal_id, queue_id, params::Dict{String,<:Any})
Disassociates a member from a queue.
# Arguments
- `farm_id`: The farm ID for the queue to disassociate from a member.
- `principal_id`: A member's principal ID to disassociate from a queue.
- `queue_id`: The queue ID of the queue in which you're disassociating from a member.
"""
function disassociate_member_from_queue(
farmId, principalId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/members/$(principalId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_member_from_queue(
farmId,
principalId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"DELETE",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/members/$(principalId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_budget(budget_id, farm_id)
get_budget(budget_id, farm_id, params::Dict{String,<:Any})
Get a budget.
# Arguments
- `budget_id`: The budget ID.
- `farm_id`: The farm ID of the farm connected to the budget.
"""
function get_budget(budgetId, farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/budgets/$(budgetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_budget(
budgetId,
farmId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/budgets/$(budgetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_farm(farm_id)
get_farm(farm_id, params::Dict{String,<:Any})
Get a farm.
# Arguments
- `farm_id`: The farm ID of the farm.
"""
function get_farm(farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_farm(
farmId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_fleet(farm_id, fleet_id)
get_fleet(farm_id, fleet_id, params::Dict{String,<:Any})
Get a fleet.
# Arguments
- `farm_id`: The farm ID of the farm in the fleet.
- `fleet_id`: The fleet ID of the fleet to get.
"""
function get_fleet(farmId, fleetId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_fleet(
farmId,
fleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job(farm_id, job_id, queue_id)
get_job(farm_id, job_id, queue_id, params::Dict{String,<:Any})
Gets a Deadline Cloud job.
# Arguments
- `farm_id`: The farm ID of the farm in the job.
- `job_id`: The job ID.
- `queue_id`: The queue ID associated with the job.
"""
function get_job(farmId, jobId, queueId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job(
farmId,
jobId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_license_endpoint(license_endpoint_id)
get_license_endpoint(license_endpoint_id, params::Dict{String,<:Any})
Gets a licence endpoint.
# Arguments
- `license_endpoint_id`: The license endpoint ID.
"""
function get_license_endpoint(
licenseEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/license-endpoints/$(licenseEndpointId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_license_endpoint(
licenseEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/license-endpoints/$(licenseEndpointId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_monitor(monitor_id)
get_monitor(monitor_id, params::Dict{String,<:Any})
Gets information about the specified monitor.
# Arguments
- `monitor_id`: The unique identifier for the monitor. This ID is returned by the
CreateMonitor operation.
"""
function get_monitor(monitorId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/monitors/$(monitorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_monitor(
monitorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/monitors/$(monitorId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_queue(farm_id, queue_id)
get_queue(farm_id, queue_id, params::Dict{String,<:Any})
Gets a queue.
# Arguments
- `farm_id`: The farm ID of the farm in the queue.
- `queue_id`: The queue ID for the queue to retrieve.
"""
function get_queue(farmId, queueId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_queue(
farmId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_queue_environment(farm_id, queue_environment_id, queue_id)
get_queue_environment(farm_id, queue_environment_id, queue_id, params::Dict{String,<:Any})
Gets a queue environment.
# Arguments
- `farm_id`: The farm ID for the queue environment.
- `queue_environment_id`: The queue environment ID.
- `queue_id`: The queue ID for the queue environment.
"""
function get_queue_environment(
farmId, queueEnvironmentId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/environments/$(queueEnvironmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_queue_environment(
farmId,
queueEnvironmentId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/environments/$(queueEnvironmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_queue_fleet_association(farm_id, fleet_id, queue_id)
get_queue_fleet_association(farm_id, fleet_id, queue_id, params::Dict{String,<:Any})
Gets a queue-fleet association.
# Arguments
- `farm_id`: The farm ID of the farm that contains the queue-fleet association.
- `fleet_id`: The fleet ID for the queue-fleet association.
- `queue_id`: The queue ID for the queue-fleet association.
"""
function get_queue_fleet_association(
farmId, fleetId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queue-fleet-associations/$(queueId)/$(fleetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_queue_fleet_association(
farmId,
fleetId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queue-fleet-associations/$(queueId)/$(fleetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_session(farm_id, job_id, queue_id, session_id)
get_session(farm_id, job_id, queue_id, session_id, params::Dict{String,<:Any})
Gets a session.
# Arguments
- `farm_id`: The farm ID for the session.
- `job_id`: The job ID for the session.
- `queue_id`: The queue ID for the session.
- `session_id`: The session ID.
"""
function get_session(
farmId, jobId, queueId, sessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/sessions/$(sessionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_session(
farmId,
jobId,
queueId,
sessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/sessions/$(sessionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_session_action(farm_id, job_id, queue_id, session_action_id)
get_session_action(farm_id, job_id, queue_id, session_action_id, params::Dict{String,<:Any})
Gets a session action for the job.
# Arguments
- `farm_id`: The farm ID for the session action.
- `job_id`: The job ID for the session.
- `queue_id`: The queue ID for the session action.
- `session_action_id`: The session action ID for the session.
"""
function get_session_action(
farmId,
jobId,
queueId,
sessionActionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/session-actions/$(sessionActionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_session_action(
farmId,
jobId,
queueId,
sessionActionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/session-actions/$(sessionActionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sessions_statistics_aggregation(aggregation_id, farm_id)
get_sessions_statistics_aggregation(aggregation_id, farm_id, params::Dict{String,<:Any})
Gets a set of statistics for queues or farms. Before you can call the
GetSessionStatisticsAggregation operation, you must first call the
StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you
call the StartSessionsStatisticsAggregation operation.
# Arguments
- `aggregation_id`: The identifier returned by the StartSessionsStatisticsAggregation
operation that identifies the aggregated statistics.
- `farm_id`: The identifier of the farm to include in the statistics. This should be the
same as the farm ID used in the call to the StartSessionsStatisticsAggregation 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. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function get_sessions_statistics_aggregation(
aggregationId, farmId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/sessions-statistics-aggregation",
Dict{String,Any}("aggregationId" => aggregationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sessions_statistics_aggregation(
aggregationId,
farmId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/sessions-statistics-aggregation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("aggregationId" => aggregationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_step(farm_id, job_id, queue_id, step_id)
get_step(farm_id, job_id, queue_id, step_id, params::Dict{String,<:Any})
Gets a step.
# Arguments
- `farm_id`: The farm ID for the step.
- `job_id`: The job ID for the step.
- `queue_id`: The queue ID for the step.
- `step_id`: The step ID.
"""
function get_step(
farmId, jobId, queueId, stepId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_step(
farmId,
jobId,
queueId,
stepId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_storage_profile(farm_id, storage_profile_id)
get_storage_profile(farm_id, storage_profile_id, params::Dict{String,<:Any})
Gets a storage profile.
# Arguments
- `farm_id`: The farm ID for the storage profile.
- `storage_profile_id`: The storage profile ID.
"""
function get_storage_profile(
farmId, storageProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/storage-profiles/$(storageProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_storage_profile(
farmId,
storageProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/storage-profiles/$(storageProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_storage_profile_for_queue(farm_id, queue_id, storage_profile_id)
get_storage_profile_for_queue(farm_id, queue_id, storage_profile_id, params::Dict{String,<:Any})
Gets a storage profile for a queue.
# Arguments
- `farm_id`: The farm ID for the queue in storage profile.
- `queue_id`: The queue ID the queue in the storage profile.
- `storage_profile_id`: The storage profile ID for the storage profile in the queue.
"""
function get_storage_profile_for_queue(
farmId, queueId, storageProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/storage-profiles/$(storageProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_storage_profile_for_queue(
farmId,
queueId,
storageProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/storage-profiles/$(storageProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_task(farm_id, job_id, queue_id, step_id, task_id)
get_task(farm_id, job_id, queue_id, step_id, task_id, params::Dict{String,<:Any})
Gets a task.
# Arguments
- `farm_id`: The farm ID of the farm connected to the task.
- `job_id`: The job ID of the job connected to the task.
- `queue_id`: The queue ID for the queue connected to the task.
- `step_id`: The step ID for the step connected to the task.
- `task_id`: The task ID.
"""
function get_task(
farmId,
jobId,
queueId,
stepId,
taskId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)/tasks/$(taskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_task(
farmId,
jobId,
queueId,
stepId,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)/tasks/$(taskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_worker(farm_id, fleet_id, worker_id)
get_worker(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})
Gets a worker.
# Arguments
- `farm_id`: The farm ID for the worker.
- `fleet_id`: The fleet ID of the worker.
- `worker_id`: The worker ID.
"""
function get_worker(
farmId, fleetId, workerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_worker(
farmId,
fleetId,
workerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_available_metered_products()
list_available_metered_products(params::Dict{String,<:Any})
A list of the available metered products.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_available_metered_products(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/metered-products";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_available_metered_products(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/metered-products",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_budgets(farm_id)
list_budgets(farm_id, params::Dict{String,<:Any})
A list of budgets in a farm.
# Arguments
- `farm_id`: The farm ID associated with the budgets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
- `"status"`: The status to list for the budgets.
"""
function list_budgets(farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/budgets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_budgets(
farmId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/budgets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_farm_members(farm_id)
list_farm_members(farm_id, params::Dict{String,<:Any})
Lists the members of a farm.
# Arguments
- `farm_id`: The farm 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. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_farm_members(farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/members";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_farm_members(
farmId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/members",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_farms()
list_farms(params::Dict{String,<:Any})
Lists farms.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
- `"principalId"`: The principal ID of the member to list on the farm.
"""
function list_farms(; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET", "/2023-10-12/farms"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_farms(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fleet_members(farm_id, fleet_id)
list_fleet_members(farm_id, fleet_id, params::Dict{String,<:Any})
Lists fleet members.
# Arguments
- `farm_id`: The farm ID of the fleet.
- `fleet_id`: The fleet ID to include on the 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. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_fleet_members(
farmId, fleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/members";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_fleet_members(
farmId,
fleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/members",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fleets(farm_id)
list_fleets(farm_id, params::Dict{String,<:Any})
Lists fleets.
# Arguments
- `farm_id`: The farm ID of the fleets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"displayName"`: The display names of a list of fleets.
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
- `"principalId"`: The principal ID of the members to include in the fleet.
- `"status"`: The status of the fleet.
"""
function list_fleets(farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_fleets(
farmId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_job_members(farm_id, job_id, queue_id)
list_job_members(farm_id, job_id, queue_id, params::Dict{String,<:Any})
Lists members on a job.
# Arguments
- `farm_id`: The farm ID of the job to list.
- `job_id`: The job ID to include on the list.
- `queue_id`: The queue ID to include on the 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. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_job_members(
farmId, jobId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/members";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_job_members(
farmId,
jobId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/members",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs(farm_id, queue_id)
list_jobs(farm_id, queue_id, params::Dict{String,<:Any})
Lists jobs.
# Arguments
- `farm_id`: The farm ID for the jobs.
- `queue_id`: The queue ID for the 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. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
- `"principalId"`: The principal ID of the members on the jobs.
"""
function list_jobs(farmId, queueId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_jobs(
farmId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_license_endpoints()
list_license_endpoints(params::Dict{String,<:Any})
Lists license endpoints.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_license_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/license-endpoints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_license_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/license-endpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_metered_products(license_endpoint_id)
list_metered_products(license_endpoint_id, params::Dict{String,<:Any})
Lists metered products.
# Arguments
- `license_endpoint_id`: The license endpoint ID to include on the list of metered products.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_metered_products(
licenseEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/license-endpoints/$(licenseEndpointId)/metered-products";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_metered_products(
licenseEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/license-endpoints/$(licenseEndpointId)/metered-products",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_monitors()
list_monitors(params::Dict{String,<:Any})
Gets a list of your monitors in Deadline Cloud.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_monitors(; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/monitors";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_monitors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/monitors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_queue_environments(farm_id, queue_id)
list_queue_environments(farm_id, queue_id, params::Dict{String,<:Any})
Lists queue environments.
# Arguments
- `farm_id`: The farm ID for the queue environment list.
- `queue_id`: The queue ID for the queue environment 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. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_queue_environments(
farmId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/environments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_queue_environments(
farmId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/environments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_queue_fleet_associations(farm_id)
list_queue_fleet_associations(farm_id, params::Dict{String,<:Any})
Lists queue-fleet associations.
# Arguments
- `farm_id`: The farm ID for the queue-fleet association list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"fleetId"`: The fleet ID for the queue-fleet association list.
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
- `"queueId"`: The queue ID for the queue-fleet association list.
"""
function list_queue_fleet_associations(
farmId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queue-fleet-associations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_queue_fleet_associations(
farmId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queue-fleet-associations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_queue_members(farm_id, queue_id)
list_queue_members(farm_id, queue_id, params::Dict{String,<:Any})
Lists the members in a queue.
# Arguments
- `farm_id`: The farm ID for the queue.
- `queue_id`: The queue ID to include on the 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. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_queue_members(
farmId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/members";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_queue_members(
farmId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/members",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_queues(farm_id)
list_queues(farm_id, params::Dict{String,<:Any})
Lists queues.
# Arguments
- `farm_id`: The farm ID of the queue.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
- `"principalId"`: The principal ID. This filter is only valid when using Nimble Studio
credentials and should match the user ID in the credentials of the caller.
- `"status"`: The status of the queues listed. ACTIVE–The queues are active.
SCHEDULING–The queues are scheduling. SCHEDULING_BLOCKED–The queue scheduling is
blocked for these queues.
"""
function list_queues(farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_queues(
farmId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_session_actions(farm_id, job_id, queue_id)
list_session_actions(farm_id, job_id, queue_id, params::Dict{String,<:Any})
Lists session actions.
# Arguments
- `farm_id`: The farm ID for the session actions list.
- `job_id`: The job ID for the session actions list.
- `queue_id`: The queue ID for the session actions 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. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
- `"sessionId"`: The session ID to include on the sessions action list.
- `"taskId"`: The task ID for the session actions list.
"""
function list_session_actions(
farmId, jobId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/session-actions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_session_actions(
farmId,
jobId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/session-actions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sessions(farm_id, job_id, queue_id)
list_sessions(farm_id, job_id, queue_id, params::Dict{String,<:Any})
Lists sessions.
# Arguments
- `farm_id`: The farm ID for the list of sessions.
- `job_id`: The job ID for the list of sessions.
- `queue_id`: The queue ID for the list of sessions
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_sessions(
farmId, jobId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/sessions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sessions(
farmId,
jobId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/sessions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sessions_for_worker(farm_id, fleet_id, worker_id)
list_sessions_for_worker(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})
Lists sessions for a worker.
# Arguments
- `farm_id`: The farm ID for the session.
- `fleet_id`: The fleet ID for the session.
- `worker_id`: The worker ID for the session.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_sessions_for_worker(
farmId, fleetId, workerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)/sessions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_sessions_for_worker(
farmId,
fleetId,
workerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)/sessions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_step_consumers(farm_id, job_id, queue_id, step_id)
list_step_consumers(farm_id, job_id, queue_id, step_id, params::Dict{String,<:Any})
Lists step consumers.
# Arguments
- `farm_id`: The farm ID for the list of step consumers.
- `job_id`: The job ID for the step consumer.
- `queue_id`: The queue ID for the step consumer.
- `step_id`: The step ID to include on the 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. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_step_consumers(
farmId, jobId, queueId, stepId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)/consumers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_step_consumers(
farmId,
jobId,
queueId,
stepId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)/consumers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_step_dependencies(farm_id, job_id, queue_id, step_id)
list_step_dependencies(farm_id, job_id, queue_id, step_id, params::Dict{String,<:Any})
Lists the dependencies for a step.
# Arguments
- `farm_id`: The farm ID for the step dependencies list.
- `job_id`: The job ID for the step dependencies list.
- `queue_id`: The queue ID for the step dependencies list.
- `step_id`: The step ID to include on the 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. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_step_dependencies(
farmId, jobId, queueId, stepId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)/dependencies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_step_dependencies(
farmId,
jobId,
queueId,
stepId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)/dependencies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_steps(farm_id, job_id, queue_id)
list_steps(farm_id, job_id, queue_id, params::Dict{String,<:Any})
Lists steps for a job.
# Arguments
- `farm_id`: The farm ID to include on the list of steps.
- `job_id`: The job ID to include on the list of steps.
- `queue_id`: The queue ID to include on the list of steps.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_steps(
farmId, jobId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_steps(
farmId,
jobId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_storage_profiles(farm_id)
list_storage_profiles(farm_id, params::Dict{String,<:Any})
Lists storage profiles.
# Arguments
- `farm_id`: The farm ID of the storage profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_storage_profiles(farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/storage-profiles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_storage_profiles(
farmId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/storage-profiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_storage_profiles_for_queue(farm_id, queue_id)
list_storage_profiles_for_queue(farm_id, queue_id, params::Dict{String,<:Any})
Lists storage profiles for a queue.
# Arguments
- `farm_id`: The farm ID of the queue's storage profile.
- `queue_id`: The queue ID for the storage profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_storage_profiles_for_queue(
farmId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/storage-profiles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_storage_profiles_for_queue(
farmId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/storage-profiles",
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 tags for a resource.
# Arguments
- `resource_arn`: The resource ARN to list tags for.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/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 deadline(
"GET",
"/2023-10-12/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tasks(farm_id, job_id, queue_id, step_id)
list_tasks(farm_id, job_id, queue_id, step_id, params::Dict{String,<:Any})
Lists tasks for a job.
# Arguments
- `farm_id`: The farm ID connected to the tasks.
- `job_id`: The job ID for the tasks.
- `queue_id`: The queue ID connected to the tasks.
- `step_id`: The step ID for the tasks.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_tasks(
farmId, jobId, queueId, stepId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)/tasks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tasks(
farmId,
jobId,
queueId,
stepId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)/tasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workers(farm_id, fleet_id)
list_workers(farm_id, fleet_id, params::Dict{String,<:Any})
Lists workers.
# Arguments
- `farm_id`: The farm ID connected to the workers.
- `fleet_id`: The fleet ID of the workers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to return. Use this parameter with
NextToken to get results as a set of sequential pages.
- `"nextToken"`: The token for the next set of results, or null to start from the beginning.
"""
function list_workers(farmId, fleetId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workers(
farmId,
fleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"GET",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_metered_product(license_endpoint_id, product_id)
put_metered_product(license_endpoint_id, product_id, params::Dict{String,<:Any})
Adds a metered product.
# Arguments
- `license_endpoint_id`: The license endpoint ID to add to the metered product.
- `product_id`: The product ID to add to the metered product.
"""
function put_metered_product(
licenseEndpointId, productId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"PUT",
"/2023-10-12/license-endpoints/$(licenseEndpointId)/metered-products/$(productId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_metered_product(
licenseEndpointId,
productId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PUT",
"/2023-10-12/license-endpoints/$(licenseEndpointId)/metered-products/$(productId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_jobs(farm_id, item_offset, queue_ids)
search_jobs(farm_id, item_offset, queue_ids, params::Dict{String,<:Any})
Searches for jobs.
# Arguments
- `farm_id`: The farm ID of the job.
- `item_offset`: Defines how far into the scrollable list to start the return of results.
- `queue_ids`: The queue ID to use in the job search.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterExpressions"`: The filter expression, AND or OR, to use when searching among a
group of search strings in a resource. You can use two groupings per search each within
parenthesis ().
- `"pageSize"`: Specifies the number of items per page for the resource.
- `"sortExpressions"`: The search terms for a resource.
"""
function search_jobs(
farmId, itemOffset, queueIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/search/jobs",
Dict{String,Any}("itemOffset" => itemOffset, "queueIds" => queueIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_jobs(
farmId,
itemOffset,
queueIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/search/jobs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("itemOffset" => itemOffset, "queueIds" => queueIds),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_steps(farm_id, item_offset, queue_ids)
search_steps(farm_id, item_offset, queue_ids, params::Dict{String,<:Any})
Searches for steps.
# Arguments
- `farm_id`: The farm ID to use for the step search.
- `item_offset`: Defines how far into the scrollable list to start the return of results.
- `queue_ids`: The queue IDs in the step search.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterExpressions"`: The filter expression, AND or OR, to use when searching among a
group of search strings in a resource. You can use two groupings per search each within
parenthesis ().
- `"jobId"`: The job ID to use in the step search.
- `"pageSize"`: Specifies the number of items per page for the resource.
- `"sortExpressions"`: The search terms for a resource.
"""
function search_steps(
farmId, itemOffset, queueIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/search/steps",
Dict{String,Any}("itemOffset" => itemOffset, "queueIds" => queueIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_steps(
farmId,
itemOffset,
queueIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/search/steps",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("itemOffset" => itemOffset, "queueIds" => queueIds),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_tasks(farm_id, item_offset, queue_ids)
search_tasks(farm_id, item_offset, queue_ids, params::Dict{String,<:Any})
Searches for tasks.
# Arguments
- `farm_id`: The farm ID of the task.
- `item_offset`: Defines how far into the scrollable list to start the return of results.
- `queue_ids`: The queue IDs to include in the search.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterExpressions"`: The filter expression, AND or OR, to use when searching among a
group of search strings in a resource. You can use two groupings per search each within
parenthesis ().
- `"jobId"`: The job ID for the task search.
- `"pageSize"`: Specifies the number of items per page for the resource.
- `"sortExpressions"`: The search terms for a resource.
"""
function search_tasks(
farmId, itemOffset, queueIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/search/tasks",
Dict{String,Any}("itemOffset" => itemOffset, "queueIds" => queueIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_tasks(
farmId,
itemOffset,
queueIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/search/tasks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("itemOffset" => itemOffset, "queueIds" => queueIds),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_workers(farm_id, fleet_ids, item_offset)
search_workers(farm_id, fleet_ids, item_offset, params::Dict{String,<:Any})
Searches for workers.
# Arguments
- `farm_id`: The farm ID in the workers search.
- `fleet_ids`: The fleet ID of the workers to search for.
- `item_offset`: Defines how far into the scrollable list to start the return of results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterExpressions"`: The filter expression, AND or OR, to use when searching among a
group of search strings in a resource. You can use two groupings per search each within
parenthesis ().
- `"pageSize"`: Specifies the number of items per page for the resource.
- `"sortExpressions"`: The search terms for a resource.
"""
function search_workers(
farmId, fleetIds, itemOffset; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/search/workers",
Dict{String,Any}("fleetIds" => fleetIds, "itemOffset" => itemOffset);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_workers(
farmId,
fleetIds,
itemOffset,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/search/workers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("fleetIds" => fleetIds, "itemOffset" => itemOffset),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_sessions_statistics_aggregation(end_time, farm_id, group_by, resource_ids, start_time, statistics)
start_sessions_statistics_aggregation(end_time, farm_id, group_by, resource_ids, start_time, statistics, params::Dict{String,<:Any})
Starts an asynchronous request for getting aggregated statistics about queues and farms.
Get the statistics using the GetSessionsStatisticsAggregation operation. Statistics are
available for 1 hour after you call the StartSessionsStatisticsAggregation operation.
# Arguments
- `end_time`: The Linux timestamp of the date and time that the statistics end.
- `farm_id`: The identifier of the farm that contains queues or fleets to return statistics
for.
- `group_by`: The field to use to group the statistics.
- `resource_ids`: A list of fleet IDs or queue IDs to gather statistics for.
- `start_time`: The Linux timestamp of the date and time that the statistics start.
- `statistics`: One to four statistics to return.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"period"`: The period to aggregate the statistics.
- `"timezone"`: The timezone to use for the statistics. Use UTC notation such as \"UTC+8.\"
"""
function start_sessions_statistics_aggregation(
endTime,
farmId,
groupBy,
resourceIds,
startTime,
statistics;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/sessions-statistics-aggregation",
Dict{String,Any}(
"endTime" => endTime,
"groupBy" => groupBy,
"resourceIds" => resourceIds,
"startTime" => startTime,
"statistics" => statistics,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_sessions_statistics_aggregation(
endTime,
farmId,
groupBy,
resourceIds,
startTime,
statistics,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"POST",
"/2023-10-12/farms/$(farmId)/sessions-statistics-aggregation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"groupBy" => groupBy,
"resourceIds" => resourceIds,
"startTime" => startTime,
"statistics" => statistics,
),
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 using the resource's ARN and desired tags.
# Arguments
- `resource_arn`: The ARN of the resource to apply tags to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: Each tag consists of a tag key and a tag value. Tag keys and values are both
required, but tag values can be empty strings.
"""
function tag_resource(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"POST",
"/2023-10-12/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 deadline(
"POST",
"/2023-10-12/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 from a resource using the resource's ARN and tag to remove.
# Arguments
- `resource_arn`: The ARN of the resource to remove the tag from.
- `tag_keys`: They keys of the tag.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"DELETE",
"/2023-10-12/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 deadline(
"DELETE",
"/2023-10-12/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_budget(budget_id, farm_id)
update_budget(budget_id, farm_id, params::Dict{String,<:Any})
Updates a budget that sets spending thresholds for rendering activity.
# Arguments
- `budget_id`: The budget ID to update.
- `farm_id`: The farm ID of the budget to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"actionsToAdd"`: The budget actions to add. Budget actions specify what happens when the
budget runs out.
- `"actionsToRemove"`: The budget actions to remove from the budget.
- `"approximateDollarLimit"`: The dollar limit to update on the budget. Based on consumed
usage.
- `"description"`: The description of the budget to update.
- `"displayName"`: The display name of the budget to update.
- `"schedule"`: The schedule to update.
- `"status"`: Updates the status of the budget. ACTIVE–The budget is being evaluated.
INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted
statuses.
"""
function update_budget(budgetId, farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/budgets/$(budgetId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_budget(
budgetId,
farmId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/budgets/$(budgetId)",
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_farm(farm_id)
update_farm(farm_id, params::Dict{String,<:Any})
Updates a farm.
# Arguments
- `farm_id`: The farm ID to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the farm to update.
- `"displayName"`: The display name of the farm to update.
"""
function update_farm(farmId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_farm(
farmId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_fleet(farm_id, fleet_id)
update_fleet(farm_id, fleet_id, params::Dict{String,<:Any})
Updates a fleet.
# Arguments
- `farm_id`: The farm ID to update.
- `fleet_id`: The fleet ID to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"configuration"`: The fleet configuration to update.
- `"description"`: The description of the fleet to update.
- `"displayName"`: The display name of the fleet to update.
- `"maxWorkerCount"`: The maximum number of workers in the fleet.
- `"minWorkerCount"`: The minimum number of workers in the fleet.
- `"roleArn"`: The IAM role ARN that the fleet's workers assume while running jobs.
"""
function update_fleet(farmId, fleetId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_fleet(
farmId,
fleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)",
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_job(farm_id, job_id, queue_id)
update_job(farm_id, job_id, queue_id, params::Dict{String,<:Any})
Updates a job.
# Arguments
- `farm_id`: The farm ID of the job to update.
- `job_id`: The job ID to update.
- `queue_id`: The queue ID of the job to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"lifecycleStatus"`: The status of a job in its lifecycle.
- `"maxFailedTasksCount"`: The number of task failures before the job stops running and is
marked as FAILED.
- `"maxRetriesPerTask"`: The maximum number of retries for a job.
- `"priority"`: The job priority to update.
- `"targetTaskRunStatus"`: The task status to update the job's tasks to.
"""
function update_job(
farmId, jobId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_job(
farmId,
jobId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)",
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_monitor(monitor_id)
update_monitor(monitor_id, params::Dict{String,<:Any})
Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the
settings when you call UpdateMonitor.
# Arguments
- `monitor_id`: The unique identifier of the monitor to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"displayName"`: The new value to use for the monitor's display name.
- `"roleArn"`: The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.
- `"subdomain"`: The new value of the subdomain to use when forming the monitor URL.
"""
function update_monitor(monitorId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"PATCH",
"/2023-10-12/monitors/$(monitorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_monitor(
monitorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/monitors/$(monitorId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_queue(farm_id, queue_id)
update_queue(farm_id, queue_id, params::Dict{String,<:Any})
Updates a queue.
# Arguments
- `farm_id`: The farm ID to update in the queue.
- `queue_id`: The queue ID to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The idempotency token to update in the queue.
- `"allowedStorageProfileIdsToAdd"`: The storage profile IDs to add.
- `"allowedStorageProfileIdsToRemove"`: The storage profile ID to remove.
- `"defaultBudgetAction"`: The default action to take for a queue update if a budget isn't
configured.
- `"description"`: The description of the queue to update.
- `"displayName"`: The display name of the queue to update.
- `"jobAttachmentSettings"`: The job attachment settings to update for the queue.
- `"jobRunAsUser"`: Update the jobs in the queue to run as a specified POSIX user.
- `"requiredFileSystemLocationNamesToAdd"`: The required file system location names to add
to the queue.
- `"requiredFileSystemLocationNamesToRemove"`: The required file system location names to
remove from the queue.
- `"roleArn"`: The IAM role ARN that's used to run jobs from this queue.
"""
function update_queue(farmId, queueId; aws_config::AbstractAWSConfig=global_aws_config())
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_queue(
farmId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)",
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_queue_environment(farm_id, queue_environment_id, queue_id)
update_queue_environment(farm_id, queue_environment_id, queue_id, params::Dict{String,<:Any})
Updates the queue environment.
# Arguments
- `farm_id`: The farm ID of the queue environment to update.
- `queue_environment_id`: The queue environment ID to update.
- `queue_id`: The queue ID of the queue environment to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"priority"`: The priority to update.
- `"template"`: The template to update.
- `"templateType"`: The template type to update.
"""
function update_queue_environment(
farmId, queueEnvironmentId, queueId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/environments/$(queueEnvironmentId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_queue_environment(
farmId,
queueEnvironmentId,
queueId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/environments/$(queueEnvironmentId)",
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_queue_fleet_association(farm_id, fleet_id, queue_id, status)
update_queue_fleet_association(farm_id, fleet_id, queue_id, status, params::Dict{String,<:Any})
Updates a queue-fleet association.
# Arguments
- `farm_id`: The farm ID to update.
- `fleet_id`: The fleet ID to update.
- `queue_id`: The queue ID to update.
- `status`: The status to update.
"""
function update_queue_fleet_association(
farmId, fleetId, queueId, status; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queue-fleet-associations/$(queueId)/$(fleetId)",
Dict{String,Any}("status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_queue_fleet_association(
farmId,
fleetId,
queueId,
status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queue-fleet-associations/$(queueId)/$(fleetId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("status" => status), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_session(farm_id, job_id, queue_id, session_id, target_lifecycle_status)
update_session(farm_id, job_id, queue_id, session_id, target_lifecycle_status, params::Dict{String,<:Any})
Updates a session.
# Arguments
- `farm_id`: The farm ID to update in the session.
- `job_id`: The job ID to update in the session.
- `queue_id`: The queue ID to update in the session.
- `session_id`: The session ID to update.
- `target_lifecycle_status`: The life cycle status to update in the session.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
"""
function update_session(
farmId,
jobId,
queueId,
sessionId,
targetLifecycleStatus;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/sessions/$(sessionId)",
Dict{String,Any}(
"targetLifecycleStatus" => targetLifecycleStatus,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_session(
farmId,
jobId,
queueId,
sessionId,
targetLifecycleStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/sessions/$(sessionId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"targetLifecycleStatus" => targetLifecycleStatus,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_step(farm_id, job_id, queue_id, step_id, target_task_run_status)
update_step(farm_id, job_id, queue_id, step_id, target_task_run_status, params::Dict{String,<:Any})
Updates a step.
# Arguments
- `farm_id`: The farm ID to update.
- `job_id`: The job ID to update.
- `queue_id`: The queue ID to update.
- `step_id`: The step ID to update.
- `target_task_run_status`: The task status to update the step's tasks to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
"""
function update_step(
farmId,
jobId,
queueId,
stepId,
targetTaskRunStatus;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)",
Dict{String,Any}(
"targetTaskRunStatus" => targetTaskRunStatus,
"X-Amz-Client-Token" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_step(
farmId,
jobId,
queueId,
stepId,
targetTaskRunStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"targetTaskRunStatus" => targetTaskRunStatus,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_storage_profile(farm_id, storage_profile_id)
update_storage_profile(farm_id, storage_profile_id, params::Dict{String,<:Any})
Updates a storage profile.
# Arguments
- `farm_id`: The farm ID to update.
- `storage_profile_id`: The storage profile ID to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
- `"displayName"`: The display name of the storage profile to update.
- `"fileSystemLocationsToAdd"`: The file system location names to add.
- `"fileSystemLocationsToRemove"`: The file system location names to remove.
- `"osFamily"`: The OS system to update.
"""
function update_storage_profile(
farmId, storageProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/storage-profiles/$(storageProfileId)",
Dict{String,Any}("X-Amz-Client-Token" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_storage_profile(
farmId,
storageProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/storage-profiles/$(storageProfileId)",
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_task(farm_id, job_id, queue_id, step_id, target_run_status, task_id)
update_task(farm_id, job_id, queue_id, step_id, target_run_status, task_id, params::Dict{String,<:Any})
Updates a task.
# Arguments
- `farm_id`: The farm ID to update.
- `job_id`: The job ID to update.
- `queue_id`: The queue ID to update.
- `step_id`: The step ID to update.
- `target_run_status`: The run status with which to start the task.
- `task_id`: The task ID to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amz-Client-Token"`: The unique token which the server uses to recognize retries of
the same request.
"""
function update_task(
farmId,
jobId,
queueId,
stepId,
targetRunStatus,
taskId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)/tasks/$(taskId)",
Dict{String,Any}(
"targetRunStatus" => targetRunStatus, "X-Amz-Client-Token" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_task(
farmId,
jobId,
queueId,
stepId,
targetRunStatus,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/queues/$(queueId)/jobs/$(jobId)/steps/$(stepId)/tasks/$(taskId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"targetRunStatus" => targetRunStatus,
"X-Amz-Client-Token" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_worker(farm_id, fleet_id, worker_id)
update_worker(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})
Updates a worker.
# Arguments
- `farm_id`: The farm ID to update.
- `fleet_id`: The fleet ID to update.
- `worker_id`: The worker ID to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capabilities"`: The worker capabilities to update.
- `"hostProperties"`: The host properties to update.
- `"status"`: The worker status to update.
"""
function update_worker(
farmId, fleetId, workerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_worker(
farmId,
fleetId,
workerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_worker_schedule(farm_id, fleet_id, worker_id)
update_worker_schedule(farm_id, fleet_id, worker_id, params::Dict{String,<:Any})
Updates the schedule for a worker.
# Arguments
- `farm_id`: The farm ID to update.
- `fleet_id`: The fleet ID to update.
- `worker_id`: The worker ID to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"updatedSessionActions"`: The session actions associated with the worker schedule to
update.
"""
function update_worker_schedule(
farmId, fleetId, workerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)/schedule";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_worker_schedule(
farmId,
fleetId,
workerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return deadline(
"PATCH",
"/2023-10-12/farms/$(farmId)/fleets/$(fleetId)/workers/$(workerId)/schedule",
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 | 44323 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: detective
using AWS.Compat
using AWS.UUIDs
"""
accept_invitation(graph_arn)
accept_invitation(graph_arn, params::Dict{String,<:Any})
Accepts an invitation for the member account to contribute data to a behavior graph. This
operation can only be called by an invited member account. The request provides the ARN of
behavior graph. The member account status in the graph must be INVITED.
# Arguments
- `graph_arn`: The ARN of the behavior graph that the member account is accepting the
invitation for. The member account status in the behavior graph must be INVITED.
"""
function accept_invitation(GraphArn; aws_config::AbstractAWSConfig=global_aws_config())
return detective(
"PUT",
"/invitation",
Dict{String,Any}("GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_invitation(
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"PUT",
"/invitation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_graph_member_datasources(account_ids, graph_arn)
batch_get_graph_member_datasources(account_ids, graph_arn, params::Dict{String,<:Any})
Gets data source package information for the behavior graph.
# Arguments
- `account_ids`: The list of Amazon Web Services accounts to get data source package
information on.
- `graph_arn`: The ARN of the behavior graph.
"""
function batch_get_graph_member_datasources(
AccountIds, GraphArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/graph/datasources/get",
Dict{String,Any}("AccountIds" => AccountIds, "GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_graph_member_datasources(
AccountIds,
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/graph/datasources/get",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountIds" => AccountIds, "GraphArn" => GraphArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_membership_datasources(graph_arns)
batch_get_membership_datasources(graph_arns, params::Dict{String,<:Any})
Gets information on the data source package history for an account.
# Arguments
- `graph_arns`: The ARN of the behavior graph.
"""
function batch_get_membership_datasources(
GraphArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/membership/datasources/get",
Dict{String,Any}("GraphArns" => GraphArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_membership_datasources(
GraphArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/membership/datasources/get",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GraphArns" => GraphArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_graph()
create_graph(params::Dict{String,<:Any})
Creates a new behavior graph for the calling account, and sets that account as the
administrator account. This operation is called by the account that is enabling Detective.
The operation also enables Detective for the calling account in the currently selected
Region. It returns the ARN of the new behavior graph. CreateGraph triggers a process to
create the corresponding data tables for the new behavior graph. An account can only be the
administrator account for one behavior graph within a Region. If the same account calls
CreateGraph with the same administrator account, it always returns the same behavior graph
ARN. It does not create a new behavior graph.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to assign to the new behavior graph. You can add up to 50 tags. For
each tag, you provide the tag key and the tag value. Each tag key can contain up to 128
characters. Each tag value can contain up to 256 characters.
"""
function create_graph(; aws_config::AbstractAWSConfig=global_aws_config())
return detective(
"POST", "/graph"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_graph(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST", "/graph", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_members(accounts, graph_arn)
create_members(accounts, graph_arn, params::Dict{String,<:Any})
CreateMembers is used to send invitations to accounts. For the organization behavior
graph, the Detective administrator account uses CreateMembers to enable organization
accounts as member accounts. For invited accounts, CreateMembers sends a request to invite
the specified Amazon Web Services accounts to be member accounts in the behavior graph.
This operation can only be called by the administrator account for a behavior graph.
CreateMembers verifies the accounts and then invites the verified accounts. The
administrator can optionally specify to not send invitation emails to the member accounts.
This would be used when the administrator manages their member accounts centrally. For
organization accounts in the organization behavior graph, CreateMembers attempts to enable
the accounts. The organization accounts do not receive invitations. The request provides
the behavior graph ARN and the list of accounts to invite or to enable. The response
separates the requested accounts into two lists: The accounts that CreateMembers was able
to process. For invited accounts, includes member accounts that are being verified, that
have passed verification and are to be invited, and that have failed verification. For
organization accounts in the organization behavior graph, includes accounts that can be
enabled and that cannot be enabled. The accounts that CreateMembers was unable to
process. This list includes accounts that were already invited to be member accounts in the
behavior graph.
# Arguments
- `accounts`: The list of Amazon Web Services accounts to invite or to enable. You can
invite or enable up to 50 accounts at a time. For each invited account, the account list
contains the account identifier and the Amazon Web Services account root user email
address. For organization accounts in the organization behavior graph, the email address is
not required.
- `graph_arn`: The ARN of the behavior graph.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisableEmailNotification"`: if set to true, then the invited accounts do not receive
email notifications. By default, this is set to false, and the invited accounts receive
email notifications. Organization accounts in the organization behavior graph do not
receive email notifications.
- `"Message"`: Customized message text to include in the invitation email message to the
invited member accounts.
"""
function create_members(
Accounts, GraphArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/graph/members",
Dict{String,Any}("Accounts" => Accounts, "GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_members(
Accounts,
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/graph/members",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Accounts" => Accounts, "GraphArn" => GraphArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_graph(graph_arn)
delete_graph(graph_arn, params::Dict{String,<:Any})
Disables the specified behavior graph and queues it to be deleted. This operation removes
the behavior graph from each member account's list of behavior graphs. DeleteGraph can
only be called by the administrator account for a behavior graph.
# Arguments
- `graph_arn`: The ARN of the behavior graph to disable.
"""
function delete_graph(GraphArn; aws_config::AbstractAWSConfig=global_aws_config())
return detective(
"POST",
"/graph/removal",
Dict{String,Any}("GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_graph(
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/graph/removal",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_members(account_ids, graph_arn)
delete_members(account_ids, graph_arn, params::Dict{String,<:Any})
Removes the specified member accounts from the behavior graph. The removed accounts no
longer contribute data to the behavior graph. This operation can only be called by the
administrator account for the behavior graph. For invited accounts, the removed accounts
are deleted from the list of accounts in the behavior graph. To restore the account, the
administrator account must send another invitation. For organization accounts in the
organization behavior graph, the Detective administrator account can always enable the
organization account again. Organization accounts that are not enabled as member accounts
are not included in the ListMembers results for the organization behavior graph. An
administrator account cannot use DeleteMembers to remove their own account from the
behavior graph. To disable a behavior graph, the administrator account uses the DeleteGraph
API method.
# Arguments
- `account_ids`: The list of Amazon Web Services account identifiers for the member
accounts to remove from the behavior graph. You can remove up to 50 member accounts at a
time.
- `graph_arn`: The ARN of the behavior graph to remove members from.
"""
function delete_members(
AccountIds, GraphArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/graph/members/removal",
Dict{String,Any}("AccountIds" => AccountIds, "GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_members(
AccountIds,
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/graph/members/removal",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountIds" => AccountIds, "GraphArn" => GraphArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_configuration(graph_arn)
describe_organization_configuration(graph_arn, params::Dict{String,<:Any})
Returns information about the configuration for the organization behavior graph. Currently
indicates whether to automatically enable new organization accounts as member accounts. Can
only be called by the Detective administrator account for the organization.
# Arguments
- `graph_arn`: The ARN of the organization behavior graph.
"""
function describe_organization_configuration(
GraphArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/orgs/describeOrganizationConfiguration",
Dict{String,Any}("GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_configuration(
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/orgs/describeOrganizationConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_organization_admin_account()
disable_organization_admin_account(params::Dict{String,<:Any})
Removes the Detective administrator account in the current Region. Deletes the organization
behavior graph. Can only be called by the organization management account. Removing the
Detective administrator account does not affect the delegated administrator account for
Detective in Organizations. To remove the delegated administrator account in Organizations,
use the Organizations API. Removing the delegated administrator account also removes the
Detective administrator account in all Regions, except for Regions where the Detective
administrator account is the organization management account.
"""
function disable_organization_admin_account(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/orgs/disableAdminAccount";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_organization_admin_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/orgs/disableAdminAccount",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_membership(graph_arn)
disassociate_membership(graph_arn, params::Dict{String,<:Any})
Removes the member account from the specified behavior graph. This operation can only be
called by an invited member account that has the ENABLED status. DisassociateMembership
cannot be called by an organization account in the organization behavior graph. For the
organization behavior graph, the Detective administrator account determines which
organization accounts to enable or disable as member accounts.
# Arguments
- `graph_arn`: The ARN of the behavior graph to remove the member account from. The member
account's member status in the behavior graph must be ENABLED.
"""
function disassociate_membership(
GraphArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/membership/removal",
Dict{String,Any}("GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_membership(
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/membership/removal",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_organization_admin_account(account_id)
enable_organization_admin_account(account_id, params::Dict{String,<:Any})
Designates the Detective administrator account for the organization in the current Region.
If the account does not have Detective enabled, then enables Detective for that account and
creates a new behavior graph. Can only be called by the organization management account. If
the organization has a delegated administrator account in Organizations, then the Detective
administrator account must be either the delegated administrator account or the
organization management account. If the organization does not have a delegated
administrator account in Organizations, then you can choose any account in the
organization. If you choose an account other than the organization management account,
Detective calls Organizations to make that account the delegated administrator account for
Detective. The organization management account cannot be the delegated administrator
account.
# Arguments
- `account_id`: The Amazon Web Services account identifier of the account to designate as
the Detective administrator account for the organization.
"""
function enable_organization_admin_account(
AccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/orgs/enableAdminAccount",
Dict{String,Any}("AccountId" => AccountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_organization_admin_account(
AccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/orgs/enableAdminAccount",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountId" => AccountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_investigation(graph_arn, investigation_id)
get_investigation(graph_arn, investigation_id, params::Dict{String,<:Any})
Detective investigations lets you investigate IAM users and IAM roles using indicators of
compromise. An indicator of compromise (IOC) is an artifact observed in or on a network,
system, or environment that can (with a high level of confidence) identify malicious
activity or a security incident. GetInvestigation returns the investigation results of an
investigation for a behavior graph.
# Arguments
- `graph_arn`: The Amazon Resource Name (ARN) of the behavior graph.
- `investigation_id`: The investigation ID of the investigation report.
"""
function get_investigation(
GraphArn, InvestigationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/investigations/getInvestigation",
Dict{String,Any}("GraphArn" => GraphArn, "InvestigationId" => InvestigationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_investigation(
GraphArn,
InvestigationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/investigations/getInvestigation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GraphArn" => GraphArn, "InvestigationId" => InvestigationId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_members(account_ids, graph_arn)
get_members(account_ids, graph_arn, params::Dict{String,<:Any})
Returns the membership details for specified member accounts for a behavior graph.
# Arguments
- `account_ids`: The list of Amazon Web Services account identifiers for the member account
for which to return member details. You can request details for up to 50 member accounts at
a time. You cannot use GetMembers to retrieve information about member accounts that were
removed from the behavior graph.
- `graph_arn`: The ARN of the behavior graph for which to request the member details.
"""
function get_members(
AccountIds, GraphArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/graph/members/get",
Dict{String,Any}("AccountIds" => AccountIds, "GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_members(
AccountIds,
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/graph/members/get",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountIds" => AccountIds, "GraphArn" => GraphArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_datasource_packages(graph_arn)
list_datasource_packages(graph_arn, params::Dict{String,<:Any})
Lists data source packages in the behavior graph.
# Arguments
- `graph_arn`: The ARN of the behavior graph.
# 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"`: For requests to get the next page of results, the pagination token that
was returned with the previous set of results. The initial request does not include a
pagination token.
"""
function list_datasource_packages(
GraphArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/graph/datasources/list",
Dict{String,Any}("GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_datasource_packages(
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/graph/datasources/list",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_graphs()
list_graphs(params::Dict{String,<:Any})
Returns the list of behavior graphs that the calling account is an administrator account
of. This operation can only be called by an administrator account. Because an account can
currently only be the administrator of one behavior graph within a Region, the results
always contain a single behavior graph.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of graphs to return at a time. The total must be less
than the overall limit on the number of results to return, which is currently 200.
- `"NextToken"`: For requests to get the next page of results, the pagination token that
was returned with the previous set of results. The initial request does not include a
pagination token.
"""
function list_graphs(; aws_config::AbstractAWSConfig=global_aws_config())
return detective(
"POST", "/graphs/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_graphs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/graphs/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_indicators(graph_arn, investigation_id)
list_indicators(graph_arn, investigation_id, params::Dict{String,<:Any})
Gets the indicators from an investigation. You can use the information from the indicators
to determine if an IAM user and/or IAM role is involved in an unusual activity that could
indicate malicious behavior and its impact.
# Arguments
- `graph_arn`: The Amazon Resource Name (ARN) of the behavior graph.
- `investigation_id`: The investigation ID of the investigation report.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IndicatorType"`: For the list of indicators of compromise that are generated by
Detective investigations, see Detective investigations.
- `"MaxResults"`: Lists the maximum number of indicators in a page.
- `"NextToken"`: Lists if there are more results available. The value of nextToken is a
unique pagination token for each page. Repeat the call using the returned token to retrieve
the next page. Keep all other arguments unchanged. Each pagination token expires after 24
hours. Using an expired pagination token will return a Validation Exception error.
"""
function list_indicators(
GraphArn, InvestigationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/investigations/listIndicators",
Dict{String,Any}("GraphArn" => GraphArn, "InvestigationId" => InvestigationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_indicators(
GraphArn,
InvestigationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/investigations/listIndicators",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GraphArn" => GraphArn, "InvestigationId" => InvestigationId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_investigations(graph_arn)
list_investigations(graph_arn, params::Dict{String,<:Any})
Detective investigations lets you investigate IAM users and IAM roles using indicators of
compromise. An indicator of compromise (IOC) is an artifact observed in or on a network,
system, or environment that can (with a high level of confidence) identify malicious
activity or a security incident. ListInvestigations lists all active Detective
investigations.
# Arguments
- `graph_arn`: The Amazon Resource Name (ARN) of the behavior graph.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FilterCriteria"`: Filters the investigation results based on a criteria.
- `"MaxResults"`: Lists the maximum number of investigations in a page.
- `"NextToken"`: Lists if there are more results available. The value of nextToken is a
unique pagination token for each page. Repeat the call using the returned token to retrieve
the next page. Keep all other arguments unchanged. Each pagination token expires after 24
hours. Using an expired pagination token will return a Validation Exception error.
- `"SortCriteria"`: Sorts the investigation results based on a criteria.
"""
function list_investigations(GraphArn; aws_config::AbstractAWSConfig=global_aws_config())
return detective(
"POST",
"/investigations/listInvestigations",
Dict{String,Any}("GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_investigations(
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/investigations/listInvestigations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_invitations()
list_invitations(params::Dict{String,<:Any})
Retrieves the list of open and accepted behavior graph invitations for the member account.
This operation can only be called by an invited member account. Open invitations are
invitations that the member account has not responded to. The results do not include
behavior graphs for which the member account declined the invitation. The results also do
not include behavior graphs that the member account resigned from or was removed from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of behavior graph invitations to return in the
response. The total must be less than the overall limit on the number of results to return,
which is currently 200.
- `"NextToken"`: For requests to retrieve the next page of results, the pagination token
that was returned with the previous page of results. The initial request does not include a
pagination token.
"""
function list_invitations(; aws_config::AbstractAWSConfig=global_aws_config())
return detective(
"POST", "/invitations/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_invitations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/invitations/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_members(graph_arn)
list_members(graph_arn, params::Dict{String,<:Any})
Retrieves the list of member accounts for a behavior graph. For invited accounts, the
results do not include member accounts that were removed from the behavior graph. For the
organization behavior graph, the results do not include organization accounts that the
Detective administrator account has not enabled as member accounts.
# Arguments
- `graph_arn`: The ARN of the behavior graph for which to retrieve the list of member
accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of member accounts to include in the response. The
total must be less than the overall limit on the number of results to return, which is
currently 200.
- `"NextToken"`: For requests to retrieve the next page of member account results, the
pagination token that was returned with the previous page of results. The initial request
does not include a pagination token.
"""
function list_members(GraphArn; aws_config::AbstractAWSConfig=global_aws_config())
return detective(
"POST",
"/graph/members/list",
Dict{String,Any}("GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_members(
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/graph/members/list",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_organization_admin_accounts()
list_organization_admin_accounts(params::Dict{String,<:Any})
Returns information about the Detective administrator account for an organization. Can only
be called by the organization management 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.
- `"NextToken"`: For requests to get the next page of results, the pagination token that
was returned with the previous set of results. The initial request does not include a
pagination token.
"""
function list_organization_admin_accounts(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/orgs/adminAccountslist";
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 detective(
"POST",
"/orgs/adminAccountslist",
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 tag values that are assigned to a behavior graph.
# Arguments
- `resource_arn`: The ARN of the behavior graph for which to retrieve the tag values.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"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 detective(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_invitation(graph_arn)
reject_invitation(graph_arn, params::Dict{String,<:Any})
Rejects an invitation to contribute the account data to a behavior graph. This operation
must be called by an invited member account that has the INVITED status. RejectInvitation
cannot be called by an organization account in the organization behavior graph. In the
organization behavior graph, organization accounts do not receive an invitation.
# Arguments
- `graph_arn`: The ARN of the behavior graph to reject the invitation to. The member
account's current member status in the behavior graph must be INVITED.
"""
function reject_invitation(GraphArn; aws_config::AbstractAWSConfig=global_aws_config())
return detective(
"POST",
"/invitation/removal",
Dict{String,Any}("GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_invitation(
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/invitation/removal",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_investigation(entity_arn, graph_arn, scope_end_time, scope_start_time)
start_investigation(entity_arn, graph_arn, scope_end_time, scope_start_time, params::Dict{String,<:Any})
Detective investigations lets you investigate IAM users and IAM roles using indicators of
compromise. An indicator of compromise (IOC) is an artifact observed in or on a network,
system, or environment that can (with a high level of confidence) identify malicious
activity or a security incident. StartInvestigation initiates an investigation on an entity
in a behavior graph.
# Arguments
- `entity_arn`: The unique Amazon Resource Name (ARN) of the IAM user and IAM role.
- `graph_arn`: The Amazon Resource Name (ARN) of the behavior graph.
- `scope_end_time`: The data and time when the investigation ended. The value is an UTC
ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
- `scope_start_time`: The data and time when the investigation began. The value is an UTC
ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
"""
function start_investigation(
EntityArn,
GraphArn,
ScopeEndTime,
ScopeStartTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/investigations/startInvestigation",
Dict{String,Any}(
"EntityArn" => EntityArn,
"GraphArn" => GraphArn,
"ScopeEndTime" => ScopeEndTime,
"ScopeStartTime" => ScopeStartTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_investigation(
EntityArn,
GraphArn,
ScopeEndTime,
ScopeStartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/investigations/startInvestigation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EntityArn" => EntityArn,
"GraphArn" => GraphArn,
"ScopeEndTime" => ScopeEndTime,
"ScopeStartTime" => ScopeStartTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_monitoring_member(account_id, graph_arn)
start_monitoring_member(account_id, graph_arn, params::Dict{String,<:Any})
Sends a request to enable data ingest for a member account that has a status of
ACCEPTED_BUT_DISABLED. For valid member accounts, the status is updated as follows. If
Detective enabled the member account, then the new status is ENABLED. If Detective cannot
enable the member account, the status remains ACCEPTED_BUT_DISABLED.
# Arguments
- `account_id`: The account ID of the member account to try to enable. The account must be
an invited member account with a status of ACCEPTED_BUT_DISABLED.
- `graph_arn`: The ARN of the behavior graph.
"""
function start_monitoring_member(
AccountId, GraphArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/graph/member/monitoringstate",
Dict{String,Any}("AccountId" => AccountId, "GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_monitoring_member(
AccountId,
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/graph/member/monitoringstate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccountId" => AccountId, "GraphArn" => GraphArn),
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 tag values to a behavior graph.
# Arguments
- `resource_arn`: The ARN of the behavior graph to assign the tags to.
- `tags`: The tags to assign to the behavior graph. You can add up to 50 tags. For each
tag, you provide the tag key and the tag value. Each tag key can contain up to 128
characters. Each tag value can contain up to 256 characters.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return detective(
"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 detective(
"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 behavior graph.
# Arguments
- `resource_arn`: The ARN of the behavior graph to remove the tags from.
- `tag_keys`: The tag keys of the tags to remove from the behavior graph. You can remove up
to 50 tags at a time.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"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 detective(
"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_datasource_packages(datasource_packages, graph_arn)
update_datasource_packages(datasource_packages, graph_arn, params::Dict{String,<:Any})
Starts a data source packages for the behavior graph.
# Arguments
- `datasource_packages`: The data source package start for the behavior graph.
- `graph_arn`: The ARN of the behavior graph.
"""
function update_datasource_packages(
DatasourcePackages, GraphArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/graph/datasources/update",
Dict{String,Any}(
"DatasourcePackages" => DatasourcePackages, "GraphArn" => GraphArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_datasource_packages(
DatasourcePackages,
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/graph/datasources/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatasourcePackages" => DatasourcePackages, "GraphArn" => GraphArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_investigation_state(graph_arn, investigation_id, state)
update_investigation_state(graph_arn, investigation_id, state, params::Dict{String,<:Any})
Updates the state of an investigation.
# Arguments
- `graph_arn`: The Amazon Resource Name (ARN) of the behavior graph.
- `investigation_id`: The investigation ID of the investigation report.
- `state`: The current state of the investigation. An archived investigation indicates you
have completed reviewing the investigation.
"""
function update_investigation_state(
GraphArn, InvestigationId, State; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/investigations/updateInvestigationState",
Dict{String,Any}(
"GraphArn" => GraphArn, "InvestigationId" => InvestigationId, "State" => State
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_investigation_state(
GraphArn,
InvestigationId,
State,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/investigations/updateInvestigationState",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GraphArn" => GraphArn,
"InvestigationId" => InvestigationId,
"State" => State,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_organization_configuration(graph_arn)
update_organization_configuration(graph_arn, params::Dict{String,<:Any})
Updates the configuration for the Organizations integration in the current Region. Can only
be called by the Detective administrator account for the organization.
# Arguments
- `graph_arn`: The ARN of the organization behavior graph.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoEnable"`: Indicates whether to automatically enable new organization accounts as
member accounts in the organization behavior graph.
"""
function update_organization_configuration(
GraphArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return detective(
"POST",
"/orgs/updateOrganizationConfiguration",
Dict{String,Any}("GraphArn" => GraphArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_organization_configuration(
GraphArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return detective(
"POST",
"/orgs/updateOrganizationConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GraphArn" => GraphArn), 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 | 96891 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: device_farm
using AWS.Compat
using AWS.UUIDs
"""
create_device_pool(name, project_arn, rules)
create_device_pool(name, project_arn, rules, params::Dict{String,<:Any})
Creates a device pool.
# Arguments
- `name`: The device pool's name.
- `project_arn`: The ARN of the project for the device pool.
- `rules`: The device pool's rules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The device pool's description.
- `"maxDevices"`: The number of devices that Device Farm can add to your device pool.
Device Farm adds devices that are available and meet the criteria that you assign for the
rules parameter. Depending on how many devices meet these constraints, your device pool
might contain fewer devices than the value for this parameter. By specifying the maximum
number of devices, you can control the costs that you incur by running tests.
"""
function create_device_pool(
name, projectArn, rules; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"CreateDevicePool",
Dict{String,Any}("name" => name, "projectArn" => projectArn, "rules" => rules);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_device_pool(
name,
projectArn,
rules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"CreateDevicePool",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "projectArn" => projectArn, "rules" => rules
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance_profile(name)
create_instance_profile(name, params::Dict{String,<:Any})
Creates a profile that can be applied to one or more private fleet device instances.
# Arguments
- `name`: The name of your instance profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of your instance profile.
- `"excludeAppPackagesFromCleanup"`: An array of strings that specifies the list of app
packages that should not be cleaned up from the device after a test run. The list of
packages is considered only if you set packageCleanup to true.
- `"packageCleanup"`: When set to true, Device Farm removes app packages after a test run.
The default value is false for private devices.
- `"rebootAfterUse"`: When set to true, Device Farm reboots the instance after a test run.
The default value is true.
"""
function create_instance_profile(name; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"CreateInstanceProfile",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instance_profile(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"CreateInstanceProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network_profile(name, project_arn)
create_network_profile(name, project_arn, params::Dict{String,<:Any})
Creates a network profile.
# Arguments
- `name`: The name for the new network profile.
- `project_arn`: The Amazon Resource Name (ARN) of the project for which you want to create
a network profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the network profile.
- `"downlinkBandwidthBits"`: The data throughput rate in bits per second, as an integer
from 0 to 104857600.
- `"downlinkDelayMs"`: Delay time for all packets to destination in milliseconds as an
integer from 0 to 2000.
- `"downlinkJitterMs"`: Time variation in the delay of received packets in milliseconds as
an integer from 0 to 2000.
- `"downlinkLossPercent"`: Proportion of received packets that fail to arrive from 0 to 100
percent.
- `"type"`: The type of network profile to create. Valid values are listed here.
- `"uplinkBandwidthBits"`: The data throughput rate in bits per second, as an integer from
0 to 104857600.
- `"uplinkDelayMs"`: Delay time for all packets to destination in milliseconds as an
integer from 0 to 2000.
- `"uplinkJitterMs"`: Time variation in the delay of received packets in milliseconds as an
integer from 0 to 2000.
- `"uplinkLossPercent"`: Proportion of transmitted packets that fail to arrive from 0 to
100 percent.
"""
function create_network_profile(
name, projectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"CreateNetworkProfile",
Dict{String,Any}("name" => name, "projectArn" => projectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network_profile(
name,
projectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"CreateNetworkProfile",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "projectArn" => projectArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project(name)
create_project(name, params::Dict{String,<:Any})
Creates a project.
# Arguments
- `name`: The project's name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"defaultJobTimeoutMinutes"`: Sets the execution timeout value (in minutes) for a
project. All test runs in this project use the specified execution timeout value unless
overridden when scheduling a run.
- `"vpcConfig"`: The VPC security groups and subnets that are attached to a project.
"""
function create_project(name; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"CreateProject",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"CreateProject",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_remote_access_session(device_arn, project_arn)
create_remote_access_session(device_arn, project_arn, params::Dict{String,<:Any})
Specifies and starts a remote access session.
# Arguments
- `device_arn`: The ARN of the device for which you want to create a remote access session.
- `project_arn`: The Amazon Resource Name (ARN) of the project for which you want to create
a remote access session.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientId"`: Unique identifier for the client. If you want access to multiple devices on
the same client, you should pass the same clientId value in each call to
CreateRemoteAccessSession. This identifier is required only if remoteDebugEnabled is set to
true. Remote debugging is no longer supported.
- `"configuration"`: The configuration information for the remote access session request.
- `"instanceArn"`: The Amazon Resource Name (ARN) of the device instance for which you want
to create a remote access session.
- `"interactionMode"`: The interaction mode of the remote access session. Valid values are:
INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the
screen. You cannot run XCUITest framework-based tests in this mode. NO_VIDEO: You are
connected to the device, but cannot interact with it or view the screen. This mode has the
fastest test execution speed. You can run XCUITest framework-based tests in this mode.
VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest
framework-based tests and watch the screen in this mode.
- `"name"`: The name of the remote access session to create.
- `"remoteDebugEnabled"`: Set to true if you want to access devices remotely for debugging
in your remote access session. Remote debugging is no longer supported.
- `"remoteRecordAppArn"`: The Amazon Resource Name (ARN) for the app to be recorded in the
remote access session.
- `"remoteRecordEnabled"`: Set to true to enable remote recording for the remote access
session.
- `"skipAppResign"`: When set to true, for private devices, Device Farm does not sign your
app again. For public devices, Device Farm always signs your apps again. For more
information on how Device Farm modifies your uploads during tests, see Do you modify my
app?
- `"sshPublicKey"`: Ignored. The public key of the ssh key pair you want to use for
connecting to remote devices in your remote debugging session. This key is required only if
remoteDebugEnabled is set to true. Remote debugging is no longer supported.
"""
function create_remote_access_session(
deviceArn, projectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"CreateRemoteAccessSession",
Dict{String,Any}("deviceArn" => deviceArn, "projectArn" => projectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_remote_access_session(
deviceArn,
projectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"CreateRemoteAccessSession",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("deviceArn" => deviceArn, "projectArn" => projectArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_test_grid_project(name)
create_test_grid_project(name, params::Dict{String,<:Any})
Creates a Selenium testing project. Projects are used to track TestGridSession instances.
# Arguments
- `name`: Human-readable name of the Selenium testing project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: Human-readable description of the project.
- `"vpcConfig"`: The VPC security groups and subnets that are attached to a project.
"""
function create_test_grid_project(name; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"CreateTestGridProject",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_test_grid_project(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"CreateTestGridProject",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_test_grid_url(expires_in_seconds, project_arn)
create_test_grid_url(expires_in_seconds, project_arn, params::Dict{String,<:Any})
Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver
constructor.
# Arguments
- `expires_in_seconds`: Lifetime, in seconds, of the URL.
- `project_arn`: ARN (from CreateTestGridProject or ListTestGridProjects) to associate with
the short-term URL.
"""
function create_test_grid_url(
expiresInSeconds, projectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"CreateTestGridUrl",
Dict{String,Any}(
"expiresInSeconds" => expiresInSeconds, "projectArn" => projectArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_test_grid_url(
expiresInSeconds,
projectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"CreateTestGridUrl",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"expiresInSeconds" => expiresInSeconds, "projectArn" => projectArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_upload(name, project_arn, type)
create_upload(name, project_arn, type, params::Dict{String,<:Any})
Uploads an app or test scripts.
# Arguments
- `name`: The upload's file name. The name should not contain any forward slashes (/). If
you are uploading an iOS app, the file name must end with the .ipa extension. If you are
uploading an Android app, the file name must end with the .apk extension. For all others,
the file name must end with the .zip file extension.
- `project_arn`: The ARN of the project for the upload.
- `type`: The upload's upload type. Must be one of the following values: ANDROID_APP
IOS_APP WEB_APP EXTERNAL_DATA APPIUM_JAVA_JUNIT_TEST_PACKAGE
APPIUM_JAVA_TESTNG_TEST_PACKAGE APPIUM_PYTHON_TEST_PACKAGE APPIUM_NODE_TEST_PACKAGE
APPIUM_RUBY_TEST_PACKAGE APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE APPIUM_WEB_PYTHON_TEST_PACKAGE
APPIUM_WEB_NODE_TEST_PACKAGE APPIUM_WEB_RUBY_TEST_PACKAGE CALABASH_TEST_PACKAGE
INSTRUMENTATION_TEST_PACKAGE UIAUTOMATION_TEST_PACKAGE UIAUTOMATOR_TEST_PACKAGE
XCTEST_TEST_PACKAGE XCTEST_UI_TEST_PACKAGE APPIUM_JAVA_JUNIT_TEST_SPEC
APPIUM_JAVA_TESTNG_TEST_SPEC APPIUM_PYTHON_TEST_SPEC APPIUM_NODE_TEST_SPEC
APPIUM_RUBY_TEST_SPEC APPIUM_WEB_JAVA_JUNIT_TEST_SPEC APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
APPIUM_WEB_PYTHON_TEST_SPEC APPIUM_WEB_NODE_TEST_SPEC APPIUM_WEB_RUBY_TEST_SPEC
INSTRUMENTATION_TEST_SPEC XCTEST_UI_TEST_SPEC If you call CreateUpload with WEB_APP
specified, AWS Device Farm throws an ArgumentException error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contentType"`: The upload's content type (for example, application/octet-stream).
"""
function create_upload(
name, projectArn, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"CreateUpload",
Dict{String,Any}("name" => name, "projectArn" => projectArn, "type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_upload(
name,
projectArn,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"CreateUpload",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "projectArn" => projectArn, "type" => type
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpceconfiguration(service_dns_name, vpce_configuration_name, vpce_service_name)
create_vpceconfiguration(service_dns_name, vpce_configuration_name, vpce_service_name, params::Dict{String,<:Any})
Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC)
endpoint.
# Arguments
- `service_dns_name`: The DNS name of the service running in your VPC that you want Device
Farm to test.
- `vpce_configuration_name`: The friendly name you give to your VPC endpoint configuration,
to manage your configurations more easily.
- `vpce_service_name`: The name of the VPC endpoint service running in your AWS account
that you want Device Farm to test.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"vpceConfigurationDescription"`: An optional description that provides details about
your VPC endpoint configuration.
"""
function create_vpceconfiguration(
serviceDnsName,
vpceConfigurationName,
vpceServiceName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"CreateVPCEConfiguration",
Dict{String,Any}(
"serviceDnsName" => serviceDnsName,
"vpceConfigurationName" => vpceConfigurationName,
"vpceServiceName" => vpceServiceName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpceconfiguration(
serviceDnsName,
vpceConfigurationName,
vpceServiceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"CreateVPCEConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"serviceDnsName" => serviceDnsName,
"vpceConfigurationName" => vpceConfigurationName,
"vpceServiceName" => vpceServiceName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_device_pool(arn)
delete_device_pool(arn, params::Dict{String,<:Any})
Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by
the system.
# Arguments
- `arn`: Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.
"""
function delete_device_pool(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"DeleteDevicePool",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_device_pool(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"DeleteDevicePool",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance_profile(arn)
delete_instance_profile(arn, params::Dict{String,<:Any})
Deletes a profile that can be applied to one or more private device instances.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the instance profile you are requesting to
delete.
"""
function delete_instance_profile(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"DeleteInstanceProfile",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance_profile(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"DeleteInstanceProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_profile(arn)
delete_network_profile(arn, params::Dict{String,<:Any})
Deletes a network profile.
# Arguments
- `arn`: The ARN of the network profile to delete.
"""
function delete_network_profile(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"DeleteNetworkProfile",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_profile(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"DeleteNetworkProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project(arn)
delete_project(arn, params::Dict{String,<:Any})
Deletes an AWS Device Farm project, given the project ARN. Deleting this resource does not
stop an in-progress run.
# Arguments
- `arn`: Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.
"""
function delete_project(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"DeleteProject",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"DeleteProject",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_remote_access_session(arn)
delete_remote_access_session(arn, params::Dict{String,<:Any})
Deletes a completed remote access session and its results.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the session for which you want to delete remote
access.
"""
function delete_remote_access_session(
arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"DeleteRemoteAccessSession",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_remote_access_session(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"DeleteRemoteAccessSession",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_run(arn)
delete_run(arn, params::Dict{String,<:Any})
Deletes the run, given the run ARN. Deleting this resource does not stop an in-progress
run.
# Arguments
- `arn`: The Amazon Resource Name (ARN) for the run to delete.
"""
function delete_run(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"DeleteRun",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_run(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"DeleteRun",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_test_grid_project(project_arn)
delete_test_grid_project(project_arn, params::Dict{String,<:Any})
Deletes a Selenium testing project and all content generated under it. You cannot undo
this operation. You cannot delete a project if it has active sessions.
# Arguments
- `project_arn`: The ARN of the project to delete, from CreateTestGridProject or
ListTestGridProjects.
"""
function delete_test_grid_project(
projectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"DeleteTestGridProject",
Dict{String,Any}("projectArn" => projectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_test_grid_project(
projectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"DeleteTestGridProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("projectArn" => projectArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_upload(arn)
delete_upload(arn, params::Dict{String,<:Any})
Deletes an upload given the upload ARN.
# Arguments
- `arn`: Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.
"""
function delete_upload(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"DeleteUpload",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_upload(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"DeleteUpload",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpceconfiguration(arn)
delete_vpceconfiguration(arn, params::Dict{String,<:Any})
Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to
delete.
"""
function delete_vpceconfiguration(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"DeleteVPCEConfiguration",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpceconfiguration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"DeleteVPCEConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_settings()
get_account_settings(params::Dict{String,<:Any})
Returns the number of unmetered iOS or unmetered Android devices that have been purchased
by the account.
"""
function get_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"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 device_farm(
"GetAccountSettings", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_device(arn)
get_device(arn, params::Dict{String,<:Any})
Gets information about a unique device type.
# Arguments
- `arn`: The device type's ARN.
"""
function get_device(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetDevice",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetDevice",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_instance(arn)
get_device_instance(arn, params::Dict{String,<:Any})
Returns information about a device instance that belongs to a private device fleet.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the instance you're requesting information about.
"""
function get_device_instance(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetDeviceInstance",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_instance(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetDeviceInstance",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_pool(arn)
get_device_pool(arn, params::Dict{String,<:Any})
Gets information about a device pool.
# Arguments
- `arn`: The device pool's ARN.
"""
function get_device_pool(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetDevicePool",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_pool(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetDevicePool",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_pool_compatibility(device_pool_arn)
get_device_pool_compatibility(device_pool_arn, params::Dict{String,<:Any})
Gets information about compatibility with a device pool.
# Arguments
- `device_pool_arn`: The device pool's ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appArn"`: The ARN of the app that is associated with the specified device pool.
- `"configuration"`: An object that contains information about the settings for a run.
- `"test"`: Information about the uploaded test to be run against the device pool.
- `"testType"`: The test type for the specified device pool. Allowed values include the
following: BUILTIN_FUZZ. BUILTIN_EXPLORER. For Android, an app explorer that traverses
an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT. APPIUM_JAVA_TESTNG. APPIUM_PYTHON. APPIUM_NODE. APPIUM_RUBY.
APPIUM_WEB_JAVA_JUNIT. APPIUM_WEB_JAVA_TESTNG. APPIUM_WEB_PYTHON. APPIUM_WEB_NODE.
APPIUM_WEB_RUBY. CALABASH. INSTRUMENTATION. UIAUTOMATION. UIAUTOMATOR. XCTEST.
XCTEST_UI.
"""
function get_device_pool_compatibility(
devicePoolArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetDevicePoolCompatibility",
Dict{String,Any}("devicePoolArn" => devicePoolArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_pool_compatibility(
devicePoolArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"GetDevicePoolCompatibility",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("devicePoolArn" => devicePoolArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_profile(arn)
get_instance_profile(arn, params::Dict{String,<:Any})
Returns information about the specified instance profile.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of an instance profile.
"""
function get_instance_profile(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetInstanceProfile",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_profile(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetInstanceProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job(arn)
get_job(arn, params::Dict{String,<:Any})
Gets information about a job.
# Arguments
- `arn`: The job's ARN.
"""
function get_job(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetJob",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_profile(arn)
get_network_profile(arn, params::Dict{String,<:Any})
Returns information about a network profile.
# Arguments
- `arn`: The ARN of the network profile to return information about.
"""
function get_network_profile(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetNetworkProfile",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_profile(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetNetworkProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_offering_status()
get_offering_status(params::Dict{String,<:Any})
Gets the current status and future status of all offerings purchased by an AWS account. The
response indicates how many offerings are currently available and the offerings that will
be available in the next period. The API returns a NotEligible error if the user is not
permitted to invoke the operation. If you must be able to invoke this operation, contact
[email protected].
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function get_offering_status(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetOfferingStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_offering_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetOfferingStatus", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_project(arn)
get_project(arn, params::Dict{String,<:Any})
Gets information about a project.
# Arguments
- `arn`: The project's ARN.
"""
function get_project(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetProject",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_project(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetProject",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_remote_access_session(arn)
get_remote_access_session(arn, params::Dict{String,<:Any})
Returns a link to a currently running remote access session.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the remote access session about which you want
to get session information.
"""
function get_remote_access_session(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetRemoteAccessSession",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_remote_access_session(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetRemoteAccessSession",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_run(arn)
get_run(arn, params::Dict{String,<:Any})
Gets information about a run.
# Arguments
- `arn`: The run's ARN.
"""
function get_run(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetRun",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_run(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetRun",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_suite(arn)
get_suite(arn, params::Dict{String,<:Any})
Gets information about a suite.
# Arguments
- `arn`: The suite's ARN.
"""
function get_suite(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetSuite",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_suite(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetSuite",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_test(arn)
get_test(arn, params::Dict{String,<:Any})
Gets information about a test.
# Arguments
- `arn`: The test's ARN.
"""
function get_test(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetTest",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_test(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetTest",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_test_grid_project(project_arn)
get_test_grid_project(project_arn, params::Dict{String,<:Any})
Retrieves information about a Selenium testing project.
# Arguments
- `project_arn`: The ARN of the Selenium testing project, from either CreateTestGridProject
or ListTestGridProjects.
"""
function get_test_grid_project(
projectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetTestGridProject",
Dict{String,Any}("projectArn" => projectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_test_grid_project(
projectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"GetTestGridProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("projectArn" => projectArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_test_grid_session()
get_test_grid_session(params::Dict{String,<:Any})
A session is an instance of a browser created through a RemoteWebDriver with the URL from
CreateTestGridUrlResulturl. You can use the following to look up sessions: The session
ARN (GetTestGridSessionRequestsessionArn). The project ARN and a session ID
(GetTestGridSessionRequestprojectArn and GetTestGridSessionRequestsessionId).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"projectArn"`: The ARN for the project that this session belongs to. See
CreateTestGridProject and ListTestGridProjects.
- `"sessionArn"`: An ARN that uniquely identifies a TestGridSession.
- `"sessionId"`: An ID associated with this session.
"""
function get_test_grid_session(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetTestGridSession"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_test_grid_session(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetTestGridSession", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_upload(arn)
get_upload(arn, params::Dict{String,<:Any})
Gets information about an upload.
# Arguments
- `arn`: The upload's ARN.
"""
function get_upload(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetUpload",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_upload(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetUpload",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vpceconfiguration(arn)
get_vpceconfiguration(arn, params::Dict{String,<:Any})
Returns information about the configuration settings for your Amazon Virtual Private Cloud
(VPC) endpoint.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to
describe.
"""
function get_vpceconfiguration(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"GetVPCEConfiguration",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vpceconfiguration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"GetVPCEConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
install_to_remote_access_session(app_arn, remote_access_session_arn)
install_to_remote_access_session(app_arn, remote_access_session_arn, params::Dict{String,<:Any})
Installs an application to the device in a remote access session. For Android applications,
the file must be in .apk format. For iOS applications, the file must be in .ipa format.
# Arguments
- `app_arn`: The ARN of the app about which you are requesting information.
- `remote_access_session_arn`: The Amazon Resource Name (ARN) of the remote access session
about which you are requesting information.
"""
function install_to_remote_access_session(
appArn, remoteAccessSessionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"InstallToRemoteAccessSession",
Dict{String,Any}(
"appArn" => appArn, "remoteAccessSessionArn" => remoteAccessSessionArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function install_to_remote_access_session(
appArn,
remoteAccessSessionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"InstallToRemoteAccessSession",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"appArn" => appArn, "remoteAccessSessionArn" => remoteAccessSessionArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_artifacts(arn, type)
list_artifacts(arn, type, params::Dict{String,<:Any})
Gets information about artifacts.
# Arguments
- `arn`: The run, job, suite, or test ARN.
- `type`: The artifacts' type. Allowed values include: FILE LOG SCREENSHOT
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_artifacts(arn, type; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListArtifacts",
Dict{String,Any}("arn" => arn, "type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_artifacts(
arn,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"ListArtifacts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("arn" => arn, "type" => type), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_device_instances()
list_device_instances(params::Dict{String,<:Any})
Returns information about the private device instances associated with one or more AWS
accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An integer that specifies the maximum number of items you want to return
in the API response.
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_device_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListDeviceInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_device_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListDeviceInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_device_pools(arn)
list_device_pools(arn, params::Dict{String,<:Any})
Gets information about device pools.
# Arguments
- `arn`: The project ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
- `"type"`: The device pools' type. Allowed values include: CURATED: A device pool that
is created and managed by AWS Device Farm. PRIVATE: A device pool that is created and
managed by the device pool developer.
"""
function list_device_pools(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListDevicePools",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_device_pools(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListDevicePools",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_devices()
list_devices(params::Dict{String,<:Any})
Gets information about unique device types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"arn"`: The Amazon Resource Name (ARN) of the project.
- `"filters"`: Used to select a set of devices. A filter is made up of an attribute, an
operator, and one or more values. Attribute: The aspect of a device such as platform or
model used as the selection criteria in a device filter. Allowed values include: ARN: The
Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example). PLATFORM: The device platform. Valid
values are ANDROID or IOS. OS_VERSION: The operating system version (for example,
10.3.2). MODEL: The device model (for example, iPad 5th Gen). AVAILABILITY: The current
availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or
TEMPORARY_NOT_AVAILABLE. FORM_FACTOR: The device form factor. Valid values are PHONE or
TABLET. MANUFACTURER: The device manufacturer (for example, Apple).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are
TRUE or FALSE. REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this
attribute is ignored. INSTANCE_ARN: The Amazon Resource Name (ARN) of the device
instance. INSTANCE_LABELS: The label of the device instance. FLEET_TYPE: The fleet
type. Valid values are PUBLIC or PRIVATE. Operator: The filter operator. The EQUALS
operator is available for every attribute except INSTANCE_LABELS. The CONTAINS operator
is available for the INSTANCE_LABELS and MODEL attributes. The IN and NOT_IN operators
are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are
also available for the OS_VERSION attribute. Values: An array of one or more filter
values. The IN and NOT_IN operators take a values array that has one or more elements.
The other operators require an array with a single element. In a request, the
AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or
TEMPORARY_NOT_AVAILABLE.
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_devices(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListDevices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_devices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListDevices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_instance_profiles()
list_instance_profiles(params::Dict{String,<:Any})
Returns information about all the instance profiles in an AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An integer that specifies the maximum number of items you want to return
in the API response.
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_instance_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListInstanceProfiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_instance_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListInstanceProfiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs(arn)
list_jobs(arn, params::Dict{String,<:Any})
Gets information about jobs for a given test run.
# Arguments
- `arn`: The run's Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_jobs(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListJobs",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_jobs(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListJobs",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_network_profiles(arn)
list_network_profiles(arn, params::Dict{String,<:Any})
Returns the list of available network profiles.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the project for which you want to list network
profiles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
- `"type"`: The type of network profile to return information about. Valid values are
listed here.
"""
function list_network_profiles(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListNetworkProfiles",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_network_profiles(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListNetworkProfiles",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_offering_promotions()
list_offering_promotions(params::Dict{String,<:Any})
Returns a list of offering promotions. Each offering promotion record contains the ID and
description of the promotion. The API returns a NotEligible error if the caller is not
permitted to invoke the operation. Contact [email protected] if you must be
able to invoke this operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_offering_promotions(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListOfferingPromotions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_offering_promotions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListOfferingPromotions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_offering_transactions()
list_offering_transactions(params::Dict{String,<:Any})
Returns a list of all historical purchases, renewals, and system renewal transactions for
an AWS account. The list is paginated and ordered by a descending timestamp (most recent
transactions are first). The API returns a NotEligible error if the user is not permitted
to invoke the operation. If you must be able to invoke this operation, contact
[email protected].
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_offering_transactions(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListOfferingTransactions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_offering_transactions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListOfferingTransactions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_offerings()
list_offerings(params::Dict{String,<:Any})
Returns a list of products or offerings that the user can manage through the API. Each
offering record indicates the recurring price per unit and the frequency for that offering.
The API returns a NotEligible error if the user is not permitted to invoke the operation.
If you must be able to invoke this operation, contact [email protected].
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_offerings(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListOfferings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListOfferings", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_projects()
list_projects(params::Dict{String,<:Any})
Gets information about projects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"arn"`: Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm
returns a list of all projects for the AWS account. You can also specify a project ARN.
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListProjects"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_projects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListProjects", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_remote_access_sessions(arn)
list_remote_access_sessions(arn, params::Dict{String,<:Any})
Returns a list of all currently running remote access sessions.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the project about which you are requesting
information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_remote_access_sessions(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListRemoteAccessSessions",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_remote_access_sessions(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListRemoteAccessSessions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_runs(arn)
list_runs(arn, params::Dict{String,<:Any})
Gets information about runs, given an AWS Device Farm project ARN.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the project for which you want to list runs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_runs(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListRuns",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_runs(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListRuns",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_samples(arn)
list_samples(arn, params::Dict{String,<:Any})
Gets information about samples, given an AWS Device Farm job ARN.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the job used to list samples.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_samples(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListSamples",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_samples(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListSamples",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_suites(arn)
list_suites(arn, params::Dict{String,<:Any})
Gets information about test suites for a given job.
# Arguments
- `arn`: The job's Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_suites(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListSuites",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_suites(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListSuites",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), 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 for an AWS Device Farm resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource or resources for which to
list tags. You can associate tags with the following Device Farm resources: PROJECT, RUN,
NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and
VPCE_CONFIGURATION.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"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 device_farm(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_test_grid_projects()
list_test_grid_projects(params::Dict{String,<:Any})
Gets a list of all Selenium testing projects in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResult"`: Return no more than this number of results.
- `"nextToken"`: From a response, used to continue a paginated listing.
"""
function list_test_grid_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListTestGridProjects"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_test_grid_projects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListTestGridProjects",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_test_grid_session_actions(session_arn)
list_test_grid_session_actions(session_arn, params::Dict{String,<:Any})
Returns a list of the actions taken in a TestGridSession.
# Arguments
- `session_arn`: The ARN of the session to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResult"`: The maximum number of sessions to return per response.
- `"nextToken"`: Pagination token.
"""
function list_test_grid_session_actions(
sessionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListTestGridSessionActions",
Dict{String,Any}("sessionArn" => sessionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_test_grid_session_actions(
sessionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"ListTestGridSessionActions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sessionArn" => sessionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_test_grid_session_artifacts(session_arn)
list_test_grid_session_artifacts(session_arn, params::Dict{String,<:Any})
Retrieves a list of artifacts created during the session.
# Arguments
- `session_arn`: The ARN of a TestGridSession.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResult"`: The maximum number of results to be returned by a request.
- `"nextToken"`: Pagination token.
- `"type"`: Limit results to a specified type of artifact.
"""
function list_test_grid_session_artifacts(
sessionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListTestGridSessionArtifacts",
Dict{String,Any}("sessionArn" => sessionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_test_grid_session_artifacts(
sessionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"ListTestGridSessionArtifacts",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sessionArn" => sessionArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_test_grid_sessions(project_arn)
list_test_grid_sessions(project_arn, params::Dict{String,<:Any})
Retrieves a list of sessions for a TestGridProject.
# Arguments
- `project_arn`: ARN of a TestGridProject.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"creationTimeAfter"`: Return only sessions created after this time.
- `"creationTimeBefore"`: Return only sessions created before this time.
- `"endTimeAfter"`: Return only sessions that ended after this time.
- `"endTimeBefore"`: Return only sessions that ended before this time.
- `"maxResult"`: Return only this many results at a time.
- `"nextToken"`: Pagination token.
- `"status"`: Return only sessions in this state.
"""
function list_test_grid_sessions(
projectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListTestGridSessions",
Dict{String,Any}("projectArn" => projectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_test_grid_sessions(
projectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"ListTestGridSessions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("projectArn" => projectArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tests(arn)
list_tests(arn, params::Dict{String,<:Any})
Gets information about tests in a given test suite.
# Arguments
- `arn`: The test suite's Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_tests(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListTests",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tests(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListTests",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_unique_problems(arn)
list_unique_problems(arn, params::Dict{String,<:Any})
Gets information about unique problems, such as exceptions or crashes. Unique problems are
defined as a single instance of an error across a run, job, or suite. For example, if a
call in your application consistently raises an exception (OutOfBoundsException in
MyActivity.java:386), ListUniqueProblems returns a single entry instead of many individual
entries for that exception.
# Arguments
- `arn`: The unique problems' ARNs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_unique_problems(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListUniqueProblems",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_unique_problems(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListUniqueProblems",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_uploads(arn)
list_uploads(arn, params::Dict{String,<:Any})
Gets information about uploads, given an AWS Device Farm project ARN.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the project for which you want to list uploads.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
- `"type"`: The type of upload. Must be one of the following values: ANDROID_APP
IOS_APP WEB_APP EXTERNAL_DATA APPIUM_JAVA_JUNIT_TEST_PACKAGE
APPIUM_JAVA_TESTNG_TEST_PACKAGE APPIUM_PYTHON_TEST_PACKAGE APPIUM_NODE_TEST_PACKAGE
APPIUM_RUBY_TEST_PACKAGE APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE APPIUM_WEB_PYTHON_TEST_PACKAGE
APPIUM_WEB_NODE_TEST_PACKAGE APPIUM_WEB_RUBY_TEST_PACKAGE CALABASH_TEST_PACKAGE
INSTRUMENTATION_TEST_PACKAGE UIAUTOMATION_TEST_PACKAGE UIAUTOMATOR_TEST_PACKAGE
XCTEST_TEST_PACKAGE XCTEST_UI_TEST_PACKAGE APPIUM_JAVA_JUNIT_TEST_SPEC
APPIUM_JAVA_TESTNG_TEST_SPEC APPIUM_PYTHON_TEST_SPEC APPIUM_NODE_TEST_SPEC
APPIUM_RUBY_TEST_SPEC APPIUM_WEB_JAVA_JUNIT_TEST_SPEC APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
APPIUM_WEB_PYTHON_TEST_SPEC APPIUM_WEB_NODE_TEST_SPEC APPIUM_WEB_RUBY_TEST_SPEC
INSTRUMENTATION_TEST_SPEC XCTEST_UI_TEST_SPEC
"""
function list_uploads(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListUploads",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_uploads(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListUploads",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vpceconfigurations()
list_vpceconfigurations(params::Dict{String,<:Any})
Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in
the AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: An integer that specifies the maximum number of items you want to return
in the API response.
- `"nextToken"`: An identifier that was returned from the previous call to this operation,
which can be used to return the next set of items in the list.
"""
function list_vpceconfigurations(; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ListVPCEConfigurations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_vpceconfigurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"ListVPCEConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_offering(offering_id, quantity)
purchase_offering(offering_id, quantity, params::Dict{String,<:Any})
Immediately purchases offerings for an AWS account. Offerings renew with the latest total
purchased quantity for an offering, unless the renewal was overridden. The API returns a
NotEligible error if the user is not permitted to invoke the operation. If you must be able
to invoke this operation, contact [email protected].
# Arguments
- `offering_id`: The ID of the offering.
- `quantity`: The number of device slots to purchase in an offering request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"offeringPromotionId"`: The ID of the offering promotion to be applied to the purchase.
"""
function purchase_offering(
offeringId, quantity; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"PurchaseOffering",
Dict{String,Any}("offeringId" => offeringId, "quantity" => quantity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_offering(
offeringId,
quantity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"PurchaseOffering",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("offeringId" => offeringId, "quantity" => quantity),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
renew_offering(offering_id, quantity)
renew_offering(offering_id, quantity, params::Dict{String,<:Any})
Explicitly sets the quantity of devices to renew for an offering, starting from the
effectiveDate of the next period. The API returns a NotEligible error if the user is not
permitted to invoke the operation. If you must be able to invoke this operation, contact
[email protected].
# Arguments
- `offering_id`: The ID of a request to renew an offering.
- `quantity`: The quantity requested in an offering renewal.
"""
function renew_offering(
offeringId, quantity; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"RenewOffering",
Dict{String,Any}("offeringId" => offeringId, "quantity" => quantity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function renew_offering(
offeringId,
quantity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"RenewOffering",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("offeringId" => offeringId, "quantity" => quantity),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
schedule_run(project_arn, test)
schedule_run(project_arn, test, params::Dict{String,<:Any})
Schedules a run.
# Arguments
- `project_arn`: The ARN of the project for the run to be scheduled.
- `test`: Information about the test for the run to be scheduled.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appArn"`: The ARN of an application package to run tests against, created with
CreateUpload. See ListUploads.
- `"configuration"`: Information about the settings for the run to be scheduled.
- `"devicePoolArn"`: The ARN of the device pool for the run to be scheduled.
- `"deviceSelectionConfiguration"`: The filter criteria used to dynamically select a set of
devices for a test run and the maximum number of devices to be included in the run. Either
devicePoolArn or deviceSelectionConfiguration is required in a request.
- `"executionConfiguration"`: Specifies configuration information about a test run, such as
the execution timeout (in minutes).
- `"name"`: The name for the run to be scheduled.
"""
function schedule_run(projectArn, test; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"ScheduleRun",
Dict{String,Any}("projectArn" => projectArn, "test" => test);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function schedule_run(
projectArn,
test,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"ScheduleRun",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("projectArn" => projectArn, "test" => test), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_job(arn)
stop_job(arn, params::Dict{String,<:Any})
Initiates a stop request for the current job. AWS Device Farm immediately stops the job on
the device where tests have not started. You are not billed for this device. On the device
where tests have started, setup suite and teardown suite tests run to completion on the
device. You are billed for setup, teardown, and any tests that were in progress or already
completed.
# Arguments
- `arn`: Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.
"""
function stop_job(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"StopJob",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_job(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"StopJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_remote_access_session(arn)
stop_remote_access_session(arn, params::Dict{String,<:Any})
Ends a specified remote access session.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the remote access session to stop.
"""
function stop_remote_access_session(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"StopRemoteAccessSession",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_remote_access_session(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"StopRemoteAccessSession",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_run(arn)
stop_run(arn, params::Dict{String,<:Any})
Initiates a stop request for the current test run. AWS Device Farm immediately stops the
run on devices where tests have not started. You are not billed for these devices. On
devices where tests have started executing, setup suite and teardown suite tests run to
completion on those devices. You are billed for setup, teardown, and any tests that were in
progress or already completed.
# Arguments
- `arn`: Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.
"""
function stop_run(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"StopRun",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_run(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"StopRun",
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})
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 also deleted.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource or resources to which to
add tags. You can associate tags with the following Device Farm resources: PROJECT, RUN,
NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and
VPCE_CONFIGURATION.
- `tags`: The tags to add to the resource. A tag is an array of key-value pairs. Tag keys
can have a maximum character length of 128 characters. Tag values can have a maximum length
of 256 characters.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"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 device_farm(
"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 the specified tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource or resources from which to
delete tags. You can associate tags with the following Device Farm resources: PROJECT, RUN,
NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and
VPCE_CONFIGURATION.
- `tag_keys`: The keys of the tags to be removed.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"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 device_farm(
"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_device_instance(arn)
update_device_instance(arn, params::Dict{String,<:Any})
Updates information about a private device instance.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the device instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"labels"`: An array of strings that you want to associate with the device instance.
- `"profileArn"`: The ARN of the profile that you want to associate with the device
instance.
"""
function update_device_instance(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"UpdateDeviceInstance",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_device_instance(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"UpdateDeviceInstance",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_device_pool(arn)
update_device_pool(arn, params::Dict{String,<:Any})
Modifies the name, description, and rules in a device pool given the attributes and the
pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or
not at all).
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the Device Farm device pool to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clearMaxDevices"`: Sets whether the maxDevices parameter applies to your device pool.
If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm
does not limit the number of devices that it adds to your device pool. In this case, Device
Farm adds all available devices that meet the criteria specified in the rules parameter. If
you use this parameter in your request, you cannot use the maxDevices parameter in the same
request.
- `"description"`: A description of the device pool to update.
- `"maxDevices"`: The number of devices that Device Farm can add to your device pool.
Device Farm adds devices that are available and that meet the criteria that you assign for
the rules parameter. Depending on how many devices meet these constraints, your device pool
might contain fewer devices than the value for this parameter. By specifying the maximum
number of devices, you can control the costs that you incur by running tests. If you use
this parameter in your request, you cannot use the clearMaxDevices parameter in the same
request.
- `"name"`: A string that represents the name of the device pool to update.
- `"rules"`: Represents the rules to modify for the device pool. Updating rules is
optional. If you update rules for your request, the update replaces the existing rules.
"""
function update_device_pool(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"UpdateDevicePool",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_device_pool(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"UpdateDevicePool",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_instance_profile(arn)
update_instance_profile(arn, params::Dict{String,<:Any})
Updates information about an existing private device instance profile.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the instance profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The updated description for your instance profile.
- `"excludeAppPackagesFromCleanup"`: An array of strings that specifies the list of app
packages that should not be cleaned up from the device after a test run is over. The list
of packages is only considered if you set packageCleanup to true.
- `"name"`: The updated name for your instance profile.
- `"packageCleanup"`: The updated choice for whether you want to specify package cleanup.
The default value is false for private devices.
- `"rebootAfterUse"`: The updated choice for whether you want to reboot the device after
use. The default value is true.
"""
function update_instance_profile(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"UpdateInstanceProfile",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_instance_profile(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"UpdateInstanceProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_network_profile(arn)
update_network_profile(arn, params::Dict{String,<:Any})
Updates the network profile.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the project for which you want to update network
profile settings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the network profile about which you are returning
information.
- `"downlinkBandwidthBits"`: The data throughput rate in bits per second, as an integer
from 0 to 104857600.
- `"downlinkDelayMs"`: Delay time for all packets to destination in milliseconds as an
integer from 0 to 2000.
- `"downlinkJitterMs"`: Time variation in the delay of received packets in milliseconds as
an integer from 0 to 2000.
- `"downlinkLossPercent"`: Proportion of received packets that fail to arrive from 0 to 100
percent.
- `"name"`: The name of the network profile about which you are returning information.
- `"type"`: The type of network profile to return information about. Valid values are
listed here.
- `"uplinkBandwidthBits"`: The data throughput rate in bits per second, as an integer from
0 to 104857600.
- `"uplinkDelayMs"`: Delay time for all packets to destination in milliseconds as an
integer from 0 to 2000.
- `"uplinkJitterMs"`: Time variation in the delay of received packets in milliseconds as an
integer from 0 to 2000.
- `"uplinkLossPercent"`: Proportion of transmitted packets that fail to arrive from 0 to
100 percent.
"""
function update_network_profile(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"UpdateNetworkProfile",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_network_profile(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"UpdateNetworkProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_project(arn)
update_project(arn, params::Dict{String,<:Any})
Modifies the specified project name, given the project ARN and a new name.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the project whose name to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"defaultJobTimeoutMinutes"`: The number of minutes a test run in the project executes
before it times out.
- `"name"`: A string that represents the new name of the project that you are updating.
- `"vpcConfig"`: The VPC security groups and subnets that are attached to a project.
"""
function update_project(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"UpdateProject",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_project(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"UpdateProject",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_test_grid_project(project_arn)
update_test_grid_project(project_arn, params::Dict{String,<:Any})
Change details of a project.
# Arguments
- `project_arn`: ARN of the project to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: Human-readable description for the project.
- `"name"`: Human-readable name for the project.
- `"vpcConfig"`: The VPC security groups and subnets that are attached to a project.
"""
function update_test_grid_project(
projectArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"UpdateTestGridProject",
Dict{String,Any}("projectArn" => projectArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_test_grid_project(
projectArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return device_farm(
"UpdateTestGridProject",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("projectArn" => projectArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_upload(arn)
update_upload(arn, params::Dict{String,<:Any})
Updates an uploaded test spec.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the uploaded test spec.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contentType"`: The upload's content type (for example, application/x-yaml).
- `"editContent"`: Set to true if the YAML file has changed and must be updated. Otherwise,
set to false.
- `"name"`: The upload's test spec file name. The name must not contain any forward slashes
(/). The test spec file name must end with the .yaml or .yml file extension.
"""
function update_upload(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"UpdateUpload",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_upload(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"UpdateUpload",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_vpceconfiguration(arn)
update_vpceconfiguration(arn, params::Dict{String,<:Any})
Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"serviceDnsName"`: The DNS (domain) name used to connect to your private service in your
VPC. The DNS name must not already be in use on the internet.
- `"vpceConfigurationDescription"`: An optional description that provides details about
your VPC endpoint configuration.
- `"vpceConfigurationName"`: The friendly name you give to your VPC endpoint configuration
to manage your configurations more easily.
- `"vpceServiceName"`: The name of the VPC endpoint service running in your AWS account
that you want Device Farm to test.
"""
function update_vpceconfiguration(arn; aws_config::AbstractAWSConfig=global_aws_config())
return device_farm(
"UpdateVPCEConfiguration",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_vpceconfiguration(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return device_farm(
"UpdateVPCEConfiguration",
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 | 43263 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: devops_guru
using AWS.Compat
using AWS.UUIDs
"""
add_notification_channel(config)
add_notification_channel(config, params::Dict{String,<:Any})
Adds a notification channel to DevOps Guru. A notification channel is used to notify you
about important DevOps Guru events, such as when an insight is generated. If you use an
Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru
permission to send it notifications. DevOps Guru adds the required policy on your behalf to
send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS
topics. For more information, see Permissions for Amazon SNS topics. If you use an Amazon
SNS topic that is encrypted by an Amazon Web Services Key Management Service
customer-managed key (CMK), then you must add permissions to the CMK. For more information,
see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
# Arguments
- `config`: A NotificationChannelConfig object that specifies what type of notification
channel to add. The one supported notification channel is Amazon Simple Notification
Service (Amazon SNS).
"""
function add_notification_channel(Config; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"PUT",
"/channels",
Dict{String,Any}("Config" => Config);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_notification_channel(
Config, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"PUT",
"/channels",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Config" => Config), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_insight(id)
delete_insight(id, params::Dict{String,<:Any})
Deletes the insight along with the associated anomalies, events and recommendations.
# Arguments
- `id`: The ID of the insight.
"""
function delete_insight(Id; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"DELETE", "/insights/$(Id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_insight(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"DELETE",
"/insights/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_health()
describe_account_health(params::Dict{String,<:Any})
Returns the number of open reactive insights, the number of open proactive insights, and
the number of metrics analyzed in your Amazon Web Services account. Use these numbers to
gauge the health of operations in your Amazon Web Services account.
"""
function describe_account_health(; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"GET", "/accounts/health"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_account_health(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"GET",
"/accounts/health",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_overview(from_time)
describe_account_overview(from_time, params::Dict{String,<:Any})
For the time range passed in, returns the number of open reactive insight that were
created, the number of open proactive insights that were created, and the Mean Time to
Recover (MTTR) for all closed reactive insights.
# Arguments
- `from_time`: The start of the time range passed in. The start time granularity is at the
day level. The floor of the start time is used. Returned information occurred after this
day.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ToTime"`: The end of the time range passed in. The start time granularity is at the
day level. The floor of the start time is used. Returned information occurred before this
day. If this is not specified, then the current day is used.
"""
function describe_account_overview(
FromTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/accounts/overview",
Dict{String,Any}("FromTime" => FromTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_account_overview(
FromTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"POST",
"/accounts/overview",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FromTime" => FromTime), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_anomaly(id)
describe_anomaly(id, params::Dict{String,<:Any})
Returns details about an anomaly that you specify using its ID.
# Arguments
- `id`: The ID of the anomaly.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountId"`: The ID of the member account.
"""
function describe_anomaly(Id; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"GET", "/anomalies/$(Id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_anomaly(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"GET",
"/anomalies/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_sources_config()
describe_event_sources_config(params::Dict{String,<:Any})
Returns the integration status of services that are integrated with DevOps Guru as Consumer
via EventBridge. The one service that can be integrated with DevOps Guru is Amazon CodeGuru
Profiler, which can produce proactive recommendations which can be stored and viewed in
DevOps Guru.
"""
function describe_event_sources_config(; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"POST", "/event-sources"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_event_sources_config(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/event-sources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_feedback()
describe_feedback(params::Dict{String,<:Any})
Returns the most recent feedback submitted 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:
- `"InsightId"`: The ID of the insight for which the feedback was provided.
"""
function describe_feedback(; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"POST", "/feedback"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_feedback(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST", "/feedback", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_insight(id)
describe_insight(id, params::Dict{String,<:Any})
Returns details about an insight that you specify using its ID.
# Arguments
- `id`: The ID of the insight.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountId"`: The ID of the member account in the organization.
"""
function describe_insight(Id; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"GET", "/insights/$(Id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_insight(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"GET",
"/insights/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_health()
describe_organization_health(params::Dict{String,<:Any})
Returns active insights, predictive insights, and resource hours analyzed in last hour.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountIds"`: The ID of the Amazon Web Services account.
- `"OrganizationalUnitIds"`: The ID of the organizational unit.
"""
function describe_organization_health(; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"POST",
"/organization/health";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_health(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/organization/health",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_overview(from_time)
describe_organization_overview(from_time, params::Dict{String,<:Any})
Returns an overview of your organization's history based on the specified time range. The
overview includes the total reactive and proactive insights.
# Arguments
- `from_time`: The start of the time range passed in. The start time granularity is at the
day level. The floor of the start time is used. Returned information occurred after this
day.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountIds"`: The ID of the Amazon Web Services account.
- `"OrganizationalUnitIds"`: The ID of the organizational unit.
- `"ToTime"`: The end of the time range passed in. The start time granularity is at the
day level. The floor of the start time is used. Returned information occurred before this
day. If this is not specified, then the current day is used.
"""
function describe_organization_overview(
FromTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/organization/overview",
Dict{String,Any}("FromTime" => FromTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_overview(
FromTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"POST",
"/organization/overview",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FromTime" => FromTime), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_resource_collection_health(organization_resource_collection_type)
describe_organization_resource_collection_health(organization_resource_collection_type, params::Dict{String,<:Any})
Provides an overview of your system's health. If additional member accounts are part of
your organization, you can filter those accounts using the AccountIds field.
# Arguments
- `organization_resource_collection_type`: An Amazon Web Services resource collection
type. This type specifies how analyzed Amazon Web Services resources are defined. The two
types of Amazon Web Services resource collections supported are Amazon Web Services
CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web
Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources
that are defined in the stacks or that are tagged using the same tag key. You can specify
up to 500 Amazon Web Services CloudFormation stacks.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountIds"`: The ID of the Amazon Web Services account.
- `"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 pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
- `"OrganizationalUnitIds"`: The ID of the organizational unit.
"""
function describe_organization_resource_collection_health(
OrganizationResourceCollectionType; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/organization/health/resource-collection",
Dict{String,Any}(
"OrganizationResourceCollectionType" => OrganizationResourceCollectionType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_resource_collection_health(
OrganizationResourceCollectionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"POST",
"/organization/health/resource-collection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OrganizationResourceCollectionType" =>
OrganizationResourceCollectionType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resource_collection_health(resource_collection_type)
describe_resource_collection_health(resource_collection_type, params::Dict{String,<:Any})
Returns the number of open proactive insights, open reactive insights, and the Mean Time
to Recover (MTTR) for all closed insights in resource collections in your account. You
specify the type of Amazon Web Services resources collection. The two types of Amazon Web
Services resource collections supported are Amazon Web Services CloudFormation stacks and
Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru
can be configured to analyze the Amazon Web Services resources that are defined in the
stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web
Services CloudFormation stacks.
# Arguments
- `resource_collection_type`: An Amazon Web Services resource collection type. This type
specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon
Web Services resource collections supported are Amazon Web Services CloudFormation stacks
and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps
Guru can be configured to analyze the Amazon Web Services resources that are defined in the
stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web
Services CloudFormation stacks.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: The pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function describe_resource_collection_health(
ResourceCollectionType; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"GET",
"/accounts/health/resource-collection/$(ResourceCollectionType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_resource_collection_health(
ResourceCollectionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"GET",
"/accounts/health/resource-collection/$(ResourceCollectionType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_service_integration()
describe_service_integration(params::Dict{String,<:Any})
Returns the integration status of services that are integrated with DevOps Guru. The one
service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager,
which can be used to create an OpsItem for each generated insight.
"""
function describe_service_integration(; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"GET",
"/service-integrations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_service_integration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"GET",
"/service-integrations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cost_estimation()
get_cost_estimation(params::Dict{String,<:Any})
Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services
resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon
DevOps Guru pricing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: The pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function get_cost_estimation(; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"GET", "/cost-estimation"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_cost_estimation(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"GET",
"/cost-estimation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_collection(resource_collection_type)
get_resource_collection(resource_collection_type, params::Dict{String,<:Any})
Returns lists Amazon Web Services resources that are of the specified resource collection
type. The two types of Amazon Web Services resource collections supported are Amazon Web
Services CloudFormation stacks and Amazon Web Services resources that contain the same
Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services
resources that are defined in the stacks or that are tagged using the same tag key. You can
specify up to 500 Amazon Web Services CloudFormation stacks.
# Arguments
- `resource_collection_type`: The type of Amazon Web Services resource collections to
return. The one valid value is CLOUD_FORMATION for Amazon Web Services CloudFormation
stacks.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: The pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function get_resource_collection(
ResourceCollectionType; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"GET",
"/resource-collections/$(ResourceCollectionType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_collection(
ResourceCollectionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"GET",
"/resource-collections/$(ResourceCollectionType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_anomalies_for_insight(insight_id)
list_anomalies_for_insight(insight_id, params::Dict{String,<:Any})
Returns a list of the anomalies that belong to an insight that you specify using its ID.
# Arguments
- `insight_id`: The ID of the insight. The returned anomalies belong to this insight.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountId"`: The ID of the Amazon Web Services account.
- `"Filters"`: Specifies one or more service names that are used to list anomalies.
- `"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 pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
- `"StartTimeRange"`: A time range used to specify when the requested anomalies started.
All returned anomalies started during this time range.
"""
function list_anomalies_for_insight(
InsightId; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/anomalies/insight/$(InsightId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_anomalies_for_insight(
InsightId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"POST",
"/anomalies/insight/$(InsightId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_anomalous_log_groups(insight_id)
list_anomalous_log_groups(insight_id, params::Dict{String,<:Any})
Returns the list of log groups that contain log anomalies.
# Arguments
- `insight_id`: The ID of the insight containing the log groups.
# 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 pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function list_anomalous_log_groups(
InsightId; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/list-log-anomalies",
Dict{String,Any}("InsightId" => InsightId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_anomalous_log_groups(
InsightId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"POST",
"/list-log-anomalies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InsightId" => InsightId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_events(filters)
list_events(filters, params::Dict{String,<:Any})
Returns a list of the events emitted by the resources that are evaluated by DevOps Guru.
You can use filters to specify which events are returned.
# Arguments
- `filters`: A ListEventsFilters object used to specify which events to return.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountId"`: The ID of the Amazon Web Services account.
- `"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 pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function list_events(Filters; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"POST",
"/events",
Dict{String,Any}("Filters" => Filters);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_events(
Filters, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/events",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Filters" => Filters), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_insights(status_filter)
list_insights(status_filter, params::Dict{String,<:Any})
Returns a list of insights in your Amazon Web Services account. You can specify which
insights are returned by their start time and status (ONGOING, CLOSED, or ANY).
# Arguments
- `status_filter`: A filter used to filter the returned insights by their status. You can
specify one status filter.
# 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 pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function list_insights(StatusFilter; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"POST",
"/insights",
Dict{String,Any}("StatusFilter" => StatusFilter);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_insights(
StatusFilter,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"POST",
"/insights",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StatusFilter" => StatusFilter), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_monitored_resources()
list_monitored_resources(params::Dict{String,<:Any})
Returns the list of all log groups that are being monitored and tagged by DevOps Guru.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters to determine which monitored resources you want to retrieve. You
can filter by resource type or resource permission status.
- `"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 pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function list_monitored_resources(; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"POST",
"/monitoredResources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_monitored_resources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/monitoredResources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_notification_channels()
list_notification_channels(params::Dict{String,<:Any})
Returns a list of notification channels configured for DevOps Guru. Each notification
channel is used to notify you when DevOps Guru generates an insight that contains
information about how to improve your operations. The one supported notification channel is
Amazon Simple Notification Service (Amazon SNS).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: The pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function list_notification_channels(; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"POST", "/channels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_notification_channels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST", "/channels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_organization_insights(status_filter)
list_organization_insights(status_filter, params::Dict{String,<:Any})
Returns a list of insights associated with the account or OU Id.
# Arguments
- `status_filter`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountIds"`: The ID of the Amazon Web Services account.
- `"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 pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
- `"OrganizationalUnitIds"`: The ID of the organizational unit.
"""
function list_organization_insights(
StatusFilter; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/organization/insights",
Dict{String,Any}("StatusFilter" => StatusFilter);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_organization_insights(
StatusFilter,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"POST",
"/organization/insights",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StatusFilter" => StatusFilter), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_recommendations(insight_id)
list_recommendations(insight_id, params::Dict{String,<:Any})
Returns a list of a specified insight's recommendations. Each recommendation includes a
list of related metrics and a list of related events.
# Arguments
- `insight_id`: The ID of the requested insight.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccountId"`: The ID of the Amazon Web Services account.
- `"Locale"`: A locale that specifies the language to use for recommendations.
- `"NextToken"`: The pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function list_recommendations(InsightId; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"POST",
"/recommendations",
Dict{String,Any}("InsightId" => InsightId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_recommendations(
InsightId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"POST",
"/recommendations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InsightId" => InsightId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_feedback()
put_feedback(params::Dict{String,<:Any})
Collects customer feedback about the specified insight.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InsightFeedback"`: The feedback from customers is about the recommendations in this
insight.
"""
function put_feedback(; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"PUT", "/feedback"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function put_feedback(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"PUT", "/feedback", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
remove_notification_channel(id)
remove_notification_channel(id, params::Dict{String,<:Any})
Removes a notification channel from DevOps Guru. A notification channel is used to notify
you when DevOps Guru generates an insight that contains information about how to improve
your operations.
# Arguments
- `id`: The ID of the notification channel to be removed.
"""
function remove_notification_channel(Id; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"DELETE", "/channels/$(Id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function remove_notification_channel(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"DELETE",
"/channels/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_insights(start_time_range, type)
search_insights(start_time_range, type, params::Dict{String,<:Any})
Returns a list of insights in your Amazon Web Services account. You can specify which
insights are returned by their start time, one or more statuses (ONGOING or CLOSED), one or
more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE). Use the
Filters parameter to specify status and severity search parameters. Use the Type parameter
to specify REACTIVE or PROACTIVE in your search.
# Arguments
- `start_time_range`: The start of the time range passed in. Returned insights occurred
after this time.
- `type`: The type of insights you are searching for (REACTIVE or PROACTIVE).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A SearchInsightsFilters object that is used to set the severity and status
filters on your insight search.
- `"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 pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function search_insights(
StartTimeRange, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/insights/search",
Dict{String,Any}("StartTimeRange" => StartTimeRange, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_insights(
StartTimeRange,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"POST",
"/insights/search",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("StartTimeRange" => StartTimeRange, "Type" => Type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_organization_insights(account_ids, start_time_range, type)
search_organization_insights(account_ids, start_time_range, type, params::Dict{String,<:Any})
Returns a list of insights in your organization. You can specify which insights are
returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or
more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE). Use the
Filters parameter to specify status and severity search parameters. Use the Type parameter
to specify REACTIVE or PROACTIVE in your search.
# Arguments
- `account_ids`: The ID of the Amazon Web Services account.
- `start_time_range`:
- `type`: The type of insights you are searching for (REACTIVE or PROACTIVE).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A SearchOrganizationInsightsFilters object that is used to set the severity
and status filters on your insight search.
- `"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 pagination token to use to retrieve the next page of results for this
operation. If this value is null, it retrieves the first page.
"""
function search_organization_insights(
AccountIds, StartTimeRange, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"POST",
"/organization/insights/search",
Dict{String,Any}(
"AccountIds" => AccountIds, "StartTimeRange" => StartTimeRange, "Type" => Type
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_organization_insights(
AccountIds,
StartTimeRange,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"POST",
"/organization/insights/search",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccountIds" => AccountIds,
"StartTimeRange" => StartTimeRange,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_cost_estimation(resource_collection)
start_cost_estimation(resource_collection, params::Dict{String,<:Any})
Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services
resources.
# Arguments
- `resource_collection`: The collection of Amazon Web Services resources used to create a
monthly DevOps Guru cost estimate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: The idempotency token used to identify each cost estimate request.
"""
function start_cost_estimation(
ResourceCollection; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"PUT",
"/cost-estimation",
Dict{String,Any}(
"ResourceCollection" => ResourceCollection, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_cost_estimation(
ResourceCollection,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"PUT",
"/cost-estimation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceCollection" => ResourceCollection,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_event_sources_config()
update_event_sources_config(params::Dict{String,<:Any})
Enables or disables integration with a service that can be integrated with DevOps Guru. The
one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can
produce proactive recommendations which can be stored and viewed in DevOps Guru.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventSources"`: Configuration information about the integration of DevOps Guru as the
Consumer via EventBridge with another AWS Service.
"""
function update_event_sources_config(; aws_config::AbstractAWSConfig=global_aws_config())
return devops_guru(
"PUT", "/event-sources"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_event_sources_config(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"PUT",
"/event-sources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_collection(action, resource_collection)
update_resource_collection(action, resource_collection, params::Dict{String,<:Any})
Updates the collection of resources that DevOps Guru analyzes. The two types of Amazon Web
Services resource collections supported are Amazon Web Services CloudFormation stacks and
Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru
can be configured to analyze the Amazon Web Services resources that are defined in the
stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web
Services CloudFormation stacks. This method also creates the IAM role required for you to
use DevOps Guru.
# Arguments
- `action`: Specifies if the resource collection in the request is added or deleted to the
resource collection.
- `resource_collection`:
"""
function update_resource_collection(
Action, ResourceCollection; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"PUT",
"/resource-collections",
Dict{String,Any}("Action" => Action, "ResourceCollection" => ResourceCollection);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_collection(
Action,
ResourceCollection,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"PUT",
"/resource-collections",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Action" => Action, "ResourceCollection" => ResourceCollection
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_integration(service_integration)
update_service_integration(service_integration, params::Dict{String,<:Any})
Enables or disables integration with a service that can be integrated with DevOps Guru.
The one service that can be integrated with DevOps Guru is Amazon Web Services Systems
Manager, which can be used to create an OpsItem for each generated insight.
# Arguments
- `service_integration`: An IntegratedServiceConfig object used to specify the integrated
service you want to update, and whether you want to update it to enabled or disabled.
"""
function update_service_integration(
ServiceIntegration; aws_config::AbstractAWSConfig=global_aws_config()
)
return devops_guru(
"PUT",
"/service-integrations",
Dict{String,Any}("ServiceIntegration" => ServiceIntegration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_integration(
ServiceIntegration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return devops_guru(
"PUT",
"/service-integrations",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ServiceIntegration" => ServiceIntegration), 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 | 104708 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: direct_connect
using AWS.Compat
using AWS.UUIDs
"""
accept_direct_connect_gateway_association_proposal(associated_gateway_owner_account, direct_connect_gateway_id, proposal_id)
accept_direct_connect_gateway_association_proposal(associated_gateway_owner_account, direct_connect_gateway_id, proposal_id, params::Dict{String,<:Any})
Accepts a proposal request to attach a virtual private gateway or transit gateway to a
Direct Connect gateway.
# Arguments
- `associated_gateway_owner_account`: The ID of the Amazon Web Services account that owns
the virtual private gateway or transit gateway.
- `direct_connect_gateway_id`: The ID of the Direct Connect gateway.
- `proposal_id`: The ID of the request proposal.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"overrideAllowedPrefixesToDirectConnectGateway"`: Overrides the Amazon VPC prefixes
advertised to the Direct Connect gateway. For information about how to set the prefixes,
see Allowed Prefixes in the Direct Connect User Guide.
"""
function accept_direct_connect_gateway_association_proposal(
associatedGatewayOwnerAccount,
directConnectGatewayId,
proposalId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AcceptDirectConnectGatewayAssociationProposal",
Dict{String,Any}(
"associatedGatewayOwnerAccount" => associatedGatewayOwnerAccount,
"directConnectGatewayId" => directConnectGatewayId,
"proposalId" => proposalId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_direct_connect_gateway_association_proposal(
associatedGatewayOwnerAccount,
directConnectGatewayId,
proposalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AcceptDirectConnectGatewayAssociationProposal",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"associatedGatewayOwnerAccount" => associatedGatewayOwnerAccount,
"directConnectGatewayId" => directConnectGatewayId,
"proposalId" => proposalId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
allocate_connection_on_interconnect(bandwidth, connection_name, interconnect_id, owner_account, vlan)
allocate_connection_on_interconnect(bandwidth, connection_name, interconnect_id, owner_account, vlan, params::Dict{String,<:Any})
Deprecated. Use AllocateHostedConnection instead. Creates a hosted connection on an
interconnect. Allocates a VLAN number and a specified amount of bandwidth for use by a
hosted connection on the specified interconnect. Intended for use by Direct Connect
Partners only.
# Arguments
- `bandwidth`: The bandwidth of the connection. The possible values are 50Mbps, 100Mbps,
200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those
Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps,
2Gbps, 5Gbps or 10Gbps hosted connection.
- `connection_name`: The name of the provisioned connection.
- `interconnect_id`: The ID of the interconnect on which the connection will be provisioned.
- `owner_account`: The ID of the Amazon Web Services account of the customer for whom the
connection will be provisioned.
- `vlan`: The dedicated VLAN provisioned to the connection.
"""
function allocate_connection_on_interconnect(
bandwidth,
connectionName,
interconnectId,
ownerAccount,
vlan;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AllocateConnectionOnInterconnect",
Dict{String,Any}(
"bandwidth" => bandwidth,
"connectionName" => connectionName,
"interconnectId" => interconnectId,
"ownerAccount" => ownerAccount,
"vlan" => vlan,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function allocate_connection_on_interconnect(
bandwidth,
connectionName,
interconnectId,
ownerAccount,
vlan,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AllocateConnectionOnInterconnect",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"bandwidth" => bandwidth,
"connectionName" => connectionName,
"interconnectId" => interconnectId,
"ownerAccount" => ownerAccount,
"vlan" => vlan,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
allocate_hosted_connection(bandwidth, connection_id, connection_name, owner_account, vlan)
allocate_hosted_connection(bandwidth, connection_id, connection_name, owner_account, vlan, params::Dict{String,<:Any})
Creates a hosted connection on the specified interconnect or a link aggregation group (LAG)
of interconnects. Allocates a VLAN number and a specified amount of capacity (bandwidth)
for use by a hosted connection on the specified interconnect or LAG of interconnects.
Amazon Web Services polices the hosted connection for the specified capacity and the Direct
Connect Partner must also police the hosted connection for the specified capacity.
Intended for use by Direct Connect Partners only.
# Arguments
- `bandwidth`: The bandwidth of the connection. The possible values are 50Mbps, 100Mbps,
200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those
Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps,
2Gbps, 5Gbps or 10Gbps hosted connection.
- `connection_id`: The ID of the interconnect or LAG.
- `connection_name`: The name of the hosted connection.
- `owner_account`: The ID of the Amazon Web Services account ID of the customer for the
connection.
- `vlan`: The dedicated VLAN provisioned to the hosted connection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tags associated with the connection.
"""
function allocate_hosted_connection(
bandwidth,
connectionId,
connectionName,
ownerAccount,
vlan;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AllocateHostedConnection",
Dict{String,Any}(
"bandwidth" => bandwidth,
"connectionId" => connectionId,
"connectionName" => connectionName,
"ownerAccount" => ownerAccount,
"vlan" => vlan,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function allocate_hosted_connection(
bandwidth,
connectionId,
connectionName,
ownerAccount,
vlan,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AllocateHostedConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"bandwidth" => bandwidth,
"connectionId" => connectionId,
"connectionName" => connectionName,
"ownerAccount" => ownerAccount,
"vlan" => vlan,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
allocate_private_virtual_interface(connection_id, new_private_virtual_interface_allocation, owner_account)
allocate_private_virtual_interface(connection_id, new_private_virtual_interface_allocation, owner_account, params::Dict{String,<:Any})
Provisions a private virtual interface to be owned by the specified Amazon Web Services
account. Virtual interfaces created using this action must be confirmed by the owner using
ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming
state and is not available to handle traffic.
# Arguments
- `connection_id`: The ID of the connection on which the private virtual interface is
provisioned.
- `new_private_virtual_interface_allocation`: Information about the private virtual
interface.
- `owner_account`: The ID of the Amazon Web Services account that owns the virtual private
interface.
"""
function allocate_private_virtual_interface(
connectionId,
newPrivateVirtualInterfaceAllocation,
ownerAccount;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AllocatePrivateVirtualInterface",
Dict{String,Any}(
"connectionId" => connectionId,
"newPrivateVirtualInterfaceAllocation" => newPrivateVirtualInterfaceAllocation,
"ownerAccount" => ownerAccount,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function allocate_private_virtual_interface(
connectionId,
newPrivateVirtualInterfaceAllocation,
ownerAccount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AllocatePrivateVirtualInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectionId" => connectionId,
"newPrivateVirtualInterfaceAllocation" =>
newPrivateVirtualInterfaceAllocation,
"ownerAccount" => ownerAccount,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
allocate_public_virtual_interface(connection_id, new_public_virtual_interface_allocation, owner_account)
allocate_public_virtual_interface(connection_id, new_public_virtual_interface_allocation, owner_account, params::Dict{String,<:Any})
Provisions a public virtual interface to be owned by the specified Amazon Web Services
account. The owner of a connection calls this function to provision a public virtual
interface to be owned by the specified Amazon Web Services account. Virtual interfaces
created using this function must be confirmed by the owner using
ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is
in the confirming state and is not available to handle traffic. When creating an IPv6
public virtual interface, omit the Amazon address and customer address. IPv6 addresses are
automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom
IPv6 addresses.
# Arguments
- `connection_id`: The ID of the connection on which the public virtual interface is
provisioned.
- `new_public_virtual_interface_allocation`: Information about the public virtual interface.
- `owner_account`: The ID of the Amazon Web Services account that owns the public virtual
interface.
"""
function allocate_public_virtual_interface(
connectionId,
newPublicVirtualInterfaceAllocation,
ownerAccount;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AllocatePublicVirtualInterface",
Dict{String,Any}(
"connectionId" => connectionId,
"newPublicVirtualInterfaceAllocation" => newPublicVirtualInterfaceAllocation,
"ownerAccount" => ownerAccount,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function allocate_public_virtual_interface(
connectionId,
newPublicVirtualInterfaceAllocation,
ownerAccount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AllocatePublicVirtualInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectionId" => connectionId,
"newPublicVirtualInterfaceAllocation" =>
newPublicVirtualInterfaceAllocation,
"ownerAccount" => ownerAccount,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
allocate_transit_virtual_interface(connection_id, new_transit_virtual_interface_allocation, owner_account)
allocate_transit_virtual_interface(connection_id, new_transit_virtual_interface_allocation, owner_account, params::Dict{String,<:Any})
Provisions a transit virtual interface to be owned by the specified Amazon Web Services
account. Use this type of interface to connect a transit gateway to your Direct Connect
gateway. The owner of a connection provisions a transit virtual interface to be owned by
the specified Amazon Web Services account. After you create a transit virtual interface, it
must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has
been completed, the transit virtual interface is in the requested state and is not
available to handle traffic.
# Arguments
- `connection_id`: The ID of the connection on which the transit virtual interface is
provisioned.
- `new_transit_virtual_interface_allocation`: Information about the transit virtual
interface.
- `owner_account`: The ID of the Amazon Web Services account that owns the transit virtual
interface.
"""
function allocate_transit_virtual_interface(
connectionId,
newTransitVirtualInterfaceAllocation,
ownerAccount;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AllocateTransitVirtualInterface",
Dict{String,Any}(
"connectionId" => connectionId,
"newTransitVirtualInterfaceAllocation" => newTransitVirtualInterfaceAllocation,
"ownerAccount" => ownerAccount,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function allocate_transit_virtual_interface(
connectionId,
newTransitVirtualInterfaceAllocation,
ownerAccount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AllocateTransitVirtualInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectionId" => connectionId,
"newTransitVirtualInterfaceAllocation" =>
newTransitVirtualInterfaceAllocation,
"ownerAccount" => ownerAccount,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_connection_with_lag(connection_id, lag_id)
associate_connection_with_lag(connection_id, lag_id, params::Dict{String,<:Any})
Associates an existing connection with a link aggregation group (LAG). The connection is
interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services
is interrupted). The connection must be hosted on the same Direct Connect endpoint as the
LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a
connection that's currently associated with a different LAG; however, if removing the
connection would cause the original LAG to fall below its setting for minimum number of
operational connections, the request fails. Any virtual interfaces that are directly
associated with the connection are automatically re-associated with the LAG. If the
connection was originally associated with a different LAG, the virtual interfaces remain
associated with the original LAG. For interconnects, any hosted connections are
automatically re-associated with the LAG. If the interconnect was originally associated
with a different LAG, the hosted connections remain associated with the original LAG.
# Arguments
- `connection_id`: The ID of the connection.
- `lag_id`: The ID of the LAG with which to associate the connection.
"""
function associate_connection_with_lag(
connectionId, lagId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"AssociateConnectionWithLag",
Dict{String,Any}("connectionId" => connectionId, "lagId" => lagId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_connection_with_lag(
connectionId,
lagId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AssociateConnectionWithLag",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("connectionId" => connectionId, "lagId" => lagId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_hosted_connection(connection_id, parent_connection_id)
associate_hosted_connection(connection_id, parent_connection_id, params::Dict{String,<:Any})
Associates a hosted connection and its virtual interfaces with a link aggregation group
(LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection
with a conflicting VLAN number or IP address, the operation fails. This action temporarily
interrupts the hosted connection's connectivity to Amazon Web Services as it is being
migrated. Intended for use by Direct Connect Partners only.
# Arguments
- `connection_id`: The ID of the hosted connection.
- `parent_connection_id`: The ID of the interconnect or the LAG.
"""
function associate_hosted_connection(
connectionId, parentConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"AssociateHostedConnection",
Dict{String,Any}(
"connectionId" => connectionId, "parentConnectionId" => parentConnectionId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_hosted_connection(
connectionId,
parentConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AssociateHostedConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectionId" => connectionId,
"parentConnectionId" => parentConnectionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_mac_sec_key(connection_id)
associate_mac_sec_key(connection_id, params::Dict{String,<:Any})
Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key
(CAK) pair with an Direct Connect dedicated connection. You must supply either the
secretARN, or the CKN/CAK (ckn and cak) pair in the request. For information about MAC
Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in
the Direct Connect User Guide.
# Arguments
- `connection_id`: The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG
(dxlag-xxxx). You can use DescribeConnections or DescribeLags to retrieve connection ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cak"`: The MAC Security (MACsec) CAK to associate with the dedicated connection. You
can create the CKN/CAK pair using an industry standard tool. The valid values are 64
hexadecimal characters (0-9, A-E). If you use this request parameter, you must use the ckn
request parameter and not use the secretARN request parameter.
- `"ckn"`: The MAC Security (MACsec) CKN to associate with the dedicated connection. You
can create the CKN/CAK pair using an industry standard tool. The valid values are 64
hexadecimal characters (0-9, A-E). If you use this request parameter, you must use the cak
request parameter and not use the secretARN request parameter.
- `"secretARN"`: The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to
associate with the dedicated connection. You can use DescribeConnections or DescribeLags to
retrieve the MAC Security (MACsec) secret key. If you use this request parameter, you do
not use the ckn and cak request parameters.
"""
function associate_mac_sec_key(
connectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"AssociateMacSecKey",
Dict{String,Any}("connectionId" => connectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_mac_sec_key(
connectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AssociateMacSecKey",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("connectionId" => connectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_virtual_interface(connection_id, virtual_interface_id)
associate_virtual_interface(connection_id, virtual_interface_id, params::Dict{String,<:Any})
Associates a virtual interface with a specified link aggregation group (LAG) or connection.
Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is
being migrated. If the target connection or LAG has an associated virtual interface with a
conflicting VLAN number or a conflicting IP address, the operation fails. Virtual
interfaces associated with a hosted connection cannot be associated with a LAG; hosted
connections must be migrated along with their virtual interfaces using
AssociateHostedConnection. To reassociate a virtual interface to a new connection or LAG,
the requester must own either the virtual interface itself or the connection to which the
virtual interface is currently associated. Additionally, the requester must own the
connection or LAG for the association.
# Arguments
- `connection_id`: The ID of the LAG or connection.
- `virtual_interface_id`: The ID of the virtual interface.
"""
function associate_virtual_interface(
connectionId, virtualInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"AssociateVirtualInterface",
Dict{String,Any}(
"connectionId" => connectionId, "virtualInterfaceId" => virtualInterfaceId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_virtual_interface(
connectionId,
virtualInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"AssociateVirtualInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectionId" => connectionId,
"virtualInterfaceId" => virtualInterfaceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_connection(connection_id)
confirm_connection(connection_id, params::Dict{String,<:Any})
Confirms the creation of the specified hosted connection on an interconnect. Upon creation,
the hosted connection is initially in the Ordering state, and remains in this state until
the owner confirms creation of the hosted connection.
# Arguments
- `connection_id`: The ID of the hosted connection.
"""
function confirm_connection(connectionId; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"ConfirmConnection",
Dict{String,Any}("connectionId" => connectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function confirm_connection(
connectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"ConfirmConnection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("connectionId" => connectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_customer_agreement()
confirm_customer_agreement(params::Dict{String,<:Any})
The confirmation of the terms of agreement when creating the connection/link aggregation
group (LAG).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"agreementName"`: The name of the customer agreement.
"""
function confirm_customer_agreement(; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"ConfirmCustomerAgreement"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function confirm_customer_agreement(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"ConfirmCustomerAgreement",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_private_virtual_interface(virtual_interface_id)
confirm_private_virtual_interface(virtual_interface_id, params::Dict{String,<:Any})
Accepts ownership of a private virtual interface created by another Amazon Web Services
account. After the virtual interface owner makes this call, the virtual interface is
created and attached to the specified virtual private gateway or Direct Connect gateway,
and is made available to handle traffic.
# Arguments
- `virtual_interface_id`: The ID of the virtual interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"directConnectGatewayId"`: The ID of the Direct Connect gateway.
- `"virtualGatewayId"`: The ID of the virtual private gateway.
"""
function confirm_private_virtual_interface(
virtualInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"ConfirmPrivateVirtualInterface",
Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function confirm_private_virtual_interface(
virtualInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"ConfirmPrivateVirtualInterface",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_public_virtual_interface(virtual_interface_id)
confirm_public_virtual_interface(virtual_interface_id, params::Dict{String,<:Any})
Accepts ownership of a public virtual interface created by another Amazon Web Services
account. After the virtual interface owner makes this call, the specified virtual interface
is created and made available to handle traffic.
# Arguments
- `virtual_interface_id`: The ID of the virtual interface.
"""
function confirm_public_virtual_interface(
virtualInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"ConfirmPublicVirtualInterface",
Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function confirm_public_virtual_interface(
virtualInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"ConfirmPublicVirtualInterface",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_transit_virtual_interface(direct_connect_gateway_id, virtual_interface_id)
confirm_transit_virtual_interface(direct_connect_gateway_id, virtual_interface_id, params::Dict{String,<:Any})
Accepts ownership of a transit virtual interface created by another Amazon Web Services
account. After the owner of the transit virtual interface makes this call, the specified
transit virtual interface is created and made available to handle traffic.
# Arguments
- `direct_connect_gateway_id`: The ID of the Direct Connect gateway.
- `virtual_interface_id`: The ID of the virtual interface.
"""
function confirm_transit_virtual_interface(
directConnectGatewayId,
virtualInterfaceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"ConfirmTransitVirtualInterface",
Dict{String,Any}(
"directConnectGatewayId" => directConnectGatewayId,
"virtualInterfaceId" => virtualInterfaceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function confirm_transit_virtual_interface(
directConnectGatewayId,
virtualInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"ConfirmTransitVirtualInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"directConnectGatewayId" => directConnectGatewayId,
"virtualInterfaceId" => virtualInterfaceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_bgppeer()
create_bgppeer(params::Dict{String,<:Any})
Creates a BGP peer on the specified virtual interface. You must create a BGP peer for the
corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources
that also use that address family. If logical redundancy is not supported by the
connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an
existing BGP peer on the virtual interface. When creating a IPv6 BGP peer, omit the Amazon
address and customer address. IPv6 addresses are automatically assigned from the Amazon
pool of IPv6 addresses; you cannot specify custom IPv6 addresses. If you let Amazon Web
Services auto-assign IPv4 addresses, a /30 CIDR will be allocated from 169.254.0.0/16.
Amazon Web Services does not recommend this option if you intend to use the customer router
peer IP address as the source and destination for traffic. Instead you should use RFC 1918
or other addressing, and specify the address yourself. For more information about RFC 1918
see Address Allocation for Private Internets. For a public virtual interface, the
Autonomous System Number (ASN) must be private or already on the allow list for the virtual
interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"newBGPPeer"`: Information about the BGP peer.
- `"virtualInterfaceId"`: The ID of the virtual interface.
"""
function create_bgppeer(; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"CreateBGPPeer"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_bgppeer(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"CreateBGPPeer", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_connection(bandwidth, connection_name, location)
create_connection(bandwidth, connection_name, location, params::Dict{String,<:Any})
Creates a connection between a customer network and a specific Direct Connect location. A
connection links your internal network to an Direct Connect location over a standard
Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to
an Direct Connect router. To find the locations for your Region, use DescribeLocations. You
can automatically add the new connection to a link aggregation group (LAG) by specifying a
LAG ID in the request. This ensures that the new connection is allocated on the same Direct
Connect endpoint that hosts the specified LAG. If there are no available ports on the
endpoint, the request fails and no connection is created.
# Arguments
- `bandwidth`: The bandwidth of the connection.
- `connection_name`: The name of the connection.
- `location`: The location of the connection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"lagId"`: The ID of the LAG.
- `"providerName"`: The name of the service provider associated with the requested
connection.
- `"requestMACSec"`: Indicates whether you want the connection to support MAC Security
(MACsec). MAC Security (MACsec) is only available on dedicated connections. For information
about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect
User Guide.
- `"tags"`: The tags to associate with the lag.
"""
function create_connection(
bandwidth, connectionName, location; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"CreateConnection",
Dict{String,Any}(
"bandwidth" => bandwidth,
"connectionName" => connectionName,
"location" => location,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connection(
bandwidth,
connectionName,
location,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreateConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"bandwidth" => bandwidth,
"connectionName" => connectionName,
"location" => location,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_direct_connect_gateway(direct_connect_gateway_name)
create_direct_connect_gateway(direct_connect_gateway_name, params::Dict{String,<:Any})
Creates a Direct Connect gateway, which is an intermediate object that enables you to
connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway
is global and visible in any Amazon Web Services Region after it is created. The virtual
interfaces and virtual private gateways that are connected through a Direct Connect gateway
can be in different Amazon Web Services Regions. This enables you to connect to a VPC in
any Region, regardless of the Region in which the virtual interfaces are located, and pass
traffic between them.
# Arguments
- `direct_connect_gateway_name`: The name of the Direct Connect gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"amazonSideAsn"`: The autonomous system number (ASN) for Border Gateway Protocol (BGP)
to be configured on the Amazon side of the connection. The ASN must be in the private range
of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.
"""
function create_direct_connect_gateway(
directConnectGatewayName; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"CreateDirectConnectGateway",
Dict{String,Any}("directConnectGatewayName" => directConnectGatewayName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_direct_connect_gateway(
directConnectGatewayName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreateDirectConnectGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("directConnectGatewayName" => directConnectGatewayName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_direct_connect_gateway_association(direct_connect_gateway_id)
create_direct_connect_gateway_association(direct_connect_gateway_id, params::Dict{String,<:Any})
Creates an association between a Direct Connect gateway and a virtual private gateway. The
virtual private gateway must be attached to a VPC and must not be associated with another
Direct Connect gateway.
# Arguments
- `direct_connect_gateway_id`: The ID of the Direct Connect gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addAllowedPrefixesToDirectConnectGateway"`: The Amazon VPC prefixes to advertise to the
Direct Connect gateway This parameter is required when you create an association to a
transit gateway. For information about how to set the prefixes, see Allowed Prefixes in the
Direct Connect User Guide.
- `"gatewayId"`: The ID of the virtual private gateway or transit gateway.
- `"virtualGatewayId"`: The ID of the virtual private gateway.
"""
function create_direct_connect_gateway_association(
directConnectGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"CreateDirectConnectGatewayAssociation",
Dict{String,Any}("directConnectGatewayId" => directConnectGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_direct_connect_gateway_association(
directConnectGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreateDirectConnectGatewayAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("directConnectGatewayId" => directConnectGatewayId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_direct_connect_gateway_association_proposal(direct_connect_gateway_id, direct_connect_gateway_owner_account, gateway_id)
create_direct_connect_gateway_association_proposal(direct_connect_gateway_id, direct_connect_gateway_owner_account, gateway_id, params::Dict{String,<:Any})
Creates a proposal to associate the specified virtual private gateway or transit gateway
with the specified Direct Connect gateway. You can associate a Direct Connect gateway and
virtual private gateway or transit gateway that is owned by any Amazon Web Services
account.
# Arguments
- `direct_connect_gateway_id`: The ID of the Direct Connect gateway.
- `direct_connect_gateway_owner_account`: The ID of the Amazon Web Services account that
owns the Direct Connect gateway.
- `gateway_id`: The ID of the virtual private gateway or transit gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addAllowedPrefixesToDirectConnectGateway"`: The Amazon VPC prefixes to advertise to the
Direct Connect gateway.
- `"removeAllowedPrefixesToDirectConnectGateway"`: The Amazon VPC prefixes to no longer
advertise to the Direct Connect gateway.
"""
function create_direct_connect_gateway_association_proposal(
directConnectGatewayId,
directConnectGatewayOwnerAccount,
gatewayId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreateDirectConnectGatewayAssociationProposal",
Dict{String,Any}(
"directConnectGatewayId" => directConnectGatewayId,
"directConnectGatewayOwnerAccount" => directConnectGatewayOwnerAccount,
"gatewayId" => gatewayId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_direct_connect_gateway_association_proposal(
directConnectGatewayId,
directConnectGatewayOwnerAccount,
gatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreateDirectConnectGatewayAssociationProposal",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"directConnectGatewayId" => directConnectGatewayId,
"directConnectGatewayOwnerAccount" => directConnectGatewayOwnerAccount,
"gatewayId" => gatewayId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_interconnect(bandwidth, interconnect_name, location)
create_interconnect(bandwidth, interconnect_name, location, params::Dict{String,<:Any})
Creates an interconnect between an Direct Connect Partner's network and a specific Direct
Connect location. An interconnect is a connection that is capable of hosting other
connections. The Direct Connect Partner can use an interconnect to provide Direct Connect
hosted connections to customers through their own network services. Like a standard
connection, an interconnect links the partner's network to an Direct Connect location over
a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the
other to an Direct Connect router. You can automatically add the new interconnect to a link
aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new
interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG.
If there are no available ports on the endpoint, the request fails and no interconnect is
created. For each end customer, the Direct Connect Partner provisions a connection on their
interconnect by calling AllocateHostedConnection. The end customer can then connect to
Amazon Web Services resources by creating a virtual interface on their connection, using
the VLAN assigned to them by the Direct Connect Partner. Intended for use by Direct
Connect Partners only.
# Arguments
- `bandwidth`: The port bandwidth, in Gbps. The possible values are 1 and 10.
- `interconnect_name`: The name of the interconnect.
- `location`: The location of the interconnect.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"lagId"`: The ID of the LAG.
- `"providerName"`: The name of the service provider associated with the interconnect.
- `"tags"`: The tags to associate with the interconnect.
"""
function create_interconnect(
bandwidth, interconnectName, location; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"CreateInterconnect",
Dict{String,Any}(
"bandwidth" => bandwidth,
"interconnectName" => interconnectName,
"location" => location,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_interconnect(
bandwidth,
interconnectName,
location,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreateInterconnect",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"bandwidth" => bandwidth,
"interconnectName" => interconnectName,
"location" => location,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_lag(connections_bandwidth, lag_name, location, number_of_connections)
create_lag(connections_bandwidth, lag_name, location, number_of_connections, params::Dict{String,<:Any})
Creates a link aggregation group (LAG) with the specified number of bundled physical
dedicated connections between the customer network and a specific Direct Connect location.
A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to
aggregate multiple interfaces, enabling you to treat them as a single interface. All
connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must
terminate at the same Direct Connect endpoint. You can have up to 10 dedicated connections
per LAG. Regardless of this limit, if you request more connections for the LAG than Direct
Connect can allocate on a single endpoint, no LAG is created. You can specify an existing
physical dedicated connection or interconnect to include in the LAG (which counts towards
the total number of connections). Doing so interrupts the current physical dedicated
connection, and re-establishes them as a member of the LAG. The LAG will be created on the
same Direct Connect endpoint to which the dedicated connection terminates. Any virtual
interfaces associated with the dedicated connection are automatically disassociated and
re-associated with the LAG. The connection ID does not change. If the Amazon Web Services
account used to create a LAG is a registered Direct Connect Partner, the LAG is
automatically enabled to host sub-connections. For a LAG owned by a partner, any associated
virtual interfaces cannot be directly configured.
# Arguments
- `connections_bandwidth`: The bandwidth of the individual physical dedicated connections
bundled by the LAG. The possible values are 1Gbps and 10Gbps.
- `lag_name`: The name of the LAG.
- `location`: The location for the LAG.
- `number_of_connections`: The number of physical dedicated connections initially
provisioned and bundled by the LAG. You can have a maximum of four connections when the
port speed is 1G or 10G, or two when the port speed is 100G.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"childConnectionTags"`: The tags to associate with the automtically created LAGs.
- `"connectionId"`: The ID of an existing dedicated connection to migrate to the LAG.
- `"providerName"`: The name of the service provider associated with the LAG.
- `"requestMACSec"`: Indicates whether the connection will support MAC Security (MACsec).
All connections in the LAG must be capable of supporting MAC Security (MACsec). For
information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the
Direct Connect User Guide.
- `"tags"`: The tags to associate with the LAG.
"""
function create_lag(
connectionsBandwidth,
lagName,
location,
numberOfConnections;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreateLag",
Dict{String,Any}(
"connectionsBandwidth" => connectionsBandwidth,
"lagName" => lagName,
"location" => location,
"numberOfConnections" => numberOfConnections,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_lag(
connectionsBandwidth,
lagName,
location,
numberOfConnections,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreateLag",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectionsBandwidth" => connectionsBandwidth,
"lagName" => lagName,
"location" => location,
"numberOfConnections" => numberOfConnections,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_private_virtual_interface(connection_id, new_private_virtual_interface)
create_private_virtual_interface(connection_id, new_private_virtual_interface, params::Dict{String,<:Any})
Creates a private virtual interface. A virtual interface is the VLAN that transports Direct
Connect traffic. A private virtual interface can be connected to either a Direct Connect
gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a
Direct Connect gateway enables the possibility for connecting to multiple VPCs, including
VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to
a VGW only provides access to a single VPC within the same Region. Setting the MTU of a
virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical
connection if it wasn't updated to support jumbo frames. Updating the connection disrupts
network connectivity for all virtual interfaces associated with the connection for up to 30
seconds. To check whether your connection supports jumbo frames, call DescribeConnections.
To check whether your virtual interface supports jumbo frames, call
DescribeVirtualInterfaces.
# Arguments
- `connection_id`: The ID of the connection.
- `new_private_virtual_interface`: Information about the private virtual interface.
"""
function create_private_virtual_interface(
connectionId,
newPrivateVirtualInterface;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreatePrivateVirtualInterface",
Dict{String,Any}(
"connectionId" => connectionId,
"newPrivateVirtualInterface" => newPrivateVirtualInterface,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_private_virtual_interface(
connectionId,
newPrivateVirtualInterface,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreatePrivateVirtualInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectionId" => connectionId,
"newPrivateVirtualInterface" => newPrivateVirtualInterface,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_public_virtual_interface(connection_id, new_public_virtual_interface)
create_public_virtual_interface(connection_id, new_public_virtual_interface, params::Dict{String,<:Any})
Creates a public virtual interface. A virtual interface is the VLAN that transports Direct
Connect traffic. A public virtual interface supports sending traffic to public services of
Amazon Web Services such as Amazon S3. When creating an IPv6 public virtual interface
(addressFamily is ipv6), leave the customer and amazon address fields blank to use
auto-assigned IPv6 space. Custom IPv6 addresses are not supported.
# Arguments
- `connection_id`: The ID of the connection.
- `new_public_virtual_interface`: Information about the public virtual interface.
"""
function create_public_virtual_interface(
connectionId,
newPublicVirtualInterface;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreatePublicVirtualInterface",
Dict{String,Any}(
"connectionId" => connectionId,
"newPublicVirtualInterface" => newPublicVirtualInterface,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_public_virtual_interface(
connectionId,
newPublicVirtualInterface,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreatePublicVirtualInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectionId" => connectionId,
"newPublicVirtualInterface" => newPublicVirtualInterface,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_virtual_interface(connection_id, new_transit_virtual_interface)
create_transit_virtual_interface(connection_id, new_transit_virtual_interface, params::Dict{String,<:Any})
Creates a transit virtual interface. A transit virtual interface should be used to access
one or more transit gateways associated with Direct Connect gateways. A transit virtual
interface enables the connection of multiple VPCs attached to a transit gateway to a Direct
Connect gateway. If you associate your transit gateway with one or more Direct Connect
gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct
Connect gateway must be different. For example, if you use the default ASN 64512 for both
your the transit gateway and Direct Connect gateway, the association request fails. A
jumbo MTU value must be either 1500 or 8500. No other values will be accepted. Setting the
MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying
physical connection if it wasn't updated to support jumbo frames. Updating the connection
disrupts network connectivity for all virtual interfaces associated with the connection for
up to 30 seconds. To check whether your connection supports jumbo frames, call
DescribeConnections. To check whether your virtual interface supports jumbo frames, call
DescribeVirtualInterfaces.
# Arguments
- `connection_id`: The ID of the connection.
- `new_transit_virtual_interface`: Information about the transit virtual interface.
"""
function create_transit_virtual_interface(
connectionId,
newTransitVirtualInterface;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreateTransitVirtualInterface",
Dict{String,Any}(
"connectionId" => connectionId,
"newTransitVirtualInterface" => newTransitVirtualInterface,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_virtual_interface(
connectionId,
newTransitVirtualInterface,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"CreateTransitVirtualInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectionId" => connectionId,
"newTransitVirtualInterface" => newTransitVirtualInterface,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_bgppeer()
delete_bgppeer(params::Dict{String,<:Any})
Deletes the specified BGP peer on the specified virtual interface with the specified
customer address and ASN. You cannot delete the last BGP peer from a virtual interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"asn"`: The autonomous system (AS) number for Border Gateway Protocol (BGP)
configuration.
- `"bgpPeerId"`: The ID of the BGP peer.
- `"customerAddress"`: The IP address assigned to the customer interface.
- `"virtualInterfaceId"`: The ID of the virtual interface.
"""
function delete_bgppeer(; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DeleteBGPPeer"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_bgppeer(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DeleteBGPPeer", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_connection(connection_id)
delete_connection(connection_id, params::Dict{String,<:Any})
Deletes the specified connection. Deleting a connection only stops the Direct Connect port
hour and data transfer charges. If you are partnering with any third parties to connect
with the Direct Connect location, you must cancel your service with them separately.
# Arguments
- `connection_id`: The ID of the connection.
"""
function delete_connection(connectionId; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DeleteConnection",
Dict{String,Any}("connectionId" => connectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connection(
connectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DeleteConnection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("connectionId" => connectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_direct_connect_gateway(direct_connect_gateway_id)
delete_direct_connect_gateway(direct_connect_gateway_id, params::Dict{String,<:Any})
Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces
that are attached to the Direct Connect gateway and disassociate all virtual private
gateways associated with the Direct Connect gateway.
# Arguments
- `direct_connect_gateway_id`: The ID of the Direct Connect gateway.
"""
function delete_direct_connect_gateway(
directConnectGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DeleteDirectConnectGateway",
Dict{String,Any}("directConnectGatewayId" => directConnectGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_direct_connect_gateway(
directConnectGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DeleteDirectConnectGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("directConnectGatewayId" => directConnectGatewayId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_direct_connect_gateway_association()
delete_direct_connect_gateway_association(params::Dict{String,<:Any})
Deletes the association between the specified Direct Connect gateway and virtual private
gateway. We recommend that you specify the associationID to delete the association.
Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can
specify the virtualGatewayId and directConnectGatewayId to delete an association.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"associationId"`: The ID of the Direct Connect gateway association.
- `"directConnectGatewayId"`: The ID of the Direct Connect gateway.
- `"virtualGatewayId"`: The ID of the virtual private gateway.
"""
function delete_direct_connect_gateway_association(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DeleteDirectConnectGatewayAssociation";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_direct_connect_gateway_association(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DeleteDirectConnectGatewayAssociation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_direct_connect_gateway_association_proposal(proposal_id)
delete_direct_connect_gateway_association_proposal(proposal_id, params::Dict{String,<:Any})
Deletes the association proposal request between the specified Direct Connect gateway and
virtual private gateway or transit gateway.
# Arguments
- `proposal_id`: The ID of the proposal.
"""
function delete_direct_connect_gateway_association_proposal(
proposalId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DeleteDirectConnectGatewayAssociationProposal",
Dict{String,Any}("proposalId" => proposalId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_direct_connect_gateway_association_proposal(
proposalId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DeleteDirectConnectGatewayAssociationProposal",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("proposalId" => proposalId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_interconnect(interconnect_id)
delete_interconnect(interconnect_id, params::Dict{String,<:Any})
Deletes the specified interconnect. Intended for use by Direct Connect Partners only.
# Arguments
- `interconnect_id`: The ID of the interconnect.
"""
function delete_interconnect(
interconnectId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DeleteInterconnect",
Dict{String,Any}("interconnectId" => interconnectId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_interconnect(
interconnectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DeleteInterconnect",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("interconnectId" => interconnectId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lag(lag_id)
delete_lag(lag_id, params::Dict{String,<:Any})
Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has
active virtual interfaces or hosted connections.
# Arguments
- `lag_id`: The ID of the LAG.
"""
function delete_lag(lagId; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DeleteLag",
Dict{String,Any}("lagId" => lagId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lag(
lagId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DeleteLag",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("lagId" => lagId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_virtual_interface(virtual_interface_id)
delete_virtual_interface(virtual_interface_id, params::Dict{String,<:Any})
Deletes a virtual interface.
# Arguments
- `virtual_interface_id`: The ID of the virtual interface.
"""
function delete_virtual_interface(
virtualInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DeleteVirtualInterface",
Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_virtual_interface(
virtualInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DeleteVirtualInterface",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_connection_loa(connection_id)
describe_connection_loa(connection_id, params::Dict{String,<:Any})
Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for a connection. The Letter of
Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN
partner or service provider uses when establishing your cross connect to Amazon Web
Services at the colocation facility. For more information, see Requesting Cross Connects at
Direct Connect Locations in the Direct Connect User Guide.
# Arguments
- `connection_id`: The ID of the connection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"loaContentType"`: The standard media type for the LOA-CFA document. The only supported
value is application/pdf.
- `"providerName"`: The name of the APN partner or service provider who establishes
connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider
name alongside your company name as the requester of the cross connect.
"""
function describe_connection_loa(
connectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeConnectionLoa",
Dict{String,Any}("connectionId" => connectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_connection_loa(
connectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DescribeConnectionLoa",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("connectionId" => connectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_connections()
describe_connections(params::Dict{String,<:Any})
Displays the specified connection or all connections in this Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"connectionId"`: The ID of the connection.
"""
function describe_connections(; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DescribeConnections"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeConnections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_connections_on_interconnect(interconnect_id)
describe_connections_on_interconnect(interconnect_id, params::Dict{String,<:Any})
Deprecated. Use DescribeHostedConnections instead. Lists the connections that have been
provisioned on the specified interconnect. Intended for use by Direct Connect Partners
only.
# Arguments
- `interconnect_id`: The ID of the interconnect.
"""
function describe_connections_on_interconnect(
interconnectId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeConnectionsOnInterconnect",
Dict{String,Any}("interconnectId" => interconnectId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_connections_on_interconnect(
interconnectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DescribeConnectionsOnInterconnect",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("interconnectId" => interconnectId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_customer_metadata()
describe_customer_metadata(params::Dict{String,<:Any})
Get and view a list of customer agreements, along with their signed status and whether the
customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
"""
function describe_customer_metadata(; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DescribeCustomerMetadata"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_customer_metadata(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeCustomerMetadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_direct_connect_gateway_association_proposals()
describe_direct_connect_gateway_association_proposals(params::Dict{String,<:Any})
Describes one or more association proposals for connection between a virtual private
gateway or transit gateway and a Direct Connect gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"associatedGatewayId"`: The ID of the associated gateway.
- `"directConnectGatewayId"`: The ID of the Direct Connect gateway.
- `"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.
- `"proposalId"`: The ID of the proposal.
"""
function describe_direct_connect_gateway_association_proposals(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeDirectConnectGatewayAssociationProposals";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_direct_connect_gateway_association_proposals(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeDirectConnectGatewayAssociationProposals",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_direct_connect_gateway_associations()
describe_direct_connect_gateway_associations(params::Dict{String,<:Any})
Lists the associations between your Direct Connect gateways and virtual private gateways
and transit gateways. You must specify one of the following: A Direct Connect gateway The
response contains all virtual private gateways and transit gateways associated with the
Direct Connect gateway. A virtual private gateway The response contains the Direct
Connect gateway. A transit gateway The response contains the Direct Connect gateway. A
Direct Connect gateway and a virtual private gateway The response contains the association
between the Direct Connect gateway and virtual private gateway. A Direct Connect gateway
and a transit gateway The response contains the association between the Direct Connect
gateway and transit gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"associatedGatewayId"`: The ID of the associated gateway.
- `"associationId"`: The ID of the Direct Connect gateway association.
- `"directConnectGatewayId"`: The ID of the Direct Connect gateway.
- `"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 provided in the previous call to retrieve the next page.
- `"virtualGatewayId"`: The ID of the virtual private gateway or transit gateway.
"""
function describe_direct_connect_gateway_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeDirectConnectGatewayAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_direct_connect_gateway_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeDirectConnectGatewayAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_direct_connect_gateway_attachments()
describe_direct_connect_gateway_attachments(params::Dict{String,<:Any})
Lists the attachments between your Direct Connect gateways and virtual interfaces. You must
specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct
Connect gateway, the response contains all virtual interfaces attached to the Direct
Connect gateway. If you specify a virtual interface, the response contains all Direct
Connect gateways attached to the virtual interface. If you specify both, the response
contains the attachment between the Direct Connect gateway and the virtual interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"directConnectGatewayId"`: The ID of the Direct Connect gateway.
- `"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 provided in the previous call to retrieve the next page.
- `"virtualInterfaceId"`: The ID of the virtual interface.
"""
function describe_direct_connect_gateway_attachments(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeDirectConnectGatewayAttachments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_direct_connect_gateway_attachments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeDirectConnectGatewayAttachments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_direct_connect_gateways()
describe_direct_connect_gateways(params::Dict{String,<:Any})
Lists all your Direct Connect gateways or only the specified Direct Connect gateway.
Deleted Direct Connect gateways are not returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"directConnectGatewayId"`: The ID of the Direct Connect gateway.
- `"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 provided in the previous call to retrieve the next page.
"""
function describe_direct_connect_gateways(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeDirectConnectGateways";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_direct_connect_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeDirectConnectGateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_hosted_connections(connection_id)
describe_hosted_connections(connection_id, params::Dict{String,<:Any})
Lists the hosted connections that have been provisioned on the specified interconnect or
link aggregation group (LAG). Intended for use by Direct Connect Partners only.
# Arguments
- `connection_id`: The ID of the interconnect or LAG.
"""
function describe_hosted_connections(
connectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeHostedConnections",
Dict{String,Any}("connectionId" => connectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_hosted_connections(
connectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DescribeHostedConnections",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("connectionId" => connectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_interconnect_loa(interconnect_id)
describe_interconnect_loa(interconnect_id, params::Dict{String,<:Any})
Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for the specified interconnect. The
Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is
used when establishing your cross connect to Amazon Web Services at the colocation
facility. For more information, see Requesting Cross Connects at Direct Connect Locations
in the Direct Connect User Guide.
# Arguments
- `interconnect_id`: The ID of the interconnect.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"loaContentType"`: The standard media type for the LOA-CFA document. The only supported
value is application/pdf.
- `"providerName"`: The name of the service provider who establishes connectivity on your
behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your
company name as the requester of the cross connect.
"""
function describe_interconnect_loa(
interconnectId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeInterconnectLoa",
Dict{String,Any}("interconnectId" => interconnectId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_interconnect_loa(
interconnectId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DescribeInterconnectLoa",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("interconnectId" => interconnectId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_interconnects()
describe_interconnects(params::Dict{String,<:Any})
Lists the interconnects owned by the Amazon Web Services account or only the specified
interconnect.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"interconnectId"`: The ID of the interconnect.
"""
function describe_interconnects(; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DescribeInterconnects"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_interconnects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeInterconnects",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_lags()
describe_lags(params::Dict{String,<:Any})
Describes all your link aggregation groups (LAG) or the specified LAG.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"lagId"`: The ID of the LAG.
"""
function describe_lags(; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DescribeLags"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_lags(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeLags", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_loa(connection_id)
describe_loa(connection_id, params::Dict{String,<:Any})
Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG). The
Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is
used when establishing your cross connect to Amazon Web Services at the colocation
facility. For more information, see Requesting Cross Connects at Direct Connect Locations
in the Direct Connect User Guide.
# Arguments
- `connection_id`: The ID of a connection, LAG, or interconnect.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"loaContentType"`: The standard media type for the LOA-CFA document. The only supported
value is application/pdf.
- `"providerName"`: The name of the service provider who establishes connectivity on your
behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your
company name as the requester of the cross connect.
"""
function describe_loa(connectionId; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DescribeLoa",
Dict{String,Any}("connectionId" => connectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_loa(
connectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DescribeLoa",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("connectionId" => connectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_locations()
describe_locations(params::Dict{String,<:Any})
Lists the Direct Connect locations in the current Amazon Web Services Region. These are the
locations that can be selected when calling CreateConnection or CreateInterconnect.
"""
function describe_locations(; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DescribeLocations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_locations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeLocations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_router_configuration(virtual_interface_id)
describe_router_configuration(virtual_interface_id, params::Dict{String,<:Any})
Details about the router.
# Arguments
- `virtual_interface_id`: The ID of the virtual interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"routerTypeIdentifier"`: Identifies the router by a combination of vendor, platform, and
software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.
"""
function describe_router_configuration(
virtualInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeRouterConfiguration",
Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_router_configuration(
virtualInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DescribeRouterConfiguration",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tags(resource_arns)
describe_tags(resource_arns, params::Dict{String,<:Any})
Describes the tags associated with the specified Direct Connect resources.
# Arguments
- `resource_arns`: The Amazon Resource Names (ARNs) of the resources.
"""
function describe_tags(resourceArns; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DescribeTags",
Dict{String,Any}("resourceArns" => resourceArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tags(
resourceArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DescribeTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArns" => resourceArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_virtual_gateways()
describe_virtual_gateways(params::Dict{String,<:Any})
Lists the virtual private gateways owned by the Amazon Web Services account. You can create
one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
"""
function describe_virtual_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DescribeVirtualGateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_virtual_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeVirtualGateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_virtual_interfaces()
describe_virtual_interfaces(params::Dict{String,<:Any})
Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces
deleted fewer than 15 minutes before you make the request are also returned. If you specify
a connection ID, only the virtual interfaces associated with the connection are returned.
If you specify a virtual interface ID, then only a single virtual interface is returned. A
virtual interface (VLAN) transmits the traffic between the Direct Connect location and the
customer network.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"connectionId"`: The ID of the connection.
- `"virtualInterfaceId"`: The ID of the virtual interface.
"""
function describe_virtual_interfaces(; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"DescribeVirtualInterfaces"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_virtual_interfaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DescribeVirtualInterfaces",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_connection_from_lag(connection_id, lag_id)
disassociate_connection_from_lag(connection_id, lag_id, params::Dict{String,<:Any})
Disassociates a connection from a link aggregation group (LAG). The connection is
interrupted and re-established as a standalone connection (the connection is not deleted;
to delete the connection, use the DeleteConnection request). If the LAG has associated
virtual interfaces or hosted connections, they remain associated with the LAG. A
disassociated connection owned by an Direct Connect Partner is automatically converted to
an interconnect. If disassociating the connection would cause the LAG to fall below its
setting for minimum number of operational connections, the request fails, except when it's
the last member of the LAG. If all connections are disassociated, the LAG continues to
exist as an empty LAG with no physical connections.
# Arguments
- `connection_id`: The ID of the connection.
- `lag_id`: The ID of the LAG.
"""
function disassociate_connection_from_lag(
connectionId, lagId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DisassociateConnectionFromLag",
Dict{String,Any}("connectionId" => connectionId, "lagId" => lagId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_connection_from_lag(
connectionId,
lagId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DisassociateConnectionFromLag",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("connectionId" => connectionId, "lagId" => lagId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_mac_sec_key(connection_id, secret_arn)
disassociate_mac_sec_key(connection_id, secret_arn, params::Dict{String,<:Any})
Removes the association between a MAC Security (MACsec) security key and an Direct Connect
dedicated connection.
# Arguments
- `connection_id`: The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG
(dxlag-xxxx). You can use DescribeConnections or DescribeLags to retrieve connection ID.
- `secret_arn`: The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key. You
can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.
"""
function disassociate_mac_sec_key(
connectionId, secretARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"DisassociateMacSecKey",
Dict{String,Any}("connectionId" => connectionId, "secretARN" => secretARN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_mac_sec_key(
connectionId,
secretARN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"DisassociateMacSecKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("connectionId" => connectionId, "secretARN" => secretARN),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_virtual_interface_test_history()
list_virtual_interface_test_history(params::Dict{String,<:Any})
Lists the virtual interface failover test history.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bgpPeers"`: The BGP peers that were placed in the DOWN state during the virtual
interface failover test.
- `"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.
- `"status"`: The status of the virtual interface failover test.
- `"testId"`: The ID of the virtual interface failover test.
- `"virtualInterfaceId"`: The ID of the virtual interface that was tested.
"""
function list_virtual_interface_test_history(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"ListVirtualInterfaceTestHistory";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_virtual_interface_test_history(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"ListVirtualInterfaceTestHistory",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_bgp_failover_test(virtual_interface_id)
start_bgp_failover_test(virtual_interface_id, params::Dict{String,<:Any})
Starts the virtual interface failover test that verifies your configuration meets your
resiliency requirements by placing the BGP peering session in the DOWN state. You can then
send traffic to verify that there are no outages. You can run the test on public, private,
transit, and hosted virtual interfaces. You can use ListVirtualInterfaceTestHistory to view
the virtual interface test history. If you need to stop the test before the test interval
completes, use StopBgpFailoverTest.
# Arguments
- `virtual_interface_id`: The ID of the virtual interface you want to test.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bgpPeers"`: The BGP peers to place in the DOWN state.
- `"testDurationInMinutes"`: The time in minutes that the virtual interface failover test
will last. Maximum value: 4,320 minutes (72 hours). Default: 180 minutes (3 hours).
"""
function start_bgp_failover_test(
virtualInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"StartBgpFailoverTest",
Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_bgp_failover_test(
virtualInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"StartBgpFailoverTest",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_bgp_failover_test(virtual_interface_id)
stop_bgp_failover_test(virtual_interface_id, params::Dict{String,<:Any})
Stops the virtual interface failover test.
# Arguments
- `virtual_interface_id`: The ID of the virtual interface you no longer want to test.
"""
function stop_bgp_failover_test(
virtualInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"StopBgpFailoverTest",
Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_bgp_failover_test(
virtualInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"StopBgpFailoverTest",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId), 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 Direct Connect resource. Each resource can have a
maximum of 50 tags. Each tag consists of a key and an optional value. If a tag with the
same key is already associated with the resource, this action updates its value.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: The tags to add.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"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 direct_connect(
"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 the specified Direct Connect resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: The tag keys of the tags to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"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 direct_connect(
"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_connection(connection_id)
update_connection(connection_id, params::Dict{String,<:Any})
Updates the Direct Connect dedicated connection configuration. You can update the following
parameters for a connection: The connection name The connection's MAC Security (MACsec)
encryption mode.
# Arguments
- `connection_id`: The ID of the dedicated connection. You can use DescribeConnections to
retrieve the connection ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"connectionName"`: The name of the connection.
- `"encryptionMode"`: The connection MAC Security (MACsec) encryption mode. The valid
values are no_encrypt, should_encrypt, and must_encrypt.
"""
function update_connection(connectionId; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"UpdateConnection",
Dict{String,Any}("connectionId" => connectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connection(
connectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"UpdateConnection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("connectionId" => connectionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_direct_connect_gateway(direct_connect_gateway_id, new_direct_connect_gateway_name)
update_direct_connect_gateway(direct_connect_gateway_id, new_direct_connect_gateway_name, params::Dict{String,<:Any})
Updates the name of a current Direct Connect gateway.
# Arguments
- `direct_connect_gateway_id`: The ID of the Direct Connect gateway to update.
- `new_direct_connect_gateway_name`: The new name for the Direct Connect gateway.
"""
function update_direct_connect_gateway(
directConnectGatewayId,
newDirectConnectGatewayName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"UpdateDirectConnectGateway",
Dict{String,Any}(
"directConnectGatewayId" => directConnectGatewayId,
"newDirectConnectGatewayName" => newDirectConnectGatewayName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_direct_connect_gateway(
directConnectGatewayId,
newDirectConnectGatewayName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"UpdateDirectConnectGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"directConnectGatewayId" => directConnectGatewayId,
"newDirectConnectGatewayName" => newDirectConnectGatewayName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_direct_connect_gateway_association()
update_direct_connect_gateway_association(params::Dict{String,<:Any})
Updates the specified attributes of the Direct Connect gateway association. Add or remove
prefixes from the association.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addAllowedPrefixesToDirectConnectGateway"`: The Amazon VPC prefixes to advertise to the
Direct Connect gateway.
- `"associationId"`: The ID of the Direct Connect gateway association.
- `"removeAllowedPrefixesToDirectConnectGateway"`: The Amazon VPC prefixes to no longer
advertise to the Direct Connect gateway.
"""
function update_direct_connect_gateway_association(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"UpdateDirectConnectGatewayAssociation";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_direct_connect_gateway_association(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"UpdateDirectConnectGatewayAssociation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_lag(lag_id)
update_lag(lag_id, params::Dict{String,<:Any})
Updates the attributes of the specified link aggregation group (LAG). You can update the
following LAG attributes: The name of the LAG. The value for the minimum number of
connections that must be operational for the LAG itself to be operational. The LAG's
MACsec encryption mode. Amazon Web Services assigns this value to each connection which is
part of the LAG. The tags If you adjust the threshold value for the minimum number of
operational connections, ensure that the new value does not cause the LAG to fall below the
threshold and become non-operational.
# Arguments
- `lag_id`: The ID of the LAG.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"encryptionMode"`: The LAG MAC Security (MACsec) encryption mode. Amazon Web Services
applies the value to all connections which are part of the LAG.
- `"lagName"`: The name of the LAG.
- `"minimumLinks"`: The minimum number of physical connections that must be operational for
the LAG itself to be operational.
"""
function update_lag(lagId; aws_config::AbstractAWSConfig=global_aws_config())
return direct_connect(
"UpdateLag",
Dict{String,Any}("lagId" => lagId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_lag(
lagId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"UpdateLag",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("lagId" => lagId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_virtual_interface_attributes(virtual_interface_id)
update_virtual_interface_attributes(virtual_interface_id, params::Dict{String,<:Any})
Updates the specified attributes of the specified virtual private interface. Setting the
MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying
physical connection if it wasn't updated to support jumbo frames. Updating the connection
disrupts network connectivity for all virtual interfaces associated with the connection for
up to 30 seconds. To check whether your connection supports jumbo frames, call
DescribeConnections. To check whether your virtual interface supports jumbo frames, call
DescribeVirtualInterfaces.
# Arguments
- `virtual_interface_id`: The ID of the virtual private interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enableSiteLink"`: Indicates whether to enable or disable SiteLink.
- `"mtu"`: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and
9001. The default value is 1500.
- `"virtualInterfaceName"`: The name of the virtual private interface.
"""
function update_virtual_interface_attributes(
virtualInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return direct_connect(
"UpdateVirtualInterfaceAttributes",
Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_virtual_interface_attributes(
virtualInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return direct_connect(
"UpdateVirtualInterfaceAttributes",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("virtualInterfaceId" => virtualInterfaceId), 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 | 103044 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: directory_service
using AWS.Compat
using AWS.UUIDs
"""
accept_shared_directory(shared_directory_id)
accept_shared_directory(shared_directory_id, params::Dict{String,<:Any})
Accepts a directory sharing request that was sent from the directory owner account.
# Arguments
- `shared_directory_id`: Identifier of the shared directory in the directory consumer
account. This identifier is different for each directory owner account.
"""
function accept_shared_directory(
SharedDirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"AcceptSharedDirectory",
Dict{String,Any}("SharedDirectoryId" => SharedDirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_shared_directory(
SharedDirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"AcceptSharedDirectory",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SharedDirectoryId" => SharedDirectoryId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_ip_routes(directory_id, ip_routes)
add_ip_routes(directory_id, ip_routes, params::Dict{String,<:Any})
If the DNS server for your self-managed domain uses a publicly addressable IP address, you
must add a CIDR address block to correctly route traffic to and from your Microsoft AD on
Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to
facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web
Services to a peer VPC. Before you call AddIpRoutes, ensure that all of the required
permissions have been explicitly granted through a policy. For details about what
permissions are required to run the AddIpRoutes operation, see Directory Service API
Permissions: Actions, Resources, and Conditions Reference.
# Arguments
- `directory_id`: Identifier (ID) of the directory to which to add the address block.
- `ip_routes`: IP address blocks, using CIDR format, of the traffic to route. This is often
the IP address block of the DNS server used for your self-managed domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UpdateSecurityGroupForDirectoryControllers"`: If set to true, updates the inbound and
outbound rules of the security group that has the description: \"Amazon Web Services
created security group for directory ID directory controllers.\" Following are the new
rules: Inbound: Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0
Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0 Type: Custom UDP
Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP,
Range: 389, Source: 0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source:
0.0.0.0/0 Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0 Type:
Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0 Type: Custom TCP Rule,
Protocol: TCP, Range: 135, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range:
445, Source: 0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source:
0.0.0.0/0 Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0 Type:
Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0 Type: Custom TCP
Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0 Type: DNS (UDP), Protocol: UDP,
Range: 53, Source: 0.0.0.0/0 Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0
Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0 Type: All ICMP, Protocol: All,
Range: N/A, Source: 0.0.0.0/0 Outbound: Type: All traffic, Protocol: All, Range: All,
Destination: 0.0.0.0/0 These security rules impact an internal network interface that is
not exposed publicly.
"""
function add_ip_routes(
DirectoryId, IpRoutes; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"AddIpRoutes",
Dict{String,Any}("DirectoryId" => DirectoryId, "IpRoutes" => IpRoutes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_ip_routes(
DirectoryId,
IpRoutes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"AddIpRoutes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DirectoryId" => DirectoryId, "IpRoutes" => IpRoutes),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_region(directory_id, region_name, vpcsettings)
add_region(directory_id, region_name, vpcsettings, params::Dict{String,<:Any})
Adds two domain controllers in the specified Region for the specified directory.
# Arguments
- `directory_id`: The identifier of the directory to which you want to add Region
replication.
- `region_name`: The name of the Region where you want to add domain controllers for
replication. For example, us-east-1.
- `vpcsettings`:
"""
function add_region(
DirectoryId, RegionName, VPCSettings; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"AddRegion",
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"RegionName" => RegionName,
"VPCSettings" => VPCSettings,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_region(
DirectoryId,
RegionName,
VPCSettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"AddRegion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"RegionName" => RegionName,
"VPCSettings" => VPCSettings,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_tags_to_resource(resource_id, tags)
add_tags_to_resource(resource_id, tags, params::Dict{String,<:Any})
Adds or overwrites one or more tags for the specified directory. Each directory can have a
maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique
to each resource.
# Arguments
- `resource_id`: Identifier (ID) for the directory to which to add the tag.
- `tags`: The tags to be assigned to the directory.
"""
function add_tags_to_resource(
ResourceId, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"AddTagsToResource",
Dict{String,Any}("ResourceId" => ResourceId, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags_to_resource(
ResourceId,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"AddTagsToResource",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ResourceId" => ResourceId, "Tags" => Tags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_schema_extension(directory_id, schema_extension_id)
cancel_schema_extension(directory_id, schema_extension_id, params::Dict{String,<:Any})
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema
extension has started replicating to all domain controllers, the task can no longer be
canceled. A schema extension can be canceled during any of the following states;
Initializing, CreatingSnapshot, and UpdatingSchema.
# Arguments
- `directory_id`: The identifier of the directory whose schema extension will be canceled.
- `schema_extension_id`: The identifier of the schema extension that will be canceled.
"""
function cancel_schema_extension(
DirectoryId, SchemaExtensionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"CancelSchemaExtension",
Dict{String,Any}(
"DirectoryId" => DirectoryId, "SchemaExtensionId" => SchemaExtensionId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_schema_extension(
DirectoryId,
SchemaExtensionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CancelSchemaExtension",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId, "SchemaExtensionId" => SchemaExtensionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
connect_directory(connect_settings, name, password, size)
connect_directory(connect_settings, name, password, size, params::Dict{String,<:Any})
Creates an AD Connector to connect to a self-managed directory. Before you call
ConnectDirectory, ensure that all of the required permissions have been explicitly granted
through a policy. For details about what permissions are required to run the
ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and
Conditions Reference.
# Arguments
- `connect_settings`: A DirectoryConnectSettings object that contains additional
information for the operation.
- `name`: The fully qualified name of your self-managed directory, such as corp.example.com.
- `password`: The password for your self-managed user account.
- `size`: The size of the directory.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the directory.
- `"ShortName"`: The NetBIOS name of your self-managed directory, such as CORP.
- `"Tags"`: The tags to be assigned to AD Connector.
"""
function connect_directory(
ConnectSettings, Name, Password, Size; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"ConnectDirectory",
Dict{String,Any}(
"ConnectSettings" => ConnectSettings,
"Name" => Name,
"Password" => Password,
"Size" => Size,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function connect_directory(
ConnectSettings,
Name,
Password,
Size,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"ConnectDirectory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectSettings" => ConnectSettings,
"Name" => Name,
"Password" => Password,
"Size" => Size,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_alias(alias, directory_id)
create_alias(alias, directory_id, params::Dict{String,<:Any})
Creates an alias for a directory and assigns the alias to the directory. The alias is used
to construct the access URL for the directory, such as http://<alias>.awsapps.com.
After an alias has been created, it cannot be deleted or reused, so this operation should
only be used when absolutely necessary.
# Arguments
- `alias`: The requested alias. The alias must be unique amongst all aliases in Amazon Web
Services. This operation throws an EntityAlreadyExistsException error if the alias already
exists.
- `directory_id`: The identifier of the directory for which to create the alias.
"""
function create_alias(Alias, DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"CreateAlias",
Dict{String,Any}("Alias" => Alias, "DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_alias(
Alias,
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CreateAlias",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Alias" => Alias, "DirectoryId" => DirectoryId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_computer(computer_name, directory_id, password)
create_computer(computer_name, directory_id, password, params::Dict{String,<:Any})
Creates an Active Directory computer object in the specified directory.
# Arguments
- `computer_name`: The name of the computer account.
- `directory_id`: The identifier of the directory in which to create the computer account.
- `password`: A one-time password that is used to join the computer to the directory. You
should generate a random, strong password to use for this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComputerAttributes"`: An array of Attribute objects that contain any LDAP attributes to
apply to the computer account.
- `"OrganizationalUnitDistinguishedName"`: The fully-qualified distinguished name of the
organizational unit to place the computer account in.
"""
function create_computer(
ComputerName, DirectoryId, Password; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"CreateComputer",
Dict{String,Any}(
"ComputerName" => ComputerName,
"DirectoryId" => DirectoryId,
"Password" => Password,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_computer(
ComputerName,
DirectoryId,
Password,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CreateComputer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ComputerName" => ComputerName,
"DirectoryId" => DirectoryId,
"Password" => Password,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_conditional_forwarder(directory_id, dns_ip_addrs, remote_domain_name)
create_conditional_forwarder(directory_id, dns_ip_addrs, remote_domain_name, params::Dict{String,<:Any})
Creates a conditional forwarder associated with your Amazon Web Services directory.
Conditional forwarders are required in order to set up a trust relationship with another
domain. The conditional forwarder points to the trusted domain.
# Arguments
- `directory_id`: The directory ID of the Amazon Web Services directory for which you are
creating the conditional forwarder.
- `dns_ip_addrs`: The IP addresses of the remote DNS server associated with
RemoteDomainName.
- `remote_domain_name`: The fully qualified domain name (FQDN) of the remote domain with
which you will set up a trust relationship.
"""
function create_conditional_forwarder(
DirectoryId,
DnsIpAddrs,
RemoteDomainName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CreateConditionalForwarder",
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"DnsIpAddrs" => DnsIpAddrs,
"RemoteDomainName" => RemoteDomainName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_conditional_forwarder(
DirectoryId,
DnsIpAddrs,
RemoteDomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CreateConditionalForwarder",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"DnsIpAddrs" => DnsIpAddrs,
"RemoteDomainName" => RemoteDomainName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_directory(name, password, size)
create_directory(name, password, size, params::Dict{String,<:Any})
Creates a Simple AD directory. For more information, see Simple Active Directory in the
Directory Service Admin Guide. Before you call CreateDirectory, ensure that all of the
required permissions have been explicitly granted through a policy. For details about what
permissions are required to run the CreateDirectory operation, see Directory Service API
Permissions: Actions, Resources, and Conditions Reference.
# Arguments
- `name`: The fully qualified name for the directory, such as corp.example.com.
- `password`: The password for the directory administrator. The directory creation process
creates a directory administrator account with the user name Administrator and this
password. If you need to change the password for the administrator account, you can use the
ResetUserPassword API call. The regex pattern for this string is made up of the following
conditions: Length (?=^.{8,64}) – Must be between 8 and 64 characters AND any 3 of
the following password complexity rules required by Active Directory: Numbers and upper
case and lowercase (?=.*d)(?=.*[A-Z])(?=.*[a-z]) Numbers and special characters and lower
case (?=.*d)(?=.*[^A-Za-z0-9s])(?=.*[a-z]) Special characters and upper case and lower
case (?=.*[^A-Za-z0-9s])(?=.*[A-Z])(?=.*[a-z]) Numbers and upper case and special
characters (?=.*d)(?=.*[A-Z])(?=.*[^A-Za-z0-9s]) For additional information about how
Active Directory passwords are enforced, see Password must meet complexity requirements on
the Microsoft website.
- `size`: The size of the directory.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the directory.
- `"ShortName"`: The NetBIOS name of the directory, such as CORP.
- `"Tags"`: The tags to be assigned to the Simple AD directory.
- `"VpcSettings"`: A DirectoryVpcSettings object that contains additional information for
the operation.
"""
function create_directory(
Name, Password, Size; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"CreateDirectory",
Dict{String,Any}("Name" => Name, "Password" => Password, "Size" => Size);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_directory(
Name,
Password,
Size,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CreateDirectory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "Password" => Password, "Size" => Size),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_log_subscription(directory_id, log_group_name)
create_log_subscription(directory_id, log_group_name, params::Dict{String,<:Any})
Creates a subscription to forward real-time Directory Service domain controller security
logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
# Arguments
- `directory_id`: Identifier of the directory to which you want to subscribe and receive
real-time logs to your specified CloudWatch log group.
- `log_group_name`: The name of the CloudWatch log group where the real-time domain
controller logs are forwarded.
"""
function create_log_subscription(
DirectoryId, LogGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"CreateLogSubscription",
Dict{String,Any}("DirectoryId" => DirectoryId, "LogGroupName" => LogGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_log_subscription(
DirectoryId,
LogGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CreateLogSubscription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId, "LogGroupName" => LogGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_microsoft_ad(name, password, vpc_settings)
create_microsoft_ad(name, password, vpc_settings, params::Dict{String,<:Any})
Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information,
see Managed Microsoft AD in the Directory Service Admin Guide. Before you call
CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted
through a policy. For details about what permissions are required to run the
CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and
Conditions Reference.
# Arguments
- `name`: The fully qualified domain name for the Managed Microsoft AD directory, such as
corp.example.com. This name will resolve inside your VPC only. It does not need to be
publicly resolvable.
- `password`: The password for the default administrative user named Admin. If you need to
change the password for the administrator account, you can use the ResetUserPassword API
call.
- `vpc_settings`: Contains VPC information for the CreateDirectory or CreateMicrosoftAD
operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the directory. This label will appear on the Amazon
Web Services console Directory Details page after the directory is created.
- `"Edition"`: Managed Microsoft AD is available in two editions: Standard and Enterprise.
Enterprise is the default.
- `"ShortName"`: The NetBIOS name for your domain, such as CORP. If you don't specify a
NetBIOS name, it will default to the first part of your directory DNS. For example, CORP
for the directory DNS corp.example.com.
- `"Tags"`: The tags to be assigned to the Managed Microsoft AD directory.
"""
function create_microsoft_ad(
Name, Password, VpcSettings; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"CreateMicrosoftAD",
Dict{String,Any}(
"Name" => Name, "Password" => Password, "VpcSettings" => VpcSettings
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_microsoft_ad(
Name,
Password,
VpcSettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CreateMicrosoftAD",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "Password" => Password, "VpcSettings" => VpcSettings
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot(directory_id)
create_snapshot(directory_id, params::Dict{String,<:Any})
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services
cloud. You cannot take snapshots of AD Connector directories.
# Arguments
- `directory_id`: The identifier of the directory of which to take a snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The descriptive name to apply to the snapshot.
"""
function create_snapshot(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"CreateSnapshot",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CreateSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_trust(directory_id, remote_domain_name, trust_direction, trust_password)
create_trust(directory_id, remote_domain_name, trust_direction, trust_password, params::Dict{String,<:Any})
Directory Service for Microsoft Active Directory allows you to configure trust
relationships. For example, you can establish a trust between your Managed Microsoft AD
directory, and your existing self-managed Microsoft Active Directory. This would allow you
to provide users and groups access to resources in either domain, with a single set of
credentials. This action initiates the creation of the Amazon Web Services side of a trust
relationship between an Managed Microsoft AD directory and an external domain. You can
create either a forest trust or an external trust.
# Arguments
- `directory_id`: The Directory ID of the Managed Microsoft AD directory for which to
establish the trust relationship.
- `remote_domain_name`: The Fully Qualified Domain Name (FQDN) of the external domain for
which to create the trust relationship.
- `trust_direction`: The direction of the trust relationship.
- `trust_password`: The trust password. The must be the same password that was used when
creating the trust relationship on the external domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConditionalForwarderIpAddrs"`: The IP addresses of the remote DNS server associated
with RemoteDomainName.
- `"SelectiveAuth"`: Optional parameter to enable selective authentication for the trust.
- `"TrustType"`: The trust relationship type. Forest is the default.
"""
function create_trust(
DirectoryId,
RemoteDomainName,
TrustDirection,
TrustPassword;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CreateTrust",
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"RemoteDomainName" => RemoteDomainName,
"TrustDirection" => TrustDirection,
"TrustPassword" => TrustPassword,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_trust(
DirectoryId,
RemoteDomainName,
TrustDirection,
TrustPassword,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"CreateTrust",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"RemoteDomainName" => RemoteDomainName,
"TrustDirection" => TrustDirection,
"TrustPassword" => TrustPassword,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_conditional_forwarder(directory_id, remote_domain_name)
delete_conditional_forwarder(directory_id, remote_domain_name, params::Dict{String,<:Any})
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
# Arguments
- `directory_id`: The directory ID for which you are deleting the conditional forwarder.
- `remote_domain_name`: The fully qualified domain name (FQDN) of the remote domain with
which you are deleting the conditional forwarder.
"""
function delete_conditional_forwarder(
DirectoryId, RemoteDomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DeleteConditionalForwarder",
Dict{String,Any}(
"DirectoryId" => DirectoryId, "RemoteDomainName" => RemoteDomainName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_conditional_forwarder(
DirectoryId,
RemoteDomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DeleteConditionalForwarder",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId, "RemoteDomainName" => RemoteDomainName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_directory(directory_id)
delete_directory(directory_id, params::Dict{String,<:Any})
Deletes an Directory Service directory. Before you call DeleteDirectory, ensure that all of
the required permissions have been explicitly granted through a policy. For details about
what permissions are required to run the DeleteDirectory operation, see Directory Service
API Permissions: Actions, Resources, and Conditions Reference.
# Arguments
- `directory_id`: The identifier of the directory to delete.
"""
function delete_directory(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DeleteDirectory",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_directory(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DeleteDirectory",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_log_subscription(directory_id)
delete_log_subscription(directory_id, params::Dict{String,<:Any})
Deletes the specified log subscription.
# Arguments
- `directory_id`: Identifier of the directory whose log subscription you want to delete.
"""
function delete_log_subscription(
DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DeleteLogSubscription",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_log_subscription(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DeleteLogSubscription",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_snapshot(snapshot_id)
delete_snapshot(snapshot_id, params::Dict{String,<:Any})
Deletes a directory snapshot.
# Arguments
- `snapshot_id`: The identifier of the directory snapshot to be deleted.
"""
function delete_snapshot(SnapshotId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DeleteSnapshot",
Dict{String,Any}("SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_snapshot(
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DeleteSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotId" => SnapshotId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_trust(trust_id)
delete_trust(trust_id, params::Dict{String,<:Any})
Deletes an existing trust relationship between your Managed Microsoft AD directory and an
external domain.
# Arguments
- `trust_id`: The Trust ID of the trust relationship to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteAssociatedConditionalForwarder"`: Delete a conditional forwarder as part of a
DeleteTrustRequest.
"""
function delete_trust(TrustId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DeleteTrust",
Dict{String,Any}("TrustId" => TrustId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_trust(
TrustId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DeleteTrust",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TrustId" => TrustId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_certificate(certificate_id, directory_id)
deregister_certificate(certificate_id, directory_id, params::Dict{String,<:Any})
Deletes from the system the certificate that was registered for secure LDAP or client
certificate authentication.
# Arguments
- `certificate_id`: The identifier of the certificate.
- `directory_id`: The identifier of the directory.
"""
function deregister_certificate(
CertificateId, DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DeregisterCertificate",
Dict{String,Any}("CertificateId" => CertificateId, "DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_certificate(
CertificateId,
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DeregisterCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CertificateId" => CertificateId, "DirectoryId" => DirectoryId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_event_topic(directory_id, topic_name)
deregister_event_topic(directory_id, topic_name, params::Dict{String,<:Any})
Removes the specified directory as a publisher to the specified Amazon SNS topic.
# Arguments
- `directory_id`: The Directory ID to remove as a publisher. This directory will no longer
send messages to the specified Amazon SNS topic.
- `topic_name`: The name of the Amazon SNS topic from which to remove the directory as a
publisher.
"""
function deregister_event_topic(
DirectoryId, TopicName; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DeregisterEventTopic",
Dict{String,Any}("DirectoryId" => DirectoryId, "TopicName" => TopicName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_event_topic(
DirectoryId,
TopicName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DeregisterEventTopic",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DirectoryId" => DirectoryId, "TopicName" => TopicName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_certificate(certificate_id, directory_id)
describe_certificate(certificate_id, directory_id, params::Dict{String,<:Any})
Displays information about the certificate registered for secure LDAP or client certificate
authentication.
# Arguments
- `certificate_id`: The identifier of the certificate.
- `directory_id`: The identifier of the directory.
"""
function describe_certificate(
CertificateId, DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeCertificate",
Dict{String,Any}("CertificateId" => CertificateId, "DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_certificate(
CertificateId,
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DescribeCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CertificateId" => CertificateId, "DirectoryId" => DirectoryId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_client_authentication_settings(directory_id)
describe_client_authentication_settings(directory_id, params::Dict{String,<:Any})
Retrieves information about the type of client authentication for the specified directory,
if the type is specified. If no type is specified, information about all client
authentication types that are supported for the specified directory is retrieved.
Currently, only SmartCard is supported.
# Arguments
- `directory_id`: The identifier of the directory for which to retrieve information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of items to return. If this value is zero, the maximum
number of items is specified by the limitations of the operation.
- `"NextToken"`: The DescribeClientAuthenticationSettingsResult.NextToken value from a
previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.
- `"Type"`: The type of client authentication for which to retrieve information. If no type
is specified, a list of all client authentication types that are supported for the
specified directory is retrieved.
"""
function describe_client_authentication_settings(
DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeClientAuthenticationSettings",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_client_authentication_settings(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DescribeClientAuthenticationSettings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_conditional_forwarders(directory_id)
describe_conditional_forwarders(directory_id, params::Dict{String,<:Any})
Obtains information about the conditional forwarders for this account. If no input
parameters are provided for RemoteDomainNames, this request describes all conditional
forwarders for the specified directory ID.
# Arguments
- `directory_id`: The directory ID for which to get the list of associated conditional
forwarders.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RemoteDomainNames"`: The fully qualified domain names (FQDN) of the remote domains for
which to get the list of associated conditional forwarders. If this member is null, all
conditional forwarders are returned.
"""
function describe_conditional_forwarders(
DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeConditionalForwarders",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_conditional_forwarders(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DescribeConditionalForwarders",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_directories()
describe_directories(params::Dict{String,<:Any})
Obtains information about the directories that belong to this account. You can retrieve
information about specific directories by passing the directory identifiers in the
DirectoryIds parameter. Otherwise, all directories that belong to the current account are
returned. This operation supports pagination with the use of the NextToken request and
response parameters. If more results are available, the DescribeDirectoriesResult.NextToken
member contains a token that you pass in the next call to DescribeDirectories to retrieve
the next set of items. You can also specify a maximum number of return results with the
Limit parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DirectoryIds"`: A list of identifiers of the directories for which to obtain the
information. If this member is null, all directories that belong to the current account are
returned. An empty list results in an InvalidParameterException being thrown.
- `"Limit"`: The maximum number of items to return. If this value is zero, the maximum
number of items is specified by the limitations of the operation.
- `"NextToken"`: The DescribeDirectoriesResult.NextToken value from a previous call to
DescribeDirectories. Pass null if this is the first call.
"""
function describe_directories(; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DescribeDirectories"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_directories(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeDirectories",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain_controllers(directory_id)
describe_domain_controllers(directory_id, params::Dict{String,<:Any})
Provides information about any domain controllers in your directory.
# Arguments
- `directory_id`: Identifier of the directory for which to retrieve the domain controller
information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DomainControllerIds"`: A list of identifiers for the domain controllers whose
information will be provided.
- `"Limit"`: The maximum number of items to return.
- `"NextToken"`: The DescribeDomainControllers.NextToken value from a previous call to
DescribeDomainControllers. Pass null if this is the first call.
"""
function describe_domain_controllers(
DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeDomainControllers",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain_controllers(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DescribeDomainControllers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_topics()
describe_event_topics(params::Dict{String,<:Any})
Obtains information about which Amazon SNS topics receive status messages from the
specified directory. If no input parameters are provided, such as DirectoryId or TopicName,
this request describes all of the associations in the account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DirectoryId"`: The Directory ID for which to get the list of associated Amazon SNS
topics. If this member is null, associations for all Directory IDs are returned.
- `"TopicNames"`: A list of Amazon SNS topic names for which to obtain the information. If
this member is null, all associations for the specified Directory ID are returned. An empty
list results in an InvalidParameterException being thrown.
"""
function describe_event_topics(; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DescribeEventTopics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_event_topics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeEventTopics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ldapssettings(directory_id)
describe_ldapssettings(directory_id, params::Dict{String,<:Any})
Describes the status of LDAP security for the specified directory.
# Arguments
- `directory_id`: The identifier of the directory.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifies the number of items that should be displayed on one page.
- `"NextToken"`: The type of next token used for pagination.
- `"Type"`: The type of LDAP security to enable. Currently only the value Client is
supported.
"""
function describe_ldapssettings(
DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeLDAPSSettings",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_ldapssettings(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DescribeLDAPSSettings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_regions(directory_id)
describe_regions(directory_id, params::Dict{String,<:Any})
Provides information about the Regions that are configured for multi-Region replication.
# Arguments
- `directory_id`: The identifier of the directory.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: The DescribeRegionsResult.NextToken value from a previous call to
DescribeRegions. Pass null if this is the first call.
- `"RegionName"`: The name of the Region. For example, us-east-1.
"""
function describe_regions(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DescribeRegions",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_regions(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DescribeRegions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_settings(directory_id)
describe_settings(directory_id, params::Dict{String,<:Any})
Retrieves information about the configurable settings for the specified directory.
# Arguments
- `directory_id`: The identifier of the directory for which to retrieve information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: The DescribeSettingsResult.NextToken value from a previous call to
DescribeSettings. Pass null if this is the first call.
- `"Status"`: The status of the directory settings for which to retrieve information.
"""
function describe_settings(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DescribeSettings",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_settings(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DescribeSettings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_shared_directories(owner_directory_id)
describe_shared_directories(owner_directory_id, params::Dict{String,<:Any})
Returns the shared directories in your account.
# Arguments
- `owner_directory_id`: Returns the identifier of the directory in the directory owner
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The number of shared directories to return in the response object.
- `"NextToken"`: The DescribeSharedDirectoriesResult.NextToken value from a previous call
to DescribeSharedDirectories. Pass null if this is the first call.
- `"SharedDirectoryIds"`: A list of identifiers of all shared directories in your account.
"""
function describe_shared_directories(
OwnerDirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeSharedDirectories",
Dict{String,Any}("OwnerDirectoryId" => OwnerDirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_shared_directories(
OwnerDirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DescribeSharedDirectories",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("OwnerDirectoryId" => OwnerDirectoryId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshots()
describe_snapshots(params::Dict{String,<:Any})
Obtains information about the directory snapshots that belong to this account. This
operation supports pagination with the use of the NextToken request and response
parameters. If more results are available, the DescribeSnapshots.NextToken member contains
a token that you pass in the next call to DescribeSnapshots to retrieve the next set of
items. You can also specify a maximum number of return results with the Limit parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DirectoryId"`: The identifier of the directory for which to retrieve snapshot
information.
- `"Limit"`: The maximum number of objects to return.
- `"NextToken"`: The DescribeSnapshotsResult.NextToken value from a previous call to
DescribeSnapshots. Pass null if this is the first call.
- `"SnapshotIds"`: A list of identifiers of the snapshots to obtain the information for. If
this member is null or empty, all snapshots are returned using the Limit and NextToken
members.
"""
function describe_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DescribeSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeSnapshots", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_trusts()
describe_trusts(params::Dict{String,<:Any})
Obtains information about the trust relationships for this account. If no input parameters
are provided, such as DirectoryId or TrustIds, this request describes all the trust
relationships belonging to the account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DirectoryId"`: The Directory ID of the Amazon Web Services directory that is a part of
the requested trust relationship.
- `"Limit"`: The maximum number of objects to return.
- `"NextToken"`: The DescribeTrustsResult.NextToken value from a previous call to
DescribeTrusts. Pass null if this is the first call.
- `"TrustIds"`: A list of identifiers of the trust relationships for which to obtain the
information. If this member is null, all trust relationships that belong to the current
account are returned. An empty list results in an InvalidParameterException being thrown.
"""
function describe_trusts(; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DescribeTrusts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_trusts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeTrusts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_update_directory(directory_id, update_type)
describe_update_directory(directory_id, update_type, params::Dict{String,<:Any})
Describes the updates of a directory for a particular update type.
# Arguments
- `directory_id`: The unique identifier of the directory.
- `update_type`: The type of updates you want to describe for the directory.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: The DescribeUpdateDirectoryResult. NextToken value from a previous call
to DescribeUpdateDirectory. Pass null if this is the first call.
- `"RegionName"`: The name of the Region.
"""
function describe_update_directory(
DirectoryId, UpdateType; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DescribeUpdateDirectory",
Dict{String,Any}("DirectoryId" => DirectoryId, "UpdateType" => UpdateType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_update_directory(
DirectoryId,
UpdateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DescribeUpdateDirectory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DirectoryId" => DirectoryId, "UpdateType" => UpdateType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_client_authentication(directory_id, type)
disable_client_authentication(directory_id, type, params::Dict{String,<:Any})
Disables alternative client authentication methods for the specified directory.
# Arguments
- `directory_id`: The identifier of the directory
- `type`: The type of client authentication to disable. Currently, only the parameter,
SmartCard is supported.
"""
function disable_client_authentication(
DirectoryId, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"DisableClientAuthentication",
Dict{String,Any}("DirectoryId" => DirectoryId, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_client_authentication(
DirectoryId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DisableClientAuthentication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DirectoryId" => DirectoryId, "Type" => Type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_ldaps(directory_id, type)
disable_ldaps(directory_id, type, params::Dict{String,<:Any})
Deactivates LDAP secure calls for the specified directory.
# Arguments
- `directory_id`: The identifier of the directory.
- `type`: The type of LDAP security to enable. Currently only the value Client is supported.
"""
function disable_ldaps(DirectoryId, Type; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DisableLDAPS",
Dict{String,Any}("DirectoryId" => DirectoryId, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_ldaps(
DirectoryId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DisableLDAPS",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DirectoryId" => DirectoryId, "Type" => Type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_radius(directory_id)
disable_radius(directory_id, params::Dict{String,<:Any})
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User
Service (RADIUS) server for an AD Connector or Microsoft AD directory.
# Arguments
- `directory_id`: The identifier of the directory for which to disable MFA.
"""
function disable_radius(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DisableRadius",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_radius(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DisableRadius",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_sso(directory_id)
disable_sso(directory_id, params::Dict{String,<:Any})
Disables single-sign on for a directory.
# Arguments
- `directory_id`: The identifier of the directory for which to disable single-sign on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Password"`: The password of an alternate account to use to disable single-sign on. This
is only used for AD Connector directories. For more information, see the UserName parameter.
- `"UserName"`: The username of an alternate account to use to disable single-sign on. This
is only used for AD Connector directories. This account must have privileges to remove a
service principal name. If the AD Connector service account does not have privileges to
remove a service principal name, you can specify an alternate account with the UserName and
Password parameters. These credentials are only used to disable single sign-on and are not
stored by the service. The AD Connector service account is not changed.
"""
function disable_sso(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"DisableSso",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_sso(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"DisableSso",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_client_authentication(directory_id, type)
enable_client_authentication(directory_id, type, params::Dict{String,<:Any})
Enables alternative client authentication methods for the specified directory.
# Arguments
- `directory_id`: The identifier of the specified directory.
- `type`: The type of client authentication to enable. Currently only the value SmartCard
is supported. Smart card authentication in AD Connector requires that you enable Kerberos
Constrained Delegation for the Service User to the LDAP service in your self-managed AD.
"""
function enable_client_authentication(
DirectoryId, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"EnableClientAuthentication",
Dict{String,Any}("DirectoryId" => DirectoryId, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_client_authentication(
DirectoryId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"EnableClientAuthentication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DirectoryId" => DirectoryId, "Type" => Type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_ldaps(directory_id, type)
enable_ldaps(directory_id, type, params::Dict{String,<:Any})
Activates the switch for the specific directory to always use LDAP secure calls.
# Arguments
- `directory_id`: The identifier of the directory.
- `type`: The type of LDAP security to enable. Currently only the value Client is supported.
"""
function enable_ldaps(DirectoryId, Type; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"EnableLDAPS",
Dict{String,Any}("DirectoryId" => DirectoryId, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_ldaps(
DirectoryId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"EnableLDAPS",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DirectoryId" => DirectoryId, "Type" => Type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_radius(directory_id, radius_settings)
enable_radius(directory_id, radius_settings, params::Dict{String,<:Any})
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User
Service (RADIUS) server for an AD Connector or Microsoft AD directory.
# Arguments
- `directory_id`: The identifier of the directory for which to enable MFA.
- `radius_settings`: A RadiusSettings object that contains information about the RADIUS
server.
"""
function enable_radius(
DirectoryId, RadiusSettings; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"EnableRadius",
Dict{String,Any}("DirectoryId" => DirectoryId, "RadiusSettings" => RadiusSettings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_radius(
DirectoryId,
RadiusSettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"EnableRadius",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId, "RadiusSettings" => RadiusSettings
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_sso(directory_id)
enable_sso(directory_id, params::Dict{String,<:Any})
Enables single sign-on for a directory. Single sign-on allows users in your directory to
access certain Amazon Web Services services from a computer joined to the directory without
having to enter their credentials separately.
# Arguments
- `directory_id`: The identifier of the directory for which to enable single-sign on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Password"`: The password of an alternate account to use to enable single-sign on. This
is only used for AD Connector directories. For more information, see the UserName parameter.
- `"UserName"`: The username of an alternate account to use to enable single-sign on. This
is only used for AD Connector directories. This account must have privileges to add a
service principal name. If the AD Connector service account does not have privileges to add
a service principal name, you can specify an alternate account with the UserName and
Password parameters. These credentials are only used to enable single sign-on and are not
stored by the service. The AD Connector service account is not changed.
"""
function enable_sso(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"EnableSso",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_sso(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"EnableSso",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_directory_limits()
get_directory_limits(params::Dict{String,<:Any})
Obtains directory limit information for the current Region.
"""
function get_directory_limits(; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"GetDirectoryLimits"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_directory_limits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"GetDirectoryLimits", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_snapshot_limits(directory_id)
get_snapshot_limits(directory_id, params::Dict{String,<:Any})
Obtains the manual snapshot limits for a directory.
# Arguments
- `directory_id`: Contains the identifier of the directory to obtain the limits for.
"""
function get_snapshot_limits(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"GetSnapshotLimits",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_snapshot_limits(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"GetSnapshotLimits",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_certificates(directory_id)
list_certificates(directory_id, params::Dict{String,<:Any})
For the specified directory, lists all the certificates registered for a secure LDAP or
client certificate authentication.
# Arguments
- `directory_id`: The identifier of the directory.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The number of items that should show up on one page
- `"NextToken"`: A token for requesting another page of certificates if the NextToken
response element indicates that more certificates are available. Use the value of the
returned NextToken element in your request until the token comes back as null. Pass null if
this is the first call.
"""
function list_certificates(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"ListCertificates",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_certificates(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"ListCertificates",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_ip_routes(directory_id)
list_ip_routes(directory_id, params::Dict{String,<:Any})
Lists the address blocks that you have added to a directory.
# Arguments
- `directory_id`: Identifier (ID) of the directory for which you want to retrieve the IP
addresses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Maximum number of items to return. If this value is zero, the maximum number
of items is specified by the limitations of the operation.
- `"NextToken"`: The ListIpRoutes.NextToken value from a previous call to ListIpRoutes.
Pass null if this is the first call.
"""
function list_ip_routes(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"ListIpRoutes",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_ip_routes(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"ListIpRoutes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_log_subscriptions()
list_log_subscriptions(params::Dict{String,<:Any})
Lists the active log subscriptions for the Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DirectoryId"`: If a DirectoryID is provided, lists only the log subscription associated
with that directory. If no DirectoryId is provided, lists all log subscriptions associated
with your Amazon Web Services account. If there are no log subscriptions for the Amazon Web
Services account or the directory, an empty list will be returned.
- `"Limit"`: The maximum number of items returned.
- `"NextToken"`: The token for the next set of items to return.
"""
function list_log_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"ListLogSubscriptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_log_subscriptions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"ListLogSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_schema_extensions(directory_id)
list_schema_extensions(directory_id, params::Dict{String,<:Any})
Lists all schema extensions applied to a Microsoft AD Directory.
# Arguments
- `directory_id`: The identifier of the directory from which to retrieve the schema
extension information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of items to return.
- `"NextToken"`: The ListSchemaExtensions.NextToken value from a previous call to
ListSchemaExtensions. Pass null if this is the first call.
"""
function list_schema_extensions(
DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"ListSchemaExtensions",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_schema_extensions(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"ListSchemaExtensions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), 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 all tags on a directory.
# Arguments
- `resource_id`: Identifier (ID) of the directory for which you want to retrieve tags.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Reserved for future use.
- `"NextToken"`: Reserved for future use.
"""
function list_tags_for_resource(
ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"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 directory_service(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceId" => ResourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_certificate(certificate_data, directory_id)
register_certificate(certificate_data, directory_id, params::Dict{String,<:Any})
Registers a certificate for a secure LDAP or client certificate authentication.
# Arguments
- `certificate_data`: The certificate PEM string that needs to be registered.
- `directory_id`: The identifier of the directory.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientCertAuthSettings"`: A ClientCertAuthSettings object that contains client
certificate authentication settings.
- `"Type"`: The function that the registered certificate performs. Valid values include
ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
"""
function register_certificate(
CertificateData, DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"RegisterCertificate",
Dict{String,Any}(
"CertificateData" => CertificateData, "DirectoryId" => DirectoryId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_certificate(
CertificateData,
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"RegisterCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CertificateData" => CertificateData, "DirectoryId" => DirectoryId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_event_topic(directory_id, topic_name)
register_event_topic(directory_id, topic_name, params::Dict{String,<:Any})
Associates a directory with an Amazon SNS topic. This establishes the directory as a
publisher to the specified Amazon SNS topic. You can then receive email or text (SMS)
messages when the status of your directory changes. You get notified if your directory goes
from an Active status to an Impaired or Inoperable status. You also receive a notification
when the directory returns to an Active status.
# Arguments
- `directory_id`: The Directory ID that will publish status messages to the Amazon SNS
topic.
- `topic_name`: The Amazon SNS topic name to which the directory will publish status
messages. This Amazon SNS topic must be in the same region as the specified Directory ID.
"""
function register_event_topic(
DirectoryId, TopicName; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"RegisterEventTopic",
Dict{String,Any}("DirectoryId" => DirectoryId, "TopicName" => TopicName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_event_topic(
DirectoryId,
TopicName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"RegisterEventTopic",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DirectoryId" => DirectoryId, "TopicName" => TopicName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_shared_directory(shared_directory_id)
reject_shared_directory(shared_directory_id, params::Dict{String,<:Any})
Rejects a directory sharing request that was sent from the directory owner account.
# Arguments
- `shared_directory_id`: Identifier of the shared directory in the directory consumer
account. This identifier is different for each directory owner account.
"""
function reject_shared_directory(
SharedDirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"RejectSharedDirectory",
Dict{String,Any}("SharedDirectoryId" => SharedDirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_shared_directory(
SharedDirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"RejectSharedDirectory",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SharedDirectoryId" => SharedDirectoryId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_ip_routes(cidr_ips, directory_id)
remove_ip_routes(cidr_ips, directory_id, params::Dict{String,<:Any})
Removes IP address blocks from a directory.
# Arguments
- `cidr_ips`: IP address blocks that you want to remove.
- `directory_id`: Identifier (ID) of the directory from which you want to remove the IP
addresses.
"""
function remove_ip_routes(
CidrIps, DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"RemoveIpRoutes",
Dict{String,Any}("CidrIps" => CidrIps, "DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_ip_routes(
CidrIps,
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"RemoveIpRoutes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CidrIps" => CidrIps, "DirectoryId" => DirectoryId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_region(directory_id)
remove_region(directory_id, params::Dict{String,<:Any})
Stops all replication and removes the domain controllers from the specified Region. You
cannot remove the primary Region with this operation. Instead, use the DeleteDirectory API.
# Arguments
- `directory_id`: The identifier of the directory for which you want to remove Region
replication.
"""
function remove_region(DirectoryId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"RemoveRegion",
Dict{String,Any}("DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_region(
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"RemoveRegion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DirectoryId" => DirectoryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags_from_resource(resource_id, tag_keys)
remove_tags_from_resource(resource_id, tag_keys, params::Dict{String,<:Any})
Removes tags from a directory.
# Arguments
- `resource_id`: Identifier (ID) of the directory from which to remove the tag.
- `tag_keys`: The tag key (name) of the tag to be removed.
"""
function remove_tags_from_resource(
ResourceId, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"RemoveTagsFromResource",
Dict{String,Any}("ResourceId" => ResourceId, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags_from_resource(
ResourceId,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"RemoveTagsFromResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceId" => ResourceId, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_user_password(directory_id, new_password, user_name)
reset_user_password(directory_id, new_password, user_name, params::Dict{String,<:Any})
Resets the password for any user in your Managed Microsoft AD or Simple AD directory. You
can reset the password for any user in your directory with the following exceptions: For
Simple AD, you cannot reset the password for any user that is a member of either the Domain
Admins or Enterprise Admins group except for the administrator user. For Managed
Microsoft AD, you can only reset the password for a user that is in an OU based off of the
NetBIOS name that you typed when you created your directory. For example, you cannot reset
the password for a user in the Amazon Web Services Reserved OU. For more information about
the OU structure for an Managed Microsoft AD directory, see What Gets Created in the
Directory Service Administration Guide.
# Arguments
- `directory_id`: Identifier of the Managed Microsoft AD or Simple AD directory in which
the user resides.
- `new_password`: The new password that will be reset.
- `user_name`: The user name of the user whose password will be reset.
"""
function reset_user_password(
DirectoryId, NewPassword, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"ResetUserPassword",
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"NewPassword" => NewPassword,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_user_password(
DirectoryId,
NewPassword,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"ResetUserPassword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"NewPassword" => NewPassword,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_from_snapshot(snapshot_id)
restore_from_snapshot(snapshot_id, params::Dict{String,<:Any})
Restores a directory using an existing directory snapshot. When you restore a directory
from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the
progress of the restore operation by calling the DescribeDirectories operation with the
directory identifier. When the DirectoryDescription.Stage value changes to Active, the
restore operation is complete.
# Arguments
- `snapshot_id`: The identifier of the snapshot to restore from.
"""
function restore_from_snapshot(
SnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"RestoreFromSnapshot",
Dict{String,Any}("SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_from_snapshot(
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"RestoreFromSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotId" => SnapshotId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
share_directory(directory_id, share_method, share_target)
share_directory(directory_id, share_method, share_target, params::Dict{String,<:Any})
Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory
owner) with another Amazon Web Services account (directory consumer). With this operation
you can use your directory from any Amazon Web Services account and from any Amazon VPC
within an Amazon Web Services Region. When you share your Managed Microsoft AD directory,
Directory Service creates a shared directory in the directory consumer account. This shared
directory contains the metadata to provide access to the directory within the directory
owner account. The shared directory is visible in all VPCs in the directory consumer
account. The ShareMethod parameter determines whether the specified directory can be shared
between Amazon Web Services accounts inside the same Amazon Web Services organization
(ORGANIZATIONS). It also determines whether you can share the directory with any other
Amazon Web Services account either inside or outside of the organization (HANDSHAKE). The
ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing
request to the directory consumer.
# Arguments
- `directory_id`: Identifier of the Managed Microsoft AD directory that you want to share
with other Amazon Web Services accounts.
- `share_method`: The method used when sharing a directory to determine whether the
directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or
with any Amazon Web Services account by sending a directory sharing request (HANDSHAKE).
- `share_target`: Identifier for the directory consumer account with whom the directory is
to be shared.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ShareNotes"`: A directory share request that is sent by the directory owner to the
directory consumer. The request includes a typed message to help the directory consumer
administrator determine whether to approve or reject the share invitation.
"""
function share_directory(
DirectoryId, ShareMethod, ShareTarget; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"ShareDirectory",
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"ShareMethod" => ShareMethod,
"ShareTarget" => ShareTarget,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function share_directory(
DirectoryId,
ShareMethod,
ShareTarget,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"ShareDirectory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"ShareMethod" => ShareMethod,
"ShareTarget" => ShareTarget,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_schema_extension(create_snapshot_before_schema_extension, description, directory_id, ldif_content)
start_schema_extension(create_snapshot_before_schema_extension, description, directory_id, ldif_content, params::Dict{String,<:Any})
Applies a schema extension to a Microsoft AD directory.
# Arguments
- `create_snapshot_before_schema_extension`: If true, creates a snapshot of the directory
before applying the schema extension.
- `description`: A description of the schema extension.
- `directory_id`: The identifier of the directory for which the schema extension will be
applied to.
- `ldif_content`: The LDIF file represented as a string. To construct the LdifContent
string, precede each line as it would be formatted in an ldif file with n. See the example
request below for more details. The file size can be no larger than 1MB.
"""
function start_schema_extension(
CreateSnapshotBeforeSchemaExtension,
Description,
DirectoryId,
LdifContent;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"StartSchemaExtension",
Dict{String,Any}(
"CreateSnapshotBeforeSchemaExtension" => CreateSnapshotBeforeSchemaExtension,
"Description" => Description,
"DirectoryId" => DirectoryId,
"LdifContent" => LdifContent,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_schema_extension(
CreateSnapshotBeforeSchemaExtension,
Description,
DirectoryId,
LdifContent,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"StartSchemaExtension",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CreateSnapshotBeforeSchemaExtension" =>
CreateSnapshotBeforeSchemaExtension,
"Description" => Description,
"DirectoryId" => DirectoryId,
"LdifContent" => LdifContent,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unshare_directory(directory_id, unshare_target)
unshare_directory(directory_id, unshare_target, params::Dict{String,<:Any})
Stops the directory sharing between the directory owner and consumer accounts.
# Arguments
- `directory_id`: The identifier of the Managed Microsoft AD directory that you want to
stop sharing.
- `unshare_target`: Identifier for the directory consumer account with whom the directory
has to be unshared.
"""
function unshare_directory(
DirectoryId, UnshareTarget; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"UnshareDirectory",
Dict{String,Any}("DirectoryId" => DirectoryId, "UnshareTarget" => UnshareTarget);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unshare_directory(
DirectoryId,
UnshareTarget,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"UnshareDirectory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId, "UnshareTarget" => UnshareTarget
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_conditional_forwarder(directory_id, dns_ip_addrs, remote_domain_name)
update_conditional_forwarder(directory_id, dns_ip_addrs, remote_domain_name, params::Dict{String,<:Any})
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
# Arguments
- `directory_id`: The directory ID of the Amazon Web Services directory for which to update
the conditional forwarder.
- `dns_ip_addrs`: The updated IP addresses of the remote DNS server associated with the
conditional forwarder.
- `remote_domain_name`: The fully qualified domain name (FQDN) of the remote domain with
which you will set up a trust relationship.
"""
function update_conditional_forwarder(
DirectoryId,
DnsIpAddrs,
RemoteDomainName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"UpdateConditionalForwarder",
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"DnsIpAddrs" => DnsIpAddrs,
"RemoteDomainName" => RemoteDomainName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_conditional_forwarder(
DirectoryId,
DnsIpAddrs,
RemoteDomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"UpdateConditionalForwarder",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId,
"DnsIpAddrs" => DnsIpAddrs,
"RemoteDomainName" => RemoteDomainName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_directory_setup(directory_id, update_type)
update_directory_setup(directory_id, update_type, params::Dict{String,<:Any})
Updates the directory for a particular update type.
# Arguments
- `directory_id`: The identifier of the directory on which you want to perform the update.
- `update_type`: The type of update that needs to be performed on the directory. For
example, OS.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreateSnapshotBeforeUpdate"`: The boolean that specifies if a snapshot for the
directory needs to be taken before updating the directory.
- `"OSUpdateSettings"`: The settings for the OS update that needs to be performed on the
directory.
"""
function update_directory_setup(
DirectoryId, UpdateType; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"UpdateDirectorySetup",
Dict{String,Any}("DirectoryId" => DirectoryId, "UpdateType" => UpdateType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_directory_setup(
DirectoryId,
UpdateType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"UpdateDirectorySetup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DirectoryId" => DirectoryId, "UpdateType" => UpdateType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_number_of_domain_controllers(desired_number, directory_id)
update_number_of_domain_controllers(desired_number, directory_id, params::Dict{String,<:Any})
Adds or removes domain controllers to or from the directory. Based on the difference
between current value and new value (provided through this API call), domain controllers
will be added or removed. It may take up to 45 minutes for any new domain controllers to
become fully active once the requested number of domain controllers is updated. During this
time, you cannot make another update request.
# Arguments
- `desired_number`: The number of domain controllers desired in the directory.
- `directory_id`: Identifier of the directory to which the domain controllers will be added
or removed.
"""
function update_number_of_domain_controllers(
DesiredNumber, DirectoryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"UpdateNumberOfDomainControllers",
Dict{String,Any}("DesiredNumber" => DesiredNumber, "DirectoryId" => DirectoryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_number_of_domain_controllers(
DesiredNumber,
DirectoryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"UpdateNumberOfDomainControllers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DesiredNumber" => DesiredNumber, "DirectoryId" => DirectoryId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_radius(directory_id, radius_settings)
update_radius(directory_id, radius_settings, params::Dict{String,<:Any})
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an
AD Connector or Microsoft AD directory.
# Arguments
- `directory_id`: The identifier of the directory for which to update the RADIUS server
information.
- `radius_settings`: A RadiusSettings object that contains information about the RADIUS
server.
"""
function update_radius(
DirectoryId, RadiusSettings; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"UpdateRadius",
Dict{String,Any}("DirectoryId" => DirectoryId, "RadiusSettings" => RadiusSettings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_radius(
DirectoryId,
RadiusSettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"UpdateRadius",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DirectoryId" => DirectoryId, "RadiusSettings" => RadiusSettings
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_settings(directory_id, settings)
update_settings(directory_id, settings, params::Dict{String,<:Any})
Updates the configurable settings for the specified directory.
# Arguments
- `directory_id`: The identifier of the directory for which to update settings.
- `settings`: The list of Setting objects.
"""
function update_settings(
DirectoryId, Settings; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"UpdateSettings",
Dict{String,Any}("DirectoryId" => DirectoryId, "Settings" => Settings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_settings(
DirectoryId,
Settings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return directory_service(
"UpdateSettings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DirectoryId" => DirectoryId, "Settings" => Settings),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_trust(trust_id)
update_trust(trust_id, params::Dict{String,<:Any})
Updates the trust that has been set up between your Managed Microsoft AD directory and an
self-managed Active Directory.
# Arguments
- `trust_id`: Identifier of the trust relationship.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SelectiveAuth"`: Updates selective authentication for the trust.
"""
function update_trust(TrustId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"UpdateTrust",
Dict{String,Any}("TrustId" => TrustId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_trust(
TrustId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"UpdateTrust",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TrustId" => TrustId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
verify_trust(trust_id)
verify_trust(trust_id, params::Dict{String,<:Any})
Directory Service for Microsoft Active Directory allows you to configure and verify trust
relationships. This action verifies a trust relationship between your Managed Microsoft AD
directory and an external domain.
# Arguments
- `trust_id`: The unique Trust ID of the trust relationship to verify.
"""
function verify_trust(TrustId; aws_config::AbstractAWSConfig=global_aws_config())
return directory_service(
"VerifyTrust",
Dict{String,Any}("TrustId" => TrustId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function verify_trust(
TrustId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return directory_service(
"VerifyTrust",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TrustId" => TrustId), 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 | 14783 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: dlm
using AWS.Compat
using AWS.UUIDs
"""
create_lifecycle_policy(description, execution_role_arn, state)
create_lifecycle_policy(description, execution_role_arn, state, params::Dict{String,<:Any})
Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager
supports the following policy types: Custom EBS snapshot policy Custom EBS-backed AMI
policy Cross-account copy event policy Default policy for EBS snapshots Default
policy for EBS-backed AMIs For more information, see Default policies vs custom
policies. If you create a default policy, you can specify the request parameters either in
the request body, or in the PolicyDetails request structure, but not both.
# Arguments
- `description`: A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+ are
supported.
- `execution_role_arn`: The Amazon Resource Name (ARN) of the IAM role used to run the
operations specified by the lifecycle policy.
- `state`: The activation state of the lifecycle policy after creation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CopyTags"`: [Default policies only] Indicates whether the policy should copy tags from
the source resource to the snapshot or AMI. If you do not specify a value, the default is
false. Default: false
- `"CreateInterval"`: [Default policies only] Specifies how often the policy should run
and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do
not specify a value, the default is 1. Default: 1
- `"CrossRegionCopyTargets"`: [Default policies only] Specifies destination Regions for
snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to
create cross-Region copies, omit this parameter.
- `"DefaultPolicy"`: [Default policies only] Specify the type of default policy to create.
To create a default policy for EBS snapshots, that creates snapshots of all volumes in
the Region that do not have recent backups, specify VOLUME. To create a default policy
for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do
not have recent backups, specify INSTANCE.
- `"Exclusions"`: [Default policies only] Specifies exclusion parameters for volumes or
instances for which you do not want to create snapshots or AMIs. The policy will not create
snapshots or AMIs for target resources that match any of the specified exclusion parameters.
- `"ExtendDeletion"`: [Default policies only] Defines the snapshot or AMI retention
behavior for the policy if the source volume or instance is deleted, or if the policy
enters the error, disabled, or deleted state. By default (ExtendDeletion=false): If a
source resource is deleted, Amazon Data Lifecycle Manager will continue to delete
previously created snapshots or AMIs, up to but not including the last one, based on the
specified retention period. If you want Amazon Data Lifecycle Manager to delete all
snapshots or AMIs, including the last one, specify true. If a policy enters the error,
disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and
AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs,
including the last one, if the policy enters one of these states, specify true. If you
enable extended deletion (ExtendDeletion=true), you override both default behaviors
simultaneously. If you do not specify a value, the default is false. Default: false
- `"PolicyDetails"`: The configuration details of the lifecycle policy. If you create a
default policy, you can specify the request parameters either in the request body, or in
the PolicyDetails request structure, but not both.
- `"RetainInterval"`: [Default policies only] Specifies how long the policy should retain
snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days,
but it must be greater than the creation frequency to ensure that the policy retains at
least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.
Default: 7
- `"Tags"`: The tags to apply to the lifecycle policy during creation.
"""
function create_lifecycle_policy(
Description, ExecutionRoleArn, State; aws_config::AbstractAWSConfig=global_aws_config()
)
return dlm(
"POST",
"/policies",
Dict{String,Any}(
"Description" => Description,
"ExecutionRoleArn" => ExecutionRoleArn,
"State" => State,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_lifecycle_policy(
Description,
ExecutionRoleArn,
State,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dlm(
"POST",
"/policies",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Description" => Description,
"ExecutionRoleArn" => ExecutionRoleArn,
"State" => State,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lifecycle_policy(policy_id)
delete_lifecycle_policy(policy_id, params::Dict{String,<:Any})
Deletes the specified lifecycle policy and halts the automated operations that the policy
specified. For more information about deleting a policy, see Delete lifecycle policies.
# Arguments
- `policy_id`: The identifier of the lifecycle policy.
"""
function delete_lifecycle_policy(
policyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dlm(
"DELETE",
"/policies/$(policyId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lifecycle_policy(
policyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dlm(
"DELETE",
"/policies/$(policyId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lifecycle_policies()
get_lifecycle_policies(params::Dict{String,<:Any})
Gets summary information about all or the specified data lifecycle policies. To get
complete information about a policy, use GetLifecyclePolicy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"defaultPolicyType"`: [Default policies only] Specifies the type of default policy to
get. Specify one of the following: VOLUME - To get only the default policy for EBS
snapshots INSTANCE - To get only the default policy for EBS-backed AMIs ALL - To get
all default policies
- `"policyIds"`: The identifiers of the data lifecycle policies.
- `"resourceTypes"`: The resource type.
- `"state"`: The activation state.
- `"tagsToAdd"`: The tags to add to objects created by the policy. Tags are strings in the
format key=value. These user-defined tags are added in addition to the Amazon Web
Services-added lifecycle tags.
- `"targetTags"`: The target tag for a policy. Tags are strings in the format key=value.
"""
function get_lifecycle_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return dlm("GET", "/policies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_lifecycle_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dlm(
"GET", "/policies", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_lifecycle_policy(policy_id)
get_lifecycle_policy(policy_id, params::Dict{String,<:Any})
Gets detailed information about the specified lifecycle policy.
# Arguments
- `policy_id`: The identifier of the lifecycle policy.
"""
function get_lifecycle_policy(policyId; aws_config::AbstractAWSConfig=global_aws_config())
return dlm(
"GET",
"/policies/$(policyId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lifecycle_policy(
policyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dlm(
"GET",
"/policies/$(policyId)",
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 dlm(
"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 dlm(
"GET",
"/tags/$(resourceArn)",
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 the specified tags to the specified resource.
# Arguments
- `tags`: One or more tags.
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
"""
function tag_resource(Tags, resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return dlm(
"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 dlm(
"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 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 dlm(
"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 dlm(
"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_lifecycle_policy(policy_id)
update_lifecycle_policy(policy_id, params::Dict{String,<:Any})
Updates the specified lifecycle policy. For more information about updating a policy, see
Modify lifecycle policies.
# Arguments
- `policy_id`: The identifier of the lifecycle policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CopyTags"`: [Default policies only] Indicates whether the policy should copy tags from
the source resource to the snapshot or AMI.
- `"CreateInterval"`: [Default policies only] Specifies how often the policy should run
and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.
- `"CrossRegionCopyTargets"`: [Default policies only] Specifies destination Regions for
snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to
create cross-Region copies, omit this parameter.
- `"Description"`: A description of the lifecycle policy.
- `"Exclusions"`: [Default policies only] Specifies exclusion parameters for volumes or
instances for which you do not want to create snapshots or AMIs. The policy will not create
snapshots or AMIs for target resources that match any of the specified exclusion parameters.
- `"ExecutionRoleArn"`: The Amazon Resource Name (ARN) of the IAM role used to run the
operations specified by the lifecycle policy.
- `"ExtendDeletion"`: [Default policies only] Defines the snapshot or AMI retention
behavior for the policy if the source volume or instance is deleted, or if the policy
enters the error, disabled, or deleted state. By default (ExtendDeletion=false): If a
source resource is deleted, Amazon Data Lifecycle Manager will continue to delete
previously created snapshots or AMIs, up to but not including the last one, based on the
specified retention period. If you want Amazon Data Lifecycle Manager to delete all
snapshots or AMIs, including the last one, specify true. If a policy enters the error,
disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and
AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs,
including the last one, if the policy enters one of these states, specify true. If you
enable extended deletion (ExtendDeletion=true), you override both default behaviors
simultaneously. Default: false
- `"PolicyDetails"`: The configuration of the lifecycle policy. You cannot update the
policy type or the resource type.
- `"RetainInterval"`: [Default policies only] Specifies how long the policy should retain
snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days,
but it must be greater than the creation frequency to ensure that the policy retains at
least 1 snapshot or AMI at any given time.
- `"State"`: The desired activation state of the lifecycle policy after creation.
"""
function update_lifecycle_policy(
policyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return dlm(
"PATCH",
"/policies/$(policyId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_lifecycle_policy(
policyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dlm(
"PATCH",
"/policies/$(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 | 132324 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: docdb
using AWS.Compat
using AWS.UUIDs
"""
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: If the source type
is an instance, a DBInstanceIdentifier must be provided. If the source type is a security
group, a DBSecurityGroupName must be provided. If the source type is a parameter group, a
DBParameterGroupName must be provided. If the source type is a snapshot, a
DBSnapshotIdentifier must be provided.
- `subscription_name`: The name of the Amazon DocumentDB event notification subscription
that you want to add a source identifier to.
"""
function add_source_identifier_to_subscription(
SourceIdentifier, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 DocumentDB resource. You can use these tags with cost
allocation reporting to track costs that are associated with Amazon DocumentDB resources or
in a Condition statement in an Identity and Access Management (IAM) policy for Amazon
DocumentDB.
# Arguments
- `resource_name`: The Amazon DocumentDB resource that the tags are added to. This value is
an Amazon Resource Name .
- `tag`: The tags to be assigned to the Amazon DocumentDB 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 DocumentDB resource.
"""
function add_tags_to_resource(
ResourceName, Tag; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 an Amazon DocumentDB
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.
"""
function apply_pending_maintenance_action(
ApplyAction,
OptInType,
ResourceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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 cluster parameter group.
# Arguments
- `source_dbcluster_parameter_group_identifier`: The identifier or Amazon Resource Name
(ARN) for the source cluster parameter group. Constraints: Must specify a valid cluster
parameter group. If the source cluster parameter group is in the same Amazon Web Services
Region as the copy, specify a valid parameter group identifier; for example,
my-db-cluster-param-group, or a valid ARN. If the source parameter group is in a
different Amazon Web Services Region than the copy, specify a valid cluster parameter group
ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.
- `target_dbcluster_parameter_group_description`: A description for the copied cluster
parameter group.
- `target_dbcluster_parameter_group_identifier`: The identifier for the copied cluster
parameter group. Constraints: Cannot be null, empty, or blank. Must contain from 1 to
255 letters, numbers, or hyphens. The 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 that are to be assigned to the parameter group.
"""
function copy_dbcluster_parameter_group(
SourceDBClusterParameterGroupIdentifier,
TargetDBClusterParameterGroupDescription,
TargetDBClusterParameterGroupIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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 cluster. To copy a cluster snapshot from a shared manual cluster
snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the
shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted
or not, in the same Amazon Web Services Region. To cancel the copy operation after it is in
progress, delete the target cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
# Arguments
- `source_dbcluster_snapshot_identifier`: The identifier of the cluster snapshot to copy.
This parameter is not case sensitive. Constraints: Must specify a valid system snapshot
in the available state. If the source snapshot is in the same Amazon Web Services Region
as the copy, specify a valid snapshot identifier. If the source snapshot is in a
different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.
Example: my-cluster-snapshot1
- `target_dbcluster_snapshot_identifier`: The identifier of the new cluster snapshot to
create from the source cluster snapshot. This parameter is not case sensitive. 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-cluster-snapshot2
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CopyTags"`: Set to true to copy all tags from the source cluster snapshot to the target
cluster snapshot, and otherwise false. The default is false.
- `"KmsKeyId"`: The KMS key ID for an encrypted 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 cluster snapshot from your Amazon Web Services 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 cluster snapshot is encrypted with
the same KMS key as the source cluster snapshot. If you copy an encrypted cluster snapshot
that is shared from another Amazon Web Services account, then you must specify a value for
KmsKeyId. To copy an encrypted cluster snapshot to another Amazon Web Services Region, set
KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot
in the destination Region. KMS encryption keys are specific to the Amazon Web Services
Region that they are created in, and you can't use encryption keys from one Amazon Web
Services Region in another Amazon Web Services Region. If you copy an unencrypted cluster
snapshot and specify a value for the KmsKeyId parameter, an error is returned.
- `"PreSignedUrl"`: The URL that contains a Signature Version 4 signed request for
theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the
source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a
cluster snapshot from another Amazon Web Services Region. If you are using an Amazon Web
Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI)
instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a
pre-signed URL that is a valid request for the operation that can be executed in the source
Amazon Web Services Region. The presigned URL must be a valid request for the
CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services
Region that contains the cluster snapshot to be copied. The presigned URL request must
contain the following parameter values: SourceRegion - The ID of the region that
contains the snapshot to be copied. SourceDBClusterSnapshotIdentifier - The identifier
for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon
Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you
are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region,
then your SourceDBClusterSnapshotIdentifier looks something like the following:
arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be
created. This parameter isn't case sensitive.
- `"Tags"`: The tags to be assigned to the cluster snapshot.
"""
function copy_dbcluster_snapshot(
SourceDBClusterSnapshotIdentifier,
TargetDBClusterSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"CopyDBClusterSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceDBClusterSnapshotIdentifier" =>
SourceDBClusterSnapshotIdentifier,
"TargetDBClusterSnapshotIdentifier" =>
TargetDBClusterSnapshotIdentifier,
),
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 DocumentDB cluster.
# Arguments
- `dbcluster_identifier`: The cluster identifier. This parameter 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-cluster
- `engine`: The name of the database engine to be used for this cluster. Valid values:
docdb
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZones"`: A list of Amazon EC2 Availability Zones that instances in the
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.
- `"DBClusterParameterGroupName"`: The name of the cluster parameter group to associate
with this cluster.
- `"DBSubnetGroupName"`: A subnet group to associate with this cluster. Constraints: Must
match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
- `"DeletionProtection"`: Specifies whether this cluster can be deleted. If
DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection is disabled. DeletionProtection protects clusters from being
accidentally deleted.
- `"EnableCloudwatchLogsExports"`: A list of log types that need to be enabled for
exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more
information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB
Operations.
- `"EngineVersion"`: The version number of the database engine to use. The --engine-version
will default to the latest major engine version. For production workloads, we recommend
explicitly declaring this parameter with the intended major engine version.
- `"GlobalClusterIdentifier"`: The cluster identifier of the new global cluster.
- `"KmsKeyId"`: The KMS key identifier for an encrypted cluster. The KMS key identifier is
the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster
using the same Amazon Web Services account that owns the KMS encryption key that is used to
encrypt the new cluster, 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 the
StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon
Web Services account has a different default encryption key for each Amazon Web Services
Regions.
- `"MasterUserPassword"`: The password for the master database user. This password can
contain any printable ASCII character except forward slash (/), double quote (\"), or the
\"at\" symbol (@). Constraints: Must contain from 8 to 100 characters.
- `"MasterUsername"`: The name of the master user for the cluster. Constraints: Must be
from 1 to 63 letters or numbers. The first character must be a letter. Cannot be a
reserved word for the chosen database engine.
- `"Port"`: The port number on which the instances in the cluster accept connections.
- `"PreSignedUrl"`: 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 Web Services 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 Web
Services Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu,
Fri, Sat, Sun Constraints: Minimum 30-minute window.
- `"StorageEncrypted"`: Specifies whether the cluster is encrypted.
- `"StorageType"`: The storage type to associate with the DB cluster. For information on
storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the
Amazon DocumentDB Developer Guide. Valid values for storage type - standard | iopt1
Default value is standard When you create a DocumentDB DB 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 be assigned to the cluster.
- `"VpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with this
cluster.
"""
function create_dbcluster(
DBClusterIdentifier, Engine; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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_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 cluster parameter group. Parameters in a cluster parameter group apply to all
of the instances in a cluster. A cluster parameter group is initially created with the
default parameters for the database engine used by instances in the cluster. In Amazon
DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster
parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter
group and you want to modify a value in it, you must first create a new parameter group or
copy an existing parameter group, modify it, and then apply the modified parameter group
to your cluster. For the new cluster parameter group and associated settings to take
effect, you must then reboot the instances in the cluster without failover. For more
information, see Modifying Amazon DocumentDB Cluster Parameter Groups.
# Arguments
- `dbcluster_parameter_group_name`: The name of the cluster parameter group. Constraints:
Must not match the name of an existing DBClusterParameterGroup. This value is stored as
a lowercase string.
- `dbparameter_group_family`: The cluster parameter group family name.
- `description`: The description for the 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 cluster parameter group.
"""
function create_dbcluster_parameter_group(
DBClusterParameterGroupName,
DBParameterGroupFamily,
Description;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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 cluster.
# Arguments
- `dbcluster_identifier`: The identifier of the cluster to create a snapshot for. This
parameter is not case sensitive. Constraints: Must match the identifier of an existing
DBCluster. Example: my-cluster
- `dbcluster_snapshot_identifier`: The identifier of the cluster snapshot. This parameter
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-cluster-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 cluster snapshot.
"""
function create_dbcluster_snapshot(
DBClusterIdentifier,
DBClusterSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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 instance.
# Arguments
- `dbcluster_identifier`: The identifier of the cluster that the instance will belong to.
- `dbinstance_class`: The compute and memory capacity of the instance; for example,
db.r5.large.
- `dbinstance_identifier`: The instance identifier. This parameter 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
- `engine`: The name of the database engine to be used for this instance. Valid value:
docdb
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoMinorVersionUpgrade"`: This parameter does not apply to Amazon DocumentDB. Amazon
DocumentDB does not perform minor version upgrades regardless of the value set. Default:
false
- `"AvailabilityZone"`: The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services
Region. Example: us-east-1d
- `"CACertificateIdentifier"`: The CA certificate identifier to use for the DB instance's
server certificate. For more information, see Updating Your Amazon DocumentDB TLS
Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
- `"CopyTagsToSnapshot"`: A value that indicates whether to copy tags from the DB instance
to snapshots of the DB instance. By default, tags are not copied.
- `"EnablePerformanceInsights"`: A value that indicates whether to enable Performance
Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
- `"PerformanceInsightsKMSKeyId"`: The KMS key identifier for encryption of Performance
Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon
DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web
Services account. Your Amazon Web Services account has a different default KMS key for each
Amazon Web Services region.
- `"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 Web Services 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 Amazon DocumentDB replica
is promoted to the primary instance after a failure of the existing primary instance.
Default: 1 Valid values: 0-15
- `"Tags"`: The tags to be assigned to the instance. You can assign up to 10 tags to an
instance.
"""
function create_dbinstance(
DBClusterIdentifier,
DBInstanceClass,
DBInstanceIdentifier,
Engine;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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_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 subnet group. subnet groups must contain at least one subnet in at least two
Availability Zones in the Amazon Web Services Region.
# Arguments
- `dbsubnet_group_description`: The description for the subnet group.
- `dbsubnet_group_name`: The name for the 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 Amazon EC2 subnet IDs for the subnet group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SubnetIds"`: The Amazon EC2 subnet IDs for the subnet group.
- `"Tags"`: The tags to be assigned to the subnet group.
"""
function create_dbsubnet_group(
DBSubnetGroupDescription,
DBSubnetGroupName,
SubnetIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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 Amazon DocumentDB event notification subscription. This action requires a topic
Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS
console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic
in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType) that you want to be notified of. You can
also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and
you can provide a list of event categories (EventCategories) for events that 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 Amazon DocumentDB sources. If you do not specify
either the SourceType or the SourceIdentifier, you are notified of events generated from
all Amazon DocumentDB sources belonging to your customer account.
# Arguments
- `sns_topic_arn`: The Amazon Resource Name (ARN) of the SNS topic created for event
notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.
- `subscription_name`: The name of the subscription. Constraints: The name must be fewer
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.
- `"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
provided, SourceType must also be provided. If the source type is an instance, a
DBInstanceIdentifier must be provided. If the source type is a security group, a
DBSecurityGroupName must be provided. If the source type is a parameter group, a
DBParameterGroupName must be provided. If the source type is a snapshot, a
DBSnapshotIdentifier must be provided.
- `"SourceType"`: The type of source that is generating the events. For example, if you
want to be notified of events generated by an 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-cluster-snapshot
- `"Tags"`: The tags to be assigned to the event subscription.
"""
function create_event_subscription(
SnsTopicArn, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web
Services Regions. The global cluster contains one primary cluster with read-write
capability, and up-to give read-only secondary clusters. Global clusters uses storage-based
fast replication across regions with latencies less than one second, using dedicated
infrastructure with no impact to your workload’s performance. You can create a global
cluster that is initially empty, and then add a primary and a secondary to it. Or you can
specify an existing cluster during the create operation, and this cluster becomes the
primary of the global cluster. This action only applies to Amazon DocumentDB clusters.
# Arguments
- `global_cluster_identifier`: The cluster identifier of the new global cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatabaseName"`: The name for your database of up to 64 alpha-numeric characters. If you
do not provide a name, Amazon DocumentDB will not create a database in the global cluster
you are creating.
- `"DeletionProtection"`: The deletion protection setting for the new global cluster. The
global cluster can't be deleted when deletion protection is enabled.
- `"Engine"`: The name of the database engine to be used for this cluster.
- `"EngineVersion"`: The engine version of the global cluster.
- `"SourceDBClusterIdentifier"`: The Amazon Resource Name (ARN) to use as the primary
cluster of the global cluster. This parameter is optional.
- `"StorageEncrypted"`: The storage encryption setting for the new global cluster.
"""
function create_global_cluster(
GlobalClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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})
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups
for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the
specified cluster are not deleted.
# Arguments
- `dbcluster_identifier`: The cluster identifier for the 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 cluster snapshot identifier of the new 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 from 1 to 255 letters, numbers, or hyphens. The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
- `"SkipFinalSnapshot"`: Determines whether a final cluster snapshot is created before the
cluster is deleted. If true is specified, no cluster snapshot is created. If false is
specified, a cluster snapshot is created before the DB cluster is deleted. If
SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.
Default: false
"""
function delete_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"DeleteDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
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 cluster parameter group. The cluster parameter group to be deleted
can't be associated with any clusters.
# Arguments
- `dbcluster_parameter_group_name`: The name of the cluster parameter group. Constraints:
Must be the name of an existing cluster parameter group. You can't delete a default
cluster parameter group. Cannot be associated with any clusters.
"""
function delete_dbcluster_parameter_group(
DBClusterParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 cluster snapshot. If the snapshot is being copied, the copy operation is
terminated. The cluster snapshot must be in the available state to be deleted.
# Arguments
- `dbcluster_snapshot_identifier`: The identifier of the cluster snapshot to delete.
Constraints: Must be the name of an existing cluster snapshot in the available state.
"""
function delete_dbcluster_snapshot(
DBClusterSnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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})
Deletes a previously provisioned instance.
# Arguments
- `dbinstance_identifier`: The instance identifier for the instance to be deleted. This
parameter isn't case sensitive. Constraints: Must match the name of an existing instance.
"""
function delete_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"DeleteDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
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 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: 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 docdb(
"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 docdb(
"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 Amazon DocumentDB event notification subscription.
# Arguments
- `subscription_name`: The name of the Amazon DocumentDB event notification subscription
that you want to delete.
"""
function delete_event_subscription(
SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 cluster. The primary and secondary clusters must already be detached or
deleted before attempting to delete a global cluster. This action only applies to Amazon
DocumentDB clusters.
# Arguments
- `global_cluster_identifier`: The cluster identifier of the global cluster being deleted.
"""
function delete_global_cluster(
GlobalClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"DeleteGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GlobalClusterIdentifier" => GlobalClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_certificates()
describe_certificates(params::Dict{String,<:Any})
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for
this Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificateIdentifier"`: The user-supplied certificate identifier. If this parameter is
specified, information for only the specified certificate is returned. If this parameter is
omitted, a list of up to MaxRecords certificates is returned. This parameter is not case
sensitive. Constraints Must match an existing CertificateIdentifier.
- `"Filters"`: This parameter is not currently supported.
- `"Marker"`: An optional pagination token provided by a previous DescribeCertificates
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_certificates(; aws_config::AbstractAWSConfig=global_aws_config())
return docdb(
"DescribeCertificates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"DescribeCertificates",
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 contains only the description of the specified 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 cluster parameter group to return
details for. Constraints: If provided, must match the name of an existing
DBClusterParameterGroup.
- `"Filters"`: This parameter is not currently supported.
- `"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
records exist than the specified MaxRecords value, a pagination token (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 docdb(
"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 docdb(
"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 cluster parameter group.
# Arguments
- `dbcluster_parameter_group_name`: The name of a specific cluster parameter group to
return parameter details for. Constraints: If provided, 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 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 (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 docdb(
"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 docdb(
"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 cluster snapshot attribute names and values for a manual DB cluster
snapshot. When you share snapshots with other Amazon Web Services accounts,
DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the
Amazon Web Services accounts that are authorized to copy or restore the manual cluster
snapshot. If all is included in the list of values for the restore attribute, then the
manual cluster snapshot is public and can be copied or restored by all Amazon Web Services
accounts.
# Arguments
- `dbcluster_snapshot_identifier`: The identifier for the cluster snapshot to describe the
attributes for.
"""
function describe_dbcluster_snapshot_attributes(
DBClusterSnapshotIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 cluster snapshots. This API operation supports pagination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifier"`: The ID of the cluster to retrieve the list of cluster snapshots
for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This
parameter is not case sensitive. Constraints: If provided, must match the identifier of
an existing DBCluster.
- `"DBClusterSnapshotIdentifier"`: A specific cluster snapshot identifier to describe. This
parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a
lowercase string. Constraints: If provided, 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"`: Set to true to include manual cluster snapshots that are public and
can be copied or restored by any Amazon Web Services account, and otherwise false. The
default is false.
- `"IncludeShared"`: Set to true to include shared manual cluster snapshots from other
Amazon Web Services accounts that this Amazon Web Services account has been given
permission to copy or restore, and otherwise false. The default is false.
- `"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
records exist than the specified MaxRecords value, a pagination token (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 cluster snapshots to be returned. You can specify one of
the following values: automated - Return all cluster snapshots that Amazon DocumentDB
has automatically created for your Amazon Web Services account. manual - Return all
cluster snapshots that you have manually created for your Amazon Web Services account.
shared - Return all manual cluster snapshots that have been shared to your Amazon Web
Services account. public - Return all cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual cluster
snapshots are returned. You can include shared cluster snapshots with these results by
setting the IncludeShared parameter to true. You can include public cluster snapshots with
these results by setting theIncludePublic 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 docdb(
"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 docdb(
"DescribeDBClusterSnapshots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbclusters()
describe_dbclusters(params::Dict{String,<:Any})
Returns information about provisioned Amazon DocumentDB clusters. This API operation
supports pagination. For certain management features such as cluster and instance lifecycle
management, Amazon DocumentDB leverages operational technology that is shared with Amazon
RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return
only Amazon DocumentDB clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifier"`: The user-provided cluster identifier. If this parameter is
specified, information from only the specific cluster is returned. This parameter isn't
case sensitive. Constraints: If provided, must match an existing DBClusterIdentifier.
- `"Filters"`: A filter that specifies one or more clusters to describe. Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs).
The results list only includes information about the clusters identified by these ARNs.
- `"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
records exist than the specified MaxRecords value, a pagination token (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 docdb(
"DescribeDBClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbclusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 engines.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBParameterGroupFamily"`: The name of a specific parameter group family to return
details for. Constraints: If provided, 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: 3.6.0
- `"Filters"`: This parameter is 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
records exist than the specified MaxRecords value, a pagination token (marker) is included
in the response so that the remaining results can be retrieved. Default: 100 Constraints:
Minimum 20, maximum 100.
"""
function describe_dbengine_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return docdb(
"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 docdb(
"DescribeDBEngineVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dbinstances()
describe_dbinstances(params::Dict{String,<:Any})
Returns information about provisioned Amazon DocumentDB instances. This API supports
pagination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceIdentifier"`: The user-provided instance identifier. If this parameter is
specified, information from only the specific instance is returned. This parameter isn't
case sensitive. Constraints: If provided, must match the identifier of an existing
DBInstance.
- `"Filters"`: A filter that specifies one or more instances to describe. Supported
filters: db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names
(ARNs). The results list includes only the information about the instances that are
associated with the clusters that are identified by these ARNs. db-instance-id - Accepts
instance identifiers and instance ARNs. The results list includes only the information
about the instances that are identified by these ARNs.
- `"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
records exist than the specified MaxRecords value, a pagination token (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 docdb(
"DescribeDBInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dbinstances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"DescribeDBInstances",
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.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBSubnetGroupName"`: The name of the subnet group to return details for.
- `"Filters"`: This parameter is not currently supported.
- `"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
records exist than the specified MaxRecords value, a pagination token (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 docdb(
"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 docdb(
"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 cluster parameter group family to return the
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 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 (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 docdb(
"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 docdb(
"DescribeEngineDefaultClusterParameters",
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
"""
function describe_event_categories(; aws_config::AbstractAWSConfig=global_aws_config())
return docdb(
"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 docdb(
"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 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 (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 Amazon DocumentDB event notification subscription
that you want to describe.
"""
function describe_event_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return docdb(
"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 docdb(
"DescribeEventSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Returns events related to instances, security groups, snapshots, and DB parameter groups
for the past 14 days. You can obtain events specific to a particular DB instance, security
group, snapshot, or parameter group by providing the name as a parameter. By default, the
events of the past hour 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. Example: 2009-07-08T18:00Z
- `"EventCategories"`: A list of event categories that trigger notifications for an event
notification subscription.
- `"Filters"`: This parameter is not currently supported.
- `"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
records exist than the specified MaxRecords value, a pagination token (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 provided, SourceType must also be provided. If the source type is
DBInstance, a DBInstanceIdentifier must be provided. If the source type is
DBSecurityGroup, a DBSecurityGroupName must be provided. If the source type is
DBParameterGroup, a DBParameterGroupName must be provided. If the source type is
DBSnapshot, a DBSnapshotIdentifier must be provided. 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. Example: 2009-07-08T18:00Z
"""
function describe_events(; aws_config::AbstractAWSConfig=global_aws_config())
return docdb("DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A filter that specifies one or more global DB clusters to describe.
Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource
Names (ARNs). The results list will only include information about the clusters identified
by these ARNs.
- `"GlobalClusterIdentifier"`: The user-supplied cluster identifier. If this parameter is
specified, information from only the specific cluster is returned. This parameter isn't
case-sensitive.
- `"Marker"`: An optional pagination token provided by a previous DescribeGlobalClusters
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 you can retrieve the remaining results.
"""
function describe_global_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return docdb(
"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 docdb(
"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 instance options for the specified engine.
# Arguments
- `engine`: The name of the engine to retrieve instance options for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBInstanceClass"`: The instance class filter value. Specify this parameter to show only
the available offerings that match the specified instance class.
- `"EngineVersion"`: The engine version filter value. Specify this parameter to show only
the available offerings that match 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 that match the specified license model.
- `"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
records exist than the specified MaxRecords value, a pagination token (marker) is included
in the response so that the remaining results can be retrieved. Default: 100 Constraints:
Minimum 20, maximum 100.
- `"Vpc"`: The virtual private cloud (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 docdb(
"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 docdb(
"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, 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 cluster identifiers and cluster
Amazon Resource Names (ARNs). The results list includes only pending maintenance actions
for the clusters identified by these ARNs. db-instance-id - Accepts instance identifiers
and instance ARNs. The results list includes only pending maintenance actions for the DB
instances identified by these ARNs.
- `"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
records exist than the specified MaxRecords value, a pagination token (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 docdb(
"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 docdb(
"DescribePendingMaintenanceActions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
failover_dbcluster()
failover_dbcluster(params::Dict{String,<:Any})
Forces a failover for a cluster. A failover for a cluster promotes one of the Amazon
DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the
cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over
to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to
simulate a failure of a primary instance for testing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBClusterIdentifier"`: A 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 Amazon DocumentDB replica in the
cluster. For example, mydbcluster-replica1.
"""
function failover_dbcluster(; aws_config::AbstractAWSConfig=global_aws_config())
return docdb(
"FailoverDBCluster"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function failover_dbcluster(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"FailoverDBCluster", 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 DocumentDB resource.
# Arguments
- `resource_name`: The Amazon DocumentDB resource with tags to be listed. This value is 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 docdb(
"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 docdb(
"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})
Modifies a setting for an Amazon DocumentDB 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 cluster identifier for the cluster that is 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 major version upgrades are
allowed. Constraints: You must allow major version upgrades when specifying a value for the
EngineVersion parameter that is a different major version than the DB cluster's current
version.
- `"ApplyImmediately"`: A value that specifies whether the changes in this request and any
pending changes are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false,
changes to the cluster are applied during the next maintenance window. The ApplyImmediately
parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set
this parameter value to false, the changes to the NewDBClusterIdentifier and
MasterUserPassword 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 Amazon CloudWatch Logs for a specific instance or cluster. The
EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not
exported) to CloudWatch Logs.
- `"DBClusterParameterGroupName"`: The name of the cluster parameter group to use for the
cluster.
- `"DeletionProtection"`: Specifies whether this cluster can be deleted. If
DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection is disabled. DeletionProtection protects clusters from being
accidentally deleted.
- `"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 ApplyImmediately is enabled. To list all of the available
engine versions for Amazon DocumentDB use the following command: aws docdb
describe-db-engine-versions --engine docdb --query \"DBEngineVersions[].EngineVersion\"
- `"MasterUserPassword"`: The password for the master database user. This password can
contain any printable ASCII character except forward slash (/), double quote (\"), or the
\"at\" symbol (@). Constraints: Must contain from 8 to 100 characters.
- `"NewDBClusterIdentifier"`: The new cluster identifier for the cluster when renaming a
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
- `"Port"`: The port number on which the cluster accepts connections. Constraints: Must be
a value from 1150 to 65535. Default: The same port as the original 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 Web Services 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 Web
Services Region, occurring on a random day of the week. Valid days: Mon, Tue, Wed, Thu,
Fri, Sat, Sun Constraints: Minimum 30-minute window.
- `"StorageType"`: The storage type to associate with the DB cluster. For information on
storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the
Amazon DocumentDB Developer Guide. Valid values for storage type - standard | iopt1
Default value is standard
- `"VpcSecurityGroupIds"`: A list of virtual private cloud (VPC) security groups that the
cluster will belong to.
"""
function modify_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"ModifyDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
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 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 or maintenance window
before the change can take effect. After you create a cluster parameter group, you should
wait at least 5 minutes before creating your first cluster that uses that cluster parameter
group as the default parameter group. This allows Amazon DocumentDB to fully complete the
create action before the parameter group is used as the default for a new cluster. This
step is especially important for parameters that are critical when creating the default
database for a cluster, such as the character set for the default database defined by the
character_set_database parameter.
# Arguments
- `dbcluster_parameter_group_name`: The name of the cluster parameter group to modify.
- `parameter`: A list of parameters in the 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 cluster parameter group to modify.
"""
function modify_dbcluster_parameter_group(
DBClusterParameterGroupName,
Parameter;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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 cluster
snapshot. To share a manual cluster snapshot with other Amazon Web Services accounts,
specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of
IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster
snapshot. Use the value all to make the manual cluster snapshot public, which means that it
can be copied or restored by all Amazon Web Services accounts. Do not add the all value for
any manual cluster snapshots that contain private information that you don't want available
to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be
shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
# Arguments
- `attribute_name`: The name of the cluster snapshot attribute to modify. To manage
authorization for other Amazon Web Services accounts to copy or restore a manual cluster
snapshot, set this value to restore.
- `dbcluster_snapshot_identifier`: The identifier for the 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 cluster snapshot attributes to add to the attribute specified
by AttributeName. To authorize other Amazon Web Services accounts to copy or restore a
manual cluster snapshot, set this list to include one or more Amazon Web Services account
IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set
it to all. Do not add the all value for any manual cluster snapshots that contain private
information that you don't want to be available to all Amazon Web Services accounts.
- `"ValuesToRemove"`: A list of cluster snapshot attributes to remove from the attribute
specified by AttributeName. To remove authorization for other Amazon Web Services accounts
to copy or restore a manual cluster snapshot, set this list to include one or more Amazon
Web Services account identifiers. To remove authorization for any Amazon Web Services
account to copy or restore the cluster snapshot, set it to all . If you specify all, an
Amazon Web Services account whose account ID is explicitly added to the restore attribute
can still copy or restore a manual cluster snapshot.
"""
function modify_dbcluster_snapshot_attribute(
AttributeName,
DBClusterSnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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 an instance. You can change one or more database configuration
parameters by specifying these parameters and the new values in the request.
# Arguments
- `dbinstance_identifier`: The 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:
- `"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 instance. If this parameter is set to false,
changes to the instance are applied during the next maintenance window. Some parameter
changes can cause an outage and are applied on the next reboot. Default: false
- `"AutoMinorVersionUpgrade"`: This parameter does not apply to Amazon DocumentDB. Amazon
DocumentDB does not perform minor version upgrades regardless of the value set.
- `"CACertificateIdentifier"`: Indicates the certificate that needs to be associated with
the instance.
- `"CertificateRotationRestart"`: Specifies whether the DB instance is restarted when you
rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate
your SSL/TLS certificate. The certificate is not updated until the DB instance is
restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB
instance. If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon
DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB
Developer Guide.
- `"CopyTagsToSnapshot"`: A value that indicates whether to copy all tags from the DB
instance to snapshots of the DB instance. By default, tags are not copied.
- `"DBInstanceClass"`: The new compute and memory capacity of the instance; for example,
db.r5.large. Not all instance classes are available in all Amazon Web Services Regions. If
you modify the 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.
- `"EnablePerformanceInsights"`: A value that indicates whether to enable Performance
Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
- `"NewDBInstanceIdentifier"`: The new instance identifier for the instance when renaming
an instance. When you change the instance identifier, an instance reboot occurs immediately
if you set Apply Immediately to true. It occurs during the next maintenance window if you
set 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
- `"PerformanceInsightsKMSKeyId"`: The KMS key identifier for encryption of Performance
Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon
DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web
Services account. Your Amazon Web Services account has a different default KMS key for each
Amazon Web Services region.
- `"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, changing this parameter causes a
reboot of the instance. If you are 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 that 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 an Amazon DocumentDB replica
is promoted to the primary instance after a failure of the existing primary instance.
Default: 1 Valid values: 0-15
"""
function modify_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"ModifyDBInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBInstanceIdentifier" => DBInstanceIdentifier),
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 subnet group. subnet groups must contain at least one subnet in at
least two Availability Zones in the Amazon Web Services Region.
# Arguments
- `dbsubnet_group_name`: The name for the 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 Amazon EC2 subnet IDs for the subnet group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DBSubnetGroupDescription"`: The description for the subnet group.
- `"SubnetIds"`: The Amazon EC2 subnet IDs for the subnet group.
"""
function modify_dbsubnet_group(
DBSubnetGroupName, SubnetIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 Amazon DocumentDB event notification subscription.
# Arguments
- `subscription_name`: The name of the Amazon DocumentDB 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.
- `"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 an instance, 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
"""
function modify_event_subscription(
SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 DocumentDB global cluster. You can change one or more
configuration parameters (for example: deletion protection), or the global cluster
identifier by specifying these parameters and the new values in the request. This action
only applies to Amazon DocumentDB clusters.
# Arguments
- `global_cluster_identifier`: The identifier for the global cluster being modified. This
parameter isn't case-sensitive. Constraints: Must match the identifier of an existing
global cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeletionProtection"`: Indicates if the global cluster has deletion protection enabled.
The global cluster can't be deleted when deletion protection is enabled.
- `"NewGlobalClusterIdentifier"`: The new identifier for a global cluster when you modify a
global cluster. This value is stored as a lowercase string. 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 docdb(
"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 docdb(
"ModifyGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GlobalClusterIdentifier" => GlobalClusterIdentifier),
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 instance, usually for maintenance reasons. For example, if
you make certain changes, or if you change the cluster parameter group that is associated
with the instance, you must reboot the instance for the changes to take effect. Rebooting
an instance restarts the database engine service. Rebooting an instance results in a
momentary outage, during which the instance status is set to rebooting.
# Arguments
- `dbinstance_identifier`: The 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 Multi-AZ failover.
Constraint: You can't specify true if the instance is not configured for Multi-AZ.
"""
function reboot_dbinstance(
DBInstanceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes
a standalone cluster with read-write capability instead of being read-only and receiving
data from a primary in a different region. This action only applies to Amazon DocumentDB
clusters.
# Arguments
- `db_cluster_identifier`: The Amazon Resource Name (ARN) identifying the cluster that was
detached from the Amazon DocumentDB global cluster.
- `global_cluster_identifier`: The cluster identifier to detach from the Amazon DocumentDB
global cluster.
"""
function remove_from_global_cluster(
DbClusterIdentifier,
GlobalClusterIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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_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 Amazon DocumentDB event notification
subscription.
# Arguments
- `source_identifier`: The source identifier to be removed from the subscription, such as
the instance identifier for an instance, or the name of a security group.
- `subscription_name`: The name of the Amazon DocumentDB event notification subscription
that you want to remove a source identifier from.
"""
function remove_source_identifier_from_subscription(
SourceIdentifier, SubscriptionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 DocumentDB resource.
# Arguments
- `resource_name`: The Amazon DocumentDB resource that the tags are removed from. This
value is 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 docdb(
"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 docdb(
"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 cluster parameter group to the default value. To reset
specific parameters, submit a list of the following: ParameterName and ApplyMethod. To
reset the entire cluster parameter group, specify the DBClusterParameterGroupName and
ResetAllParameters parameters. When you reset the entire group, dynamic parameters are
updated immediately and static parameters are set to pending-reboot to take effect on the
next DB instance reboot.
# Arguments
- `dbcluster_parameter_group_name`: The name of the 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 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
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 docdb(
"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 docdb(
"ResetDBClusterParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DBClusterParameterGroupName" => DBClusterParameterGroupName
),
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 cluster from a snapshot or cluster snapshot. If a snapshot is specified, the
target cluster is created from the source DB snapshot with a default configuration and
default security group. If a cluster snapshot is specified, the target cluster is created
from the source cluster restore point with the same configuration as the original source DB
cluster, except that the new cluster is created with the default security group.
# Arguments
- `dbcluster_identifier`: The name of the cluster to create from the snapshot or cluster
snapshot. This parameter isn't case sensitive. 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-snapshot-id
- `engine`: The database engine to use for the new cluster. Default: The same as source.
Constraint: Must be compatible with the engine of the source.
- `snapshot_identifier`: The identifier for the snapshot or cluster snapshot to restore
from. You can use either the name or the Amazon Resource Name (ARN) to specify a cluster
snapshot. However, you can use only the ARN to specify a 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 Amazon EC2 Availability Zones that instances
in the restored DB cluster can be created in.
- `"DBClusterParameterGroupName"`: The name of the DB cluster parameter group to associate
with this DB cluster. Type: String. Required: No. If this argument is omitted,
the default DB cluster parameter group is used. If supplied, must match the name of an
existing default DB cluster parameter group. The string must consist of from 1 to 255
letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a
hyphen or contain two consecutive hyphens.
- `"DBSubnetGroupName"`: The name of the subnet group to use for the new cluster.
Constraints: If provided, must match the name of an existing DBSubnetGroup. Example:
mySubnetgroup
- `"DeletionProtection"`: Specifies whether this cluster can be deleted. If
DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection is disabled. DeletionProtection protects clusters from being
accidentally deleted.
- `"EnableCloudwatchLogsExports"`: A list of log types that must be enabled for exporting
to Amazon CloudWatch Logs.
- `"EngineVersion"`: The version of the database engine to use for the new cluster.
- `"KmsKeyId"`: The KMS key identifier to use when restoring an encrypted cluster from a DB
snapshot or cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for
the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services
account that owns the KMS encryption key used to encrypt the new 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 occurs: If the snapshot or cluster
snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using
the KMS key that was used to encrypt the snapshot or the cluster snapshot. If the
snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored
DB cluster is not encrypted.
- `"Port"`: The port number on which the new cluster accepts connections. Constraints: Must
be a value from 1150 to 65535. Default: The same port as the original cluster.
- `"StorageType"`: The storage type to associate with the DB cluster. For information on
storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the
Amazon DocumentDB Developer Guide. Valid values for storage type - standard | iopt1
Default value is standard
- `"Tags"`: The tags to be assigned to the restored cluster.
- `"VpcSecurityGroupIds"`: A list of virtual private cloud (VPC) security groups that the
new cluster will belong to.
"""
function restore_dbcluster_from_snapshot(
DBClusterIdentifier,
Engine,
SnapshotIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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 cluster to an arbitrary point in time. Users can restore to any point in time
before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is
created from the source cluster with the same configuration as the original cluster, except
that the new cluster is created with the default security group.
# Arguments
- `dbcluster_identifier`: The name of the new cluster to be created. 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.
- `source_dbcluster_identifier`: The identifier of the source 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:
- `"DBSubnetGroupName"`: The subnet group name to use for the new cluster. Constraints: If
provided, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
- `"DeletionProtection"`: Specifies whether this cluster can be deleted. If
DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and
DeletionProtection is disabled. DeletionProtection protects clusters from being
accidentally deleted.
- `"EnableCloudwatchLogsExports"`: A list of log types that must be enabled for exporting
to Amazon CloudWatch Logs.
- `"KmsKeyId"`: The KMS key identifier to use when restoring an encrypted cluster from an
encrypted cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
encryption key. If you are restoring a cluster with the same Amazon Web Services account
that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS
key alias instead of the ARN for the KMS encryption key. You can restore to a new cluster
and encrypt the new cluster with an KMS key that is different from the KMS key used to
encrypt the source 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 occurs: If the cluster is encrypted, then the restored cluster is encrypted
using the KMS key that was used to encrypt the source cluster. If the cluster is not
encrypted, then the restored cluster is not encrypted. If DBClusterIdentifier refers to a
cluster that is not encrypted, then the restore request is rejected.
- `"Port"`: The port number on which the new cluster accepts connections. Constraints: Must
be a value from 1150 to 65535. Default: The default port for the engine.
- `"RestoreToTime"`: The date and time to restore the cluster to. Valid values: A time in
Universal Coordinated Time (UTC) format. Constraints: Must be before the latest
restorable time for the instance. Must be specified if the UseLatestRestorableTime
parameter is not provided. Cannot be specified if the UseLatestRestorableTime parameter
is true. Cannot be specified if the 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. Constraints: You can't specify copy-on-write if the engine version of
the source DB cluster is earlier than 1.11. If you don't specify a RestoreType value, then
the new DB cluster is restored as a full copy of the source DB cluster.
- `"StorageType"`: The storage type to associate with the DB cluster. For information on
storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the
Amazon DocumentDB Developer Guide. Valid values for storage type - standard | iopt1
Default value is standard
- `"Tags"`: The tags to be assigned to the restored cluster.
- `"UseLatestRestorableTime"`: A value that is set to true to restore the cluster to the
latest restorable backup time, and false otherwise. Default: false Constraints: Cannot be
specified if the RestoreToTime parameter is provided.
- `"VpcSecurityGroupIds"`: A list of VPC security groups that the new cluster belongs to.
"""
function restore_dbcluster_to_point_in_time(
DBClusterIdentifier,
SourceDBClusterIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"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 docdb(
"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})
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more
information, see Stopping and Starting an Amazon DocumentDB Cluster.
# Arguments
- `dbcluster_identifier`: The identifier of the cluster to restart. Example:
docdb-2019-05-28-15-24-52
"""
function start_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"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 the running cluster that is specified by DBClusterIdentifier. The cluster must be in
the available state. For more information, see Stopping and Starting an Amazon DocumentDB
Cluster.
# Arguments
- `dbcluster_identifier`: The identifier of the cluster to stop. Example:
docdb-2019-05-28-15-24-52
"""
function stop_dbcluster(
DBClusterIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb(
"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 docdb(
"StopDBCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DBClusterIdentifier" => DBClusterIdentifier),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
switchover_global_cluster(global_cluster_identifier, target_db_cluster_identifier)
switchover_global_cluster(global_cluster_identifier, target_db_cluster_identifier, params::Dict{String,<:Any})
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary
Amazon DocumentDB cluster in the global database cluster.
# Arguments
- `global_cluster_identifier`: The identifier of the Amazon DocumentDB global database
cluster to switch over. The identifier is the unique key assigned by the user when the
cluster is created. In other words, it's the name of the global cluster. This parameter
isn’t case-sensitive. Constraints: Must match the identifier of an existing global
cluster (Amazon DocumentDB global database). Minimum length of 1. Maximum length of 255.
Pattern: [A-Za-z][0-9A-Za-z-:._]*
- `target_db_cluster_identifier`: The identifier of the secondary Amazon DocumentDB cluster
to promote to the new primary for the global database cluster. Use the Amazon Resource Name
(ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web
Services region. Constraints: Must match the identifier of an existing secondary cluster.
Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][0-9A-Za-z-:._]*
"""
function switchover_global_cluster(
GlobalClusterIdentifier,
TargetDbClusterIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"SwitchoverGlobalCluster",
Dict{String,Any}(
"GlobalClusterIdentifier" => GlobalClusterIdentifier,
"TargetDbClusterIdentifier" => TargetDbClusterIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function switchover_global_cluster(
GlobalClusterIdentifier,
TargetDbClusterIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb(
"SwitchoverGlobalCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalClusterIdentifier" => GlobalClusterIdentifier,
"TargetDbClusterIdentifier" => TargetDbClusterIdentifier,
),
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 | 25829 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: docdb_elastic
using AWS.Compat
using AWS.UUIDs
"""
copy_cluster_snapshot(snapshot_arn, target_snapshot_name)
copy_cluster_snapshot(snapshot_arn, target_snapshot_name, params::Dict{String,<:Any})
Copies a snapshot of an elastic cluster.
# Arguments
- `snapshot_arn`: The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.
- `target_snapshot_name`: The identifier of the new elastic cluster snapshot to create from
the source cluster snapshot. This parameter is not case sensitive. 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:
elastic-cluster-snapshot-5
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"copyTags"`: Set to true to copy all tags from the source cluster snapshot to the target
elastic cluster snapshot. The default is false.
- `"kmsKeyId"`: The Amazon Web Services KMS key ID for an encrypted elastic cluster
snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web
Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web
Services KMS encryption key. If you copy an encrypted elastic cluster snapshot from your
Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with
a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for KmsKeyId,
then the copy of the elastic cluster snapshot is encrypted with the same AWS KMS key as the
source elastic cluster snapshot. To copy an encrypted elastic cluster snapshot to another
Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you
want to use to encrypt the copy of the elastic cluster snapshot in the destination region.
Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that
they are created in, and you can't use encryption keys from one Amazon Web Services region
in another Amazon Web Services region. If you copy an unencrypted elastic cluster snapshot
and specify a value for the KmsKeyId parameter, an error is returned.
- `"tags"`: The tags to be assigned to the elastic cluster snapshot.
"""
function copy_cluster_snapshot(
snapshotArn, targetSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb_elastic(
"POST",
"/cluster-snapshot/$(snapshotArn)/copy",
Dict{String,Any}("targetSnapshotName" => targetSnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_cluster_snapshot(
snapshotArn,
targetSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"POST",
"/cluster-snapshot/$(snapshotArn)/copy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("targetSnapshotName" => targetSnapshotName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster(admin_user_name, admin_user_password, auth_type, cluster_name, shard_capacity, shard_count)
create_cluster(admin_user_name, admin_user_password, auth_type, cluster_name, shard_capacity, shard_count, params::Dict{String,<:Any})
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
# Arguments
- `admin_user_name`: The name of the Amazon DocumentDB elastic clusters administrator.
Constraints: Must be from 1 to 63 letters or numbers. The first character must be a
letter. Cannot be a reserved word.
- `admin_user_password`: The password for the Amazon DocumentDB elastic clusters
administrator. The password can contain any printable ASCII characters. Constraints:
Must contain from 8 to 100 characters. Cannot contain a forward slash (/), double quote
(\"), or the \"at\" symbol (@).
- `auth_type`: The authentication type used to determine where to fetch the password used
for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
- `cluster_name`: The name of the new elastic cluster. This parameter 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-cluster
- `shard_capacity`: The number of vCPUs assigned to each elastic cluster shard. Maximum is
64. Allowed values are 2, 4, 8, 16, 32, 64.
- `shard_count`: The number of shards assigned to the elastic cluster. Maximum is 32.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"backupRetentionPeriod"`: The number of days for which automatic snapshots are retained.
- `"clientToken"`: The client token for the elastic cluster.
- `"kmsKeyId"`: The KMS key identifier to use to encrypt the new elastic cluster. The KMS
key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are
creating a cluster using the same Amazon account that owns this KMS encryption key, you can
use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is
not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your
account. Your account has a different default encryption key for each Amazon Region.
- `"preferredBackupWindow"`: The daily time range during which automated backups are
created if automated backups are enabled, as determined by the backupRetentionPeriod.
- `"preferredMaintenanceWindow"`: The weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: 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. Valid days: Mon, Tue, Wed, Thu,
Fri, Sat, Sun Constraints: Minimum 30-minute window.
- `"shardInstanceCount"`: The number of replica instances applying to all shards in the
elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and
any additional instances are replicas that can be used for reads and to improve
availability.
- `"subnetIds"`: The Amazon EC2 subnet IDs for the new elastic cluster.
- `"tags"`: The tags to be assigned to the new elastic cluster.
- `"vpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with the new
elastic cluster.
"""
function create_cluster(
adminUserName,
adminUserPassword,
authType,
clusterName,
shardCapacity,
shardCount;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"POST",
"/cluster",
Dict{String,Any}(
"adminUserName" => adminUserName,
"adminUserPassword" => adminUserPassword,
"authType" => authType,
"clusterName" => clusterName,
"shardCapacity" => shardCapacity,
"shardCount" => shardCount,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster(
adminUserName,
adminUserPassword,
authType,
clusterName,
shardCapacity,
shardCount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"POST",
"/cluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"adminUserName" => adminUserName,
"adminUserPassword" => adminUserPassword,
"authType" => authType,
"clusterName" => clusterName,
"shardCapacity" => shardCapacity,
"shardCount" => shardCount,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster_snapshot(cluster_arn, snapshot_name)
create_cluster_snapshot(cluster_arn, snapshot_name, params::Dict{String,<:Any})
Creates a snapshot of an elastic cluster.
# Arguments
- `cluster_arn`: The ARN identifier of the elastic cluster of which you want to create a
snapshot.
- `snapshot_name`: The name of the new elastic cluster snapshot.
# 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 elastic cluster snapshot.
"""
function create_cluster_snapshot(
clusterArn, snapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb_elastic(
"POST",
"/cluster-snapshot",
Dict{String,Any}("clusterArn" => clusterArn, "snapshotName" => snapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster_snapshot(
clusterArn,
snapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"POST",
"/cluster-snapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clusterArn" => clusterArn, "snapshotName" => snapshotName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster(cluster_arn)
delete_cluster(cluster_arn, params::Dict{String,<:Any})
Delete an elastic cluster.
# Arguments
- `cluster_arn`: The ARN identifier of the elastic cluster that is to be deleted.
"""
function delete_cluster(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return docdb_elastic(
"DELETE",
"/cluster/$(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 docdb_elastic(
"DELETE",
"/cluster/$(clusterArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster_snapshot(snapshot_arn)
delete_cluster_snapshot(snapshot_arn, params::Dict{String,<:Any})
Delete an elastic cluster snapshot.
# Arguments
- `snapshot_arn`: The ARN identifier of the elastic cluster snapshot that is to be deleted.
"""
function delete_cluster_snapshot(
snapshotArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb_elastic(
"DELETE",
"/cluster-snapshot/$(snapshotArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster_snapshot(
snapshotArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"DELETE",
"/cluster-snapshot/$(snapshotArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cluster(cluster_arn)
get_cluster(cluster_arn, params::Dict{String,<:Any})
Returns information about a specific elastic cluster.
# Arguments
- `cluster_arn`: The ARN identifier of the elastic cluster.
"""
function get_cluster(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return docdb_elastic(
"GET",
"/cluster/$(clusterArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cluster(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"GET",
"/cluster/$(clusterArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cluster_snapshot(snapshot_arn)
get_cluster_snapshot(snapshot_arn, params::Dict{String,<:Any})
Returns information about a specific elastic cluster snapshot
# Arguments
- `snapshot_arn`: The ARN identifier of the elastic cluster snapshot.
"""
function get_cluster_snapshot(
snapshotArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb_elastic(
"GET",
"/cluster-snapshot/$(snapshotArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cluster_snapshot(
snapshotArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"GET",
"/cluster-snapshot/$(snapshotArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cluster_snapshots()
list_cluster_snapshots(params::Dict{String,<:Any})
Returns information about snapshots for a specified elastic cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clusterArn"`: The ARN identifier of the elastic cluster.
- `"maxResults"`: The maximum number of elastic cluster snapshot results to receive in the
response.
- `"nextToken"`: A pagination token provided by a previous request. If this parameter is
specified, the response includes only records beyond this token, up to the value specified
by max-results. If there is no more data in the responce, the nextToken will not be
returned.
- `"snapshotType"`: The type of cluster snapshots to be returned. You can specify one of
the following values: automated - Return all cluster snapshots that Amazon DocumentDB
has automatically created for your Amazon Web Services account. manual - Return all
cluster snapshots that you have manually created for your Amazon Web Services account.
"""
function list_cluster_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return docdb_elastic(
"GET", "/cluster-snapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_cluster_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb_elastic(
"GET",
"/cluster-snapshots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_clusters()
list_clusters(params::Dict{String,<:Any})
Returns information about provisioned Amazon DocumentDB elastic clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of elastic cluster snapshot results to receive in the
response.
- `"nextToken"`: A pagination token provided by a previous request. If this parameter is
specified, the response includes only records beyond this token, up to the value specified
by max-results. If there is no more data in the responce, the nextToken will not be
returned.
"""
function list_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return docdb_elastic(
"GET", "/clusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb_elastic(
"GET", "/clusters", 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 a elastic cluster resource
# Arguments
- `resource_arn`: The ARN identifier of the elastic cluster resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb_elastic(
"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 docdb_elastic(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_cluster_from_snapshot(cluster_name, snapshot_arn)
restore_cluster_from_snapshot(cluster_name, snapshot_arn, params::Dict{String,<:Any})
Restores an elastic cluster from a snapshot.
# Arguments
- `cluster_name`: The name of the elastic cluster.
- `snapshot_arn`: The ARN identifier of the elastic cluster snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"kmsKeyId"`: The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic
clusters cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
encryption key. If you are creating a cluster using the same Amazon account that owns this
KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption
key. If an encryption key is not specified here, Amazon DocumentDB uses the default
encryption key that KMS creates for your account. Your account has a different default
encryption key for each Amazon Region.
- `"shardCapacity"`: The capacity of each shard in the new restored elastic cluster.
- `"shardInstanceCount"`: The number of replica instances applying to all shards in the
elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and
any additional instances are replicas that can be used for reads and to improve
availability.
- `"subnetIds"`: The Amazon EC2 subnet IDs for the elastic cluster.
- `"tags"`: A list of the tag names to be assigned to the restored elastic cluster, in the
form of an array of key-value pairs in which the key is the tag name and the value is the
key value.
- `"vpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with the elastic
cluster.
"""
function restore_cluster_from_snapshot(
clusterName, snapshotArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb_elastic(
"POST",
"/cluster-snapshot/$(snapshotArn)/restore",
Dict{String,Any}("clusterName" => clusterName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_cluster_from_snapshot(
clusterName,
snapshotArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"POST",
"/cluster-snapshot/$(snapshotArn)/restore",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clusterName" => clusterName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_cluster(cluster_arn)
start_cluster(cluster_arn, params::Dict{String,<:Any})
Restarts the stopped elastic cluster that is specified by clusterARN.
# Arguments
- `cluster_arn`: The ARN identifier of the elastic cluster.
"""
function start_cluster(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return docdb_elastic(
"POST",
"/cluster/$(clusterArn)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_cluster(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"POST",
"/cluster/$(clusterArn)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_cluster(cluster_arn)
stop_cluster(cluster_arn, params::Dict{String,<:Any})
Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must
be in the available state.
# Arguments
- `cluster_arn`: The ARN identifier of the elastic cluster.
"""
function stop_cluster(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return docdb_elastic(
"POST",
"/cluster/$(clusterArn)/stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_cluster(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"POST",
"/cluster/$(clusterArn)/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 metadata tags to an elastic cluster resource
# Arguments
- `resource_arn`: The ARN identifier of the elastic cluster resource.
- `tags`: The tags that are assigned to the elastic cluster resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return docdb_elastic(
"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 docdb_elastic(
"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 metadata tags from an elastic cluster resource
# Arguments
- `resource_arn`: The ARN identifier of the elastic cluster resource.
- `tag_keys`: The tag keys to be removed from the elastic cluster resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return docdb_elastic(
"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 docdb_elastic(
"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_cluster(cluster_arn)
update_cluster(cluster_arn, params::Dict{String,<:Any})
Modifies an elastic cluster. This includes updating admin-username/password, upgrading the
API version, and setting up a backup window and maintenance window
# Arguments
- `cluster_arn`: The ARN identifier of the elastic cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"adminUserPassword"`: The password associated with the elastic cluster administrator.
This password can contain any printable ASCII character except forward slash (/), double
quote (\"), or the \"at\" symbol (@). Constraints: Must contain from 8 to 100 characters.
- `"authType"`: The authentication type used to determine where to fetch the password used
for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
- `"backupRetentionPeriod"`: The number of days for which automatic snapshots are retained.
- `"clientToken"`: The client token for the elastic cluster.
- `"preferredBackupWindow"`: The daily time range during which automated backups are
created if automated backups are enabled, as determined by the backupRetentionPeriod.
- `"preferredMaintenanceWindow"`: The weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: 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. Valid days: Mon, Tue, Wed, Thu,
Fri, Sat, Sun Constraints: Minimum 30-minute window.
- `"shardCapacity"`: The number of vCPUs assigned to each elastic cluster shard. Maximum is
64. Allowed values are 2, 4, 8, 16, 32, 64.
- `"shardCount"`: The number of shards assigned to the elastic cluster. Maximum is 32.
- `"shardInstanceCount"`: The number of replica instances applying to all shards in the
elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and
any additional instances are replicas that can be used for reads and to improve
availability.
- `"subnetIds"`: The Amazon EC2 subnet IDs for the elastic cluster.
- `"vpcSecurityGroupIds"`: A list of EC2 VPC security groups to associate with the elastic
cluster.
"""
function update_cluster(clusterArn; aws_config::AbstractAWSConfig=global_aws_config())
return docdb_elastic(
"PUT",
"/cluster/$(clusterArn)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster(
clusterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return docdb_elastic(
"PUT",
"/cluster/$(clusterArn)",
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 | 72332 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: drs
using AWS.Compat
using AWS.UUIDs
"""
associate_source_network_stack(cfn_stack_name, source_network_id)
associate_source_network_stack(cfn_stack_name, source_network_id, params::Dict{String,<:Any})
Associate a Source Network to an existing CloudFormation Stack and modify launch templates
to use this network. Can be used for reverting to previously deployed CloudFormation stacks.
# Arguments
- `cfn_stack_name`: CloudFormation template to associate with a Source Network.
- `source_network_id`: The Source Network ID to associate with CloudFormation template.
"""
function associate_source_network_stack(
cfnStackName, sourceNetworkID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/AssociateSourceNetworkStack",
Dict{String,Any}(
"cfnStackName" => cfnStackName, "sourceNetworkID" => sourceNetworkID
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_source_network_stack(
cfnStackName,
sourceNetworkID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/AssociateSourceNetworkStack",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"cfnStackName" => cfnStackName, "sourceNetworkID" => sourceNetworkID
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_extended_source_server(source_server_arn)
create_extended_source_server(source_server_arn, params::Dict{String,<:Any})
Create an extended source server in the target Account based on the source server in
staging account.
# Arguments
- `source_server_arn`: This defines the ARN of the source server in staging Account based
on which you want to create an extended source server.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A list of tags associated with the extended source server.
"""
function create_extended_source_server(
sourceServerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/CreateExtendedSourceServer",
Dict{String,Any}("sourceServerArn" => sourceServerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_extended_source_server(
sourceServerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/CreateExtendedSourceServer",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("sourceServerArn" => sourceServerArn), 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:
- `"copyPrivateIp"`: Copy private IP.
- `"copyTags"`: Copy tags.
- `"exportBucketArn"`: S3 bucket ARN to export Source Network templates.
- `"launchDisposition"`: Launch disposition.
- `"launchIntoSourceInstance"`: DRS will set the 'launch into instance ID' of any source
server when performing a drill, recovery or failback to the previous region or availability
zone, using the instance ID of the source instance.
- `"licensing"`: Licensing.
- `"postLaunchEnabled"`: Whether we want to activate post-launch actions.
- `"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 drs(
"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 drs(
"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, pit_policy, 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, pit_policy, 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`: Whether to associate the default Elastic Disaster
Recovery Security group with the Replication Configuration Template.
- `bandwidth_throttling`: Configure bandwidth throttling for the outbound data transfer
rate of the Source Server in Mbps.
- `create_public_ip`: Whether to create a Public IP for the Recovery Instance by default.
- `data_plane_routing`: The data plane routing mechanism that will be used for replication.
- `default_large_staging_disk_type`: The Staging Disk EBS volume type to be used during
replication.
- `ebs_encryption`: The type of EBS encryption to be used during replication.
- `pit_policy`: The Point in time (PIT) policy to manage snapshots taken during replication.
- `replication_server_instance_type`: The instance type to be used for the replication
server.
- `replication_servers_security_groups_ids`: The security group IDs that will be used by
the replication server.
- `staging_area_subnet_id`: The subnet to be used by the replication staging area.
- `staging_area_tags`: A set of tags to be associated with all resources created in the
replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
- `use_dedicated_replication_server`: Whether to use a dedicated Replication Server in the
replication staging area.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoReplicateNewDisks"`: Whether to allow the AWS replication agent to automatically
replicate newly added disks.
- `"ebsEncryptionKeyArn"`: The ARN of the EBS encryption key to be used during replication.
- `"tags"`: A set of tags to be associated with the Replication Configuration Template
resource.
"""
function create_replication_configuration_template(
associateDefaultSecurityGroup,
bandwidthThrottling,
createPublicIP,
dataPlaneRouting,
defaultLargeStagingDiskType,
ebsEncryption,
pitPolicy,
replicationServerInstanceType,
replicationServersSecurityGroupsIDs,
stagingAreaSubnetId,
stagingAreaTags,
useDedicatedReplicationServer;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/CreateReplicationConfigurationTemplate",
Dict{String,Any}(
"associateDefaultSecurityGroup" => associateDefaultSecurityGroup,
"bandwidthThrottling" => bandwidthThrottling,
"createPublicIP" => createPublicIP,
"dataPlaneRouting" => dataPlaneRouting,
"defaultLargeStagingDiskType" => defaultLargeStagingDiskType,
"ebsEncryption" => ebsEncryption,
"pitPolicy" => pitPolicy,
"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,
pitPolicy,
replicationServerInstanceType,
replicationServersSecurityGroupsIDs,
stagingAreaSubnetId,
stagingAreaTags,
useDedicatedReplicationServer,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/CreateReplicationConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"associateDefaultSecurityGroup" => associateDefaultSecurityGroup,
"bandwidthThrottling" => bandwidthThrottling,
"createPublicIP" => createPublicIP,
"dataPlaneRouting" => dataPlaneRouting,
"defaultLargeStagingDiskType" => defaultLargeStagingDiskType,
"ebsEncryption" => ebsEncryption,
"pitPolicy" => pitPolicy,
"replicationServerInstanceType" => replicationServerInstanceType,
"replicationServersSecurityGroupsIDs" =>
replicationServersSecurityGroupsIDs,
"stagingAreaSubnetId" => stagingAreaSubnetId,
"stagingAreaTags" => stagingAreaTags,
"useDedicatedReplicationServer" => useDedicatedReplicationServer,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_source_network(origin_account_id, origin_region, vpc_id)
create_source_network(origin_account_id, origin_region, vpc_id, params::Dict{String,<:Any})
Create a new Source Network resource for a provided VPC ID.
# Arguments
- `origin_account_id`: Account containing the VPC to protect.
- `origin_region`: Region containing the VPC to protect.
- `vpc_id`: Which VPC ID to protect.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A set of tags to be associated with the Source Network resource.
"""
function create_source_network(
originAccountID, originRegion, vpcID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/CreateSourceNetwork",
Dict{String,Any}(
"originAccountID" => originAccountID,
"originRegion" => originRegion,
"vpcID" => vpcID,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_source_network(
originAccountID,
originRegion,
vpcID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/CreateSourceNetwork",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"originAccountID" => originAccountID,
"originRegion" => originRegion,
"vpcID" => vpcID,
),
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`: The ID of the Job to be deleted.
"""
function delete_job(jobID; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"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 drs(
"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_action(action_id, resource_id)
delete_launch_action(action_id, resource_id, params::Dict{String,<:Any})
Deletes a resource launch action.
# Arguments
- `action_id`:
- `resource_id`:
"""
function delete_launch_action(
actionId, resourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/DeleteLaunchAction",
Dict{String,Any}("actionId" => actionId, "resourceId" => resourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_launch_action(
actionId,
resourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/DeleteLaunchAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("actionId" => actionId, "resourceId" => resourceId),
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`: The ID of the Launch Configuration Template to be
deleted.
"""
function delete_launch_configuration_template(
launchConfigurationTemplateID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"POST",
"/DeleteLaunchConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"launchConfigurationTemplateID" => launchConfigurationTemplateID
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_recovery_instance(recovery_instance_id)
delete_recovery_instance(recovery_instance_id, params::Dict{String,<:Any})
Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from
Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to
delete it.
# Arguments
- `recovery_instance_id`: The ID of the Recovery Instance to be deleted.
"""
function delete_recovery_instance(
recoveryInstanceID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/DeleteRecoveryInstance",
Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_recovery_instance(
recoveryInstanceID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/DeleteRecoveryInstance",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID), 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`: The ID of the Replication Configuration Template
to be deleted.
"""
function delete_replication_configuration_template(
replicationConfigurationTemplateID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"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_network(source_network_id)
delete_source_network(source_network_id, params::Dict{String,<:Any})
Delete Source Network resource.
# Arguments
- `source_network_id`: ID of the Source Network to delete.
"""
function delete_source_network(
sourceNetworkID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/DeleteSourceNetwork",
Dict{String,Any}("sourceNetworkID" => sourceNetworkID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_source_network(
sourceNetworkID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/DeleteSourceNetwork",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("sourceNetworkID" => sourceNetworkID), 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. The Source Server must be disconnected first.
# Arguments
- `source_server_id`: The ID of the Source Server to be deleted.
"""
function delete_source_server(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"POST",
"/DeleteSourceServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), 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 a detailed Job log with pagination.
# Arguments
- `job_id`: The ID of the Job for which Job log items will be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of Job log items to retrieve.
- `"nextToken"`: The token of the next Job log items to retrieve.
"""
function describe_job_log_items(jobID; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"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 drs(
"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 toDate filters to limit which jobs
are returned. The response is sorted by creationDataTime - latest date first. Jobs are
created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch 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:
- `"filters"`: A set of filters by which to return Jobs.
- `"maxResults"`: Maximum number of Jobs to retrieve.
- `"nextToken"`: The token of the next Job to retrieve.
"""
function describe_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"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 drs(
"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"`: The token of the next Launch Configuration Template to retrieve.
"""
function describe_launch_configuration_templates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"POST",
"/DescribeLaunchConfigurationTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_recovery_instances()
describe_recovery_instances(params::Dict{String,<:Any})
Lists all Recovery Instances or multiple Recovery Instances by ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: A set of filters by which to return Recovery Instances.
- `"maxResults"`: Maximum number of Recovery Instances to retrieve.
- `"nextToken"`: The token of the next Recovery Instance to retrieve.
"""
function describe_recovery_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"POST",
"/DescribeRecoveryInstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_recovery_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/DescribeRecoveryInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_recovery_snapshots(source_server_id)
describe_recovery_snapshots(source_server_id, params::Dict{String,<:Any})
Lists all Recovery Snapshots for a single Source Server.
# Arguments
- `source_server_id`: Filter Recovery Snapshots by Source Server ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: A set of filters by which to return Recovery Snapshots.
- `"maxResults"`: Maximum number of Recovery Snapshots to retrieve.
- `"nextToken"`: The token of the next Recovery Snapshot to retrieve.
- `"order"`: The sorted ordering by which to return Recovery Snapshots.
"""
function describe_recovery_snapshots(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/DescribeRecoverySnapshots",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_recovery_snapshots(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/DescribeRecoverySnapshots",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), 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"`: Maximum number of Replication Configuration Templates to retrieve.
- `"nextToken"`: The token of the next Replication Configuration Template to retrieve.
- `"replicationConfigurationTemplateIDs"`: The IDs of the Replication Configuration
Templates to retrieve. An empty list means all Replication Configuration Templates.
"""
function describe_replication_configuration_templates(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"POST",
"/DescribeReplicationConfigurationTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_source_networks()
describe_source_networks(params::Dict{String,<:Any})
Lists all Source Networks or multiple Source Networks filtered by ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: A set of filters by which to return Source Networks.
- `"maxResults"`: Maximum number of Source Networks to retrieve.
- `"nextToken"`: The token of the next Source Networks to retrieve.
"""
function describe_source_networks(; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"POST",
"/DescribeSourceNetworks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_source_networks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/DescribeSourceNetworks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_source_servers()
describe_source_servers(params::Dict{String,<:Any})
Lists all Source Servers or multiple Source Servers filtered by ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: A set of filters by which to return Source Servers.
- `"maxResults"`: Maximum number of Source Servers to retrieve.
- `"nextToken"`: The token of the next Source Server to retrieve.
"""
function describe_source_servers(; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"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 drs(
"POST",
"/DescribeSourceServers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disconnect_recovery_instance(recovery_instance_id)
disconnect_recovery_instance(recovery_instance_id, params::Dict{String,<:Any})
Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped
immediately. All AWS resources created by Elastic Disaster Recovery for enabling the
replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the
agent on the Recovery Instance has not been prevented from communicating with the Elastic
Disaster Recovery service, then it will receive a command to uninstall itself (within
approximately 10 minutes). The following properties of the Recovery Instance 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
- `recovery_instance_id`: The ID of the Recovery Instance to disconnect.
"""
function disconnect_recovery_instance(
recoveryInstanceID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/DisconnectRecoveryInstance",
Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disconnect_recovery_instance(
recoveryInstanceID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/DisconnectRecoveryInstance",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disconnect_source_server(source_server_id)
disconnect_source_server(source_server_id, params::Dict{String,<:Any})
Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is
stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling
the replication of the Source Server will be terminated / deleted within 90 minutes. You
cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source
Server has not been prevented from communicating with the Elastic Disaster Recovery
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`: The ID of the Source Server to disconnect.
"""
function disconnect_source_server(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/DisconnectSourceServer",
Dict{String,Any}("sourceServerID" => sourceServerID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disconnect_source_server(
sourceServerID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/DisconnectSourceServer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_source_network_cfn_template(source_network_id)
export_source_network_cfn_template(source_network_id, params::Dict{String,<:Any})
Export the Source Network CloudFormation template to an S3 bucket.
# Arguments
- `source_network_id`: The Source Network ID to export its CloudFormation template to an S3
bucket.
"""
function export_source_network_cfn_template(
sourceNetworkID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/ExportSourceNetworkCfnTemplate",
Dict{String,Any}("sourceNetworkID" => sourceNetworkID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_source_network_cfn_template(
sourceNetworkID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/ExportSourceNetworkCfnTemplate",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("sourceNetworkID" => sourceNetworkID), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_failback_replication_configuration(recovery_instance_id)
get_failback_replication_configuration(recovery_instance_id, params::Dict{String,<:Any})
Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
# Arguments
- `recovery_instance_id`: The ID of the Recovery Instance whose failback replication
configuration should be returned.
"""
function get_failback_replication_configuration(
recoveryInstanceID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/GetFailbackReplicationConfiguration",
Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_failback_replication_configuration(
recoveryInstanceID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/GetFailbackReplicationConfiguration",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID), 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})
Gets a LaunchConfiguration, filtered by Source Server IDs.
# Arguments
- `source_server_id`: The ID of the Source Server that we want to retrieve a Launch
Configuration for.
"""
function get_launch_configuration(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"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})
Gets a ReplicationConfiguration, filtered by Source Server ID.
# Arguments
- `source_server_id`: The ID of the Source Serve for this Replication Configuration.r
"""
function get_replication_configuration(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"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 Elastic Disaster Recovery.
"""
function initialize_service(; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"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 drs(
"POST",
"/InitializeService",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_extensible_source_servers(staging_account_id)
list_extensible_source_servers(staging_account_id, params::Dict{String,<:Any})
Returns a list of source servers on a staging account that are extensible, which means
that: a. The source server is not already extended into this Account. b. The source server
on the Account we’re reading from is not an extension of another source server.
# Arguments
- `staging_account_id`: The Id of the staging Account to retrieve extensible source servers
from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of extensible source servers to retrieve.
- `"nextToken"`: The token of the next extensible source server to retrieve.
"""
function list_extensible_source_servers(
stagingAccountID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/ListExtensibleSourceServers",
Dict{String,Any}("stagingAccountID" => stagingAccountID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_extensible_source_servers(
stagingAccountID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/ListExtensibleSourceServers",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("stagingAccountID" => stagingAccountID), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_launch_actions(resource_id)
list_launch_actions(resource_id, params::Dict{String,<:Any})
Lists resource launch actions.
# Arguments
- `resource_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Filters to apply when listing resource launch actions.
- `"maxResults"`: Maximum amount of items to return when listing resource launch actions.
- `"nextToken"`: Next token to use when listing resource launch actions.
"""
function list_launch_actions(resourceId; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"POST",
"/ListLaunchActions",
Dict{String,Any}("resourceId" => resourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_launch_actions(
resourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/ListLaunchActions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceId" => resourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_staging_accounts()
list_staging_accounts(params::Dict{String,<:Any})
Returns an array of staging accounts for existing extended source servers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of staging Accounts to retrieve.
- `"nextToken"`: The token of the next staging Account to retrieve.
"""
function list_staging_accounts(; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"GET",
"/ListStagingAccounts";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_staging_accounts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"GET",
"/ListStagingAccounts",
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 Elastic Disaster Recovery resources.
# Arguments
- `resource_arn`: The ARN of the resource whose tags should be returned.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_launch_action(action_code, action_id, action_version, active, category, description, name, optional, order, resource_id)
put_launch_action(action_code, action_id, action_version, active, category, description, name, optional, order, resource_id, params::Dict{String,<:Any})
Puts a resource launch action.
# Arguments
- `action_code`: Launch action code.
- `action_id`:
- `action_version`:
- `active`: Whether the launch action is active.
- `category`:
- `description`:
- `name`:
- `optional`: Whether the launch will not be marked as failed if this action fails.
- `order`:
- `resource_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parameters"`:
"""
function put_launch_action(
actionCode,
actionId,
actionVersion,
active,
category,
description,
name,
optional,
order,
resourceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/PutLaunchAction",
Dict{String,Any}(
"actionCode" => actionCode,
"actionId" => actionId,
"actionVersion" => actionVersion,
"active" => active,
"category" => category,
"description" => description,
"name" => name,
"optional" => optional,
"order" => order,
"resourceId" => resourceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_launch_action(
actionCode,
actionId,
actionVersion,
active,
category,
description,
name,
optional,
order,
resourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/PutLaunchAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actionCode" => actionCode,
"actionId" => actionId,
"actionVersion" => actionVersion,
"active" => active,
"category" => category,
"description" => description,
"name" => name,
"optional" => optional,
"order" => order,
"resourceId" => resourceId,
),
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})
WARNING: RetryDataReplication is deprecated. Causes the data replication initiation
sequence to begin immediately upon next Handshake for the specified Source Server ID,
regardless of when the previous initiation started. This command will work only if the
Source Server is stalled or is in a DISCONNECTED or STOPPED state.
# Arguments
- `source_server_id`: The ID of the Source Server whose data replication should be retried.
"""
function retry_data_replication(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"POST",
"/RetryDataReplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reverse_replication(recovery_instance_id)
reverse_replication(recovery_instance_id, params::Dict{String,<:Any})
Start replication to origin / target region - applies only to protected instances that
originated in EC2. For recovery instances on target region - starts replication back to
origin region. For failback instances on origin region - starts replication to target
region to re-protect them.
# Arguments
- `recovery_instance_id`: The ID of the Recovery Instance that we want to reverse the
replication for.
"""
function reverse_replication(
recoveryInstanceID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/ReverseReplication",
Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reverse_replication(
recoveryInstanceID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/ReverseReplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_failback_launch(recovery_instance_ids)
start_failback_launch(recovery_instance_ids, params::Dict{String,<:Any})
Initiates a Job for launching the machine that is being failed back to from the specified
Recovery Instance. This will run conversion on the failback client and will reboot your
machine, thus completing the failback process.
# Arguments
- `recovery_instance_ids`: The IDs of the Recovery Instance whose failback launch we want
to request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tags to be associated with the failback launch Job.
"""
function start_failback_launch(
recoveryInstanceIDs; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/StartFailbackLaunch",
Dict{String,Any}("recoveryInstanceIDs" => recoveryInstanceIDs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_failback_launch(
recoveryInstanceIDs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/StartFailbackLaunch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("recoveryInstanceIDs" => recoveryInstanceIDs),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_recovery(source_servers)
start_recovery(source_servers, params::Dict{String,<:Any})
Launches Recovery Instances for the specified Source Servers. For each Source Server you
may choose a point in time snapshot to launch from, or use an on demand snapshot.
# Arguments
- `source_servers`: The Source Servers that we want to start a Recovery Job for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isDrill"`: Whether this Source Server Recovery operation is a drill or not.
- `"tags"`: The tags to be associated with the Recovery Job.
"""
function start_recovery(sourceServers; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"POST",
"/StartRecovery",
Dict{String,Any}("sourceServers" => sourceServers);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_recovery(
sourceServers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/StartRecovery",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServers" => sourceServers), 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 a stopped Source Server. This action would make the Source Server
protected again and restart billing for it.
# Arguments
- `source_server_id`: The ID of the Source Server to start replication for.
"""
function start_replication(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"POST",
"/StartReplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_source_network_recovery(source_networks)
start_source_network_recovery(source_networks, params::Dict{String,<:Any})
Deploy VPC for the specified Source Network and modify launch templates to use this
network. The VPC will be deployed using a dedicated CloudFormation stack.
# Arguments
- `source_networks`: The Source Networks that we want to start a Recovery Job for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deployAsNew"`: Don't update existing CloudFormation Stack, recover the network using a
new stack.
- `"tags"`: The tags to be associated with the Source Network recovery Job.
"""
function start_source_network_recovery(
sourceNetworks; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/StartSourceNetworkRecovery",
Dict{String,Any}("sourceNetworks" => sourceNetworks);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_source_network_recovery(
sourceNetworks,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/StartSourceNetworkRecovery",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceNetworks" => sourceNetworks), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_source_network_replication(source_network_id)
start_source_network_replication(source_network_id, params::Dict{String,<:Any})
Starts replication for a Source Network. This action would make the Source Network
protected.
# Arguments
- `source_network_id`: ID of the Source Network to replicate.
"""
function start_source_network_replication(
sourceNetworkID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/StartSourceNetworkReplication",
Dict{String,Any}("sourceNetworkID" => sourceNetworkID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_source_network_replication(
sourceNetworkID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/StartSourceNetworkReplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("sourceNetworkID" => sourceNetworkID), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_failback(recovery_instance_id)
stop_failback(recovery_instance_id, params::Dict{String,<:Any})
Stops the failback process for a specified Recovery Instance. This changes the Failback
State of the Recovery Instance back to FAILBACK_NOT_STARTED.
# Arguments
- `recovery_instance_id`: The ID of the Recovery Instance we want to stop failback for.
"""
function stop_failback(
recoveryInstanceID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/StopFailback",
Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_failback(
recoveryInstanceID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/StopFailback",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID), 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})
Stops replication for a Source Server. This action would make the Source Server
unprotected, delete its existing snapshots and stop billing for it.
# Arguments
- `source_server_id`: The ID of the Source Server to stop replication for.
"""
function stop_replication(sourceServerID; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"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 drs(
"POST",
"/StopReplication",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("sourceServerID" => sourceServerID), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_source_network_replication(source_network_id)
stop_source_network_replication(source_network_id, params::Dict{String,<:Any})
Stops replication for a Source Network. This action would make the Source Network
unprotected.
# Arguments
- `source_network_id`: ID of the Source Network to stop replication.
"""
function stop_source_network_replication(
sourceNetworkID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/StopSourceNetworkReplication",
Dict{String,Any}("sourceNetworkID" => sourceNetworkID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_source_network_replication(
sourceNetworkID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/StopSourceNetworkReplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("sourceNetworkID" => sourceNetworkID), 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 Elastic Disaster Recovery
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`: ARN of the resource for which tags are to be added or updated.
- `tags`: Array of tags to be added or updated.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return drs(
"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 drs(
"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_recovery_instances(recovery_instance_ids)
terminate_recovery_instances(recovery_instance_ids, params::Dict{String,<:Any})
Initiates a Job for terminating the EC2 resources associated with the specified Recovery
Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery
service.
# Arguments
- `recovery_instance_ids`: The IDs of the Recovery Instances that should be terminated.
"""
function terminate_recovery_instances(
recoveryInstanceIDs; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/TerminateRecoveryInstances",
Dict{String,Any}("recoveryInstanceIDs" => recoveryInstanceIDs);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function terminate_recovery_instances(
recoveryInstanceIDs,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/TerminateRecoveryInstances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("recoveryInstanceIDs" => recoveryInstanceIDs),
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 Elastic Disaster Recovery
resources.
# Arguments
- `resource_arn`: ARN of the resource for which tags are to be removed.
- `tag_keys`: Array of tags to be removed.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"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_failback_replication_configuration(recovery_instance_id)
update_failback_replication_configuration(recovery_instance_id, params::Dict{String,<:Any})
Allows you to update the failback replication configuration of a Recovery Instance by ID.
# Arguments
- `recovery_instance_id`: The ID of the Recovery Instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"bandwidthThrottling"`: Configure bandwidth throttling for the outbound data transfer
rate of the Recovery Instance in Mbps.
- `"name"`: The name of the Failback Replication Configuration.
- `"usePrivateIP"`: Whether to use Private IP for the failback replication of the Recovery
Instance.
"""
function update_failback_replication_configuration(
recoveryInstanceID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"POST",
"/UpdateFailbackReplicationConfiguration",
Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_failback_replication_configuration(
recoveryInstanceID,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return drs(
"POST",
"/UpdateFailbackReplicationConfiguration",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("recoveryInstanceID" => recoveryInstanceID), 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 a LaunchConfiguration by Source Server ID.
# Arguments
- `source_server_id`: The ID of the Source Server that we want to retrieve a Launch
Configuration for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"copyPrivateIp"`: Whether we should copy the Private IP of the Source Server to the
Recovery Instance.
- `"copyTags"`: Whether we want to copy the tags of the Source Server to the EC2 machine of
the Recovery Instance.
- `"launchDisposition"`: The state of the Recovery Instance in EC2 after the recovery
operation.
- `"launchIntoInstanceProperties"`: Launch into existing instance properties.
- `"licensing"`: The licensing configuration to be used for this launch configuration.
- `"name"`: The name of the launch configuration.
- `"postLaunchEnabled"`: Whether we want to enable post-launch actions for the Source
Server.
- `"targetInstanceTypeRightSizingMethod"`: Whether Elastic Disaster Recovery should try to
automatically choose the instance type that best matches the OS, CPU, and RAM of your
Source Server.
"""
function update_launch_configuration(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"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:
- `"copyPrivateIp"`: Copy private IP.
- `"copyTags"`: Copy tags.
- `"exportBucketArn"`: S3 bucket ARN to export Source Network templates.
- `"launchDisposition"`: Launch disposition.
- `"launchIntoSourceInstance"`: DRS will set the 'launch into instance ID' of any source
server when performing a drill, recovery or failback to the previous region or availability
zone, using the instance ID of the source instance.
- `"licensing"`: Licensing.
- `"postLaunchEnabled"`: Whether we want to activate post-launch actions.
- `"targetInstanceTypeRightSizingMethod"`: Target instance type right-sizing method.
"""
function update_launch_configuration_template(
launchConfigurationTemplateID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"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 a ReplicationConfiguration by Source Server ID.
# Arguments
- `source_server_id`: The ID of the Source Server for this Replication Configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"associateDefaultSecurityGroup"`: Whether to associate the default Elastic Disaster
Recovery Security group with the Replication Configuration.
- `"autoReplicateNewDisks"`: Whether to allow the AWS replication agent to automatically
replicate newly added disks.
- `"bandwidthThrottling"`: Configure bandwidth throttling for the outbound data transfer
rate of the Source Server in Mbps.
- `"createPublicIP"`: Whether to create a Public IP for the Recovery Instance by default.
- `"dataPlaneRouting"`: The data plane routing mechanism that will be used for replication.
- `"defaultLargeStagingDiskType"`: The Staging Disk EBS volume type to be used during
replication.
- `"ebsEncryption"`: The type of EBS encryption to be used during replication.
- `"ebsEncryptionKeyArn"`: The ARN of the EBS encryption key to be used during replication.
- `"name"`: The name of the Replication Configuration.
- `"pitPolicy"`: The Point in time (PIT) policy to manage snapshots taken during
replication.
- `"replicatedDisks"`: The configuration of the disks of the Source Server to be replicated.
- `"replicationServerInstanceType"`: The instance type to be used for the replication
server.
- `"replicationServersSecurityGroupsIDs"`: The security group IDs that will be used by the
replication server.
- `"stagingAreaSubnetId"`: The subnet to be used by the replication staging area.
- `"stagingAreaTags"`: A set of tags to be associated with all resources created in the
replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
- `"useDedicatedReplicationServer"`: Whether to use a dedicated Replication Server in the
replication staging area.
"""
function update_replication_configuration(
sourceServerID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"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 a ReplicationConfigurationTemplate by ID.
# Arguments
- `replication_configuration_template_id`: The Replication Configuration Template ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"arn"`: The Replication Configuration Template ARN.
- `"associateDefaultSecurityGroup"`: Whether to associate the default Elastic Disaster
Recovery Security group with the Replication Configuration Template.
- `"autoReplicateNewDisks"`: Whether to allow the AWS replication agent to automatically
replicate newly added disks.
- `"bandwidthThrottling"`: Configure bandwidth throttling for the outbound data transfer
rate of the Source Server in Mbps.
- `"createPublicIP"`: Whether to create a Public IP for the Recovery Instance by default.
- `"dataPlaneRouting"`: The data plane routing mechanism that will be used for replication.
- `"defaultLargeStagingDiskType"`: The Staging Disk EBS volume type to be used during
replication.
- `"ebsEncryption"`: The type of EBS encryption to be used during replication.
- `"ebsEncryptionKeyArn"`: The ARN of the EBS encryption key to be used during replication.
- `"pitPolicy"`: The Point in time (PIT) policy to manage snapshots taken during
replication.
- `"replicationServerInstanceType"`: The instance type to be used for the replication
server.
- `"replicationServersSecurityGroupsIDs"`: The security group IDs that will be used by the
replication server.
- `"stagingAreaSubnetId"`: The subnet to be used by the replication staging area.
- `"stagingAreaTags"`: A set of tags to be associated with all resources created in the
replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
- `"useDedicatedReplicationServer"`: Whether to use a dedicated Replication Server in the
replication staging area.
"""
function update_replication_configuration_template(
replicationConfigurationTemplateID; aws_config::AbstractAWSConfig=global_aws_config()
)
return drs(
"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 drs(
"POST",
"/UpdateReplicationConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"replicationConfigurationTemplateID" =>
replicationConfigurationTemplateID,
),
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 | 178263 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: dynamodb
using AWS.Compat
using AWS.UUIDs
"""
batch_execute_statement(statements)
batch_execute_statement(statements, params::Dict{String,<:Any})
This operation allows you to perform batch reads or writes on data stored in DynamoDB,
using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality
condition on all key attributes. This enforces that each SELECT statement in a batch
returns at most a single item. The entire batch must consist of either read statements or
write statements, you cannot mix both in one batch. A HTTP 200 response does not mean
that all statements in the BatchExecuteStatement succeeded. Error details for individual
statements can be found under the Error field of the BatchStatementResponse for each
statement.
# Arguments
- `statements`: The list of PartiQL statements representing the batch to run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReturnConsumedCapacity"`:
"""
function batch_execute_statement(
Statements; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"BatchExecuteStatement",
Dict{String,Any}("Statements" => Statements);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_execute_statement(
Statements,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"BatchExecuteStatement",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Statements" => Statements), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_item(request_items)
batch_get_item(request_items, params::Dict{String,<:Any})
The BatchGetItem operation returns the attributes of one or more items from one or more
tables. You identify requested items by primary key. A single operation can retrieve up to
16 MB of data, which can contain as many as 100 items. BatchGetItem returns a partial
result if the response size limit is exceeded, the table's provisioned throughput is
exceeded, more than 1MB per partition is requested, or an internal processing failure
occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys.
You can use this value to retry the operation starting with the next item to get. If you
request more than 100 items, BatchGetItem returns a ValidationException with the message
\"Too many items requested for the BatchGetItem call.\" For example, if you ask to
retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items
(so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value
so you can get the next page of results. If desired, your application can include its own
logic to assemble the pages of results into one dataset. If none of the items can be
processed due to insufficient provisioned throughput on all of the tables in the request,
then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the
items is successfully processed, then BatchGetItem completes successfully, while returning
the keys of the unread items in UnprocessedKeys. If DynamoDB returns any unprocessed
items, you should retry the batch operation on those items. However, we strongly recommend
that you use an exponential backoff algorithm. If you retry the batch operation
immediately, the underlying read or write requests can still fail due to throttling on the
individual tables. If you delay the batch operation using exponential backoff, the
individual requests in the batch are much more likely to succeed. For more information, see
Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. By default,
BatchGetItem performs eventually consistent reads on every table in the request. If you
want strongly consistent reads instead, you can set ConsistentRead to true for any or all
tables. In order to minimize response latency, BatchGetItem may retrieve items in parallel.
When designing your application, keep in mind that DynamoDB does not return items in any
particular order. To help parse the response by item, include the primary key values for
the items in your request in the ProjectionExpression parameter. If a requested item does
not exist, it is not returned in the result. Requests for nonexistent items consume the
minimum read capacity units according to the type of read. For more information, see
Working with Tables in the Amazon DynamoDB Developer Guide.
# Arguments
- `request_items`: A map of one or more table names or table ARNs and, for each table, a
map that describes one or more items to retrieve from that table. Each table name or ARN
can be used only once per BatchGetItem request. Each element in the map of items to
retrieve consists of the following: ConsistentRead - If true, a strongly consistent read
is used; if false (the default), an eventually consistent read is used.
ExpressionAttributeNames - One or more substitution tokens for attribute names in the
ProjectionExpression parameter. The following are some use cases for using
ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB
reserved word. To create a placeholder for repeating occurrences of an attribute name in
an expression. To prevent special characters in an attribute name from being
misinterpreted in an expression. Use the # character in an expression to dereference an
attribute name. For example, consider the following attribute name: Percentile The
name of this attribute conflicts with a reserved word, so it cannot be used directly in an
expression. (For the complete list of reserved words, see Reserved Words in the Amazon
DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames: {\"#P\":\"Percentile\"} You could then use this
substitution in an expression, as in this example: #P = :val Tokens that begin with
the : character are expression attribute values, which are placeholders for the actual
value at runtime. For more information about expression attribute names, see Accessing
Item Attributes in the Amazon DynamoDB Developer Guide. Keys - An array of primary key
attribute values that define specific items in the table. For each primary key, you must
provide all of the key attributes. For example, with a simple primary key, you only need to
provide the partition key value. For a composite key, you must provide both the partition
key value and the sort key value. ProjectionExpression - A string that identifies one or
more attributes to retrieve from the table. These attributes can include scalars, sets, or
elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes are returned. If any of the
requested attributes are not found, they do not appear in the result. For more information,
see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. AttributesToGet -
This is a legacy parameter. Use ProjectionExpression instead. For more information, see
AttributesToGet in the Amazon DynamoDB Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReturnConsumedCapacity"`:
"""
function batch_get_item(RequestItems; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"BatchGetItem",
Dict{String,Any}("RequestItems" => RequestItems);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_item(
RequestItems,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"BatchGetItem",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RequestItems" => RequestItems), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_write_item(request_items)
batch_write_item(request_items, params::Dict{String,<:Any})
The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single
call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up
to 25 item put or delete operations. While individual items can be up to 400 KB once
stored, it's important to note that an item's representation might be greater than 400KB
while being sent in DynamoDB's JSON format for the API call. For more details on this
distinction, see Naming Rules and Data Types. BatchWriteItem cannot update items. If you
perform a BatchWriteItem operation on an existing item, that item's values will be
overwritten by the operation and it will appear like it was updated. To update items, we
recommend you use the UpdateItem action. The individual PutItem and DeleteItem operations
specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any
requested operations fail because the table's provisioned throughput is exceeded or an
internal processing failure occurs, the failed operations are returned in the
UnprocessedItems response parameter. You can investigate and optionally resend the
requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check
for unprocessed items and submit a new BatchWriteItem request with those unprocessed items
until all items have been processed. If none of the items can be processed due to
insufficient provisioned throughput on all of the tables in the request, then
BatchWriteItem returns a ProvisionedThroughputExceededException. If DynamoDB returns any
unprocessed items, you should retry the batch operation on those items. However, we
strongly recommend that you use an exponential backoff algorithm. If you retry the batch
operation immediately, the underlying read or write requests can still fail due to
throttling on the individual tables. If you delay the batch operation using exponential
backoff, the individual requests in the batch are much more likely to succeed. For more
information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer
Guide. With BatchWriteItem, you can efficiently write or delete large amounts of data,
such as from Amazon EMR, or copy data from another database into DynamoDB. In order to
improve performance with these large-scale operations, BatchWriteItem does not behave in
the same way as individual PutItem and DeleteItem calls would. For example, you cannot
specify conditions on individual put and delete requests, and BatchWriteItem does not
return deleted items in the response. If you use a programming language that supports
concurrency, you can use threads to write items in parallel. Your application must include
the necessary logic to manage the threads. With languages that don't support threading, you
must update or delete the specified items one at a time. In both situations, BatchWriteItem
performs the specified put and delete operations in parallel, giving you the power of the
thread pool approach without having to introduce complexity into your application. Parallel
processing reduces latency, but each specified put and delete request consumes the same
number of write capacity units whether it is processed in parallel or not. Delete
operations on nonexistent items consume one write capacity unit. If one or more of the
following is true, DynamoDB rejects the entire batch write operation: One or more tables
specified in the BatchWriteItem request does not exist. Primary key attributes specified
on an item in the request do not match those in the corresponding table's primary key
schema. You try to perform multiple operations on the same item in the same
BatchWriteItem request. For example, you cannot put and delete the same item in the same
BatchWriteItem request. Your request contains at least two items with identical hash
and range keys (which essentially is two put operations). There are more than 25
requests in the batch. Any individual item in a batch exceeds 400 KB. The total request
size exceeds 16 MB. Any individual items with keys exceeding the key length limits. For a
partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.
# Arguments
- `request_items`: A map of one or more table names or table ARNs and, for each table, a
list of operations to be performed (DeleteRequest or PutRequest). Each element in the map
consists of the following: DeleteRequest - Perform a DeleteItem operation on the
specified item. The item to be deleted is identified by a Key subelement: Key - A map of
primary key attribute values that uniquely identify the item. Each entry in this map
consists of an attribute name and an attribute value. For each primary key, you must
provide all of the key attributes. For example, with a simple primary key, you only need to
provide a value for the partition key. For a composite primary key, you must provide values
for both the partition key and the sort key. PutRequest - Perform a PutItem operation
on the specified item. The item to be put is identified by an Item subelement: Item - A
map of attributes and their values. Each entry in this map consists of an attribute name
and an attribute value. Attribute values must not be null; string and binary type
attributes must have lengths greater than zero; and set type attributes must not be empty.
Requests that contain empty values are rejected with a ValidationException exception. If
you specify any attributes that are part of an index key, then the data types for those
attributes must match those of the schema in the table's attribute definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReturnConsumedCapacity"`:
- `"ReturnItemCollectionMetrics"`: Determines whether item collection metrics are returned.
If set to SIZE, the response includes statistics about item collections, if any, that were
modified during the operation are returned in the response. If set to NONE (the default),
no statistics are returned.
"""
function batch_write_item(RequestItems; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"BatchWriteItem",
Dict{String,Any}("RequestItems" => RequestItems);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_write_item(
RequestItems,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"BatchWriteItem",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RequestItems" => RequestItems), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_backup(backup_name, table_name)
create_backup(backup_name, table_name, params::Dict{String,<:Any})
Creates a backup for an existing table. Each time you create an on-demand backup, the
entire table data is backed up. There is no limit to the number of on-demand backups that
can be taken. When you create an on-demand backup, a time marker of the request is
cataloged, and the backup is created asynchronously, by applying all changes until the time
of the request to the last full table snapshot. Backup requests are processed
instantaneously and become available for restore within minutes. You can call CreateBackup
at a maximum rate of 50 times per second. All backups in DynamoDB work without consuming
any provisioned throughput on the table. If you submit a backup request on 2018-12-14 at
14:25:00, the backup is guaranteed to contain all data committed to the table up to
14:24:00, and data committed after 14:26:00 will not be. The backup might contain data
modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal
consistency. Along with data, the following are also included on the backups: Global
secondary indexes (GSIs) Local secondary indexes (LSIs) Streams Provisioned read and
write capacity
# Arguments
- `backup_name`: Specified name for the backup.
- `table_name`: The name of the table. You can also provide the Amazon Resource Name (ARN)
of the table in this parameter.
"""
function create_backup(
BackupName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"CreateBackup",
Dict{String,Any}("BackupName" => BackupName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_backup(
BackupName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"CreateBackup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BackupName" => BackupName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_global_table(global_table_name, replication_group)
create_global_table(global_table_name, replication_group, params::Dict{String,<:Any})
Creates a global table from an existing table. A global table creates a replication
relationship between two or more DynamoDB tables with the same table name in the provided
Regions. This documentation is for version 2017.11.29 (Legacy) of global tables, which
should be avoided for new global tables. Customers should use Global Tables version
2019.11.21 (Current) when possible, because it provides greater flexibility, higher
efficiency, and consumes less write capacity than 2017.11.29 (Legacy). To determine which
version you're using, see Determining the global table version you are using. To update
existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current),
see Upgrading global tables. If you want to add a new replica table to a global table,
each of the following conditions must be true: The table must have the same primary key
as all of the other replicas. The table must have the same name as all of the other
replicas. The table must have DynamoDB Streams enabled, with the stream containing both
the new and the old images of the item. None of the replica tables in the global table
can contain any data. If global secondary indexes are specified, then the following
conditions must also be met: The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present). If
local secondary indexes are specified, then the following conditions must also be met:
The local secondary indexes must have the same name. The local secondary indexes must
have the same hash key and sort key (if present). Write capacity settings should be
set consistently across your replica tables and secondary indexes. DynamoDB strongly
recommends enabling auto scaling to manage the write capacity settings for all of your
global tables replicas and indexes. If you prefer to manage write capacity settings
manually, you should provision equal replicated write capacity units to your replica
tables. You should also provision equal replicated write capacity units to matching
secondary indexes across your global table.
# Arguments
- `global_table_name`: The global table name.
- `replication_group`: The Regions where the global table needs to be created.
"""
function create_global_table(
GlobalTableName, ReplicationGroup; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"CreateGlobalTable",
Dict{String,Any}(
"GlobalTableName" => GlobalTableName, "ReplicationGroup" => ReplicationGroup
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_global_table(
GlobalTableName,
ReplicationGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"CreateGlobalTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalTableName" => GlobalTableName,
"ReplicationGroup" => ReplicationGroup,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_table(attribute_definitions, key_schema, table_name)
create_table(attribute_definitions, key_schema, table_name, params::Dict{String,<:Any})
The CreateTable operation adds a new table to your account. In an Amazon Web Services
account, table names must be unique within each Region. That is, you can have two tables
with same name if you create the tables in different Regions. CreateTable is an
asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns
a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the
TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.
You can optionally define secondary indexes on the new table, as part of the CreateTable
operation. If you want to create multiple tables with secondary indexes on them, you must
create the tables sequentially. Only one table with secondary indexes can be in the
CREATING state at any given time. You can use the DescribeTable action to check the table
status.
# Arguments
- `attribute_definitions`: An array of attributes that describe the key schema for the
table and indexes.
- `key_schema`: Specifies the attributes that make up the primary key for a table or an
index. The attributes in KeySchema must also be defined in the AttributeDefinitions array.
For more information, see Data Model in the Amazon DynamoDB Developer Guide. Each
KeySchemaElement in the array is composed of: AttributeName - The name of this key
attribute. KeyType - The role that the key attribute will assume: HASH - partition
key RANGE - sort key The partition key of an item is also known as its hash
attribute. The term \"hash attribute\" derives from the DynamoDB usage of an internal hash
function to evenly distribute data items across partitions, based on their partition key
values. The sort key of an item is also known as its range attribute. The term \"range
attribute\" derives from the way DynamoDB stores items with the same partition key
physically close together, in sorted order by the sort key value. For a simple primary key
(partition key), you must provide exactly one element with a KeyType of HASH. For a
composite primary key (partition key and sort key), you must provide exactly two elements,
in this order: The first element must have a KeyType of HASH, and the second element must
have a KeyType of RANGE. For more information, see Working with Tables in the Amazon
DynamoDB Developer Guide.
- `table_name`: The name of the table to create. You can also provide the Amazon Resource
Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BillingMode"`: Controls how you are charged for read and write throughput and how you
manage capacity. This setting can be changed later. PROVISIONED - We recommend using
PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned
capacity mode. PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable
workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
- `"DeletionProtectionEnabled"`: Indicates whether deletion protection is to be enabled
(true) or disabled (false) on the table.
- `"GlobalSecondaryIndexes"`: One or more global secondary indexes (the maximum is 20) to
be created on the table. Each global secondary index in the array includes the following:
IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index. Projection -
Specifies attributes that are copied (projected) from the table into the index. These are
in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of: ProjectionType - One of the
following: KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes. ALL - All of the table attributes are
projected into the index. NonKeyAttributes - A list of one or more non-key attribute
names that are projected into the secondary index. The total count of attributes provided
in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If
you project the same attribute into two different indexes, this counts as two distinct
attributes when determining the total. ProvisionedThroughput - The provisioned
throughput settings for the global secondary index, consisting of read and write capacity
units.
- `"LocalSecondaryIndexes"`: One or more local secondary indexes (the maximum is 5) to be
created on the table. Each index is scoped to a given partition key value. There is a 10 GB
size limit per partition key value; otherwise, the size of a local secondary index is
unconstrained. Each local secondary index in the array includes the following: IndexName
- The name of the local secondary index. Must be unique only for this table. KeySchema
- Specifies the key schema for the local secondary index. The key schema must begin with
the same partition key as the table. Projection - Specifies attributes that are copied
(projected) from the table into the index. These are in addition to the primary key
attributes and index key attributes, which are automatically projected. Each attribute
specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only
the index and primary keys are projected into the index. INCLUDE - Only the specified
table attributes are projected into the index. The list of projected attributes is in
NonKeyAttributes. ALL - All of the table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into
the secondary index. The total count of attributes provided in NonKeyAttributes, summed
across all of the secondary indexes, must not exceed 100. If you project the same attribute
into two different indexes, this counts as two distinct attributes when determining the
total.
- `"OnDemandThroughput"`: Sets the maximum number of read and write units for the specified
table in on-demand capacity mode. If you use this parameter, you must specify
MaxReadRequestUnits, MaxWriteRequestUnits, or both.
- `"ProvisionedThroughput"`: Represents the provisioned throughput settings for a specified
table or index. The settings can be modified using the UpdateTable operation. If you set
BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as
PAY_PER_REQUEST, you cannot specify this property. For current minimum and maximum
provisioned throughput values, see Service, Account, and Table Quotas in the Amazon
DynamoDB Developer Guide.
- `"ResourcePolicy"`: An Amazon Web Services resource-based policy document in JSON format
that will be attached to the table. When you attach a resource-based policy while creating
a table, the policy application is strongly consistent. The maximum size supported for a
resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the
size of a policy against this limit. For a full list of all considerations that apply for
resource-based policies, see Resource-based policy considerations. You need to specify the
CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with
a resource-based policy.
- `"SSESpecification"`: Represents the settings used to enable server-side encryption.
- `"StreamSpecification"`: The settings for DynamoDB Streams on the table. These settings
consist of: StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true)
or disabled (false). StreamViewType - When an item in the table is modified,
StreamViewType determines what information is written to the table's stream. Valid values
for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified item are
written to the stream. NEW_IMAGE - The entire item, as it appears after it was modified,
is written to the stream. OLD_IMAGE - The entire item, as it appeared before it was
modified, is written to the stream. NEW_AND_OLD_IMAGES - Both the new and the old item
images of the item are written to the stream.
- `"TableClass"`: The table class of the new table. Valid values are STANDARD and
STANDARD_INFREQUENT_ACCESS.
- `"Tags"`: A list of key-value pairs to label the table. For more information, see Tagging
for DynamoDB.
"""
function create_table(
AttributeDefinitions,
KeySchema,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"CreateTable",
Dict{String,Any}(
"AttributeDefinitions" => AttributeDefinitions,
"KeySchema" => KeySchema,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_table(
AttributeDefinitions,
KeySchema,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"CreateTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AttributeDefinitions" => AttributeDefinitions,
"KeySchema" => KeySchema,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_backup(backup_arn)
delete_backup(backup_arn, params::Dict{String,<:Any})
Deletes an existing backup of a table. You can call DeleteBackup at a maximum rate of 10
times per second.
# Arguments
- `backup_arn`: The ARN associated with the backup.
"""
function delete_backup(BackupArn; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"DeleteBackup",
Dict{String,Any}("BackupArn" => BackupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_backup(
BackupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DeleteBackup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BackupArn" => BackupArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_item(key, table_name)
delete_item(key, table_name, params::Dict{String,<:Any})
Deletes a single item in a table by primary key. You can perform a conditional delete
operation that deletes the item if it exists, or if it has an expected attribute value. In
addition to deleting an item, you can also return the item's attribute values in the same
operation, using the ReturnValues parameter. Unless you specify conditions, the DeleteItem
is an idempotent operation; running it multiple times on the same item or attribute does
not result in an error response. Conditional deletes are useful for deleting items only if
specific conditions are met. If those conditions are met, DynamoDB performs the delete.
Otherwise, the item is not deleted.
# Arguments
- `key`: A map of attribute names to AttributeValue objects, representing the primary key
of the item to delete. For the primary key, you must provide all of the key attributes. For
example, with a simple primary key, you only need to provide a value for the partition key.
For a composite primary key, you must provide values for both the partition key and the
sort key.
- `table_name`: The name of the table from which to delete the item. You can also provide
the Amazon Resource Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConditionExpression"`: A condition that must be satisfied in order for a conditional
DeleteItem to succeed. An expression can contain any of the following: Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive. Comparison operators: = | <> | < | >
| <= | >= | BETWEEN | IN Logical operators: AND | OR | NOT For more
information about condition expressions, see Condition Expressions in the Amazon DynamoDB
Developer Guide.
- `"ConditionalOperator"`: This is a legacy parameter. Use ConditionExpression instead. For
more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
- `"Expected"`: This is a legacy parameter. Use ConditionExpression instead. For more
information, see Expected in the Amazon DynamoDB Developer Guide.
- `"ExpressionAttributeNames"`: One or more substitution tokens for attribute names in an
expression. The following are some use cases for using ExpressionAttributeNames: To
access an attribute whose name conflicts with a DynamoDB reserved word. To create a
placeholder for repeating occurrences of an attribute name in an expression. To prevent
special characters in an attribute name from being misinterpreted in an expression. Use
the # character in an expression to dereference an attribute name. For example, consider
the following attribute name: Percentile The name of this attribute conflicts with a
reserved word, so it cannot be used directly in an expression. (For the complete list of
reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around
this, you could specify the following for ExpressionAttributeNames:
{\"#P\":\"Percentile\"} You could then use this substitution in an expression, as in
this example: #P = :val Tokens that begin with the : character are expression
attribute values, which are placeholders for the actual value at runtime. For more
information on expression attribute names, see Specifying Item Attributes in the Amazon
DynamoDB Developer Guide.
- `"ExpressionAttributeValues"`: One or more values that can be substituted in an
expression. Use the : (colon) character in an expression to dereference an attribute value.
For example, suppose that you wanted to check whether the value of the ProductStatus
attribute was one of the following: Available | Backordered | Discontinued You would
first need to specify ExpressionAttributeValues as follows: {
\":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},
\":disc\":{\"S\":\"Discontinued\"} } You could then use these values in an expression,
such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression
attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
- `"ReturnConsumedCapacity"`:
- `"ReturnItemCollectionMetrics"`: Determines whether item collection metrics are returned.
If set to SIZE, the response includes statistics about item collections, if any, that were
modified during the operation are returned in the response. If set to NONE (the default),
no statistics are returned.
- `"ReturnValues"`: Use ReturnValues if you want to get the item attributes as they
appeared before they were deleted. For DeleteItem, the valid values are: NONE - If
ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This
setting is the default for ReturnValues.) ALL_OLD - The content of the old item is
returned. There is no additional cost associated with requesting a return value aside
from the small network and processing overhead of receiving a larger response. No read
capacity units are consumed. The ReturnValues parameter is used by several DynamoDB
operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.
- `"ReturnValuesOnConditionCheckFailure"`: An optional parameter that returns the item
attributes for a DeleteItem operation that failed a condition check. There is no additional
cost associated with requesting a return value aside from the small network and processing
overhead of receiving a larger response. No read capacity units are consumed.
"""
function delete_item(Key, TableName; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"DeleteItem",
Dict{String,Any}("Key" => Key, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_item(
Key,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DeleteItem",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Key" => Key, "TableName" => TableName), 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-based policy attached to the resource, which can be a table or stream.
DeleteResourcePolicy is an idempotent operation; running it multiple times on the same
resource doesn't result in an error response, unless you specify an ExpectedRevisionId,
which will then return a PolicyNotFoundException. To make sure that you don't
inadvertently lock yourself out of your own resources, the root principal in your Amazon
Web Services account can perform DeleteResourcePolicy requests, even if your resource-based
policy explicitly denies the root principal's access. DeleteResourcePolicy is an
asynchronous operation. If you issue a GetResourcePolicy request immediately after running
the DeleteResourcePolicy request, DynamoDB might still return the deleted policy. This is
because the policy for your resource might not have been deleted yet. Wait for a few
seconds, and then try the GetResourcePolicy request again.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the DynamoDB resource from which the
policy will be removed. The resources you can specify include tables and streams. If you
remove the policy of a table, it will also remove the permissions for the table's indexes
defined in that policy document. This is because index permissions are defined in the
table's policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExpectedRevisionId"`: A string value that you can use to conditionally delete your
policy. When you provide an expected revision ID, if the revision ID of the existing policy
on the resource doesn't match or if there's no policy attached to the resource, the request
will fail and return a PolicyNotFoundException.
"""
function delete_resource_policy(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"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 dynamodb(
"DeleteResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_table(table_name)
delete_table(table_name, params::Dict{String,<:Any})
The DeleteTable operation deletes a table and all of its items. After a DeleteTable
request, the specified table is in the DELETING state until DynamoDB completes the
deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING
or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table
does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the
DELETING state, no error is returned. For global tables, this operation only applies to
global tables using Version 2019.11.21 (Current version). DynamoDB might continue to
accept data read and write operations, such as GetItem and PutItem, on a table in the
DELETING state until the table deletion is complete. When you delete a table, any indexes
on that table are also deleted. If you have DynamoDB Streams enabled on the table, then the
corresponding stream on that table goes into the DISABLED state, and the stream is
automatically deleted after 24 hours. Use the DescribeTable action to check the status of
the table.
# Arguments
- `table_name`: The name of the table to delete. You can also provide the Amazon Resource
Name (ARN) of the table in this parameter.
"""
function delete_table(TableName; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"DeleteTable",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_table(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DeleteTable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_backup(backup_arn)
describe_backup(backup_arn, params::Dict{String,<:Any})
Describes an existing backup of a table. You can call DescribeBackup at a maximum rate of
10 times per second.
# Arguments
- `backup_arn`: The Amazon Resource Name (ARN) associated with the backup.
"""
function describe_backup(BackupArn; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"DescribeBackup",
Dict{String,Any}("BackupArn" => BackupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_backup(
BackupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeBackup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BackupArn" => BackupArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_continuous_backups(table_name)
describe_continuous_backups(table_name, params::Dict{String,<:Any})
Checks the status of continuous backups and point in time recovery on the specified table.
Continuous backups are ENABLED on all tables at table creation. If point in time recovery
is enabled, PointInTimeRecoveryStatus will be set to ENABLED. After continuous backups and
point in time recovery are enabled, you can restore to any point in time within
EarliestRestorableDateTime and LatestRestorableDateTime. LatestRestorableDateTime is
typically 5 minutes before the current time. You can restore your table to any point in
time during the last 35 days. You can call DescribeContinuousBackups at a maximum rate of
10 times per second.
# Arguments
- `table_name`: Name of the table for which the customer wants to check the continuous
backups and point in time recovery settings. You can also provide the Amazon Resource Name
(ARN) of the table in this parameter.
"""
function describe_continuous_backups(
TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"DescribeContinuousBackups",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_continuous_backups(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeContinuousBackups",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_contributor_insights(table_name)
describe_contributor_insights(table_name, params::Dict{String,<:Any})
Returns information about contributor insights for a given table or global secondary index.
# Arguments
- `table_name`: The name of the table to describe. You can also provide the Amazon Resource
Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IndexName"`: The name of the global secondary index to describe, if applicable.
"""
function describe_contributor_insights(
TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"DescribeContributorInsights",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_contributor_insights(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeContributorInsights",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoints()
describe_endpoints(params::Dict{String,<:Any})
Returns the regional endpoint information. For more information on policy permissions,
please see Internetwork traffic privacy.
"""
function describe_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"DescribeEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"DescribeEndpoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_export(export_arn)
describe_export(export_arn, params::Dict{String,<:Any})
Describes an existing table export.
# Arguments
- `export_arn`: The Amazon Resource Name (ARN) associated with the export.
"""
function describe_export(ExportArn; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"DescribeExport",
Dict{String,Any}("ExportArn" => ExportArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_export(
ExportArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeExport",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ExportArn" => ExportArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_global_table(global_table_name)
describe_global_table(global_table_name, params::Dict{String,<:Any})
Returns information about the specified global table. This documentation is for version
2017.11.29 (Legacy) of global tables, which should be avoided for new global tables.
Customers should use Global Tables version 2019.11.21 (Current) when possible, because it
provides greater flexibility, higher efficiency, and consumes less write capacity than
2017.11.29 (Legacy). To determine which version you're using, see Determining the global
table version you are using. To update existing global tables from version 2017.11.29
(Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
# Arguments
- `global_table_name`: The name of the global table.
"""
function describe_global_table(
GlobalTableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"DescribeGlobalTable",
Dict{String,Any}("GlobalTableName" => GlobalTableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_global_table(
GlobalTableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeGlobalTable",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("GlobalTableName" => GlobalTableName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_global_table_settings(global_table_name)
describe_global_table_settings(global_table_name, params::Dict{String,<:Any})
Describes Region-specific settings for a global table. This documentation is for version
2017.11.29 (Legacy) of global tables, which should be avoided for new global tables.
Customers should use Global Tables version 2019.11.21 (Current) when possible, because it
provides greater flexibility, higher efficiency, and consumes less write capacity than
2017.11.29 (Legacy). To determine which version you're using, see Determining the global
table version you are using. To update existing global tables from version 2017.11.29
(Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
# Arguments
- `global_table_name`: The name of the global table to describe.
"""
function describe_global_table_settings(
GlobalTableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"DescribeGlobalTableSettings",
Dict{String,Any}("GlobalTableName" => GlobalTableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_global_table_settings(
GlobalTableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeGlobalTableSettings",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("GlobalTableName" => GlobalTableName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_import(import_arn)
describe_import(import_arn, params::Dict{String,<:Any})
Represents the properties of the import.
# Arguments
- `import_arn`: The Amazon Resource Name (ARN) associated with the table you're importing
to.
"""
function describe_import(ImportArn; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"DescribeImport",
Dict{String,Any}("ImportArn" => ImportArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_import(
ImportArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeImport",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ImportArn" => ImportArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_kinesis_streaming_destination(table_name)
describe_kinesis_streaming_destination(table_name, params::Dict{String,<:Any})
Returns information about the status of Kinesis streaming.
# Arguments
- `table_name`: The name of the table being described. You can also provide the Amazon
Resource Name (ARN) of the table in this parameter.
"""
function describe_kinesis_streaming_destination(
TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"DescribeKinesisStreamingDestination",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_kinesis_streaming_destination(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeKinesisStreamingDestination",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_limits()
describe_limits(params::Dict{String,<:Any})
Returns the current provisioned-capacity quotas for your Amazon Web Services account in a
Region, both for the Region as a whole and for any one DynamoDB table that you create
there. When you establish an Amazon Web Services account, the account has initial quotas on
the maximum read capacity units and write capacity units that you can provision across all
of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when
you create a table there. For more information, see Service, Account, and Table Quotas page
in the Amazon DynamoDB Developer Guide. Although you can increase these quotas by filing a
case at Amazon Web Services Support Center, obtaining the increase is not instantaneous.
The DescribeLimits action lets you write code to compare the capacity you are currently
using to those quotas imposed by your account so that you have enough time to apply for an
increase before you hit a quota. For example, you could use one of the Amazon Web Services
SDKs to do the following: Call DescribeLimits for a particular Region to obtain your
current account quotas on provisioned capacity there. Create a variable to hold the
aggregate read capacity units provisioned for all your tables in that Region, and one to
hold the aggregate write capacity units. Zero them both. Call ListTables to obtain a list
of all your DynamoDB tables. For each table name listed by ListTables, do the following:
Call DescribeTable with the table name. Use the data returned by DescribeTable to add
the read capacity units and write capacity units provisioned for the table itself to your
variables. If the table has one or more global secondary indexes (GSIs), loop over these
GSIs and add their provisioned capacity values to your variables as well. Report the
account quotas for that Region returned by DescribeLimits, along with the total current
provisioned capacity levels you have calculated. This will let you see whether you are
getting close to your account-level quotas. The per-table quotas apply only when you are
creating a new table. They restrict the sum of the provisioned capacity of the new table
itself and all its global secondary indexes. For existing tables and their GSIs, DynamoDB
doesn't let you increase provisioned capacity extremely rapidly, but the only quota that
applies is that the aggregate provisioned capacity over all your tables and GSIs cannot
exceed either of the per-account quotas. DescribeLimits should only be called
periodically. You can expect throttling errors if you call it more than once in a minute.
The DescribeLimits Request element has no content.
"""
function describe_limits(; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"DescribeLimits"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_limits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"DescribeLimits", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_table(table_name)
describe_table(table_name, params::Dict{String,<:Any})
Returns information about the table, including the current status of the table, when it was
created, the primary key schema, and any indexes on the table. For global tables, this
operation only applies to global tables using Version 2019.11.21 (Current version). If
you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might
return a ResourceNotFoundException. This is because DescribeTable uses an eventually
consistent query, and the metadata for your table might not be available at that moment.
Wait for a few seconds, and then try the DescribeTable request again.
# Arguments
- `table_name`: The name of the table to describe. You can also provide the Amazon Resource
Name (ARN) of the table in this parameter.
"""
function describe_table(TableName; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"DescribeTable",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_table(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeTable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_table_replica_auto_scaling(table_name)
describe_table_replica_auto_scaling(table_name, params::Dict{String,<:Any})
Describes auto scaling settings across replicas of the global table at once. For global
tables, this operation only applies to global tables using Version 2019.11.21 (Current
version).
# Arguments
- `table_name`: The name of the table. You can also provide the Amazon Resource Name (ARN)
of the table in this parameter.
"""
function describe_table_replica_auto_scaling(
TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"DescribeTableReplicaAutoScaling",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_table_replica_auto_scaling(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeTableReplicaAutoScaling",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_time_to_live(table_name)
describe_time_to_live(table_name, params::Dict{String,<:Any})
Gives a description of the Time to Live (TTL) status on the specified table.
# Arguments
- `table_name`: The name of the table to be described. You can also provide the Amazon
Resource Name (ARN) of the table in this parameter.
"""
function describe_time_to_live(TableName; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"DescribeTimeToLive",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_time_to_live(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DescribeTimeToLive",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_kinesis_streaming_destination(stream_arn, table_name)
disable_kinesis_streaming_destination(stream_arn, table_name, params::Dict{String,<:Any})
Stops replication from the DynamoDB table to the Kinesis data stream. This is done without
deleting either of the resources.
# Arguments
- `stream_arn`: The ARN for a Kinesis data stream.
- `table_name`: The name of the DynamoDB table. You can also provide the Amazon Resource
Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnableKinesisStreamingConfiguration"`: The source for the Kinesis streaming information
that is being enabled.
"""
function disable_kinesis_streaming_destination(
StreamArn, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"DisableKinesisStreamingDestination",
Dict{String,Any}("StreamArn" => StreamArn, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_kinesis_streaming_destination(
StreamArn,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"DisableKinesisStreamingDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("StreamArn" => StreamArn, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_kinesis_streaming_destination(stream_arn, table_name)
enable_kinesis_streaming_destination(stream_arn, table_name, params::Dict{String,<:Any})
Starts table data replication to the specified Kinesis data stream at a timestamp chosen
during the enable workflow. If this operation doesn't return results immediately, use
DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is
ACTIVE.
# Arguments
- `stream_arn`: The ARN for a Kinesis data stream.
- `table_name`: The name of the DynamoDB table. You can also provide the Amazon Resource
Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnableKinesisStreamingConfiguration"`: The source for the Kinesis streaming information
that is being enabled.
"""
function enable_kinesis_streaming_destination(
StreamArn, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"EnableKinesisStreamingDestination",
Dict{String,Any}("StreamArn" => StreamArn, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_kinesis_streaming_destination(
StreamArn,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"EnableKinesisStreamingDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("StreamArn" => StreamArn, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_statement(statement)
execute_statement(statement, params::Dict{String,<:Any})
This operation allows you to perform reads and singleton writes on data stored in DynamoDB,
using PartiQL. For PartiQL reads (SELECT statement), if the total number of processed items
exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to
the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the
filter criteria in WHERE clause does not match any data, the read will return an empty
result set. A single SELECT statement response can return up to the maximum number of items
(if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering
to the results using WHERE clause). If LastEvaluatedKey is present in the response, you
need to paginate the result set. If NextToken is present, you need to paginate the result
set and include NextToken.
# Arguments
- `statement`: The PartiQL statement representing the operation to run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConsistentRead"`: The consistency of a read operation. If set to true, then a strongly
consistent read is used; otherwise, an eventually consistent read is used.
- `"Limit"`: The maximum number of items to evaluate (not necessarily the number of
matching items). If DynamoDB processes the number of items up to the limit while processing
the results, it stops the operation and returns the matching values up to that point, along
with a key in LastEvaluatedKey to apply in a subsequent operation so you can pick up where
you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this
limit, it stops the operation and returns the matching values up to the limit, and a key in
LastEvaluatedKey to apply in a subsequent operation to continue the operation.
- `"NextToken"`: Set this value to get remaining results, if NextToken was returned in the
statement response.
- `"Parameters"`: The parameters for the PartiQL statement, if any.
- `"ReturnConsumedCapacity"`:
- `"ReturnValuesOnConditionCheckFailure"`: An optional parameter that returns the item
attributes for an ExecuteStatement operation that failed a condition check. There is no
additional cost associated with requesting a return value aside from the small network and
processing overhead of receiving a larger response. No read capacity units are consumed.
"""
function execute_statement(Statement; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"ExecuteStatement",
Dict{String,Any}("Statement" => Statement);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_statement(
Statement,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"ExecuteStatement",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Statement" => Statement), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_transaction(transact_statements)
execute_transaction(transact_statements, params::Dict{String,<:Any})
This operation allows you to perform transactional reads or writes on data stored in
DynamoDB, using PartiQL. The entire transaction must consist of either read statements or
write statements, you cannot mix both in one transaction. The EXISTS function is an
exception and can be used to check the condition of specific attributes of the item in a
similar manner to ConditionCheck in the TransactWriteItems API.
# Arguments
- `transact_statements`: The list of PartiQL statements representing the transaction to run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Set this value to get remaining results, if NextToken was
returned in the statement response.
- `"ReturnConsumedCapacity"`: Determines the level of detail about either provisioned or
on-demand throughput consumption that is returned in the response. For more information,
see TransactGetItems and TransactWriteItems.
"""
function execute_transaction(
TransactStatements; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"ExecuteTransaction",
Dict{String,Any}(
"TransactStatements" => TransactStatements,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_transaction(
TransactStatements,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"ExecuteTransaction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransactStatements" => TransactStatements,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_table_to_point_in_time(s3_bucket, table_arn)
export_table_to_point_in_time(s3_bucket, table_arn, params::Dict{String,<:Any})
Exports table data to an S3 bucket. The table must have point in time recovery enabled, and
you can export data from any time within the point in time recovery window.
# Arguments
- `s3_bucket`: The name of the Amazon S3 bucket to export the snapshot to.
- `table_arn`: The Amazon Resource Name (ARN) associated with the table to export.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Providing a ClientToken makes the call to ExportTableToPointInTimeInput
idempotent, meaning that multiple identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it is completed.
After 8 hours, any request with the same client token is treated as a new request. Do not
resubmit the same request with the same client token for more than 8 hours, or the result
might not be idempotent. If you submit a request with the same client token but a change in
other parameters within the 8-hour idempotency window, DynamoDB returns an
ImportConflictException.
- `"ExportFormat"`: The format for the exported data. Valid values for ExportFormat are
DYNAMODB_JSON or ION.
- `"ExportTime"`: Time in the past from which to export table data, counted in seconds from
the start of the Unix epoch. The table export will be a snapshot of the table's state at
this point in time.
- `"ExportType"`: Choice of whether to execute as a full export or incremental export.
Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If
INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.
- `"IncrementalExportSpecification"`: Optional object containing the parameters specific to
an incremental export.
- `"S3BucketOwner"`: The ID of the Amazon Web Services account that owns the bucket the
export will be stored in. S3BucketOwner is a required parameter when exporting to a S3
bucket in another account.
- `"S3Prefix"`: The Amazon S3 bucket prefix to use as the file name and path of the
exported snapshot.
- `"S3SseAlgorithm"`: Type of encryption used on the bucket where export data will be
stored. Valid values for S3SseAlgorithm are: AES256 - server-side encryption with Amazon
S3 managed keys KMS - server-side encryption with KMS managed keys
- `"S3SseKmsKeyId"`: The ID of the KMS managed key used to encrypt the S3 bucket where
export data will be stored (if applicable).
"""
function export_table_to_point_in_time(
S3Bucket, TableArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"ExportTableToPointInTime",
Dict{String,Any}(
"S3Bucket" => S3Bucket, "TableArn" => TableArn, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_table_to_point_in_time(
S3Bucket,
TableArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"ExportTableToPointInTime",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"S3Bucket" => S3Bucket,
"TableArn" => TableArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_item(key, table_name)
get_item(key, table_name, params::Dict{String,<:Any})
The GetItem operation returns a set of attributes for the item with the given primary key.
If there is no matching item, GetItem does not return any data and there will be no Item
element in the response. GetItem provides an eventually consistent read by default. If
your application requires a strongly consistent read, set ConsistentRead to true. Although
a strongly consistent read might take more time than an eventually consistent read, it
always returns the last updated value.
# Arguments
- `key`: A map of attribute names to AttributeValue objects, representing the primary key
of the item to retrieve. For the primary key, you must provide all of the attributes. For
example, with a simple primary key, you only need to provide a value for the partition key.
For a composite primary key, you must provide values for both the partition key and the
sort key.
- `table_name`: The name of the table containing the requested item. You can also provide
the Amazon Resource Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributesToGet"`: This is a legacy parameter. Use ProjectionExpression instead. For
more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
- `"ConsistentRead"`: Determines the read consistency model: If set to true, then the
operation uses strongly consistent reads; otherwise, the operation uses eventually
consistent reads.
- `"ExpressionAttributeNames"`: One or more substitution tokens for attribute names in an
expression. The following are some use cases for using ExpressionAttributeNames: To
access an attribute whose name conflicts with a DynamoDB reserved word. To create a
placeholder for repeating occurrences of an attribute name in an expression. To prevent
special characters in an attribute name from being misinterpreted in an expression. Use
the # character in an expression to dereference an attribute name. For example, consider
the following attribute name: Percentile The name of this attribute conflicts with a
reserved word, so it cannot be used directly in an expression. (For the complete list of
reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around
this, you could specify the following for ExpressionAttributeNames:
{\"#P\":\"Percentile\"} You could then use this substitution in an expression, as in
this example: #P = :val Tokens that begin with the : character are expression
attribute values, which are placeholders for the actual value at runtime. For more
information on expression attribute names, see Specifying Item Attributes in the Amazon
DynamoDB Developer Guide.
- `"ProjectionExpression"`: A string that identifies one or more attributes to retrieve
from the table. These attributes can include scalars, sets, or elements of a JSON document.
The attributes in the expression must be separated by commas. If no attribute names are
specified, then all attributes are returned. If any of the requested attributes are not
found, they do not appear in the result. For more information, see Specifying Item
Attributes in the Amazon DynamoDB Developer Guide.
- `"ReturnConsumedCapacity"`:
"""
function get_item(Key, TableName; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"GetItem",
Dict{String,Any}("Key" => Key, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_item(
Key,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"GetItem",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Key" => Key, "TableName" => TableName), 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 the resource-based policy document attached to the resource, which can be a table
or stream, in JSON format. GetResourcePolicy follows an eventually consistent model. The
following list describes the outcomes when you issue the GetResourcePolicy request
immediately after issuing another request: If you issue a GetResourcePolicy request
immediately after a PutResourcePolicy request, DynamoDB might return a
PolicyNotFoundException. If you issue a GetResourcePolicyrequest immediately after a
DeleteResourcePolicy request, DynamoDB might return the policy that was present before the
deletion request. If you issue a GetResourcePolicy request immediately after a
CreateTable request, which includes a resource-based policy, DynamoDB might return a
ResourceNotFoundException or a PolicyNotFoundException. Because GetResourcePolicy uses an
eventually consistent query, the metadata for your policy or table might not be available
at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request. After
a GetResourcePolicy request returns a policy created using the PutResourcePolicy request,
the policy will be applied in the authorization of requests to the resource. Because this
process is eventually consistent, it will take some time to apply the policy to all
requests to a resource. Policies that you attach while creating a table using the
CreateTable request will always be applied to all requests for that table.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the DynamoDB resource to which the
policy is attached. The resources you can specify include tables and streams.
"""
function get_resource_policy(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"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 dynamodb(
"GetResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_table(input_format, s3_bucket_source, table_creation_parameters)
import_table(input_format, s3_bucket_source, table_creation_parameters, params::Dict{String,<:Any})
Imports table data from an S3 bucket.
# Arguments
- `input_format`: The format of the source data. Valid values for ImportFormat are CSV,
DYNAMODB_JSON or ION.
- `s3_bucket_source`: The S3 bucket that provides the source for the import.
- `table_creation_parameters`: Parameters for the table to import the data into.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Providing a ClientToken makes the call to ImportTableInput idempotent,
meaning that multiple identical calls have the same effect as one single call. A client
token is valid for 8 hours after the first request that uses it is completed. After 8
hours, any request with the same client token is treated as a new request. Do not resubmit
the same request with the same client token for more than 8 hours, or the result might not
be idempotent. If you submit a request with the same client token but a change in other
parameters within the 8-hour idempotency window, DynamoDB returns an
IdempotentParameterMismatch exception.
- `"InputCompressionType"`: Type of compression to be used on the input coming from the
imported table.
- `"InputFormatOptions"`: Additional properties that specify how the input is formatted,
"""
function import_table(
InputFormat,
S3BucketSource,
TableCreationParameters;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"ImportTable",
Dict{String,Any}(
"InputFormat" => InputFormat,
"S3BucketSource" => S3BucketSource,
"TableCreationParameters" => TableCreationParameters,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_table(
InputFormat,
S3BucketSource,
TableCreationParameters,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"ImportTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InputFormat" => InputFormat,
"S3BucketSource" => S3BucketSource,
"TableCreationParameters" => TableCreationParameters,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_backups()
list_backups(params::Dict{String,<:Any})
List DynamoDB backups that are associated with an Amazon Web Services account and weren't
made with Amazon Web Services Backup. To list these backups for a given table, specify
TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items
in a page. You can also specify a maximum number of entries to be returned in a page. In
the request, start time is inclusive, but end time is exclusive. Note that these boundaries
are for the time at which the original backup was requested. You can call ListBackups a
maximum of five times per second. If you want to retrieve the complete list of backups made
with Amazon Web Services Backup, use the Amazon Web Services Backup list API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BackupType"`: The backups from the table specified by BackupType are listed. Where
BackupType can be: USER - On-demand backup created by you. (The default setting if no
other backup types are specified.) SYSTEM - On-demand backup automatically created by
DynamoDB. ALL - All types of on-demand backups (USER and SYSTEM).
- `"ExclusiveStartBackupArn"`: LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of
the backup last evaluated when the current page of results was returned, inclusive of the
current page of results. This value may be specified as the ExclusiveStartBackupArn of a
new ListBackups operation in order to fetch the next page of results.
- `"Limit"`: Maximum number of backups to return at once.
- `"TableName"`: Lists the backups from the table specified in TableName. You can also
provide the Amazon Resource Name (ARN) of the table in this parameter.
- `"TimeRangeLowerBound"`: Only backups created after this time are listed.
TimeRangeLowerBound is inclusive.
- `"TimeRangeUpperBound"`: Only backups created before this time are listed.
TimeRangeUpperBound is exclusive.
"""
function list_backups(; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb("ListBackups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_backups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"ListBackups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_contributor_insights()
list_contributor_insights(params::Dict{String,<:Any})
Returns a list of ContributorInsightsSummary for a table and all its global secondary
indexes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return per page.
- `"NextToken"`: A token to for the desired page, if there is one.
- `"TableName"`: The name of the table. You can also provide the Amazon Resource Name (ARN)
of the table in this parameter.
"""
function list_contributor_insights(; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"ListContributorInsights"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_contributor_insights(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"ListContributorInsights",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_exports()
list_exports(params::Dict{String,<:Any})
Lists completed exports within the past 90 days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results to return per page.
- `"NextToken"`: An optional string that, if supplied, must be copied from the output of a
previous call to ListExports. When provided in this manner, the API fetches the next page
of results.
- `"TableArn"`: The Amazon Resource Name (ARN) associated with the exported table.
"""
function list_exports(; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb("ListExports"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_exports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"ListExports", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_global_tables()
list_global_tables(params::Dict{String,<:Any})
Lists all global tables that have a replica in the specified Region. This documentation is
for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global
tables. Customers should use Global Tables version 2019.11.21 (Current) when possible,
because it provides greater flexibility, higher efficiency, and consumes less write
capacity than 2017.11.29 (Legacy). To determine which version you're using, see Determining
the global table version you are using. To update existing global tables from version
2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveStartGlobalTableName"`: The first global table name that this operation will
evaluate.
- `"Limit"`: The maximum number of table names to return, if the parameter is not specified
DynamoDB defaults to 100. If the number of global tables DynamoDB finds reaches this limit,
it stops the operation and returns the table names collected up to that point, with a table
name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to the
ExclusiveStartGlobalTableName parameter.
- `"RegionName"`: Lists the global tables in a specific Region.
"""
function list_global_tables(; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"ListGlobalTables"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_global_tables(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"ListGlobalTables", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_imports()
list_imports(params::Dict{String,<:Any})
Lists completed imports within the past 90 days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: An optional string that, if supplied, must be copied from the output of a
previous call to ListImports. When provided in this manner, the API fetches the next page
of results.
- `"PageSize"`: The number of ImportSummary objects returned in a single page.
- `"TableArn"`: The Amazon Resource Name (ARN) associated with the table that was imported
to.
"""
function list_imports(; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb("ListImports"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_imports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"ListImports", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tables()
list_tables(params::Dict{String,<:Any})
Returns an array of table names associated with the current account and endpoint. The
output from ListTables is paginated, with each page returning a maximum of 100 table names.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveStartTableName"`: The first table name that this operation will evaluate. Use
the value that was returned for LastEvaluatedTableName in a previous operation, so that you
can obtain the next page of results.
- `"Limit"`: A maximum number of table names to return. If this parameter is not specified,
the limit is 100.
"""
function list_tables(; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb("ListTables"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_tables(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"ListTables", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_of_resource(resource_arn)
list_tags_of_resource(resource_arn, params::Dict{String,<:Any})
List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10
times per second, per account. For an overview on tagging DynamoDB resources, see Tagging
for DynamoDB in the Amazon DynamoDB Developer Guide.
# Arguments
- `resource_arn`: The Amazon DynamoDB resource with tags to be listed. This value is an
Amazon Resource Name (ARN).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: An optional string that, if supplied, must be copied from the output of a
previous call to ListTagOfResource. When provided in this manner, this API fetches the next
page of results.
"""
function list_tags_of_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"ListTagsOfResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_of_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"ListTagsOfResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_item(item, table_name)
put_item(item, table_name, params::Dict{String,<:Any})
Creates a new item, or replaces an old item with a new item. If an item that has the same
primary key as the new item already exists in the specified table, the new item completely
replaces the existing item. You can perform a conditional put operation (add a new item if
one with the specified primary key doesn't exist), or replace an existing item if it has
certain attribute values. You can return the item's attribute values in the same operation,
using the ReturnValues parameter. When you add an item, the primary key attributes are the
only required attributes. Empty String and Binary attribute values are allowed. Attribute
values of type String and Binary must have a length greater than zero if the attribute is
used as a key attribute for a table or index. Set type attributes cannot be empty. Invalid
Requests with empty values will be rejected with a ValidationException exception. To
prevent a new item from replacing an existing item, use a conditional expression that
contains the attribute_not_exists function with the name of the attribute being used as the
partition key for the table. Since every record must contain that attribute, the
attribute_not_exists function will only succeed if no matching item exists. For more
information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.
# Arguments
- `item`: A map of attribute name/value pairs, one for each attribute. Only the primary key
attributes are required; you can optionally provide other attribute name-value pairs for
the item. You must provide all of the attributes for the primary key. For example, with a
simple primary key, you only need to provide a value for the partition key. For a composite
primary key, you must provide both values for both the partition key and the sort key. If
you specify any attributes that are part of an index key, then the data types for those
attributes must match those of the schema in the table's attribute definition. Empty String
and Binary attribute values are allowed. Attribute values of type String and Binary must
have a length greater than zero if the attribute is used as a key attribute for a table or
index. For more information about primary keys, see Primary Key in the Amazon DynamoDB
Developer Guide. Each element in the Item map is an AttributeValue object.
- `table_name`: The name of the table to contain the item. You can also provide the Amazon
Resource Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConditionExpression"`: A condition that must be satisfied in order for a conditional
PutItem operation to succeed. An expression can contain any of the following: Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive. Comparison operators: = | <> | < | >
| <= | >= | BETWEEN | IN Logical operators: AND | OR | NOT For more
information on condition expressions, see Condition Expressions in the Amazon DynamoDB
Developer Guide.
- `"ConditionalOperator"`: This is a legacy parameter. Use ConditionExpression instead. For
more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
- `"Expected"`: This is a legacy parameter. Use ConditionExpression instead. For more
information, see Expected in the Amazon DynamoDB Developer Guide.
- `"ExpressionAttributeNames"`: One or more substitution tokens for attribute names in an
expression. The following are some use cases for using ExpressionAttributeNames: To
access an attribute whose name conflicts with a DynamoDB reserved word. To create a
placeholder for repeating occurrences of an attribute name in an expression. To prevent
special characters in an attribute name from being misinterpreted in an expression. Use
the # character in an expression to dereference an attribute name. For example, consider
the following attribute name: Percentile The name of this attribute conflicts with a
reserved word, so it cannot be used directly in an expression. (For the complete list of
reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around
this, you could specify the following for ExpressionAttributeNames:
{\"#P\":\"Percentile\"} You could then use this substitution in an expression, as in
this example: #P = :val Tokens that begin with the : character are expression
attribute values, which are placeholders for the actual value at runtime. For more
information on expression attribute names, see Specifying Item Attributes in the Amazon
DynamoDB Developer Guide.
- `"ExpressionAttributeValues"`: One or more values that can be substituted in an
expression. Use the : (colon) character in an expression to dereference an attribute value.
For example, suppose that you wanted to check whether the value of the ProductStatus
attribute was one of the following: Available | Backordered | Discontinued You would
first need to specify ExpressionAttributeValues as follows: {
\":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},
\":disc\":{\"S\":\"Discontinued\"} } You could then use these values in an expression,
such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression
attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
- `"ReturnConsumedCapacity"`:
- `"ReturnItemCollectionMetrics"`: Determines whether item collection metrics are returned.
If set to SIZE, the response includes statistics about item collections, if any, that were
modified during the operation are returned in the response. If set to NONE (the default),
no statistics are returned.
- `"ReturnValues"`: Use ReturnValues if you want to get the item attributes as they
appeared before they were updated with the PutItem request. For PutItem, the valid values
are: NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is
returned. (This setting is the default for ReturnValues.) ALL_OLD - If PutItem overwrote
an attribute name-value pair, then the content of the old item is returned. The values
returned are strongly consistent. There is no additional cost associated with requesting a
return value aside from the small network and processing overhead of receiving a larger
response. No read capacity units are consumed. The ReturnValues parameter is used by
several DynamoDB operations; however, PutItem does not recognize any values other than NONE
or ALL_OLD.
- `"ReturnValuesOnConditionCheckFailure"`: An optional parameter that returns the item
attributes for a PutItem operation that failed a condition check. There is no additional
cost associated with requesting a return value aside from the small network and processing
overhead of receiving a larger response. No read capacity units are consumed.
"""
function put_item(Item, TableName; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"PutItem",
Dict{String,Any}("Item" => Item, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_item(
Item,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"PutItem",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Item" => Item, "TableName" => TableName), 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 document to the resource, which can be a table or stream.
When you attach a resource-based policy using this API, the policy application is
eventually consistent . PutResourcePolicy is an idempotent operation; running it multiple
times on the same resource using the same policy document will return the same revision ID.
If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId,
the PolicyNotFoundException will be returned. PutResourcePolicy is an asynchronous
operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy
request, DynamoDB might return your previous policy, if there was one, or return the
PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent
query, and the metadata for your policy or table might not be available at that moment.
Wait for a few seconds, and then try the GetResourcePolicy request again.
# Arguments
- `policy`: An Amazon Web Services resource-based policy document in JSON format. The
maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts
whitespaces when calculating the size of a policy against this limit. Within a
resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate
data for a global table is denied, adding or deleting a replica will fail with an error.
For a full list of all considerations that apply while attaching a resource-based policy,
see Resource-based policy considerations.
- `resource_arn`: The Amazon Resource Name (ARN) of the DynamoDB resource to which the
policy will be attached. The resources you can specify include tables and streams. You can
control index permissions using the base table's policy. To specify the same permission
level for your table and its indexes, you can provide both the table and index Amazon
Resource Name (ARN)s in the Resource field of a given Statement in your policy document.
Alternatively, to specify different permissions for your table, indexes, or both, you can
define multiple Statement fields in your policy document.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConfirmRemoveSelfResourceAccess"`: Set this parameter to true to confirm that you want
to remove your permissions to change the policy of this resource in the future.
- `"ExpectedRevisionId"`: A string value that you can use to conditionally update your
policy. You can provide the revision ID of your existing policy to make mutating requests
against that policy. When you provide an expected revision ID, if the revision ID of the
existing policy on the resource doesn't match or if there's no policy attached to the
resource, your request will be rejected with a PolicyNotFoundException. To conditionally
attach a policy when no policy exists for the resource, specify NO_POLICY for the revision
ID.
"""
function put_resource_policy(
Policy, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"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 dynamodb(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Policy" => Policy, "ResourceArn" => ResourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
query(table_name)
query(table_name, params::Dict{String,<:Any})
You must provide the name of the partition key attribute and a single value for that
attribute. Query returns all items with that partition key value. Optionally, you can
provide a sort key attribute and use a comparison operator to refine the search results.
Use the KeyConditionExpression parameter to provide a specific value for the partition key.
The Query operation will return all of the items from the table or index with that
partition key value. You can optionally narrow the scope of the Query operation by
specifying a sort key value and a comparison operator in KeyConditionExpression. To further
refine the Query results, you can optionally provide a FilterExpression. A FilterExpression
determines which items within the results should be returned to you. All of the other
results are discarded. A Query operation always returns a result set. If no matching
items are found, the result set will be empty. Queries that do not return results consume
the minimum number of read capacity units for that type of read operation. DynamoDB
calculates the number of read capacity units consumed based on item size, not on the amount
of data that is returned to an application. The number of capacity units consumed will be
the same whether you request all of the attributes (the default behavior) or just some of
them (using a projection expression). The number will also be the same whether or not you
use a FilterExpression. Query results are always sorted by the sort key value. If the
data type of the sort key is Number, the results are returned in numeric order; otherwise,
the results are returned in order of UTF-8 bytes. By default, the sort order is ascending.
To reverse the order, set the ScanIndexForward parameter to false. A single Query
operation will read up to the maximum number of items set (if using the Limit parameter) or
a maximum of 1 MB of data and then apply any filtering to the results using
FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate
the result set. For more information, see Paginating the Results in the Amazon DynamoDB
Developer Guide. FilterExpression is applied after a Query finishes, but before the
results are returned. A FilterExpression cannot contain partition key or sort key
attributes. You need to specify those attributes in the KeyConditionExpression. A Query
operation can return an empty result set and a LastEvaluatedKey if all the items read for
the page of results are filtered out. You can query a table, a local secondary index, or
a global secondary index. For a query on a table or on a local secondary index, you can set
the ConsistentRead parameter to true and obtain a strongly consistent result. Global
secondary indexes support eventually consistent reads only, so do not specify
ConsistentRead when querying a global secondary index.
# Arguments
- `table_name`: The name of the table containing the requested items. You can also provide
the Amazon Resource Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributesToGet"`: This is a legacy parameter. Use ProjectionExpression instead. For
more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
- `"ConditionalOperator"`: This is a legacy parameter. Use FilterExpression instead. For
more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
- `"ConsistentRead"`: Determines the read consistency model: If set to true, then the
operation uses strongly consistent reads; otherwise, the operation uses eventually
consistent reads. Strongly consistent reads are not supported on global secondary indexes.
If you query a global secondary index with ConsistentRead set to true, you will receive a
ValidationException.
- `"ExclusiveStartKey"`: The primary key of the first item that this operation will
evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number, or Binary. No set data types
are allowed.
- `"ExpressionAttributeNames"`: One or more substitution tokens for attribute names in an
expression. The following are some use cases for using ExpressionAttributeNames: To
access an attribute whose name conflicts with a DynamoDB reserved word. To create a
placeholder for repeating occurrences of an attribute name in an expression. To prevent
special characters in an attribute name from being misinterpreted in an expression. Use
the # character in an expression to dereference an attribute name. For example, consider
the following attribute name: Percentile The name of this attribute conflicts with a
reserved word, so it cannot be used directly in an expression. (For the complete list of
reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around
this, you could specify the following for ExpressionAttributeNames:
{\"#P\":\"Percentile\"} You could then use this substitution in an expression, as in
this example: #P = :val Tokens that begin with the : character are expression
attribute values, which are placeholders for the actual value at runtime. For more
information on expression attribute names, see Specifying Item Attributes in the Amazon
DynamoDB Developer Guide.
- `"ExpressionAttributeValues"`: One or more values that can be substituted in an
expression. Use the : (colon) character in an expression to dereference an attribute value.
For example, suppose that you wanted to check whether the value of the ProductStatus
attribute was one of the following: Available | Backordered | Discontinued You would
first need to specify ExpressionAttributeValues as follows: {
\":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},
\":disc\":{\"S\":\"Discontinued\"} } You could then use these values in an expression,
such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression
attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
- `"FilterExpression"`: A string that contains conditions that DynamoDB applies after the
Query operation, but before the data is returned to you. Items that do not satisfy the
FilterExpression criteria are not returned. A FilterExpression does not allow key
attributes. You cannot define a filter expression based on a partition key or a sort key.
A FilterExpression is applied after the items have already been read; the process of
filtering does not consume any additional read capacity units. For more information, see
Filter Expressions in the Amazon DynamoDB Developer Guide.
- `"IndexName"`: The name of an index to query. This index can be any local secondary index
or global secondary index on the table. Note that if you use the IndexName parameter, you
must also provide TableName.
- `"KeyConditionExpression"`: The condition that specifies the key values for items to be
retrieved by the Query action. The condition must perform an equality test on a single
partition key value. The condition can optionally perform one of several comparison tests
on a single sort key value. This allows Query to retrieve one item with a given partition
key value and sort key value, or several items that have the same partition key value but
different sort key values. The partition key equality test is required, and must be
specified in the following format: partitionKeyName = :partitionkeyval If you also want
to provide a condition for the sort key, it must be combined using AND with the condition
for the sort key. Following is an example, using the = comparison operator for the sort
key: partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval Valid comparisons
for the sort key condition are as follows: sortKeyName = :sortkeyval - true if the sort
key value is equal to :sortkeyval. sortKeyName < :sortkeyval - true if the sort key
value is less than :sortkeyval. sortKeyName <= :sortkeyval - true if the sort key
value is less than or equal to :sortkeyval. sortKeyName > :sortkeyval - true if the
sort key value is greater than :sortkeyval. sortKeyName >= :sortkeyval - true if the
sort key value is greater than or equal to :sortkeyval. sortKeyName BETWEEN :sortkeyval1
AND :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and
less than or equal to :sortkeyval2. begins_with ( sortKeyName, :sortkeyval ) - true if
the sort key value begins with a particular operand. (You cannot use this function with a
sort key that is of type Number.) Note that the function name begins_with is
case-sensitive. Use the ExpressionAttributeValues parameter to replace tokens such as
:partitionval and :sortval with actual values at runtime. You can optionally use the
ExpressionAttributeNames parameter to replace the names of the partition key and sort key
with placeholder tokens. This option might be necessary if an attribute name conflicts with
a DynamoDB reserved word. For example, the following KeyConditionExpression parameter
causes an error because Size is a reserved word: Size = :myval To work around this,
define a placeholder (such a #S) to represent the attribute name Size.
KeyConditionExpression then is as follows: #S = :myval For a list of reserved words,
see Reserved Words in the Amazon DynamoDB Developer Guide. For more information on
ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for
Attribute Names and Values in the Amazon DynamoDB Developer Guide.
- `"KeyConditions"`: This is a legacy parameter. Use KeyConditionExpression instead. For
more information, see KeyConditions in the Amazon DynamoDB Developer Guide.
- `"Limit"`: The maximum number of items to evaluate (not necessarily the number of
matching items). If DynamoDB processes the number of items up to the limit while processing
the results, it stops the operation and returns the matching values up to that point, and a
key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where
you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this
limit, it stops the operation and returns the matching values up to the limit, and a key in
LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more
information, see Query and Scan in the Amazon DynamoDB Developer Guide.
- `"ProjectionExpression"`: A string that identifies one or more attributes to retrieve
from the table. These attributes can include scalars, sets, or elements of a JSON document.
The attributes in the expression must be separated by commas. If no attribute names are
specified, then all attributes will be returned. If any of the requested attributes are not
found, they will not appear in the result. For more information, see Accessing Item
Attributes in the Amazon DynamoDB Developer Guide.
- `"QueryFilter"`: This is a legacy parameter. Use FilterExpression instead. For more
information, see QueryFilter in the Amazon DynamoDB Developer Guide.
- `"ReturnConsumedCapacity"`:
- `"ScanIndexForward"`: Specifies the order for index traversal: If true (default), the
traversal is performed in ascending order; if false, the traversal is performed in
descending order. Items with the same partition key value are stored in sorted order by
sort key. If the sort key data type is Number, the results are stored in numeric order. For
type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB
treats each byte of the binary data as unsigned. If ScanIndexForward is true, DynamoDB
returns the results in the order in which they are stored (by sort key value). This is the
default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order
by sort key value, and then returns the results to the client.
- `"Select"`: The attributes to be returned in the result. You can retrieve all item
attributes, specific item attributes, the count of matching items, or in the case of an
index, some or all of the attributes projected into the index. ALL_ATTRIBUTES - Returns
all of the item attributes from the specified table or index. If you query a local
secondary index, then for each matching item in the index, DynamoDB fetches the entire item
from the parent table. If the index is configured to project all item attributes, then all
of the data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes
that have been projected into the index. If the index is configured to project all
attributes, this return value is equivalent to specifying ALL_ATTRIBUTES. COUNT -
Returns the number of matching items, rather than the matching items themselves. Note that
this uses the same quantity of read capacity units as getting the items, and is subject to
the same item size calculations. SPECIFIC_ATTRIBUTES - Returns only the attributes
listed in ProjectionExpression. This return value is equivalent to specifying
ProjectionExpression without specifying any value for Select. If you query or scan a local
secondary index and request only attributes that are projected into that index, the
operation will read only the index and not the table. If any of the requested attributes
are not projected into the local secondary index, DynamoDB fetches each of these attributes
from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query or scan a global secondary index, you can only request attributes that are
projected into the index. Global secondary index queries cannot fetch attributes from the
parent table. If neither Select nor ProjectionExpression are specified, DynamoDB defaults
to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an
index. You cannot use both Select and ProjectionExpression together in a single request,
unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying
ProjectionExpression without any value for Select.) If you use the ProjectionExpression
parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for
Select will return an error.
"""
function query(TableName; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"Query",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function query(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"Query",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_table_from_backup(backup_arn, target_table_name)
restore_table_from_backup(backup_arn, target_table_name, params::Dict{String,<:Any})
Creates a new table from an existing backup. Any number of users can execute up to 50
concurrent restores (any type of restore) in a given account. You can call
RestoreTableFromBackup at a maximum rate of 10 times per second. You must manually set up
the following on the restored table: Auto scaling policies IAM policies Amazon
CloudWatch metrics and alarms Tags Stream settings Time to Live (TTL) settings
# Arguments
- `backup_arn`: The Amazon Resource Name (ARN) associated with the backup.
- `target_table_name`: The name of the new table to which the backup must be restored.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BillingModeOverride"`: The billing mode of the restored table.
- `"GlobalSecondaryIndexOverride"`: List of global secondary indexes for the restored
table. The indexes provided should match existing secondary indexes. You can choose to
exclude some or all of the indexes at the time of restore.
- `"LocalSecondaryIndexOverride"`: List of local secondary indexes for the restored table.
The indexes provided should match existing secondary indexes. You can choose to exclude
some or all of the indexes at the time of restore.
- `"OnDemandThroughputOverride"`:
- `"ProvisionedThroughputOverride"`: Provisioned throughput settings for the restored table.
- `"SSESpecificationOverride"`: The new server-side encryption settings for the restored
table.
"""
function restore_table_from_backup(
BackupArn, TargetTableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"RestoreTableFromBackup",
Dict{String,Any}("BackupArn" => BackupArn, "TargetTableName" => TargetTableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_table_from_backup(
BackupArn,
TargetTableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"RestoreTableFromBackup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BackupArn" => BackupArn, "TargetTableName" => TargetTableName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_table_to_point_in_time(target_table_name)
restore_table_to_point_in_time(target_table_name, params::Dict{String,<:Any})
Restores the specified table to the specified point in time within
EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any
point in time during the last 35 days. Any number of users can execute up to 50 concurrent
restores (any type of restore) in a given account. When you restore using point in time
recovery, DynamoDB restores your table data to the state based on the selected date and
time (day:hour:minute:second) to a new table. Along with data, the following are also
included on the new restored table using point in time recovery: Global secondary
indexes (GSIs) Local secondary indexes (LSIs) Provisioned read and write capacity
Encryption settings All these settings come from the current settings of the source table
at the time of restore. You must manually set up the following on the restored table:
Auto scaling policies IAM policies Amazon CloudWatch metrics and alarms Tags Stream
settings Time to Live (TTL) settings Point in time recovery settings
# Arguments
- `target_table_name`: The name of the new table to which it must be restored to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BillingModeOverride"`: The billing mode of the restored table.
- `"GlobalSecondaryIndexOverride"`: List of global secondary indexes for the restored
table. The indexes provided should match existing secondary indexes. You can choose to
exclude some or all of the indexes at the time of restore.
- `"LocalSecondaryIndexOverride"`: List of local secondary indexes for the restored table.
The indexes provided should match existing secondary indexes. You can choose to exclude
some or all of the indexes at the time of restore.
- `"OnDemandThroughputOverride"`:
- `"ProvisionedThroughputOverride"`: Provisioned throughput settings for the restored table.
- `"RestoreDateTime"`: Time in the past to restore the table to.
- `"SSESpecificationOverride"`: The new server-side encryption settings for the restored
table.
- `"SourceTableArn"`: The DynamoDB table that will be restored. This value is an Amazon
Resource Name (ARN).
- `"SourceTableName"`: Name of the source table that is being restored.
- `"UseLatestRestorableTime"`: Restore the table to the latest possible time.
LatestRestorableDateTime is typically 5 minutes before the current time.
"""
function restore_table_to_point_in_time(
TargetTableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"RestoreTableToPointInTime",
Dict{String,Any}("TargetTableName" => TargetTableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_table_to_point_in_time(
TargetTableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"RestoreTableToPointInTime",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TargetTableName" => TargetTableName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
scan(table_name)
scan(table_name, params::Dict{String,<:Any})
The Scan operation returns one or more items and item attributes by accessing every item in
a table or a secondary index. To have DynamoDB return fewer items, you can provide a
FilterExpression operation. If the total size of scanned items exceeds the maximum dataset
size limit of 1 MB, the scan completes and results are returned to the user. The
LastEvaluatedKey value is also returned and the requestor can use the LastEvaluatedKey to
continue the scan in a subsequent operation. Each scan response also includes number of
items that were scanned (ScannedCount) as part of the request. If using a FilterExpression,
a scan result can result in no items meeting the criteria and the Count will result in
zero. If you did not use a FilterExpression in the scan request, then Count is the same as
ScannedCount. Count and ScannedCount only return the count of items specific to a single
scan request and, unless the table is less than 1MB, do not represent the total number of
items in the table. A single Scan operation first reads up to the maximum number of items
set (if using the Limit parameter) or a maximum of 1 MB of data and then applies any
filtering to the results if a FilterExpression is provided. If LastEvaluatedKey is present
in the response, pagination is required to complete the full table scan. For more
information, see Paginating the Results in the Amazon DynamoDB Developer Guide. Scan
operations proceed sequentially; however, for faster performance on a large table or
secondary index, applications can request a parallel Scan operation by providing the
Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon
DynamoDB Developer Guide. By default, a Scan uses eventually consistent reads when
accessing the items in a table. Therefore, the results from an eventually consistent Scan
may not include the latest item changes at the time the scan iterates through each item in
the table. If you require a strongly consistent read of each item as the scan iterates
through the items in the table, you can set the ConsistentRead parameter to true. Strong
consistency only relates to the consistency of the read at the item level. DynamoDB does
not provide snapshot isolation for a scan operation when the ConsistentRead parameter is
set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan
see a consistent snapshot of the table when the scan operation was requested.
# Arguments
- `table_name`: The name of the table containing the requested items or if you provide
IndexName, the name of the table to which that index belongs. You can also provide the
Amazon Resource Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributesToGet"`: This is a legacy parameter. Use ProjectionExpression instead. For
more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
- `"ConditionalOperator"`: This is a legacy parameter. Use FilterExpression instead. For
more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
- `"ConsistentRead"`: A Boolean value that determines the read consistency model during the
scan: If ConsistentRead is false, then the data returned from Scan might not contain the
results from other recently completed write operations (PutItem, UpdateItem, or
DeleteItem). If ConsistentRead is true, then all of the write operations that completed
before the Scan began are guaranteed to be contained in the Scan response. The default
setting for ConsistentRead is false. The ConsistentRead parameter is not supported on
global secondary indexes. If you scan a global secondary index with ConsistentRead set to
true, you will receive a ValidationException.
- `"ExclusiveStartKey"`: The primary key of the first item that this operation will
evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are
allowed. In a parallel scan, a Scan request that includes ExclusiveStartKey must specify
the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
- `"ExpressionAttributeNames"`: One or more substitution tokens for attribute names in an
expression. The following are some use cases for using ExpressionAttributeNames: To
access an attribute whose name conflicts with a DynamoDB reserved word. To create a
placeholder for repeating occurrences of an attribute name in an expression. To prevent
special characters in an attribute name from being misinterpreted in an expression. Use
the # character in an expression to dereference an attribute name. For example, consider
the following attribute name: Percentile The name of this attribute conflicts with a
reserved word, so it cannot be used directly in an expression. (For the complete list of
reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around
this, you could specify the following for ExpressionAttributeNames:
{\"#P\":\"Percentile\"} You could then use this substitution in an expression, as in
this example: #P = :val Tokens that begin with the : character are expression
attribute values, which are placeholders for the actual value at runtime. For more
information on expression attribute names, see Specifying Item Attributes in the Amazon
DynamoDB Developer Guide.
- `"ExpressionAttributeValues"`: One or more values that can be substituted in an
expression. Use the : (colon) character in an expression to dereference an attribute value.
For example, suppose that you wanted to check whether the value of the ProductStatus
attribute was one of the following: Available | Backordered | Discontinued You would
first need to specify ExpressionAttributeValues as follows: {
\":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},
\":disc\":{\"S\":\"Discontinued\"} } You could then use these values in an expression,
such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression
attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
- `"FilterExpression"`: A string that contains conditions that DynamoDB applies after the
Scan operation, but before the data is returned to you. Items that do not satisfy the
FilterExpression criteria are not returned. A FilterExpression is applied after the items
have already been read; the process of filtering does not consume any additional read
capacity units. For more information, see Filter Expressions in the Amazon DynamoDB
Developer Guide.
- `"IndexName"`: The name of a secondary index to scan. This index can be any local
secondary index or global secondary index. Note that if you use the IndexName parameter,
you must also provide TableName.
- `"Limit"`: The maximum number of items to evaluate (not necessarily the number of
matching items). If DynamoDB processes the number of items up to the limit while processing
the results, it stops the operation and returns the matching values up to that point, and a
key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where
you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this
limit, it stops the operation and returns the matching values up to the limit, and a key in
LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more
information, see Working with Queries in the Amazon DynamoDB Developer Guide.
- `"ProjectionExpression"`: A string that identifies one or more attributes to retrieve
from the specified table or index. These attributes can include scalars, sets, or elements
of a JSON document. The attributes in the expression must be separated by commas. If no
attribute names are specified, then all attributes will be returned. If any of the
requested attributes are not found, they will not appear in the result. For more
information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
- `"ReturnConsumedCapacity"`:
- `"ScanFilter"`: This is a legacy parameter. Use FilterExpression instead. For more
information, see ScanFilter in the Amazon DynamoDB Developer Guide.
- `"Segment"`: For a parallel Scan request, Segment identifies an individual segment to be
scanned by an application worker. Segment IDs are zero-based, so the first segment is
always 0. For example, if you want to use four application threads to scan a table or an
index, then the first thread specifies a Segment value of 0, the second thread specifies 1,
and so on. The value of LastEvaluatedKey returned from a parallel Scan request must be used
as ExclusiveStartKey with the same segment ID in a subsequent Scan operation. The value for
Segment must be greater than or equal to 0, and less than the value provided for
TotalSegments. If you provide Segment, you must also provide TotalSegments.
- `"Select"`: The attributes to be returned in the result. You can retrieve all item
attributes, specific item attributes, the count of matching items, or in the case of an
index, some or all of the attributes projected into the index. ALL_ATTRIBUTES - Returns
all of the item attributes from the specified table or index. If you query a local
secondary index, then for each matching item in the index, DynamoDB fetches the entire item
from the parent table. If the index is configured to project all item attributes, then all
of the data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes
that have been projected into the index. If the index is configured to project all
attributes, this return value is equivalent to specifying ALL_ATTRIBUTES. COUNT -
Returns the number of matching items, rather than the matching items themselves. Note that
this uses the same quantity of read capacity units as getting the items, and is subject to
the same item size calculations. SPECIFIC_ATTRIBUTES - Returns only the attributes
listed in ProjectionExpression. This return value is equivalent to specifying
ProjectionExpression without specifying any value for Select. If you query or scan a local
secondary index and request only attributes that are projected into that index, the
operation reads only the index and not the table. If any of the requested attributes are
not projected into the local secondary index, DynamoDB fetches each of these attributes
from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query or scan a global secondary index, you can only request attributes that are
projected into the index. Global secondary index queries cannot fetch attributes from the
parent table. If neither Select nor ProjectionExpression are specified, DynamoDB defaults
to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an
index. You cannot use both Select and ProjectionExpression together in a single request,
unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying
ProjectionExpression without any value for Select.) If you use the ProjectionExpression
parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for
Select will return an error.
- `"TotalSegments"`: For a parallel Scan request, TotalSegments represents the total number
of segments into which the Scan operation will be divided. The value of TotalSegments
corresponds to the number of application workers that will perform the parallel scan. For
example, if you want to use four application threads to scan a table or an index, specify a
TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1,
and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan
operation will be sequential rather than parallel. If you specify TotalSegments, you must
also specify Segment.
"""
function scan(TableName; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"Scan",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function scan(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"Scan",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), 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})
Associate a set of tags with an Amazon DynamoDB resource. You can then activate these
user-defined tags so that they appear on the Billing and Cost Management console for cost
allocation tracking. You can call TagResource up to five times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon
DynamoDB Developer Guide.
# Arguments
- `resource_arn`: Identifies the Amazon DynamoDB resource to which tags should be added.
This value is an Amazon Resource Name (ARN).
- `tags`: The tags to be assigned to the Amazon DynamoDB resource.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"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 dynamodb(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
transact_get_items(transact_items)
transact_get_items(transact_items, params::Dict{String,<:Any})
TransactGetItems is a synchronous operation that atomically retrieves multiple items from
one or more tables (but not from indexes) in a single account and Region. A
TransactGetItems call can contain up to 100 TransactGetItem objects, each of which contains
a Get structure that specifies an item to retrieve from a table in the account and Region.
A call to TransactGetItems cannot retrieve items from tables in more than one Amazon Web
Services account or Region. The aggregate size of the items in the transaction cannot
exceed 4 MB. DynamoDB rejects the entire TransactGetItems request if any of the following
is true: A conflicting operation is in the process of updating an item to be read.
There is insufficient provisioned capacity for the transaction to be completed. There is
a user error, such as an invalid data format. The aggregate size of the items in the
transaction exceeded 4 MB.
# Arguments
- `transact_items`: An ordered array of up to 100 TransactGetItem objects, each of which
contains a Get structure.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReturnConsumedCapacity"`: A value of TOTAL causes consumed capacity information to be
returned, and a value of NONE prevents that information from being returned. No other value
is valid.
"""
function transact_get_items(
TransactItems; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"TransactGetItems",
Dict{String,Any}("TransactItems" => TransactItems);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function transact_get_items(
TransactItems,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"TransactGetItems",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TransactItems" => TransactItems), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
transact_write_items(transact_items)
transact_write_items(transact_items, params::Dict{String,<:Any})
TransactWriteItems is a synchronous write operation that groups up to 100 action requests.
These actions can target items in different tables, but not in different Amazon Web
Services accounts or Regions, and no two actions can target the same item. For example, you
cannot both ConditionCheck and Update the same item. The aggregate size of the items in the
transaction cannot exceed 4 MB. The actions are completed atomically so that either all of
them succeed, or all of them fail. They are defined by the following objects: Put —
Initiates a PutItem operation to write a new item. This structure specifies the primary
key of the item to be written, the name of the table to write it in, an optional condition
expression that must be satisfied for the write to succeed, a list of the item's
attributes, and a field indicating whether to retrieve the item's attributes if the
condition is not met. Update — Initiates an UpdateItem operation to update an
existing item. This structure specifies the primary key of the item to be updated, the name
of the table where it resides, an optional condition expression that must be satisfied for
the update to succeed, an expression that defines one or more attributes to be updated, and
a field indicating whether to retrieve the item's attributes if the condition is not met.
Delete — Initiates a DeleteItem operation to delete an existing item. This
structure specifies the primary key of the item to be deleted, the name of the table where
it resides, an optional condition expression that must be satisfied for the deletion to
succeed, and a field indicating whether to retrieve the item's attributes if the condition
is not met. ConditionCheck — Applies a condition to an item that is not being
modified by the transaction. This structure specifies the primary key of the item to be
checked, the name of the table where it resides, a condition expression that must be
satisfied for the transaction to succeed, and a field indicating whether to retrieve the
item's attributes if the condition is not met. DynamoDB rejects the entire
TransactWriteItems request if any of the following is true: A condition in one of the
condition expressions is not met. An ongoing operation is in the process of updating the
same item. There is insufficient provisioned capacity for the transaction to be
completed. An item size becomes too large (bigger than 400 KB), a local secondary index
(LSI) becomes too large, or a similar validation error occurs because of changes made by
the transaction. The aggregate size of the items in the transaction exceeds 4 MB. There
is a user error, such as an invalid data format.
# Arguments
- `transact_items`: An ordered array of up to 100 TransactWriteItem objects, each of which
contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in
different tables, but the tables must reside in the same Amazon Web Services account and
Region, and no two of them can operate on the same item.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Providing a ClientRequestToken makes the call to
TransactWriteItems idempotent, meaning that multiple identical calls have the same effect
as one single call. Although multiple identical calls using the same client request token
produce the same result on the server (no side effects), the responses to the calls might
not be the same. If the ReturnConsumedCapacity parameter is set, then the initial
TransactWriteItems call returns the amount of write capacity units consumed in making the
changes. Subsequent TransactWriteItems calls with the same client token return the number
of read capacity units consumed in reading the item. A client request token is valid for 10
minutes after the first request that uses it is completed. After 10 minutes, any request
with the same client token is treated as a new request. Do not resubmit the same request
with the same client token for more than 10 minutes, or the result might not be idempotent.
If you submit a request with the same client token but a change in other parameters within
the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.
- `"ReturnConsumedCapacity"`:
- `"ReturnItemCollectionMetrics"`: Determines whether item collection metrics are returned.
If set to SIZE, the response includes statistics about item collections (if any), that were
modified during the operation and are returned in the response. If set to NONE (the
default), no statistics are returned.
"""
function transact_write_items(
TransactItems; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"TransactWriteItems",
Dict{String,Any}(
"TransactItems" => TransactItems, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function transact_write_items(
TransactItems,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"TransactWriteItems",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransactItems" => TransactItems,
"ClientRequestToken" => string(uuid4()),
),
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 association of tags from an Amazon DynamoDB resource. You can call
UntagResource up to five times per second, per account. For an overview on tagging
DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
# Arguments
- `resource_arn`: The DynamoDB resource that the tags will be removed from. This value is
an Amazon Resource Name (ARN).
- `tag_keys`: A list of tag keys. Existing tags of the resource whose keys are members of
this list will be removed from the DynamoDB resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"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 dynamodb(
"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_continuous_backups(point_in_time_recovery_specification, table_name)
update_continuous_backups(point_in_time_recovery_specification, table_name, params::Dict{String,<:Any})
UpdateContinuousBackups enables or disables point in time recovery for the specified
table. A successful UpdateContinuousBackups call returns the current
ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table
creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to
ENABLED. Once continuous backups and point in time recovery are enabled, you can restore
to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.
LatestRestorableDateTime is typically 5 minutes before the current time. You can restore
your table to any point in time during the last 35 days.
# Arguments
- `point_in_time_recovery_specification`: Represents the settings used to enable point in
time recovery.
- `table_name`: The name of the table. You can also provide the Amazon Resource Name (ARN)
of the table in this parameter.
"""
function update_continuous_backups(
PointInTimeRecoverySpecification,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"UpdateContinuousBackups",
Dict{String,Any}(
"PointInTimeRecoverySpecification" => PointInTimeRecoverySpecification,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_continuous_backups(
PointInTimeRecoverySpecification,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"UpdateContinuousBackups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PointInTimeRecoverySpecification" => PointInTimeRecoverySpecification,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_contributor_insights(contributor_insights_action, table_name)
update_contributor_insights(contributor_insights_action, table_name, params::Dict{String,<:Any})
Updates the status for contributor insights for a specific table or index. CloudWatch
Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort
key of frequently accessed items and frequently throttled items in plaintext. If you
require the use of Amazon Web Services Key Management Service (KMS) to encrypt this
table’s partition key and sort key data with an Amazon Web Services managed key or
customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB
for this table.
# Arguments
- `contributor_insights_action`: Represents the contributor insights action.
- `table_name`: The name of the table. You can also provide the Amazon Resource Name (ARN)
of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IndexName"`: The global secondary index name, if applicable.
"""
function update_contributor_insights(
ContributorInsightsAction, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"UpdateContributorInsights",
Dict{String,Any}(
"ContributorInsightsAction" => ContributorInsightsAction,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_contributor_insights(
ContributorInsightsAction,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"UpdateContributorInsights",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContributorInsightsAction" => ContributorInsightsAction,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_global_table(global_table_name, replica_updates)
update_global_table(global_table_name, replica_updates, params::Dict{String,<:Any})
Adds or removes replicas in the specified global table. The global table must already exist
to be able to use this operation. Any replica to be added must be empty, have the same name
as the global table, have the same key schema, have DynamoDB Streams enabled, and have the
same provisioned and maximum write capacity units. This documentation is for version
2017.11.29 (Legacy) of global tables, which should be avoided for new global tables.
Customers should use Global Tables version 2019.11.21 (Current) when possible, because it
provides greater flexibility, higher efficiency, and consumes less write capacity than
2017.11.29 (Legacy). To determine which version you're using, see Determining the global
table version you are using. To update existing global tables from version 2017.11.29
(Legacy) to version 2019.11.21 (Current), see Upgrading global tables. For global
tables, this operation only applies to global tables using Version 2019.11.21 (Current
version). If you are using global tables Version 2019.11.21 you can use UpdateTable
instead. Although you can use UpdateGlobalTable to add replicas and remove replicas in a
single request, for simplicity we recommend that you issue separate requests for adding or
removing replicas. If global secondary indexes are specified, then the following
conditions must also be met: The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present). The
global secondary indexes must have the same provisioned and maximum write capacity units.
# Arguments
- `global_table_name`: The global table name.
- `replica_updates`: A list of Regions that should be added or removed from the global
table.
"""
function update_global_table(
GlobalTableName, ReplicaUpdates; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"UpdateGlobalTable",
Dict{String,Any}(
"GlobalTableName" => GlobalTableName, "ReplicaUpdates" => ReplicaUpdates
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_global_table(
GlobalTableName,
ReplicaUpdates,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"UpdateGlobalTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalTableName" => GlobalTableName, "ReplicaUpdates" => ReplicaUpdates
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_global_table_settings(global_table_name)
update_global_table_settings(global_table_name, params::Dict{String,<:Any})
Updates settings for a global table. This documentation is for version 2017.11.29 (Legacy)
of global tables, which should be avoided for new global tables. Customers should use
Global Tables version 2019.11.21 (Current) when possible, because it provides greater
flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see Determining the global table version you are
using. To update existing global tables from version 2017.11.29 (Legacy) to version
2019.11.21 (Current), see Upgrading global tables.
# Arguments
- `global_table_name`: The name of the global table
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GlobalTableBillingMode"`: The billing mode of the global table. If
GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity
billing mode. PROVISIONED - We recommend using PROVISIONED for predictable workloads.
PROVISIONED sets the billing mode to Provisioned capacity mode. PAY_PER_REQUEST - We
recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the
billing mode to On-demand capacity mode.
- `"GlobalTableGlobalSecondaryIndexSettingsUpdate"`: Represents the settings of a global
secondary index for a global table that will be modified.
- `"GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate"`: Auto scaling settings
for managing provisioned write capacity for the global table.
- `"GlobalTableProvisionedWriteCapacityUnits"`: The maximum number of writes consumed per
second before DynamoDB returns a ThrottlingException.
- `"ReplicaSettingsUpdate"`: Represents the settings for a global table in a Region that
will be modified.
"""
function update_global_table_settings(
GlobalTableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"UpdateGlobalTableSettings",
Dict{String,Any}("GlobalTableName" => GlobalTableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_global_table_settings(
GlobalTableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"UpdateGlobalTableSettings",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("GlobalTableName" => GlobalTableName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_item(key, table_name)
update_item(key, table_name, params::Dict{String,<:Any})
Edits an existing item's attributes, or adds a new item to the table if it does not already
exist. You can put, delete, or add attribute values. You can also perform a conditional
update on an existing item (insert a new attribute name-value pair if it doesn't exist, or
replace an existing name-value pair if it has certain expected attribute values). You can
also return the item's attribute values in the same UpdateItem operation using the
ReturnValues parameter.
# Arguments
- `key`: The primary key of the item to be updated. Each element consists of an attribute
name and a value for that attribute. For the primary key, you must provide all of the
attributes. For example, with a simple primary key, you only need to provide a value for
the partition key. For a composite primary key, you must provide values for both the
partition key and the sort key.
- `table_name`: The name of the table containing the item to update. You can also provide
the Amazon Resource Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeUpdates"`: This is a legacy parameter. Use UpdateExpression instead. For more
information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
- `"ConditionExpression"`: A condition that must be satisfied in order for a conditional
update to succeed. An expression can contain any of the following: Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive. Comparison operators: = | <> | < | >
| <= | >= | BETWEEN | IN Logical operators: AND | OR | NOT For more
information about condition expressions, see Specifying Conditions in the Amazon DynamoDB
Developer Guide.
- `"ConditionalOperator"`: This is a legacy parameter. Use ConditionExpression instead. For
more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
- `"Expected"`: This is a legacy parameter. Use ConditionExpression instead. For more
information, see Expected in the Amazon DynamoDB Developer Guide.
- `"ExpressionAttributeNames"`: One or more substitution tokens for attribute names in an
expression. The following are some use cases for using ExpressionAttributeNames: To
access an attribute whose name conflicts with a DynamoDB reserved word. To create a
placeholder for repeating occurrences of an attribute name in an expression. To prevent
special characters in an attribute name from being misinterpreted in an expression. Use
the # character in an expression to dereference an attribute name. For example, consider
the following attribute name: Percentile The name of this attribute conflicts with a
reserved word, so it cannot be used directly in an expression. (For the complete list of
reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around
this, you could specify the following for ExpressionAttributeNames:
{\"#P\":\"Percentile\"} You could then use this substitution in an expression, as in
this example: #P = :val Tokens that begin with the : character are expression
attribute values, which are placeholders for the actual value at runtime. For more
information about expression attribute names, see Specifying Item Attributes in the Amazon
DynamoDB Developer Guide.
- `"ExpressionAttributeValues"`: One or more values that can be substituted in an
expression. Use the : (colon) character in an expression to dereference an attribute value.
For example, suppose that you wanted to check whether the value of the ProductStatus
attribute was one of the following: Available | Backordered | Discontinued You would
first need to specify ExpressionAttributeValues as follows: {
\":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},
\":disc\":{\"S\":\"Discontinued\"} } You could then use these values in an expression,
such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression
attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
- `"ReturnConsumedCapacity"`:
- `"ReturnItemCollectionMetrics"`: Determines whether item collection metrics are returned.
If set to SIZE, the response includes statistics about item collections, if any, that were
modified during the operation are returned in the response. If set to NONE (the default),
no statistics are returned.
- `"ReturnValues"`: Use ReturnValues if you want to get the item attributes as they appear
before or after they are successfully updated. For UpdateItem, the valid values are:
NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned.
(This setting is the default for ReturnValues.) ALL_OLD - Returns all of the attributes
of the item, as they appeared before the UpdateItem operation. UPDATED_OLD - Returns
only the updated attributes, as they appeared before the UpdateItem operation. ALL_NEW -
Returns all of the attributes of the item, as they appear after the UpdateItem operation.
UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem
operation. There is no additional cost associated with requesting a return value aside
from the small network and processing overhead of receiving a larger response. No read
capacity units are consumed. The values returned are strongly consistent.
- `"ReturnValuesOnConditionCheckFailure"`: An optional parameter that returns the item
attributes for an UpdateItem operation that failed a condition check. There is no
additional cost associated with requesting a return value aside from the small network and
processing overhead of receiving a larger response. No read capacity units are consumed.
- `"UpdateExpression"`: An expression that defines one or more attributes to be updated,
the action to be performed on them, and new values for them. The following action values
are available for UpdateExpression. SET - Adds one or more attributes and values to an
item. If any of these attributes already exist, they are replaced by the new values. You
can also use SET to add or subtract from an attribute that is of type Number. For example:
SET myNum = myNum + :val SET supports the following functions: if_not_exists (path,
operand) - if the item does not contain an attribute at the specified path, then
if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this
function to avoid overwriting an attribute that may already be present in the item.
list_append (operand, operand) - evaluates to a list with a new element added to it. You
can append the new element to the start or the end of the list by reversing the order of
the operands. These function names are case-sensitive. REMOVE - Removes one or more
attributes from an item. ADD - Adds the specified value to the item, if the attribute
does not already exist. If the attribute does exist, then the behavior of ADD depends on
the data type of the attribute: If the existing attribute is a number, and if Value is
also a number, then Value is mathematically added to the existing attribute. If Value is a
negative number, then it is subtracted from the existing attribute. If you use ADD to
increment or decrement a number value for an item that doesn't exist before the update,
DynamoDB uses 0 as the initial value. Similarly, if you use ADD for an existing item to
increment or decrement an attribute value that doesn't exist before the update, DynamoDB
uses 0 as the initial value. For example, suppose that the item you want to update doesn't
have an attribute named itemcount, but you decide to ADD the number 3 to this attribute
anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and
finally add 3 to it. The result will be a new itemcount attribute in the item, with a value
of 3. If the existing data type is a set and if Value is also a set, then Value is added
to the existing set. For example, if the attribute value is the set [1,2], and the ADD
action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD
action is specified for a set attribute and the attribute type specified does not match the
existing set type. Both sets must have the same primitive data type. For example, if the
existing data type is a set of strings, the Value must also be a set of strings. The ADD
action only supports Number and set data types. In addition, ADD can only be used on
top-level attributes, not nested attributes. DELETE - Deletes an element from a set. If
a set of values is specified, then those values are subtracted from the old set. For
example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c],
then the final attribute value is [b]. Specifying an empty set is an error. The DELETE
action only supports set data types. In addition, DELETE can only be used on top-level
attributes, not nested attributes. You can have many actions in a single expression,
such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5 For more
information on update expressions, see Modifying Items and Attributes in the Amazon
DynamoDB Developer Guide.
"""
function update_item(Key, TableName; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"UpdateItem",
Dict{String,Any}("Key" => Key, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_item(
Key,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"UpdateItem",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Key" => Key, "TableName" => TableName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_kinesis_streaming_destination(stream_arn, table_name)
update_kinesis_streaming_destination(stream_arn, table_name, params::Dict{String,<:Any})
The command to update the Kinesis stream destination.
# Arguments
- `stream_arn`: The Amazon Resource Name (ARN) for the Kinesis stream input.
- `table_name`: The table name for the Kinesis streaming destination input. You can also
provide the ARN of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UpdateKinesisStreamingConfiguration"`: The command to update the Kinesis stream
configuration.
"""
function update_kinesis_streaming_destination(
StreamArn, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"UpdateKinesisStreamingDestination",
Dict{String,Any}("StreamArn" => StreamArn, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_kinesis_streaming_destination(
StreamArn,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"UpdateKinesisStreamingDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("StreamArn" => StreamArn, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_table(table_name)
update_table(table_name, params::Dict{String,<:Any})
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams
settings for a given table. For global tables, this operation only applies to global
tables using Version 2019.11.21 (Current version). You can only perform one of the
following operations at once: Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table. Create a new global secondary index on
the table. After the index begins backfilling, you can use UpdateTable to perform other
operations. UpdateTable is an asynchronous operation; while it's executing, the table
status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another
UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation
is complete.
# Arguments
- `table_name`: The name of the table to be updated. You can also provide the Amazon
Resource Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeDefinitions"`: An array of attributes that describe the key schema for the
table and indexes. If you are adding a new global secondary index to the table,
AttributeDefinitions must include the key element(s) of the new index.
- `"BillingMode"`: Controls how you are charged for read and write throughput and how you
manage capacity. When switching from pay-per-request to provisioned capacity, initial
provisioned capacity values must be set. The initial provisioned capacity values are
estimated based on the consumed read and write capacity of your table and global secondary
indexes over the past 30 minutes. PROVISIONED - We recommend using PROVISIONED for
predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads.
PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
- `"DeletionProtectionEnabled"`: Indicates whether deletion protection is to be enabled
(true) or disabled (false) on the table.
- `"GlobalSecondaryIndexUpdates"`: An array of one or more global secondary indexes for the
table. For each index in the array, you can request one action: Create - add a new
global secondary index to the table. Update - modify the provisioned throughput settings
of an existing global secondary index. Delete - remove a global secondary index from the
table. You can create or delete only one global secondary index per UpdateTable
operation. For more information, see Managing Global Secondary Indexes in the Amazon
DynamoDB Developer Guide.
- `"OnDemandThroughput"`: Updates the maximum number of read and write units for the
specified table in on-demand capacity mode. If you use this parameter, you must specify
MaxReadRequestUnits, MaxWriteRequestUnits, or both.
- `"ProvisionedThroughput"`: The new provisioned throughput settings for the specified
table or index.
- `"ReplicaUpdates"`: A list of replica update actions (create, delete, or update) for the
table. For global tables, this property only applies to global tables using Version
2019.11.21 (Current version).
- `"SSESpecification"`: The new server-side encryption settings for the specified table.
- `"StreamSpecification"`: Represents the DynamoDB Streams configuration for the table.
You receive a ValidationException if you try to enable a stream on a table that already has
a stream, or if you try to disable a stream on a table that doesn't have a stream.
- `"TableClass"`: The table class of the table to be updated. Valid values are STANDARD and
STANDARD_INFREQUENT_ACCESS.
"""
function update_table(TableName; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb(
"UpdateTable",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_table(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"UpdateTable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_table_replica_auto_scaling(table_name)
update_table_replica_auto_scaling(table_name, params::Dict{String,<:Any})
Updates auto scaling settings on your global tables at once. For global tables, this
operation only applies to global tables using Version 2019.11.21 (Current version).
# Arguments
- `table_name`: The name of the global table to be updated. You can also provide the Amazon
Resource Name (ARN) of the table in this parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GlobalSecondaryIndexUpdates"`: Represents the auto scaling settings of the global
secondary indexes of the replica to be updated.
- `"ProvisionedWriteCapacityAutoScalingUpdate"`:
- `"ReplicaUpdates"`: Represents the auto scaling settings of replicas of the table that
will be modified.
"""
function update_table_replica_auto_scaling(
TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"UpdateTableReplicaAutoScaling",
Dict{String,Any}("TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_table_replica_auto_scaling(
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"UpdateTableReplicaAutoScaling",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TableName" => TableName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_time_to_live(table_name, time_to_live_specification)
update_time_to_live(table_name, time_to_live_specification, params::Dict{String,<:Any})
The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table.
A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take
up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for
the same table during this one hour duration result in a ValidationException. TTL compares
the current time in epoch time format to the time stored in the TTL attribute of an item.
If the epoch time value stored in the attribute is less than the current time, the item is
marked as expired and subsequently deleted. The epoch time format is the number of
seconds elapsed since 12:00:00 AM January 1, 1970 UTC. DynamoDB deletes expired items on
a best-effort basis to ensure availability of throughput for other data operations.
DynamoDB typically deletes expired items within two days of expiration. The exact duration
within which an item gets deleted after expiration is specific to the nature of the
workload. Items that have expired and not been deleted will still show up in reads,
queries, and scans. As items are deleted, they are removed from any local secondary index
and global secondary index immediately in the same eventually consistent way as a standard
delete operation. For more information, see Time To Live in the Amazon DynamoDB Developer
Guide.
# Arguments
- `table_name`: The name of the table to be configured. You can also provide the Amazon
Resource Name (ARN) of the table in this parameter.
- `time_to_live_specification`: Represents the settings used to enable or disable Time to
Live for the specified table.
"""
function update_time_to_live(
TableName, TimeToLiveSpecification; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb(
"UpdateTimeToLive",
Dict{String,Any}(
"TableName" => TableName, "TimeToLiveSpecification" => TimeToLiveSpecification
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_time_to_live(
TableName,
TimeToLiveSpecification,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb(
"UpdateTimeToLive",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TableName" => TableName,
"TimeToLiveSpecification" => TimeToLiveSpecification,
),
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 | 7613 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: dynamodb_streams
using AWS.Compat
using AWS.UUIDs
"""
describe_stream(stream_arn)
describe_stream(stream_arn, params::Dict{String,<:Any})
Returns information about a stream, including the current status of the stream, its Amazon
Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.
You can call DescribeStream at a maximum rate of 10 times per second. Each shard in the
stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a
StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to
receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are
present, then that shard is closed and can no longer receive more data.
# Arguments
- `stream_arn`: The Amazon Resource Name (ARN) for the stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveStartShardId"`: The shard ID of the first item that this operation will
evaluate. Use the value that was returned for LastEvaluatedShardId in the previous
operation.
- `"Limit"`: The maximum number of shard objects to return. The upper limit is 100.
"""
function describe_stream(StreamArn; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb_streams(
"DescribeStream",
Dict{String,Any}("StreamArn" => StreamArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_stream(
StreamArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb_streams(
"DescribeStream",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StreamArn" => StreamArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_records(shard_iterator)
get_records(shard_iterator, params::Dict{String,<:Any})
Retrieves the stream records from a given shard. Specify a shard iterator using the
ShardIterator parameter. The shard iterator specifies the position in the shard from which
you want to start reading stream records sequentially. If there are no stream records
available in the portion of the shard that the iterator points to, GetRecords returns an
empty list. Note that it might take multiple calls to get to a portion of the shard that
contains stream records. GetRecords can retrieve a maximum of 1 MB of data or 1000 stream
records, whichever comes first.
# Arguments
- `shard_iterator`: A shard iterator that was retrieved from a previous GetShardIterator
operation. This iterator can be used to access the stream records in this 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 from the shard. The upper limit is
1000.
"""
function get_records(ShardIterator; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb_streams(
"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 dynamodb_streams(
"GetRecords",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ShardIterator" => ShardIterator), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_shard_iterator(shard_id, shard_iterator_type, stream_arn)
get_shard_iterator(shard_id, shard_iterator_type, stream_arn, params::Dict{String,<:Any})
Returns a shard iterator. A shard iterator provides information about how to retrieve the
stream records from within a shard. Use the shard iterator in a subsequent GetRecords
request to read the stream records from the shard. A shard iterator expires 15 minutes
after it is returned to the requester.
# Arguments
- `shard_id`: The identifier of the shard. The iterator will be returned for this shard ID.
- `shard_iterator_type`: Determines how the shard iterator is used to start reading stream
records from the shard: AT_SEQUENCE_NUMBER - Start reading exactly from the position
denoted by a specific sequence number. AFTER_SEQUENCE_NUMBER - Start reading right after
the position denoted by a specific sequence number. TRIM_HORIZON - Start reading at the
last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB
Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this
limit are subject to removal (trimming) from the stream. LATEST - Start reading just
after the most recent stream record in the shard, so that you always read the most recent
data in the shard.
- `stream_arn`: The Amazon Resource Name (ARN) for the stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SequenceNumber"`: The sequence number of a stream record in the shard from which to
start reading.
"""
function get_shard_iterator(
ShardId, ShardIteratorType, StreamArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb_streams(
"GetShardIterator",
Dict{String,Any}(
"ShardId" => ShardId,
"ShardIteratorType" => ShardIteratorType,
"StreamArn" => StreamArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_shard_iterator(
ShardId,
ShardIteratorType,
StreamArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return dynamodb_streams(
"GetShardIterator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ShardId" => ShardId,
"ShardIteratorType" => ShardIteratorType,
"StreamArn" => StreamArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_streams()
list_streams(params::Dict{String,<:Any})
Returns an array of stream ARNs associated with the current account and endpoint. If the
TableName parameter is present, then ListStreams will return only the streams ARNs for that
table. You can call ListStreams at a maximum rate of 5 times per second.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveStartStreamArn"`: The ARN (Amazon Resource Name) of the first item that this
operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the
previous operation.
- `"Limit"`: The maximum number of streams to return. The upper limit is 100.
- `"TableName"`: If this parameter is provided, then only the streams associated with this
table name are returned.
"""
function list_streams(; aws_config::AbstractAWSConfig=global_aws_config())
return dynamodb_streams(
"ListStreams"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_streams(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return dynamodb_streams(
"ListStreams", 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 | 18409 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ebs
using AWS.Compat
using AWS.UUIDs
"""
complete_snapshot(snapshot_id, x-amz-_changed_blocks_count)
complete_snapshot(snapshot_id, x-amz-_changed_blocks_count, params::Dict{String,<:Any})
Seals and completes the snapshot after all of the required blocks of data have been written
to it. Completing the snapshot changes the status to completed. You cannot write new blocks
to a snapshot after it has been completed. You should always retry requests that receive
server (5xx) error responses, and ThrottlingException and RequestThrottledException client
error responses. For more information see Error retries in the Amazon Elastic Compute Cloud
User Guide.
# Arguments
- `snapshot_id`: The ID of the snapshot.
- `x-amz-_changed_blocks_count`: The number of blocks that were written to the snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-Checksum"`: An aggregated Base-64 SHA256 checksum based on the checksums of each
written block. To generate the aggregated checksum using the linear aggregation method,
arrange the checksums for each written block in ascending order of their block index,
concatenate them to form a single string, and then generate the checksum on the entire
string using the SHA256 algorithm.
- `"x-amz-Checksum-Aggregation-Method"`: The aggregation method used to generate the
checksum. Currently, the only supported aggregation method is LINEAR.
- `"x-amz-Checksum-Algorithm"`: The algorithm used to generate the checksum. Currently, the
only supported algorithm is SHA256.
"""
function complete_snapshot(
snapshotId, x_amz_ChangedBlocksCount; aws_config::AbstractAWSConfig=global_aws_config()
)
return ebs(
"POST",
"/snapshots/completion/$(snapshotId)",
Dict{String,Any}(
"headers" =>
Dict{String,Any}("x-amz-ChangedBlocksCount" => x_amz_ChangedBlocksCount),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function complete_snapshot(
snapshotId,
x_amz_ChangedBlocksCount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ebs(
"POST",
"/snapshots/completion/$(snapshotId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}(
"x-amz-ChangedBlocksCount" => x_amz_ChangedBlocksCount
),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_snapshot_block(block_index, block_token, snapshot_id)
get_snapshot_block(block_index, block_token, snapshot_id, params::Dict{String,<:Any})
Returns the data in a block in an Amazon Elastic Block Store snapshot. You should always
retry requests that receive server (5xx) error responses, and ThrottlingException and
RequestThrottledException client error responses. For more information see Error retries in
the Amazon Elastic Compute Cloud User Guide.
# Arguments
- `block_index`: The block index of the block in which to read the data. A block index is a
logical index in units of 512 KiB blocks. To identify the block index, divide the logical
offset of the data in the logical volume by the block size (logical offset of data/524288).
The logical offset of the data must be 512 KiB aligned.
- `block_token`: The block token of the block from which to get data. You can obtain the
BlockToken by running the ListChangedBlocks or ListSnapshotBlocks operations.
- `snapshot_id`: The ID of the snapshot containing the block from which to get data. If
the specified snapshot is encrypted, you must have permission to use the KMS key that was
used to encrypt the snapshot. For more information, see Using encryption in the Amazon
Elastic Compute Cloud User Guide.
"""
function get_snapshot_block(
blockIndex, blockToken, snapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ebs(
"GET",
"/snapshots/$(snapshotId)/blocks/$(blockIndex)",
Dict{String,Any}("blockToken" => blockToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_snapshot_block(
blockIndex,
blockToken,
snapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ebs(
"GET",
"/snapshots/$(snapshotId)/blocks/$(blockIndex)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("blockToken" => blockToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_changed_blocks(second_snapshot_id)
list_changed_blocks(second_snapshot_id, params::Dict{String,<:Any})
Returns information about the blocks that are different between two Amazon Elastic Block
Store snapshots of the same volume/snapshot lineage. You should always retry requests that
receive server (5xx) error responses, and ThrottlingException and RequestThrottledException
client error responses. For more information see Error retries in the Amazon Elastic
Compute Cloud User Guide.
# Arguments
- `second_snapshot_id`: The ID of the second snapshot to use for the comparison. The
SecondSnapshotId parameter must be specified with a FirstSnapshotID parameter; otherwise,
an error occurs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"firstSnapshotId"`: The ID of the first snapshot to use for the comparison. The
FirstSnapshotID parameter must be specified with a SecondSnapshotId parameter; otherwise,
an error occurs.
- `"maxResults"`: The maximum number of blocks to be returned by the request. Even if
additional blocks can be retrieved from the snapshot, the request can return less blocks
than MaxResults or an empty array of blocks. To retrieve the next set of blocks from the
snapshot, make another request with the returned NextToken value. The value of NextToken is
null when there are no more blocks to return.
- `"pageToken"`: The token to request the next page of results. If you specify NextToken,
then StartingBlockIndex is ignored.
- `"startingBlockIndex"`: The block index from which the comparison should start. The list
in the response will start from this block index or the next valid block index in the
snapshots. If you specify NextToken, then StartingBlockIndex is ignored.
"""
function list_changed_blocks(
secondSnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ebs(
"GET",
"/snapshots/$(secondSnapshotId)/changedblocks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_changed_blocks(
secondSnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ebs(
"GET",
"/snapshots/$(secondSnapshotId)/changedblocks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_snapshot_blocks(snapshot_id)
list_snapshot_blocks(snapshot_id, params::Dict{String,<:Any})
Returns information about the blocks in an Amazon Elastic Block Store snapshot. You should
always retry requests that receive server (5xx) error responses, and ThrottlingException
and RequestThrottledException client error responses. For more information see Error
retries in the Amazon Elastic Compute Cloud User Guide.
# Arguments
- `snapshot_id`: The ID of the snapshot from which to get block indexes and block tokens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of blocks to be returned by the request. Even if
additional blocks can be retrieved from the snapshot, the request can return less blocks
than MaxResults or an empty array of blocks. To retrieve the next set of blocks from the
snapshot, make another request with the returned NextToken value. The value of NextToken is
null when there are no more blocks to return.
- `"pageToken"`: The token to request the next page of results. If you specify NextToken,
then StartingBlockIndex is ignored.
- `"startingBlockIndex"`: The block index from which the list should start. The list in the
response will start from this block index or the next valid block index in the snapshot. If
you specify NextToken, then StartingBlockIndex is ignored.
"""
function list_snapshot_blocks(snapshotId; aws_config::AbstractAWSConfig=global_aws_config())
return ebs(
"GET",
"/snapshots/$(snapshotId)/blocks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_snapshot_blocks(
snapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ebs(
"GET",
"/snapshots/$(snapshotId)/blocks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_snapshot_block(block_data, block_index, snapshot_id, x-amz-_checksum, x-amz-_checksum-_algorithm, x-amz-_data-_length)
put_snapshot_block(block_data, block_index, snapshot_id, x-amz-_checksum, x-amz-_checksum-_algorithm, x-amz-_data-_length, params::Dict{String,<:Any})
Writes a block of data to a snapshot. If the specified block contains data, the existing
data is overwritten. The target snapshot must be in the pending state. Data written to a
snapshot must be aligned with 512-KiB sectors. You should always retry requests that
receive server (5xx) error responses, and ThrottlingException and RequestThrottledException
client error responses. For more information see Error retries in the Amazon Elastic
Compute Cloud User Guide.
# Arguments
- `block_data`: The data to write to the block. The block data is not signed as part of the
Signature Version 4 signing process. As a result, you must generate and provide a
Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also,
you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The
checksum that you provide is part of the Signature Version 4 signing process. It is
validated against a checksum generated by Amazon EBS to ensure the validity and
authenticity of the data. If the checksums do not correspond, the request fails. For more
information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute
Cloud User Guide.
- `block_index`: The block index of the block in which to write the data. A block index is
a logical index in units of 512 KiB blocks. To identify the block index, divide the logical
offset of the data in the logical volume by the block size (logical offset of data/524288).
The logical offset of the data must be 512 KiB aligned.
- `snapshot_id`: The ID of the snapshot. If the specified snapshot is encrypted, you must
have permission to use the KMS key that was used to encrypt the snapshot. For more
information, see Using encryption in the Amazon Elastic Compute Cloud User Guide..
- `x-amz-_checksum`: A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums
are supported.
- `x-amz-_checksum-_algorithm`: The algorithm used to generate the checksum. Currently, the
only supported algorithm is SHA256.
- `x-amz-_data-_length`: The size of the data to write to the block, in bytes. Currently,
the only supported size is 524288 bytes. Valid values: 524288
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-Progress"`: The progress of the write process, as a percentage.
"""
function put_snapshot_block(
BlockData,
blockIndex,
snapshotId,
x_amz_Checksum,
x_amz_Checksum_Algorithm,
x_amz_Data_Length;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ebs(
"PUT",
"/snapshots/$(snapshotId)/blocks/$(blockIndex)",
Dict{String,Any}(
"BlockData" => BlockData,
"headers" => Dict{String,Any}(
"x-amz-Checksum" => x_amz_Checksum,
"x-amz-Checksum-Algorithm" => x_amz_Checksum_Algorithm,
"x-amz-Data-Length" => x_amz_Data_Length,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_snapshot_block(
BlockData,
blockIndex,
snapshotId,
x_amz_Checksum,
x_amz_Checksum_Algorithm,
x_amz_Data_Length,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ebs(
"PUT",
"/snapshots/$(snapshotId)/blocks/$(blockIndex)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BlockData" => BlockData,
"headers" => Dict{String,Any}(
"x-amz-Checksum" => x_amz_Checksum,
"x-amz-Checksum-Algorithm" => x_amz_Checksum_Algorithm,
"x-amz-Data-Length" => x_amz_Data_Length,
),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_snapshot(volume_size)
start_snapshot(volume_size, params::Dict{String,<:Any})
Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the
request completes. After creating the snapshot, use PutSnapshotBlock to write blocks of
data to the snapshot. You should always retry requests that receive server (5xx) error
responses, and ThrottlingException and RequestThrottledException client error responses.
For more information see Error retries in the Amazon Elastic Compute Cloud User Guide.
# Arguments
- `volume_size`: The size of the volume, in GiB. The maximum size is 65536 GiB (64 TiB).
# 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. Idempotency ensures that an API request completes only once.
With an idempotent request, if the original request completes successfully. The subsequent
retries with the same client token return the result from the original successful request
and they have no additional effect. If you do not specify a client token, one is
automatically generated by the Amazon Web Services SDK. For more information, see
Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.
- `"Description"`: A description for the snapshot.
- `"Encrypted"`: Indicates whether to encrypt the snapshot. You can't specify Encrypted and
ParentSnapshotId in the same request. If you specify both parameters, the request fails
with ValidationException. The encryption status of the snapshot depends on the values that
you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web
Services account is enabled for encryption by default. For more information, see Using
encryption in the Amazon Elastic Compute Cloud User Guide. To create an encrypted
snapshot, you must have permission to use the KMS key. For more information, see
Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User
Guide.
- `"KmsKeyArn"`: The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to
be used to encrypt the snapshot. The encryption status of the snapshot depends on the
values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your
Amazon Web Services account is enabled for encryption by default. For more information,
see Using encryption in the Amazon Elastic Compute Cloud User Guide. To create an
encrypted snapshot, you must have permission to use the KMS key. For more information, see
Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User
Guide.
- `"ParentSnapshotId"`: The ID of the parent snapshot. If there is no parent snapshot, or
if you are creating the first snapshot for an on-premises volume, omit this parameter. You
can't specify ParentSnapshotId and Encrypted in the same request. If you specify both
parameters, the request fails with ValidationException. The encryption status of the
snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and
ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption
by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud
User Guide. If you specify an encrypted parent snapshot, you must have permission to use
the KMS key that was used to encrypt the parent snapshot. For more information, see
Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User
Guide.
- `"Tags"`: The tags to apply to the snapshot.
- `"Timeout"`: The amount of time (in minutes) after which the snapshot is automatically
cancelled if: No blocks are written to the snapshot. The snapshot is not completed
after writing the last block of data. If no value is specified, the timeout defaults to
60 minutes.
"""
function start_snapshot(VolumeSize; aws_config::AbstractAWSConfig=global_aws_config())
return ebs(
"POST",
"/snapshots",
Dict{String,Any}("VolumeSize" => VolumeSize, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_snapshot(
VolumeSize,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ebs(
"POST",
"/snapshots",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VolumeSize" => VolumeSize, "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 | 1423507 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ec2
using AWS.Compat
using AWS.UUIDs
"""
accept_address_transfer(address)
accept_address_transfer(address, params::Dict{String,<:Any})
Accepts an Elastic IP address transfer. For more information, see Accept a transferred
Elastic IP address in the Amazon VPC User Guide.
# Arguments
- `address`: The Elastic IP address you are accepting for transfer.
# 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.
- `"TagSpecification"`: tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value as the filter value. For
example, to find all resources that have a tag with the key Owner and the value TeamA,
specify tag:Owner for the filter name and TeamA for the filter value.
"""
function accept_address_transfer(Address; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"AcceptAddressTransfer",
Dict{String,Any}("Address" => Address);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_address_transfer(
Address, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AcceptAddressTransfer",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Address" => Address), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
accept_reserved_instances_exchange_quote(reserved_instance_id)
accept_reserved_instances_exchange_quote(reserved_instance_id, params::Dict{String,<:Any})
Accepts the Convertible Reserved Instance exchange quote described in the
GetReservedInstancesExchangeQuote call.
# Arguments
- `reserved_instance_id`: The IDs of the Convertible Reserved Instances to exchange for
another Convertible Reserved Instance of the same or higher value.
# 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.
- `"TargetConfiguration"`: The configuration of the target Convertible Reserved Instance to
exchange for your current Convertible Reserved Instances.
"""
function accept_reserved_instances_exchange_quote(
ReservedInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AcceptReservedInstancesExchangeQuote",
Dict{String,Any}("ReservedInstanceId" => ReservedInstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_reserved_instances_exchange_quote(
ReservedInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AcceptReservedInstancesExchangeQuote",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReservedInstanceId" => ReservedInstanceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
accept_transit_gateway_multicast_domain_associations()
accept_transit_gateway_multicast_domain_associations(params::Dict{String,<:Any})
Accepts a request to associate subnets with a transit gateway multicast domain.
# 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.
- `"SubnetIds"`: The IDs of the subnets to associate with the transit gateway multicast
domain.
- `"TransitGatewayAttachmentId"`: The ID of the transit gateway attachment.
- `"TransitGatewayMulticastDomainId"`: The ID of the transit gateway multicast domain.
"""
function accept_transit_gateway_multicast_domain_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AcceptTransitGatewayMulticastDomainAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_transit_gateway_multicast_domain_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AcceptTransitGatewayMulticastDomainAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
accept_transit_gateway_peering_attachment(transit_gateway_attachment_id)
accept_transit_gateway_peering_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Accepts a transit gateway peering attachment request. The peering attachment must be in the
pendingAcceptance state.
# Arguments
- `transit_gateway_attachment_id`: The ID of the transit gateway attachment.
# 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.
"""
function accept_transit_gateway_peering_attachment(
TransitGatewayAttachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AcceptTransitGatewayPeeringAttachment",
Dict{String,Any}("TransitGatewayAttachmentId" => TransitGatewayAttachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_transit_gateway_peering_attachment(
TransitGatewayAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AcceptTransitGatewayPeeringAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
accept_transit_gateway_vpc_attachment(transit_gateway_attachment_id)
accept_transit_gateway_vpc_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Accepts a request to attach a VPC to a transit gateway. The VPC attachment must be in the
pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC
attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment
request.
# Arguments
- `transit_gateway_attachment_id`: The ID of the attachment.
# 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.
"""
function accept_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AcceptTransitGatewayVpcAttachment",
Dict{String,Any}("TransitGatewayAttachmentId" => TransitGatewayAttachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AcceptTransitGatewayVpcAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
accept_vpc_endpoint_connections(service_id, vpc_endpoint_id)
accept_vpc_endpoint_connections(service_id, vpc_endpoint_id, params::Dict{String,<:Any})
Accepts connection requests to your VPC endpoint service.
# Arguments
- `service_id`: The ID of the VPC endpoint service.
- `vpc_endpoint_id`: The IDs of the interface VPC endpoints.
# 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.
"""
function accept_vpc_endpoint_connections(
ServiceId, VpcEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AcceptVpcEndpointConnections",
Dict{String,Any}("ServiceId" => ServiceId, "VpcEndpointId" => VpcEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_vpc_endpoint_connections(
ServiceId,
VpcEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AcceptVpcEndpointConnections",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServiceId" => ServiceId, "VpcEndpointId" => VpcEndpointId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
accept_vpc_peering_connection(vpc_peering_connection_id)
accept_vpc_peering_connection(vpc_peering_connection_id, params::Dict{String,<:Any})
Accept a VPC peering connection request. To accept a request, the VPC peering connection
must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use
DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests. For
an inter-Region VPC peering connection request, you must accept the VPC peering connection
in the Region of the accepter VPC.
# Arguments
- `vpc_peering_connection_id`: The ID of the VPC peering connection. You must specify this
parameter in the request.
# 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.
"""
function accept_vpc_peering_connection(
vpcPeeringConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AcceptVpcPeeringConnection",
Dict{String,Any}("vpcPeeringConnectionId" => vpcPeeringConnectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_vpc_peering_connection(
vpcPeeringConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AcceptVpcPeeringConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("vpcPeeringConnectionId" => vpcPeeringConnectionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
advertise_byoip_cidr(cidr)
advertise_byoip_cidr(cidr, params::Dict{String,<:Any})
Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web
Services resources through bring your own IP addresses (BYOIP). You can perform this
operation at most once every 10 seconds, even if you specify different address ranges each
time. We recommend that you stop advertising the BYOIP CIDR from other locations when you
advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon
Web Services resources to use an address from a BYOIP CIDR before it is advertised, and
then simultaneously stop advertising it from the current location and start advertising it
through Amazon Web Services. It can take a few minutes before traffic to the specified
addresses starts routing to Amazon Web Services because of BGP propagation delays. To stop
advertising the BYOIP CIDR, use WithdrawByoipCidr.
# Arguments
- `cidr`: The address range, in CIDR notation. This must be the exact range that you
provisioned. You can't advertise only a portion of the provisioned range.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Asn"`: The public 2-byte or 4-byte ASN that you want to advertise.
- `"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.
- `"NetworkBorderGroup"`: If you have Local Zones enabled, you can choose a network border
group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network
border group carefully as the EIP and the Amazon Web Services resource it is associated
with must reside in the same network border group. You can provision BYOIP address ranges
to and advertise them in the following Local Zone network border groups: us-east-1-dfw-2
us-west-2-lax-1 us-west-2-phx-2 You cannot provision or advertise BYOIPv6 address
ranges in Local Zones at this time.
"""
function advertise_byoip_cidr(Cidr; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"AdvertiseByoipCidr",
Dict{String,Any}("Cidr" => Cidr);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function advertise_byoip_cidr(
Cidr, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AdvertiseByoipCidr",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Cidr" => Cidr), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
allocate_address()
allocate_address(params::Dict{String,<:Any})
Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the
Elastic IP address you can associate it with an instance or network interface. After you
release an Elastic IP address, it is released to the IP address pool and can be allocated
to a different Amazon Web Services account. You can allocate an Elastic IP address from an
address pool owned by Amazon Web Services or from an address pool created from a public
IPv4 address range that you have brought to Amazon Web Services for use with your Amazon
Web Services resources using bring your own IP addresses (BYOIP). For more information, see
Bring Your Own IP Addresses (BYOIP) in the Amazon EC2 User Guide. If you release an Elastic
IP address, you might be able to recover it. You cannot recover an Elastic IP address that
you released after it is allocated to another Amazon Web Services account. To attempt to
recover an Elastic IP address that you released, specify it in this operation. For more
information, see Elastic IP Addresses in the Amazon EC2 User Guide. You can allocate a
carrier IP address which is a public IP address from a telecommunication carrier, to a
network interface which resides in a subnet in a Wavelength Zone (for example an EC2
instance).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Address"`: The Elastic IP address to recover or an IPv4 address from an address pool.
- `"CustomerOwnedIpv4Pool"`: The ID of a customer-owned address pool. Use this parameter to
let Amazon EC2 select an address from the address pool. Alternatively, specify a specific
address from the address pool.
- `"Domain"`: The network (vpc).
- `"NetworkBorderGroup"`: A unique set of Availability Zones, Local Zones, or Wavelength
Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit
the IP address to this location. IP addresses cannot move between network border groups.
- `"PublicIpv4Pool"`: The ID of an address pool that you own. Use this parameter to let
Amazon EC2 select an address from the address pool. To specify a specific address from the
address pool, use the Address parameter instead.
- `"TagSpecification"`: The tags to assign to the Elastic IP address.
- `"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.
"""
function allocate_address(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("AllocateAddress"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function allocate_address(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AllocateAddress", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
allocate_hosts(availability_zone)
allocate_hosts(availability_zone, params::Dict{String,<:Any})
Allocates a Dedicated Host to your account. At a minimum, specify the supported instance
type or instance family, the Availability Zone in which to allocate the host, and the
number of hosts to allocate.
# Arguments
- `availability_zone`: The Availability Zone in which to allocate the Dedicated Host.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssetId"`: The IDs of the Outpost hardware assets on which to allocate the Dedicated
Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency
between your workloads. This parameter is supported only if you specify OutpostArn. If you
are allocating the Dedicated Hosts in a Region, omit this parameter. If you specify this
parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on
each specified hardware asset. If you specify both AssetIds and Quantity, then the value
for Quantity must be equal to the number of asset IDs specified.
- `"HostMaintenance"`: Indicates whether to enable or disable host maintenance for the
Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
- `"HostRecovery"`: Indicates whether to enable or disable host recovery for the Dedicated
Host. Host recovery is disabled by default. For more information, see Host recovery in the
Amazon EC2 User Guide. Default: off
- `"InstanceFamily"`: Specifies the instance family to be supported by the Dedicated Hosts.
If you specify an instance family, the Dedicated Hosts support multiple instance types
within that instance family. If you want the Dedicated Hosts to support a specific instance
type only, omit this parameter and specify InstanceType instead. You cannot specify
InstanceFamily and InstanceType in the same request.
- `"OutpostArn"`: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on
which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify
AssetIds. If you are allocating the Dedicated Host in a Region, omit this parameter.
- `"TagSpecification"`: The tags to apply to the Dedicated Host during creation.
- `"autoPlacement"`: Indicates whether the host accepts any untargeted instance launches
that match its instance type configuration, or if it only accepts Host tenancy instance
launches that specify its unique host ID. For more information, see Understanding
auto-placement and affinity in the Amazon EC2 User Guide. Default: off
- `"clientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring Idempotency.
- `"instanceType"`: Specifies the instance type to be supported by the Dedicated Hosts. If
you specify an instance type, the Dedicated Hosts support instances of the specified
instance type only. If you want the Dedicated Hosts to support multiple instance types in a
specific instance family, omit this parameter and specify InstanceFamily instead. You
cannot specify InstanceType and InstanceFamily in the same request.
- `"quantity"`: The number of Dedicated Hosts to allocate to your account with these
parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify
AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host
on each specified hardware asset. If you specify both AssetIds and Quantity, then the value
that you specify for Quantity must be equal to the number of asset IDs specified.
"""
function allocate_hosts(availabilityZone; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"AllocateHosts",
Dict{String,Any}("availabilityZone" => availabilityZone);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function allocate_hosts(
availabilityZone,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AllocateHosts",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("availabilityZone" => availabilityZone), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
allocate_ipam_pool_cidr(ipam_pool_id)
allocate_ipam_pool_cidr(ipam_pool_id, params::Dict{String,<:Any})
Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The
locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a
resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide. This
action creates an allocation with strong consistency. The returned CIDR will not overlap
with any other allocations from the same pool.
# Arguments
- `ipam_pool_id`: The ID of the IPAM pool from which you would like to allocate a CIDR.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowedCidr"`: Include a particular CIDR range that can be returned by the pool.
Allowed CIDRs are only allowed if using netmask length for allocation.
- `"Cidr"`: The CIDR you would like to allocate from the IPAM pool. Note the following:
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify
either the NetmaskLength or the CIDR. If the DefaultNetmaskLength allocation rule is set
on the pool, you can specify either the NetmaskLength or the CIDR and the
DefaultNetmaskLength allocation rule will be ignored. Possible values: Any available IPv4
or IPv6 CIDR.
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the allocation.
- `"DisallowedCidr"`: Exclude a particular CIDR range from being returned by the pool.
Disallowed CIDRs are only allowed if using netmask length for allocation.
- `"DryRun"`: A check for 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.
- `"NetmaskLength"`: The netmask length of the CIDR you would like to allocate from the
IPAM pool. Note the following: If there is no DefaultNetmaskLength allocation rule set on
the pool, you must specify either the NetmaskLength or the CIDR. If the
DefaultNetmaskLength allocation rule is set on the pool, you can specify either the
NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6
addresses are 0 - 128.
- `"PreviewNextCidr"`: A preview of the next available CIDR in a pool.
"""
function allocate_ipam_pool_cidr(
IpamPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AllocateIpamPoolCidr",
Dict{String,Any}("IpamPoolId" => IpamPoolId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function allocate_ipam_pool_cidr(
IpamPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AllocateIpamPoolCidr",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IpamPoolId" => IpamPoolId, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
apply_security_groups_to_client_vpn_target_network(client_vpn_endpoint_id, security_group_id, vpc_id)
apply_security_groups_to_client_vpn_target_network(client_vpn_endpoint_id, security_group_id, vpc_id, params::Dict{String,<:Any})
Applies a security group to the association between the target network and the Client VPN
endpoint. This action replaces the existing security groups with the specified security
groups.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint.
- `security_group_id`: The IDs of the security groups to apply to the associated target
network. Up to 5 security groups can be applied to an associated target network.
- `vpc_id`: The ID of the VPC in which the associated target network is located.
# 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.
"""
function apply_security_groups_to_client_vpn_target_network(
ClientVpnEndpointId,
SecurityGroupId,
VpcId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ApplySecurityGroupsToClientVpnTargetNetwork",
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"SecurityGroupId" => SecurityGroupId,
"VpcId" => VpcId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function apply_security_groups_to_client_vpn_target_network(
ClientVpnEndpointId,
SecurityGroupId,
VpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ApplySecurityGroupsToClientVpnTargetNetwork",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"SecurityGroupId" => SecurityGroupId,
"VpcId" => VpcId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assign_ipv6_addresses(network_interface_id)
assign_ipv6_addresses(network_interface_id, params::Dict{String,<:Any})
Assigns one or more IPv6 addresses to the specified network interface. You can specify one
or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be
automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as
many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and
the limit varies per instance type. You must specify either the IPv6 addresses or the IPv6
address count in the request. You can optionally use Prefix Delegation on the network
interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix
Delegation count. For information, see Assigning prefixes to network interfaces in the
Amazon EC2 User Guide.
# Arguments
- `network_interface_id`: The ID of the network interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Ipv6Prefix"`: One or more IPv6 prefixes assigned to the network interface. You cannot
use this option if you use the Ipv6PrefixCount option.
- `"Ipv6PrefixCount"`: The number of IPv6 prefixes that Amazon Web Services automatically
assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes
option.
- `"ipv6AddressCount"`: The number of additional IPv6 addresses to assign to the network
interface. The specified number of IPv6 addresses are assigned in addition to the existing
IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically
selects the IPv6 addresses from the subnet range. You can't use this option if specifying
specific IPv6 addresses.
- `"ipv6Addresses"`: The IPv6 addresses to be assigned to the network interface. You can't
use this option if you're specifying a number of IPv6 addresses.
"""
function assign_ipv6_addresses(
networkInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssignIpv6Addresses",
Dict{String,Any}("networkInterfaceId" => networkInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assign_ipv6_addresses(
networkInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssignIpv6Addresses",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("networkInterfaceId" => networkInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assign_private_ip_addresses(network_interface_id)
assign_private_ip_addresses(network_interface_id, params::Dict{String,<:Any})
Assigns one or more secondary private IP addresses to the specified network interface. You
can specify one or more specific secondary IP addresses, or you can specify the number of
secondary IP addresses to be automatically assigned within the subnet's CIDR block range.
The number of secondary IP addresses that you can assign to an instance varies by instance
type. For more information about Elastic IP addresses, see Elastic IP Addresses in the
Amazon EC2 User Guide. When you move a secondary private IP address to another network
interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one
network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance
metadata to confirm that the remapping is complete. You must specify either the IP
addresses or the IP address count in the request. You can optionally use Prefix Delegation
on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or
the IPv4 Prefix Delegation count. For information, see Assigning prefixes to network
interfaces in the Amazon EC2 User Guide.
# Arguments
- `network_interface_id`: The ID of the network interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Ipv4Prefix"`: One or more IPv4 prefixes assigned to the network interface. You cannot
use this option if you use the Ipv4PrefixCount option.
- `"Ipv4PrefixCount"`: The number of IPv4 prefixes that Amazon Web Services automatically
assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes
option.
- `"allowReassignment"`: Indicates whether to allow an IP address that is already assigned
to another network interface or instance to be reassigned to the specified network
interface.
- `"privateIpAddress"`: The IP addresses to be assigned as a secondary private IP address
to the network interface. You can't specify this parameter when also specifying a number of
secondary IP addresses. If you don't specify an IP address, Amazon EC2 automatically
selects an IP address within the subnet range.
- `"secondaryPrivateIpAddressCount"`: The number of secondary IP addresses to assign to the
network interface. You can't specify this parameter when also specifying private IP
addresses.
"""
function assign_private_ip_addresses(
networkInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssignPrivateIpAddresses",
Dict{String,Any}("networkInterfaceId" => networkInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assign_private_ip_addresses(
networkInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssignPrivateIpAddresses",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("networkInterfaceId" => networkInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
assign_private_nat_gateway_address(nat_gateway_id)
assign_private_nat_gateway_address(nat_gateway_id, params::Dict{String,<:Any})
Assigns private IPv4 addresses to a private NAT gateway. For more information, see Work
with NAT gateways in the Amazon VPC User Guide.
# Arguments
- `nat_gateway_id`: The ID of the NAT gateway.
# 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.
- `"PrivateIpAddress"`: The private IPv4 addresses you want to assign to the private NAT
gateway.
- `"PrivateIpAddressCount"`: The number of private IP addresses to assign to the NAT
gateway. You can't specify this parameter when also specifying private IP addresses.
"""
function assign_private_nat_gateway_address(
NatGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssignPrivateNatGatewayAddress",
Dict{String,Any}("NatGatewayId" => NatGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assign_private_nat_gateway_address(
NatGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssignPrivateNatGatewayAddress",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("NatGatewayId" => NatGatewayId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_address()
associate_address(params::Dict{String,<:Any})
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets
in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic
IP address, you must allocate it to your account. If the Elastic IP address is already
associated with a different instance, it is disassociated from that instance and associated
with the specified instance. If you associate an Elastic IP address with an instance that
has an existing Elastic IP address, the existing address is disassociated from the
instance, but remains allocated to your account. [Subnets in Wavelength Zones] You can
associate an IP address from the telecommunication carrier to the instance or network
interface. You cannot associate an Elastic IP address with an interface in a different
network border group. This is an idempotent operation. If you perform the operation more
than once, Amazon EC2 doesn't return an error, and you may be charged for each time the
Elastic IP address is remapped to the same instance. For more information, see the Elastic
IP Addresses section of Amazon EC2 Pricing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocationId"`: The allocation ID. This is required.
- `"InstanceId"`: The ID of the instance. The instance must have exactly one attached
network interface. You can specify either the instance ID or the network interface ID, but
not both.
- `"PublicIp"`: Deprecated.
- `"allowReassociation"`: Reassociation is automatic, but you can specify false to ensure
the operation fails if the Elastic IP address is already associated with another resource.
- `"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.
- `"networkInterfaceId"`: The ID of the network interface. If the instance has more than
one network interface, you must specify a network interface ID. You can specify either the
instance ID or the network interface ID, but not both.
- `"privateIpAddress"`: The primary or secondary private IP address to associate with the
Elastic IP address. If no private IP address is specified, the Elastic IP address is
associated with the primary private IP address.
"""
function associate_address(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("AssociateAddress"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function associate_address(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateAddress", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
associate_client_vpn_target_network(client_vpn_endpoint_id, subnet_id)
associate_client_vpn_target_network(client_vpn_endpoint_id, subnet_id, params::Dict{String,<:Any})
Associates a target network with a Client VPN endpoint. A target network is a subnet in a
VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You
can associate only one subnet in each Availability Zone. We recommend that you associate at
least two subnets to provide Availability Zone redundancy. If you specified a VPC when you
created the Client VPN endpoint or if you have previous subnet associations, the specified
subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must
first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's
associated with it.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint.
- `subnet_id`: The ID of the subnet to associate with the Client VPN endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"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.
"""
function associate_client_vpn_target_network(
ClientVpnEndpointId, SubnetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateClientVpnTargetNetwork",
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"SubnetId" => SubnetId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_client_vpn_target_network(
ClientVpnEndpointId,
SubnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateClientVpnTargetNetwork",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"SubnetId" => SubnetId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_dhcp_options(dhcp_options_id, vpc_id)
associate_dhcp_options(dhcp_options_id, vpc_id, params::Dict{String,<:Any})
Associates a set of DHCP options (that you've previously created) with the specified VPC,
or associates no DHCP options with the VPC. After you associate the options with the VPC,
any existing instances and all new instances that you launch in that VPC use the options.
You don't need to restart or relaunch the instances. They automatically pick up the changes
within a few hours, depending on how frequently the instance renews its DHCP lease. You can
explicitly renew the lease using the operating system on the instance. For more
information, see DHCP option sets in the Amazon VPC User Guide.
# Arguments
- `dhcp_options_id`: The ID of the DHCP options set, or default to associate no DHCP
options with the VPC.
- `vpc_id`: The ID of the VPC.
# 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.
"""
function associate_dhcp_options(
DhcpOptionsId, VpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateDhcpOptions",
Dict{String,Any}("DhcpOptionsId" => DhcpOptionsId, "VpcId" => VpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_dhcp_options(
DhcpOptionsId,
VpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateDhcpOptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DhcpOptionsId" => DhcpOptionsId, "VpcId" => VpcId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_enclave_certificate_iam_role(certificate_arn, role_arn)
associate_enclave_certificate_iam_role(certificate_arn, role_arn, params::Dict{String,<:Any})
Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM)
certificate. This enables the certificate to be used by the ACM for Nitro Enclaves
application inside an enclave. For more information, see Certificate Manager for Nitro
Enclaves in the Amazon Web Services Nitro Enclaves User Guide. When the IAM role is
associated with the ACM certificate, the certificate, certificate chain, and encrypted
private key are placed in an Amazon S3 location that only the associated IAM role can
access. The private key of the certificate is encrypted with an Amazon Web Services managed
key that has an attached attestation-based key policy. To enable the IAM role to access the
Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket
returned by the command. To enable the IAM role to access the KMS key, you must grant it
permission to call kms:Decrypt on the KMS key returned by the command. For more
information, see Grant the role permission to access the certificate and encryption key in
the Amazon Web Services Nitro Enclaves User Guide.
# Arguments
- `certificate_arn`: The ARN of the ACM certificate with which to associate the IAM role.
- `role_arn`: The ARN of the IAM role to associate with the ACM certificate. You can
associate up to 16 IAM roles with an ACM certificate.
# 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.
"""
function associate_enclave_certificate_iam_role(
CertificateArn, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateEnclaveCertificateIamRole",
Dict{String,Any}("CertificateArn" => CertificateArn, "RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_enclave_certificate_iam_role(
CertificateArn,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateEnclaveCertificateIamRole",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CertificateArn" => CertificateArn, "RoleArn" => RoleArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_iam_instance_profile(iam_instance_profile, instance_id)
associate_iam_instance_profile(iam_instance_profile, instance_id, params::Dict{String,<:Any})
Associates an IAM instance profile with a running or stopped instance. You cannot associate
more than one IAM instance profile with an instance.
# Arguments
- `iam_instance_profile`: The IAM instance profile.
- `instance_id`: The ID of the instance.
"""
function associate_iam_instance_profile(
IamInstanceProfile, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateIamInstanceProfile",
Dict{String,Any}(
"IamInstanceProfile" => IamInstanceProfile, "InstanceId" => InstanceId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_iam_instance_profile(
IamInstanceProfile,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateIamInstanceProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IamInstanceProfile" => IamInstanceProfile, "InstanceId" => InstanceId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_instance_event_window(association_target, instance_event_window_id)
associate_instance_event_window(association_target, instance_event_window_id, params::Dict{String,<:Any})
Associates one or more targets with an event window. Only one type of target (instance IDs,
Dedicated Host IDs, or tags) can be specified with an event window. For more information,
see Define event windows for scheduled events in the Amazon EC2 User Guide.
# Arguments
- `association_target`: One or more targets associated with the specified event window.
- `instance_event_window_id`: The ID of the event window.
# 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.
"""
function associate_instance_event_window(
AssociationTarget,
InstanceEventWindowId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateInstanceEventWindow",
Dict{String,Any}(
"AssociationTarget" => AssociationTarget,
"InstanceEventWindowId" => InstanceEventWindowId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_instance_event_window(
AssociationTarget,
InstanceEventWindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateInstanceEventWindow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationTarget" => AssociationTarget,
"InstanceEventWindowId" => InstanceEventWindowId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_ipam_byoasn(asn, cidr)
associate_ipam_byoasn(asn, cidr, params::Dict{String,<:Any})
Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same
Amazon Web Services Region. For more information, see Tutorial: Bring your ASN to IPAM in
the Amazon VPC IPAM guide. After the association succeeds, the ASN is eligible for
advertisement. You can view the association with DescribeByoipCidrs. You can advertise the
CIDR with AdvertiseByoipCidr.
# Arguments
- `asn`: A public 2-byte or 4-byte ASN.
- `cidr`: The BYOIP CIDR you want to associate with an ASN.
# 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.
"""
function associate_ipam_byoasn(Asn, Cidr; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"AssociateIpamByoasn",
Dict{String,Any}("Asn" => Asn, "Cidr" => Cidr);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_ipam_byoasn(
Asn,
Cidr,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateIpamByoasn",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Asn" => Asn, "Cidr" => Cidr), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_ipam_resource_discovery(ipam_id, ipam_resource_discovery_id)
associate_ipam_resource_discovery(ipam_id, ipam_resource_discovery_id, params::Dict{String,<:Any})
Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an
IPAM component that enables IPAM to manage and monitor resources that belong to the owning
account.
# Arguments
- `ipam_id`: An IPAM ID.
- `ipam_resource_discovery_id`: A resource discovery ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A client token.
- `"DryRun"`: A check for 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.
- `"TagSpecification"`: Tag specifications.
"""
function associate_ipam_resource_discovery(
IpamId, IpamResourceDiscoveryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateIpamResourceDiscovery",
Dict{String,Any}(
"IpamId" => IpamId,
"IpamResourceDiscoveryId" => IpamResourceDiscoveryId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_ipam_resource_discovery(
IpamId,
IpamResourceDiscoveryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateIpamResourceDiscovery",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IpamId" => IpamId,
"IpamResourceDiscoveryId" => IpamResourceDiscoveryId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_nat_gateway_address(allocation_id, nat_gateway_id)
associate_nat_gateway_address(allocation_id, nat_gateway_id, params::Dict{String,<:Any})
Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT
gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide. By
default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can
increase the limit by requesting a quota adjustment. For more information, see Elastic IP
address quotas in the Amazon VPC User Guide. When you associate an EIP or secondary EIPs
with a public NAT gateway, the network border group of the EIPs must match the network
border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not
the same, the EIP will fail to associate. You can see the network border group for the
subnet's AZ by viewing the details of the subnet. Similarly, you can view the network
border group of an EIP by viewing the details of the EIP address. For more information
about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC
User Guide.
# Arguments
- `allocation_id`: The allocation IDs of EIPs that you want to associate with your NAT
gateway.
- `nat_gateway_id`: The ID of the NAT gateway.
# 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.
- `"PrivateIpAddress"`: The private IPv4 addresses that you want to assign to the NAT
gateway.
"""
function associate_nat_gateway_address(
AllocationId, NatGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateNatGatewayAddress",
Dict{String,Any}("AllocationId" => AllocationId, "NatGatewayId" => NatGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_nat_gateway_address(
AllocationId,
NatGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateNatGatewayAddress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AllocationId" => AllocationId, "NatGatewayId" => NatGatewayId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_route_table(route_table_id)
associate_route_table(route_table_id, params::Dict{String,<:Any})
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached
to your VPC with a route table in your VPC. This association causes traffic from the subnet
or gateway to be routed according to the routes in the route table. The action returns an
association ID, which you need in order to disassociate the route table later. A route
table can be associated with multiple subnets. For more information, see Route tables in
the Amazon VPC User Guide.
# Arguments
- `route_table_id`: The ID of the route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GatewayId"`: The ID of the internet gateway or virtual private gateway.
- `"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.
- `"subnetId"`: The ID of the subnet.
"""
function associate_route_table(
routeTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateRouteTable",
Dict{String,Any}("routeTableId" => routeTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_route_table(
routeTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateRouteTable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("routeTableId" => routeTableId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_subnet_cidr_block(subnet_id)
associate_subnet_cidr_block(subnet_id, params::Dict{String,<:Any})
Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block
with your subnet.
# Arguments
- `subnet_id`: The ID of your subnet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Ipv6IpamPoolId"`: An IPv6 IPAM pool ID.
- `"Ipv6NetmaskLength"`: An IPv6 netmask length.
- `"ipv6CidrBlock"`: The IPv6 CIDR block for your subnet.
"""
function associate_subnet_cidr_block(
subnetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateSubnetCidrBlock",
Dict{String,Any}("subnetId" => subnetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_subnet_cidr_block(
subnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateSubnetCidrBlock",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("subnetId" => subnetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_transit_gateway_multicast_domain(transit_gateway_attachment_id, transit_gateway_multicast_domain_id, item)
associate_transit_gateway_multicast_domain(transit_gateway_attachment_id, transit_gateway_multicast_domain_id, item, params::Dict{String,<:Any})
Associates the specified subnets and transit gateway attachments with the specified transit
gateway multicast domain. The transit gateway attachment must be in the available state
before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of
the attachment.
# Arguments
- `transit_gateway_attachment_id`: The ID of the transit gateway attachment to associate
with the transit gateway multicast domain.
- `transit_gateway_multicast_domain_id`: The ID of the transit gateway multicast domain.
- `item`: The IDs of the subnets to associate with the transit gateway multicast domain.
# 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.
- `"SubnetIds"`: The IDs of the subnets to associate with the transit gateway multicast
domain.
"""
function associate_transit_gateway_multicast_domain(
TransitGatewayAttachmentId,
TransitGatewayMulticastDomainId,
item;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateTransitGatewayMulticastDomain",
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId,
"item" => item,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_transit_gateway_multicast_domain(
TransitGatewayAttachmentId,
TransitGatewayMulticastDomainId,
item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateTransitGatewayMulticastDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId,
"item" => item,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_transit_gateway_policy_table(transit_gateway_attachment_id, transit_gateway_policy_table_id)
associate_transit_gateway_policy_table(transit_gateway_attachment_id, transit_gateway_policy_table_id, params::Dict{String,<:Any})
Associates the specified transit gateway attachment with a transit gateway policy table.
# Arguments
- `transit_gateway_attachment_id`: The ID of the transit gateway attachment to associate
with the policy table.
- `transit_gateway_policy_table_id`: The ID of the transit gateway policy table to
associate with the transit gateway attachment.
# 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.
"""
function associate_transit_gateway_policy_table(
TransitGatewayAttachmentId,
TransitGatewayPolicyTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateTransitGatewayPolicyTable",
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayPolicyTableId" => TransitGatewayPolicyTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_transit_gateway_policy_table(
TransitGatewayAttachmentId,
TransitGatewayPolicyTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateTransitGatewayPolicyTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayPolicyTableId" => TransitGatewayPolicyTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_transit_gateway_route_table(transit_gateway_attachment_id, transit_gateway_route_table_id)
associate_transit_gateway_route_table(transit_gateway_attachment_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Associates the specified attachment with the specified transit gateway route table. You can
associate only one route table with an attachment.
# Arguments
- `transit_gateway_attachment_id`: The ID of the attachment.
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# 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.
"""
function associate_transit_gateway_route_table(
TransitGatewayAttachmentId,
TransitGatewayRouteTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateTransitGatewayRouteTable",
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_transit_gateway_route_table(
TransitGatewayAttachmentId,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateTransitGatewayRouteTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_trunk_interface(branch_interface_id, trunk_interface_id)
associate_trunk_interface(branch_interface_id, trunk_interface_id, params::Dict{String,<:Any})
Associates a branch network interface with a trunk network interface. Before you create the
association, use CreateNetworkInterface command and set the interface type to trunk. You
must also create a network interface for each branch network interface that you want to
associate with the trunk network interface.
# Arguments
- `branch_interface_id`: The ID of the branch network interface.
- `trunk_interface_id`: The ID of the trunk network interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"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.
- `"GreKey"`: The application key. This applies to the GRE protocol.
- `"VlanId"`: The ID of the VLAN. This applies to the VLAN protocol.
"""
function associate_trunk_interface(
BranchInterfaceId, TrunkInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateTrunkInterface",
Dict{String,Any}(
"BranchInterfaceId" => BranchInterfaceId,
"TrunkInterfaceId" => TrunkInterfaceId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_trunk_interface(
BranchInterfaceId,
TrunkInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AssociateTrunkInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BranchInterfaceId" => BranchInterfaceId,
"TrunkInterfaceId" => TrunkInterfaceId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_vpc_cidr_block(vpc_id)
associate_vpc_cidr_block(vpc_id, params::Dict{String,<:Any})
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an
Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you
provisioned through bring your own IP addresses (BYOIP). You must specify one of the
following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR
block. For more information about associating CIDR blocks with your VPC and applicable
restrictions, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
# Arguments
- `vpc_id`: The ID of the VPC.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CidrBlock"`: An IPv4 CIDR block to associate with the VPC.
- `"Ipv4IpamPoolId"`: Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more
information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC
IPAM User Guide.
- `"Ipv4NetmaskLength"`: The netmask length of the IPv4 CIDR you would like to associate
from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see
What is IPAM? in the Amazon VPC IPAM User Guide.
- `"Ipv6CidrBlock"`: An IPv6 CIDR block from the IPv6 address pool. You must also specify
Ipv6Pool in the request. To let Amazon choose the IPv6 CIDR block for you, omit this
parameter.
- `"Ipv6CidrBlockNetworkBorderGroup"`: The name of the location from which we advertise the
IPV6 CIDR block. Use this parameter to limit the CIDR block to this location. You must set
AmazonProvidedIpv6CidrBlock to true to use this parameter. You can have one IPv6 CIDR
block association per network border group.
- `"Ipv6IpamPoolId"`: Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more
information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC
IPAM User Guide.
- `"Ipv6NetmaskLength"`: The netmask length of the IPv6 CIDR you would like to associate
from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see
What is IPAM? in the Amazon VPC IPAM User Guide.
- `"Ipv6Pool"`: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
- `"amazonProvidedIpv6CidrBlock"`: Requests an Amazon-provided IPv6 CIDR block with a /56
prefix length for the VPC. You cannot specify the range of IPv6 addresses or the size of
the CIDR block.
"""
function associate_vpc_cidr_block(vpcId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"AssociateVpcCidrBlock",
Dict{String,Any}("vpcId" => vpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_vpc_cidr_block(
vpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AssociateVpcCidrBlock",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("vpcId" => vpcId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_classic_link_vpc(security_group_id, instance_id, vpc_id)
attach_classic_link_vpc(security_group_id, instance_id, vpc_id, params::Dict{String,<:Any})
This action is deprecated. Links an EC2-Classic instance to a ClassicLink-enabled VPC
through one or more of the VPC security groups. You cannot link an EC2-Classic instance to
more than one VPC at a time. You can only link an instance that's in the running state. An
instance is automatically unlinked from a VPC when it's stopped - you can link it to the
VPC again when you restart it. After you've linked an instance, you cannot change the VPC
security groups that are associated with it. To change the security groups, you must first
unlink the instance, and then link it again. Linking your instance to a VPC is sometimes
referred to as attaching your instance.
# Arguments
- `security_group_id`: The IDs of the security groups. You cannot specify security groups
from a different VPC.
- `instance_id`: The ID of the EC2-Classic instance.
- `vpc_id`: The ID of the ClassicLink-enabled VPC.
# 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.
"""
function attach_classic_link_vpc(
SecurityGroupId, instanceId, vpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AttachClassicLinkVpc",
Dict{String,Any}(
"SecurityGroupId" => SecurityGroupId,
"instanceId" => instanceId,
"vpcId" => vpcId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_classic_link_vpc(
SecurityGroupId,
instanceId,
vpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AttachClassicLinkVpc",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SecurityGroupId" => SecurityGroupId,
"instanceId" => instanceId,
"vpcId" => vpcId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_internet_gateway(internet_gateway_id, vpc_id)
attach_internet_gateway(internet_gateway_id, vpc_id, params::Dict{String,<:Any})
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity
between the internet and the VPC. For more information, see Internet gateways in the Amazon
VPC User Guide.
# Arguments
- `internet_gateway_id`: The ID of the internet gateway.
- `vpc_id`: The ID of the VPC.
# 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.
"""
function attach_internet_gateway(
internetGatewayId, vpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AttachInternetGateway",
Dict{String,Any}("internetGatewayId" => internetGatewayId, "vpcId" => vpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_internet_gateway(
internetGatewayId,
vpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AttachInternetGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"internetGatewayId" => internetGatewayId, "vpcId" => vpcId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_network_interface(device_index, instance_id, network_interface_id)
attach_network_interface(device_index, instance_id, network_interface_id, params::Dict{String,<:Any})
Attaches a network interface to an instance.
# Arguments
- `device_index`: The index of the device for the network interface attachment.
- `instance_id`: The ID of the instance.
- `network_interface_id`: The ID of the network interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnaSrdSpecification"`: Configures ENA Express for the network interface that this
action attaches to the instance.
- `"NetworkCardIndex"`: The index of the network card. Some instance types support multiple
network cards. The primary network interface must be assigned to network card index 0. The
default is network card index 0.
- `"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.
"""
function attach_network_interface(
deviceIndex,
instanceId,
networkInterfaceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AttachNetworkInterface",
Dict{String,Any}(
"deviceIndex" => deviceIndex,
"instanceId" => instanceId,
"networkInterfaceId" => networkInterfaceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_network_interface(
deviceIndex,
instanceId,
networkInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AttachNetworkInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"deviceIndex" => deviceIndex,
"instanceId" => instanceId,
"networkInterfaceId" => networkInterfaceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_verified_access_trust_provider(verified_access_instance_id, verified_access_trust_provider_id)
attach_verified_access_trust_provider(verified_access_instance_id, verified_access_trust_provider_id, params::Dict{String,<:Any})
Attaches the specified Amazon Web Services Verified Access trust provider to the specified
Amazon Web Services Verified Access instance.
# Arguments
- `verified_access_instance_id`: The ID of the Verified Access instance.
- `verified_access_trust_provider_id`: The ID of the Verified Access trust provider.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"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.
"""
function attach_verified_access_trust_provider(
VerifiedAccessInstanceId,
VerifiedAccessTrustProviderId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AttachVerifiedAccessTrustProvider",
Dict{String,Any}(
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"VerifiedAccessTrustProviderId" => VerifiedAccessTrustProviderId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_verified_access_trust_provider(
VerifiedAccessInstanceId,
VerifiedAccessTrustProviderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AttachVerifiedAccessTrustProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"VerifiedAccessTrustProviderId" => VerifiedAccessTrustProviderId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_volume(device, instance_id, volume_id)
attach_volume(device, instance_id, volume_id, params::Dict{String,<:Any})
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with
the specified device name. Encrypted EBS volumes must be attached to instances that support
Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon EBS
User Guide. After you attach an EBS volume, you must make it available. For more
information, see Make an EBS volume available for use. If a volume has an Amazon Web
Services Marketplace product code: The volume can be attached only to a stopped instance.
Amazon Web Services Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product. The instance type and operating system of the
instance must support the product. For example, you can't detach a volume from a Windows
instance and attach it to a Linux instance. For more information, see Attach an Amazon
EBS volume to an instance in the Amazon EBS User Guide.
# Arguments
- `device`: The device name (for example, /dev/sdh or xvdh).
- `instance_id`: The ID of the instance.
- `volume_id`: The ID of the EBS volume. The volume and instance must be within the same
Availability Zone.
# 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.
"""
function attach_volume(
Device, InstanceId, VolumeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AttachVolume",
Dict{String,Any}(
"Device" => Device, "InstanceId" => InstanceId, "VolumeId" => VolumeId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_volume(
Device,
InstanceId,
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AttachVolume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Device" => Device, "InstanceId" => InstanceId, "VolumeId" => VolumeId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_vpn_gateway(vpc_id, vpn_gateway_id)
attach_vpn_gateway(vpc_id, vpn_gateway_id, params::Dict{String,<:Any})
Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to
one VPC at a time. For more information, see Amazon Web Services Site-to-Site VPN in the
Amazon Web Services Site-to-Site VPN User Guide.
# Arguments
- `vpc_id`: The ID of the VPC.
- `vpn_gateway_id`: The ID of the virtual private gateway.
# 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.
"""
function attach_vpn_gateway(
VpcId, VpnGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AttachVpnGateway",
Dict{String,Any}("VpcId" => VpcId, "VpnGatewayId" => VpnGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_vpn_gateway(
VpcId,
VpnGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AttachVpnGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VpcId" => VpcId, "VpnGatewayId" => VpnGatewayId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
authorize_client_vpn_ingress(client_vpn_endpoint_id, target_network_cidr)
authorize_client_vpn_ingress(client_vpn_endpoint_id, target_network_cidr, params::Dict{String,<:Any})
Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules
act as firewall rules that grant access to networks. You must configure ingress
authorization rules to enable clients to access resources in Amazon Web Services or
on-premises networks.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint.
- `target_network_cidr`: The IPv4 address range, in CIDR notation, of the network for which
access is being authorized.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessGroupId"`: The ID of the group to grant access to, for example, the Active
Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false
or not specified.
- `"AuthorizeAllGroups"`: Indicates whether to grant access to all clients. Specify true to
grant all clients who successfully establish a VPN connection access to the network. Must
be set to true if AccessGroupId is not specified.
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"Description"`: A brief description of the authorization rule.
- `"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.
"""
function authorize_client_vpn_ingress(
ClientVpnEndpointId,
TargetNetworkCidr;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AuthorizeClientVpnIngress",
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"TargetNetworkCidr" => TargetNetworkCidr,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function authorize_client_vpn_ingress(
ClientVpnEndpointId,
TargetNetworkCidr,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"AuthorizeClientVpnIngress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"TargetNetworkCidr" => TargetNetworkCidr,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
authorize_security_group_egress(group_id)
authorize_security_group_egress(group_id, params::Dict{String,<:Any})
Adds the specified outbound (egress) rules to a security group. An outbound rule permits
instances to send traffic to the specified IPv4 or IPv6 address ranges, the IP address
ranges specified by a prefix list, or the instances that are associated with a source
security group. For more information, see Security group rules. You must specify exactly
one of the following destinations: an IPv4 or IPv6 address range, a prefix list, or a
security group. You must specify a protocol for each rule (for example, TCP). If the
protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP
or ICMPv6, you must also specify the ICMP type and code. Rule changes are propagated to
instances associated with the security group as quickly as possible. However, a small delay
might occur. For examples of rules that you can add to security groups for specific access
scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For information about security group quotas, see Amazon VPC quotas in the Amazon VPC User
Guide.
# Arguments
- `group_id`: The ID of the security group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagSpecification"`: The tags applied to the security group rule.
- `"cidrIp"`: Not supported. Use IP permissions instead.
- `"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.
- `"fromPort"`: Not supported. Use IP permissions instead.
- `"ipPermissions"`: The permissions for the security group rules.
- `"ipProtocol"`: Not supported. Use IP permissions instead.
- `"sourceSecurityGroupName"`: Not supported. Use IP permissions instead.
- `"sourceSecurityGroupOwnerId"`: Not supported. Use IP permissions instead.
- `"toPort"`: Not supported. Use IP permissions instead.
"""
function authorize_security_group_egress(
groupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AuthorizeSecurityGroupEgress",
Dict{String,Any}("groupId" => groupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function authorize_security_group_egress(
groupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AuthorizeSecurityGroupEgress",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("groupId" => groupId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
authorize_security_group_ingress()
authorize_security_group_ingress(params::Dict{String,<:Any})
Adds the specified inbound (ingress) rules to a security group. An inbound rule permits
instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address
ranges that are specified by a prefix list, or the instances that are associated with a
destination security group. For more information, see Security group rules. You must
specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list,
or a security group. You must specify a protocol for each rule (for example, TCP). If the
protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP
or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. Rule changes are propagated
to instances associated with the security group as quickly as possible. However, a small
delay might occur. For examples of rules that you can add to security groups for specific
access scenarios, see Security group rules for different use cases in the Amazon EC2 User
Guide. For more information about security group quotas, see Amazon VPC quotas in the
Amazon VPC User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CidrIp"`: The IPv4 address range, in CIDR format. To specify an IPv6 address range, use
IP permissions instead. To specify multiple rules and descriptions for the rules, use IP
permissions instead.
- `"FromPort"`: If the protocol is TCP or UDP, this is the start of the port range. If the
protocol is ICMP, this is the ICMP type or -1 (all ICMP types). To specify multiple rules
and descriptions for the rules, use IP permissions instead.
- `"GroupId"`: The ID of the security group.
- `"GroupName"`: [Default VPC] The name of the security group. For security groups for a
default VPC you can specify either the ID or the name of the security group. For security
groups for a nondefault VPC, you must specify the ID of the security group.
- `"IpPermissions"`: The permissions for the security group rules.
- `"IpProtocol"`: The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
To specify all protocols, use -1. To specify icmpv6, use IP permissions instead. If you
specify a protocol other than one of the supported values, traffic is allowed on all ports,
regardless of any ports that you specify. To specify multiple rules and descriptions for
the rules, use IP permissions instead.
- `"SourceSecurityGroupName"`: [Default VPC] The name of the source security group. The
rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and
port range, specify a set of IP permissions instead.
- `"SourceSecurityGroupOwnerId"`: The Amazon Web Services account ID for the source
security group, if the source security group is in a different account. The rule grants
full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range,
use IP permissions instead.
- `"TagSpecification"`: The tags applied to the security group rule.
- `"ToPort"`: If the protocol is TCP or UDP, this is the end of the port range. If the
protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). If the start port is -1
(all ICMP types), then the end port must be -1 (all ICMP codes). To specify multiple rules
and descriptions for the rules, use IP permissions instead.
- `"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.
"""
function authorize_security_group_ingress(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AuthorizeSecurityGroupIngress";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function authorize_security_group_ingress(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"AuthorizeSecurityGroupIngress",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
bundle_instance(instance_id, storage)
bundle_instance(instance_id, storage, params::Dict{String,<:Any})
Bundles an Amazon instance store-backed Windows instance. During bundling, only the root
device volume (C:) is bundled. Data on other instance store volumes is not preserved. This
action is not applicable for Linux/Unix instances or Windows instances that are backed by
Amazon EBS.
# Arguments
- `instance_id`: The ID of the instance to bundle. Default: None
- `storage`: The bucket in which to store the AMI. You can specify a bucket that you
already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket
that belongs to someone else, Amazon EC2 returns an error.
# 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.
"""
function bundle_instance(
InstanceId, Storage; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"BundleInstance",
Dict{String,Any}("InstanceId" => InstanceId, "Storage" => Storage);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function bundle_instance(
InstanceId,
Storage,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"BundleInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "Storage" => Storage),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_bundle_task(bundle_id)
cancel_bundle_task(bundle_id, params::Dict{String,<:Any})
Cancels a bundling operation for an instance store-backed Windows instance.
# Arguments
- `bundle_id`: The ID of the bundle task.
# 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.
"""
function cancel_bundle_task(BundleId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CancelBundleTask",
Dict{String,Any}("BundleId" => BundleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_bundle_task(
BundleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CancelBundleTask",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BundleId" => BundleId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_capacity_reservation(capacity_reservation_id)
cancel_capacity_reservation(capacity_reservation_id, params::Dict{String,<:Any})
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the
Capacity Reservation's state to cancelled. Instances running in the reserved capacity
continue running until you stop them. Stopped instances that target the Capacity
Reservation can no longer launch. Modify these instances to either target a different
Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity
Reservation that has matching attributes and sufficient capacity.
# Arguments
- `capacity_reservation_id`: The ID of the Capacity Reservation to be cancelled.
# 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.
"""
function cancel_capacity_reservation(
CapacityReservationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CancelCapacityReservation",
Dict{String,Any}("CapacityReservationId" => CapacityReservationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_capacity_reservation(
CapacityReservationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CancelCapacityReservation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CapacityReservationId" => CapacityReservationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_capacity_reservation_fleets(capacity_reservation_fleet_id)
cancel_capacity_reservation_fleets(capacity_reservation_fleet_id, params::Dict{String,<:Any})
Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation
Fleet, the following happens: The Capacity Reservation Fleet's status changes to
cancelled. The individual Capacity Reservations in the Fleet are cancelled. Instances
running in the Capacity Reservations at the time of cancelling the Fleet continue to run in
shared capacity. The Fleet stops creating new Capacity Reservations.
# Arguments
- `capacity_reservation_fleet_id`: The IDs of the Capacity Reservation Fleets to cancel.
# 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.
"""
function cancel_capacity_reservation_fleets(
CapacityReservationFleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CancelCapacityReservationFleets",
Dict{String,Any}("CapacityReservationFleetId" => CapacityReservationFleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_capacity_reservation_fleets(
CapacityReservationFleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CancelCapacityReservationFleets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CapacityReservationFleetId" => CapacityReservationFleetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_conversion_task(conversion_task_id)
cancel_conversion_task(conversion_task_id, params::Dict{String,<:Any})
Cancels an active conversion task. The task can be the import of an instance or volume. The
action removes all artifacts of the conversion, including a partially uploaded volume or
instance. If the conversion is complete or is in the process of transferring the final disk
image, the command fails and returns an exception. For more information, see Importing a
Virtual Machine Using the Amazon EC2 CLI.
# Arguments
- `conversion_task_id`: The ID of the conversion task.
# 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.
- `"reasonMessage"`: The reason for canceling the conversion task.
"""
function cancel_conversion_task(
conversionTaskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CancelConversionTask",
Dict{String,Any}("conversionTaskId" => conversionTaskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_conversion_task(
conversionTaskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CancelConversionTask",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("conversionTaskId" => conversionTaskId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_export_task(export_task_id)
cancel_export_task(export_task_id, params::Dict{String,<:Any})
Cancels an active export task. The request removes all artifacts of the export, including
any partially-created Amazon S3 objects. If the export task is complete or is in the
process of transferring the final disk image, the command fails and returns an error.
# Arguments
- `export_task_id`: The ID of the export task. This is the ID returned by the
CreateInstanceExportTask and ExportImage operations.
"""
function cancel_export_task(exportTaskId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CancelExportTask",
Dict{String,Any}("exportTaskId" => exportTaskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_export_task(
exportTaskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CancelExportTask",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("exportTaskId" => exportTaskId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_image_launch_permission(image_id)
cancel_image_launch_permission(image_id, params::Dict{String,<:Any})
Removes your Amazon Web Services account from the launch permissions for the specified AMI.
For more information, see Cancel having an AMI shared with your Amazon Web Services
account in the Amazon EC2 User Guide.
# Arguments
- `image_id`: The ID of the AMI that was shared with your Amazon Web Services account.
# 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.
"""
function cancel_image_launch_permission(
ImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CancelImageLaunchPermission",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_image_launch_permission(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CancelImageLaunchPermission",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_import_task()
cancel_import_task(params::Dict{String,<:Any})
Cancels an in-process import virtual machine or import snapshot task.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CancelReason"`: The reason for canceling the task.
- `"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.
- `"ImportTaskId"`: The ID of the import image or import snapshot task to be canceled.
"""
function cancel_import_task(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("CancelImportTask"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function cancel_import_task(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CancelImportTask", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
cancel_reserved_instances_listing(reserved_instances_listing_id)
cancel_reserved_instances_listing(reserved_instances_listing_id, params::Dict{String,<:Any})
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. For
more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User
Guide.
# Arguments
- `reserved_instances_listing_id`: The ID of the Reserved Instance listing.
"""
function cancel_reserved_instances_listing(
reservedInstancesListingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CancelReservedInstancesListing",
Dict{String,Any}("reservedInstancesListingId" => reservedInstancesListingId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_reserved_instances_listing(
reservedInstancesListingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CancelReservedInstancesListing",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"reservedInstancesListingId" => reservedInstancesListingId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_spot_fleet_requests(spot_fleet_request_id, terminate_instances)
cancel_spot_fleet_requests(spot_fleet_request_id, terminate_instances, params::Dict{String,<:Any})
Cancels the specified Spot Fleet requests. After you cancel a Spot Fleet request, the Spot
Fleet launches no new instances. You must also specify whether a canceled Spot Fleet
request should terminate its instances. If you choose to terminate the instances, the Spot
Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request
enters the cancelled_running state and the instances continue to run until they are
interrupted or you terminate them manually. Restrictions You can delete up to 100
fleets in a single request. If you exceed the specified number, no fleets are deleted.
# Arguments
- `spot_fleet_request_id`: The IDs of the Spot Fleet requests. Constraint: You can specify
up to 100 IDs in a single request.
- `terminate_instances`: Indicates whether to terminate the associated instances when the
Spot Fleet request is canceled. The default is to terminate the instances. To let the
instances continue to run after the Spot Fleet request is canceled, specify
no-terminate-instances.
# 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.
"""
function cancel_spot_fleet_requests(
spotFleetRequestId,
terminateInstances;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CancelSpotFleetRequests",
Dict{String,Any}(
"spotFleetRequestId" => spotFleetRequestId,
"terminateInstances" => terminateInstances,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_spot_fleet_requests(
spotFleetRequestId,
terminateInstances,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CancelSpotFleetRequests",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"spotFleetRequestId" => spotFleetRequestId,
"terminateInstances" => terminateInstances,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_spot_instance_requests(spot_instance_request_id)
cancel_spot_instance_requests(spot_instance_request_id, params::Dict{String,<:Any})
Cancels one or more Spot Instance requests. Canceling a Spot Instance request does not
terminate running Spot Instances associated with the request.
# Arguments
- `spot_instance_request_id`: The IDs of the Spot Instance requests.
# 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.
"""
function cancel_spot_instance_requests(
SpotInstanceRequestId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CancelSpotInstanceRequests",
Dict{String,Any}("SpotInstanceRequestId" => SpotInstanceRequestId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_spot_instance_requests(
SpotInstanceRequestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CancelSpotInstanceRequests",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SpotInstanceRequestId" => SpotInstanceRequestId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_product_instance(instance_id, product_code)
confirm_product_instance(instance_id, product_code, params::Dict{String,<:Any})
Determines whether a product code is associated with an instance. This action can only be
used by the owner of the product code. It is useful when a product code owner must verify
whether another user's instance is eligible for support.
# Arguments
- `instance_id`: The ID of the instance.
- `product_code`: The product code. This must be a product code that you own.
# 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.
"""
function confirm_product_instance(
InstanceId, ProductCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ConfirmProductInstance",
Dict{String,Any}("InstanceId" => InstanceId, "ProductCode" => ProductCode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function confirm_product_instance(
InstanceId,
ProductCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ConfirmProductInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceId" => InstanceId, "ProductCode" => ProductCode),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_fpga_image(source_fpga_image_id, source_region)
copy_fpga_image(source_fpga_image_id, source_region, params::Dict{String,<:Any})
Copies the specified Amazon FPGA Image (AFI) to the current Region.
# Arguments
- `source_fpga_image_id`: The ID of the source AFI.
- `source_region`: The Region that contains the source AFI.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"Description"`: The description for the new AFI.
- `"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.
- `"Name"`: The name for the new AFI. The default is the name of the source AFI.
"""
function copy_fpga_image(
SourceFpgaImageId, SourceRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CopyFpgaImage",
Dict{String,Any}(
"SourceFpgaImageId" => SourceFpgaImageId, "SourceRegion" => SourceRegion
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_fpga_image(
SourceFpgaImageId,
SourceRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CopyFpgaImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceFpgaImageId" => SourceFpgaImageId, "SourceRegion" => SourceRegion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_image(name, source_image_id, source_region)
copy_image(name, source_image_id, source_region, params::Dict{String,<:Any})
Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a
Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost
to another, or within the same Outpost. To copy an AMI to another partition, see
CreateStoreImageTask. To copy an AMI from one Region to another, specify the source Region
using the SourceRegion parameter, and specify the destination Region using its endpoint.
Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted
backing snapshots remain unencrypted, unless you set Encrypted during the copy operation.
You cannot create an unencrypted copy of an encrypted backing snapshot. To copy an AMI from
a Region to an Outpost, specify the source Region using the SourceRegion parameter, and
specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots
copied to an Outpost are encrypted by default using the default encryption key for the
Region, or a different key that you specify in the request using KmsKeyId. Outposts do not
support unencrypted snapshots. For more information, Amazon EBS local snapshots on
Outposts in the Amazon EBS User Guide. For more information about the prerequisites and
limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.
# Arguments
- `name`: The name of the new AMI in the destination Region.
- `source_image_id`: The ID of the AMI to copy.
- `source_region`: The name of the Region that contains the AMI to copy.
# 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 idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `"CopyImageTags"`: Indicates whether to include your user-defined AMI tags when copying
the AMI. The following tags will not be copied: System tags (prefixed with aws:) For
public and shared AMIs, user-defined tags that are attached by other Amazon Web Services
accounts Default: Your user-defined AMI tags are not copied.
- `"Description"`: A description for the new AMI in the destination Region.
- `"DestinationOutpostArn"`: The Amazon Resource Name (ARN) of the Outpost to which to copy
the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region
to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an
AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the
Amazon EBS User Guide.
- `"TagSpecification"`: The tags to apply to the new AMI and new snapshots. You can tag the
AMI, the snapshots, or both. To tag the new AMI, the value for ResourceType must be
image. To tag the new snapshots, the value for ResourceType must be snapshot. The same
tag is applied to all the new snapshots. If you specify other values for ResourceType,
the request fails. To tag an AMI or snapshot after it has been created, see CreateTags.
- `"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.
- `"encrypted"`: Specifies whether the destination snapshots of the copied image should be
encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an
unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used
unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For
more information, see Amazon EBS encryption in the Amazon EBS User Guide.
- `"kmsKeyId"`: The identifier of the symmetric Key Management Service (KMS) KMS key to use
when creating encrypted volumes. If this parameter is not specified, your Amazon Web
Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also
set the encrypted state to true. You can specify a KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. For example,
alias/ExampleAlias. Key ARN. For example,
arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN.
For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. Amazon Web Services
authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is
not valid, the action can appear to complete, but eventually fails. The specified KMS key
must exist in the destination Region. Amazon EBS does not support asymmetric KMS keys.
"""
function copy_image(
Name, SourceImageId, SourceRegion; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CopyImage",
Dict{String,Any}(
"Name" => Name, "SourceImageId" => SourceImageId, "SourceRegion" => SourceRegion
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_image(
Name,
SourceImageId,
SourceRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CopyImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"SourceImageId" => SourceImageId,
"SourceRegion" => SourceRegion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_snapshot(source_region, source_snapshot_id)
copy_snapshot(source_region, source_snapshot_id, params::Dict{String,<:Any})
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a
snapshot within the same Region, from one Region to another, or from a Region to an
Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to
another, or within the same Outpost. You can use the snapshot to create EBS volumes or
Amazon Machine Images (AMIs). When copying snapshots to a Region, copies of encrypted EBS
snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you
enable encryption for the snapshot copy operation. By default, encrypted snapshot copies
use the default KMS key; however, you can specify a different KMS key. To copy an encrypted
snapshot that has been shared from another account, you must have permissions for the KMS
key used to encrypt the snapshot. Snapshots copied to an Outpost are encrypted by default
using the default encryption key for the Region, or a different key that you specify in the
request using KmsKeyId. Outposts do not support unencrypted snapshots. For more
information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not
be used for any purpose. For more information, see Copy an Amazon EBS snapshot in the
Amazon EBS User Guide.
# Arguments
- `source_region`: The ID of the Region that contains the snapshot to be copied.
- `source_snapshot_id`: The ID of the EBS snapshot to copy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the EBS snapshot.
- `"DestinationOutpostArn"`: The Amazon Resource Name (ARN) of the Outpost to which to copy
the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web
Services Region to an Outpost. The snapshot must be in the Region for the destination
Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to
another, or within the same Outpost. For more information, see Copy snapshots from an
Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.
- `"TagSpecification"`: The tags to apply to the new snapshot.
- `"destinationRegion"`: The destination Region to use in the PresignedUrl parameter of a
snapshot copy operation. This parameter is only valid for specifying the destination Region
in a PresignedUrl parameter, where it is required. The snapshot copy is sent to the
regional endpoint that you sent the HTTP request to (for example,
ec2.us-east-1.amazonaws.com). With the CLI, this is specified using the --region parameter
or the default Region in your Amazon Web Services configuration file.
- `"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.
- `"encrypted"`: To encrypt a copy of an unencrypted snapshot if encryption by default is
not enabled, enable encryption using this parameter. Otherwise, omit this parameter.
Encrypted snapshots are encrypted, even if you omit this parameter and encryption by
default is not enabled. You cannot set this parameter to false. For more information, see
Amazon EBS encryption in the Amazon EBS User Guide.
- `"kmsKeyId"`: The identifier of the KMS key to use for Amazon EBS encryption. If this
parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified,
the encrypted state must be true. You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. For example,
alias/ExampleAlias. Key ARN. For example,
arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN.
For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. Amazon Web Services
authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN
that is not valid, the action can appear to complete, but eventually fails.
- `"presignedUrl"`: When you copy an encrypted source snapshot using the Amazon EC2 Query
API, you must supply a pre-signed URL. This parameter is optional for unencrypted
snapshots. For more information, see Query requests. The PresignedUrl should use the
snapshot source endpoint, the CopySnapshot action, and include the SourceRegion,
SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using
Amazon Web Services Signature Version 4. Because EBS snapshots are stored in Amazon S3, the
signing algorithm for this parameter uses the same logic that is described in
Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)
in the Amazon S3 API Reference. An invalid or improperly signed PresignedUrl will cause the
copy operation to fail asynchronously, and the snapshot will move to an error state.
"""
function copy_snapshot(
SourceRegion, SourceSnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CopySnapshot",
Dict{String,Any}(
"SourceRegion" => SourceRegion, "SourceSnapshotId" => SourceSnapshotId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_snapshot(
SourceRegion,
SourceSnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CopySnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceRegion" => SourceRegion, "SourceSnapshotId" => SourceSnapshotId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_capacity_reservation(instance_count, instance_platform, instance_type)
create_capacity_reservation(instance_count, instance_platform, instance_type, params::Dict{String,<:Any})
Creates a new Capacity Reservation with the specified attributes. Capacity Reservations
enable you to reserve capacity for your Amazon EC2 instances in a specific Availability
Zone for any duration. This gives you the flexibility to selectively add capacity
reservations and still get the Regional RI discounts for that usage. By creating Capacity
Reservations, you ensure that you always have access to Amazon EC2 capacity when you need
it, for as long as you need it. For more information, see Capacity Reservations in the
Amazon EC2 User Guide. Your request to create a Capacity Reservation could fail if Amazon
EC2 does not have sufficient capacity to fulfill the request. If your request fails due to
Amazon EC2 capacity constraints, either try again at a later time, try in a different
Availability Zone, or request a smaller capacity reservation. If your application is
flexible across instance types and sizes, try to create a Capacity Reservation with
different instance attributes. Your request could also fail if the requested quantity
exceeds your On-Demand Instance limit for the selected instance type. If your request fails
due to limit constraints, increase your On-Demand Instance limit for the required instance
type and try again. For more information about increasing your instance limits, see Amazon
EC2 Service Quotas in the Amazon EC2 User Guide.
# Arguments
- `instance_count`: The number of instances for which to reserve capacity. Valid range: 1 -
1000
- `instance_platform`: The type of operating system for which to reserve capacity.
- `instance_type`: The instance type for which to reserve capacity. For more information,
see Instance types in the Amazon EC2 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZone"`: The Availability Zone in which to create the Capacity Reservation.
- `"AvailabilityZoneId"`: The ID of the Availability Zone in which to create the Capacity
Reservation.
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensure Idempotency.
- `"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.
- `"EbsOptimized"`: Indicates whether the Capacity Reservation supports EBS-optimized
instances. This optimization provides dedicated throughput to Amazon EBS and an optimized
configuration stack to provide optimal I/O performance. This optimization isn't available
with all instance types. Additional usage charges apply when using an EBS- optimized
instance.
- `"EndDate"`: The date and time at which the Capacity Reservation expires. When a Capacity
Reservation expires, the reserved capacity is released and you can no longer launch
instances into it. The Capacity Reservation's state changes to expired when it reaches its
end date and time. You must provide an EndDate value if EndDateType is limited. Omit
EndDate if EndDateType is unlimited. If the EndDateType is limited, the Capacity
Reservation is cancelled within an hour from the specified time. For example, if you
specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55
and 14:30:55 on 5/31/2019.
- `"EndDateType"`: Indicates the way in which the Capacity Reservation ends. A Capacity
Reservation can have one of the following end types: unlimited - The Capacity
Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the
EndDateType is unlimited. limited - The Capacity Reservation expires automatically at a
specified date and time. You must provide an EndDate value if the EndDateType value is
limited.
- `"EphemeralStorage"`: Deprecated.
- `"InstanceMatchCriteria"`: Indicates the type of instance launches that the Capacity
Reservation accepts. The options include: open - The Capacity Reservation automatically
matches all instances that have matching attributes (instance type, platform, and
Availability Zone). Instances that have matching attributes run in the Capacity Reservation
automatically without specifying any additional parameters. targeted - The Capacity
Reservation only accepts instances that have matching attributes (instance type, platform,
and Availability Zone), and explicitly target the Capacity Reservation. This ensures that
only permitted instances can use the reserved capacity. Default: open
- `"OutpostArn"`: The Amazon Resource Name (ARN) of the Outpost on which to create the
Capacity Reservation.
- `"PlacementGroupArn"`: The Amazon Resource Name (ARN) of the cluster placement group in
which to create the Capacity Reservation. For more information, see Capacity Reservations
for cluster placement groups in the Amazon EC2 User Guide.
- `"TagSpecifications"`: The tags to apply to the Capacity Reservation during launch.
- `"Tenancy"`: Indicates the tenancy of the Capacity Reservation. A Capacity Reservation
can have one of the following tenancy settings: default - The Capacity Reservation is
created on hardware that is shared with other Amazon Web Services accounts. dedicated -
The Capacity Reservation is created on single-tenant hardware that is dedicated to a single
Amazon Web Services account.
"""
function create_capacity_reservation(
InstanceCount,
InstancePlatform,
InstanceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateCapacityReservation",
Dict{String,Any}(
"InstanceCount" => InstanceCount,
"InstancePlatform" => InstancePlatform,
"InstanceType" => InstanceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_capacity_reservation(
InstanceCount,
InstancePlatform,
InstanceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateCapacityReservation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceCount" => InstanceCount,
"InstancePlatform" => InstancePlatform,
"InstanceType" => InstanceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_capacity_reservation_fleet(instance_type_specification, total_target_capacity)
create_capacity_reservation_fleet(instance_type_specification, total_target_capacity, params::Dict{String,<:Any})
Creates a Capacity Reservation Fleet. For more information, see Create a Capacity
Reservation Fleet in the Amazon EC2 User Guide.
# Arguments
- `instance_type_specification`: Information about the instance types for which to reserve
the capacity.
- `total_target_capacity`: The total number of capacity units to be reserved by the
Capacity Reservation Fleet. This value, together with the instance type weights that you
assign to each instance type used by the Fleet determine the number of instances for which
the Fleet reserves capacity. Both values are based on units that make sense for your
workload. For more information, see Total target capacity in the Amazon EC2 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocationStrategy"`: The strategy used by the Capacity Reservation Fleet to determine
which of the specified instance types to use. Currently, only the prioritized allocation
strategy is supported. For more information, see Allocation strategy in the Amazon EC2
User Guide. Valid values: prioritized
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensure Idempotency.
- `"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.
- `"EndDate"`: The date and time at which the Capacity Reservation Fleet expires. When the
Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity
Reservations in the Fleet expire. The Capacity Reservation Fleet expires within an hour
after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity
Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.
- `"InstanceMatchCriteria"`: Indicates the type of instance launches that the Capacity
Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance
matching criteria. Currently, Capacity Reservation Fleets support open instance matching
criteria only. This means that instances that have matching attributes (instance type,
platform, and Availability Zone) run in the Capacity Reservations automatically. Instances
do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
- `"TagSpecification"`: The tags to assign to the Capacity Reservation Fleet. The tags are
automatically assigned to the Capacity Reservations in the Fleet.
- `"Tenancy"`: Indicates the tenancy of the Capacity Reservation Fleet. All Capacity
Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one
of the following tenancy settings: default - The Capacity Reservation Fleet is created
on hardware that is shared with other Amazon Web Services accounts. dedicated - The
Capacity Reservations are created on single-tenant hardware that is dedicated to a single
Amazon Web Services account.
"""
function create_capacity_reservation_fleet(
InstanceTypeSpecification,
TotalTargetCapacity;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateCapacityReservationFleet",
Dict{String,Any}(
"InstanceTypeSpecification" => InstanceTypeSpecification,
"TotalTargetCapacity" => TotalTargetCapacity,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_capacity_reservation_fleet(
InstanceTypeSpecification,
TotalTargetCapacity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateCapacityReservationFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceTypeSpecification" => InstanceTypeSpecification,
"TotalTargetCapacity" => TotalTargetCapacity,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_carrier_gateway(vpc_id)
create_carrier_gateway(vpc_id, params::Dict{String,<:Any})
Creates a carrier gateway. For more information about carrier gateways, see Carrier
gateways in the Amazon Web Services Wavelength Developer Guide.
# Arguments
- `vpc_id`: The ID of the VPC to associate with the carrier gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `"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.
- `"TagSpecification"`: The tags to associate with the carrier gateway.
"""
function create_carrier_gateway(VpcId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateCarrierGateway",
Dict{String,Any}("VpcId" => VpcId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_carrier_gateway(
VpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateCarrierGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VpcId" => VpcId, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_client_vpn_endpoint(authentication, client_cidr_block, connection_log_options, server_certificate_arn)
create_client_vpn_endpoint(authentication, client_cidr_block, connection_log_options, server_certificate_arn, params::Dict{String,<:Any})
Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and
configure to enable and manage client VPN sessions. It is the destination endpoint at which
all client VPN sessions are terminated.
# Arguments
- `authentication`: Information about the authentication method to be used to authenticate
clients.
- `client_cidr_block`: The IPv4 address range, in CIDR notation, from which to assign
client IP addresses. The address range cannot overlap with the local CIDR of the VPC in
which the associated subnet is located, or the routes that you add manually. The address
range cannot be changed after the Client VPN endpoint has been created. Client CIDR range
must have a size of at least /22 and must not be greater than /12.
- `connection_log_options`: Information about the client connection logging options. If you
enable client connection logging, data about client connections is sent to a Cloudwatch
Logs log stream. The following information is logged: Client connection requests Client
connection results (successful and unsuccessful) Reasons for unsuccessful client
connection requests Client connection termination time
- `server_certificate_arn`: The ARN of the server certificate. For more information, see
the Certificate Manager User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientConnectOptions"`: The options for managing connection authorization for new
client connections.
- `"ClientLoginBannerOptions"`: Options for enabling a customizable text banner that will
be displayed on Amazon Web Services provided clients when a VPN session is established.
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"Description"`: A brief description of the Client VPN endpoint.
- `"DnsServers"`: Information about the DNS servers to be used for DNS resolution. A Client
VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address
configured on the device is used for the DNS server.
- `"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.
- `"SecurityGroupId"`: The IDs of one or more security groups to apply to the target
network. You must also specify the ID of the VPC that contains the security groups.
- `"SelfServicePortal"`: Specify whether to enable the self-service portal for the Client
VPN endpoint. Default Value: enabled
- `"SessionTimeoutHours"`: The maximum VPN session duration time in hours. Valid values: 8
| 10 | 12 | 24 Default value: 24
- `"SplitTunnel"`: Indicates whether split-tunnel is enabled on the Client VPN endpoint. By
default, split-tunnel on a VPN endpoint is disabled. For information about split-tunnel VPN
endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
- `"TagSpecification"`: The tags to apply to the Client VPN endpoint during creation.
- `"TransportProtocol"`: The transport protocol to be used by the VPN session. Default
value: udp
- `"VpcId"`: The ID of the VPC to associate with the Client VPN endpoint. If no security
group IDs are specified in the request, the default security group for the VPC is applied.
- `"VpnPort"`: The port number to assign to the Client VPN endpoint for TCP and UDP
traffic. Valid Values: 443 | 1194 Default Value: 443
"""
function create_client_vpn_endpoint(
Authentication,
ClientCidrBlock,
ConnectionLogOptions,
ServerCertificateArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateClientVpnEndpoint",
Dict{String,Any}(
"Authentication" => Authentication,
"ClientCidrBlock" => ClientCidrBlock,
"ConnectionLogOptions" => ConnectionLogOptions,
"ServerCertificateArn" => ServerCertificateArn,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_client_vpn_endpoint(
Authentication,
ClientCidrBlock,
ConnectionLogOptions,
ServerCertificateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateClientVpnEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Authentication" => Authentication,
"ClientCidrBlock" => ClientCidrBlock,
"ConnectionLogOptions" => ConnectionLogOptions,
"ServerCertificateArn" => ServerCertificateArn,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_client_vpn_route(client_vpn_endpoint_id, destination_cidr_block, target_vpc_subnet_id)
create_client_vpn_route(client_vpn_endpoint_id, destination_cidr_block, target_vpc_subnet_id, params::Dict{String,<:Any})
Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route
table that describes the available destination network routes. Each route in the route
table specifies the path for traffic to specific resources or networks.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint to which to add the route.
- `destination_cidr_block`: The IPv4 address range, in CIDR notation, of the route
destination. For example: To add a route for Internet access, enter 0.0.0.0/0 To add a
route for a peered VPC, enter the peered VPC's IPv4 CIDR range To add a route for an
on-premises network, enter the Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR
range To add a route for the local network, enter the client CIDR range
- `target_vpc_subnet_id`: The ID of the subnet through which you want to route traffic. The
specified subnet must be an existing target network of the Client VPN endpoint.
Alternatively, if you're adding a route for the local network, specify local.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"Description"`: A brief description of the route.
- `"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.
"""
function create_client_vpn_route(
ClientVpnEndpointId,
DestinationCidrBlock,
TargetVpcSubnetId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateClientVpnRoute",
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"DestinationCidrBlock" => DestinationCidrBlock,
"TargetVpcSubnetId" => TargetVpcSubnetId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_client_vpn_route(
ClientVpnEndpointId,
DestinationCidrBlock,
TargetVpcSubnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateClientVpnRoute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"DestinationCidrBlock" => DestinationCidrBlock,
"TargetVpcSubnetId" => TargetVpcSubnetId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_coip_cidr(cidr, coip_pool_id)
create_coip_cidr(cidr, coip_pool_id, params::Dict{String,<:Any})
Creates a range of customer-owned IP addresses.
# Arguments
- `cidr`: A customer-owned IP address range to create.
- `coip_pool_id`: The ID of the address pool.
# 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.
"""
function create_coip_cidr(
Cidr, CoipPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateCoipCidr",
Dict{String,Any}("Cidr" => Cidr, "CoipPoolId" => CoipPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_coip_cidr(
Cidr,
CoipPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateCoipCidr",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Cidr" => Cidr, "CoipPoolId" => CoipPoolId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_coip_pool(local_gateway_route_table_id)
create_coip_pool(local_gateway_route_table_id, params::Dict{String,<:Any})
Creates a pool of customer-owned IP (CoIP) addresses.
# Arguments
- `local_gateway_route_table_id`: The ID of the local gateway route table.
# 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.
- `"TagSpecification"`: The tags to assign to the CoIP address pool.
"""
function create_coip_pool(
LocalGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateCoipPool",
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_coip_pool(
LocalGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateCoipPool",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_customer_gateway(type)
create_customer_gateway(type, params::Dict{String,<:Any})
Provides information to Amazon Web Services about your customer gateway device. The
customer gateway device is the appliance at your end of the VPN connection. You must
provide the IP address of the customer gateway device’s external interface. The IP
address must be static and can be behind a device performing network address translation
(NAT). For devices that use Border Gateway Protocol (BGP), you can also provide the
device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your
network. If you don't have an ASN already, you can use a private ASN. For more information,
see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web
Services Site-to-Site VPN User Guide. To create more than one customer gateway with the
same VPN type, IP address, and BGP ASN, specify a unique device name for each customer
gateway. An identical request returns information about the existing customer gateway; it
doesn't create a new customer gateway.
# Arguments
- `type`: The type of VPN connection that this customer gateway supports (ipsec.1).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BgpAsn"`: For customer gateway devices that support BGP, specify the device's ASN. You
must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN
is larger than 2,147,483,647, you must use BgpAsnExtended. Default: 65000 Valid values: 1
to 2,147,483,647
- `"BgpAsnExtended"`: For customer gateway devices that support BGP, specify the device's
ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway.
If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended. Valid values:
2,147,483,648 to 4,294,967,295
- `"CertificateArn"`: The Amazon Resource Name (ARN) for the customer gateway certificate.
- `"DeviceName"`: A name for the customer gateway device. Length Constraints: Up to 255
characters.
- `"IpAddress"`: IPv4 address for the customer gateway device's outside interface. The
address must be static. If OutsideIpAddressType in your VPN connection options is set to
PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If
OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
- `"PublicIp"`: This member has been deprecated. The Internet-routable IP address for the
customer gateway's outside interface. The address must be static.
- `"TagSpecification"`: The tags to apply to the customer gateway.
- `"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.
"""
function create_customer_gateway(Type; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateCustomerGateway",
Dict{String,Any}("Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_customer_gateway(
Type, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateCustomerGateway",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Type" => Type), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_default_subnet(availability_zone)
create_default_subnet(availability_zone, params::Dict{String,<:Any})
Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone
in your default VPC. You can have only one default subnet per Availability Zone. For more
information, see Create a default subnet in the Amazon VPC User Guide.
# Arguments
- `availability_zone`: The Availability Zone in which to create the default subnet.
# 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.
- `"Ipv6Native"`: Indicates whether to create an IPv6 only subnet. If you already have a
default subnet for this Availability Zone, you must delete it before you can create an IPv6
only subnet.
"""
function create_default_subnet(
AvailabilityZone; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateDefaultSubnet",
Dict{String,Any}("AvailabilityZone" => AvailabilityZone);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_default_subnet(
AvailabilityZone,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateDefaultSubnet",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("AvailabilityZone" => AvailabilityZone), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_default_vpc()
create_default_vpc(params::Dict{String,<:Any})
Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each
Availability Zone. For more information about the components of a default VPC, see Default
VPCs in the Amazon VPC User Guide. You cannot specify the components of the default VPC
yourself. If you deleted your previous default VPC, you can create a default VPC. You
cannot have more than one default VPC per Region.
# 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.
"""
function create_default_vpc(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("CreateDefaultVpc"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_default_vpc(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateDefaultVpc", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_dhcp_options(dhcp_configuration)
create_dhcp_options(dhcp_configuration, params::Dict{String,<:Any})
Creates a custom set of DHCP options. After you create a DHCP option set, you associate it
with a VPC. After you associate a DHCP option set with a VPC, all existing and newly
launched instances in the VPC use this set of DHCP options. The following are the
individual DHCP options you can specify. For more information, see DHCP option sets in the
Amazon VPC User Guide. domain-name - If you're using AmazonProvidedDNS in us-east-1,
specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, specify
region.compute.internal. Otherwise, specify a custom domain name. This value is used to
complete unqualified DNS hostnames. Some Linux operating systems accept multiple domain
names separated by spaces. However, Windows and other Linux operating systems treat the
value as a single domain, which results in unexpected behavior. If your DHCP option set is
associated with a VPC that has instances running operating systems that treat the value as
a single domain, specify only one domain name. domain-name-servers - The IP addresses of
up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a
single parameter, separate the IP addresses using commas. To have your instances receive
custom DNS hostnames as specified in domain-name, you must specify a custom DNS server.
ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) servers (four
IPv4 addresses and four IPv6 addresses). netbios-name-servers - The IP addresses of up
to four NetBIOS name servers. netbios-node-type - The NetBIOS node type (1, 2, 4, or 8).
We recommend that you specify 2. Broadcast and multicast are not supported. For more
information about NetBIOS node types, see RFC 2132. ipv6-address-preferred-lease-time -
A value (in seconds, minutes, hours, or years) for how frequently a running instance with
an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140
and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease
time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase
the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs
when half of the lease time has elapsed.
# Arguments
- `dhcp_configuration`: A DHCP configuration option.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagSpecification"`: The tags to assign to the DHCP option.
- `"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.
"""
function create_dhcp_options(
dhcpConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateDhcpOptions",
Dict{String,Any}("dhcpConfiguration" => dhcpConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dhcp_options(
dhcpConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateDhcpOptions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("dhcpConfiguration" => dhcpConfiguration), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_egress_only_internet_gateway(vpc_id)
create_egress_only_internet_gateway(vpc_id, params::Dict{String,<:Any})
[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet
gateway is used to enable outbound communication over IPv6 from instances in your VPC to
the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection
with your instance.
# Arguments
- `vpc_id`: The ID of the VPC for which to create the egress-only internet gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"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.
- `"TagSpecification"`: The tags to assign to the egress-only internet gateway.
"""
function create_egress_only_internet_gateway(
VpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateEgressOnlyInternetGateway",
Dict{String,Any}("VpcId" => VpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_egress_only_internet_gateway(
VpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateEgressOnlyInternetGateway",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("VpcId" => VpcId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_fleet(target_capacity_specification, item)
create_fleet(target_capacity_specification, item, params::Dict{String,<:Any})
Creates an EC2 Fleet that contains the configuration information for On-Demand Instances
and Spot Instances. Instances are launched immediately if there is available capacity. A
single EC2 Fleet can include multiple launch specifications that vary by instance type,
AMI, Availability Zone, or subnet. For more information, see EC2 Fleet in the Amazon EC2
User Guide.
# Arguments
- `target_capacity_specification`: The number of units to request.
- `item`: The configuration for the EC2 Fleet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"Context"`: Reserved.
- `"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.
- `"ExcessCapacityTerminationPolicy"`: Indicates whether running instances should be
terminated if the total target capacity of the EC2 Fleet is decreased below the current
size of the EC2 Fleet. Supported only for fleets of type maintain.
- `"LaunchTemplateConfigs"`: The configuration for the EC2 Fleet.
- `"OnDemandOptions"`: Describes the configuration of On-Demand Instances in an EC2 Fleet.
- `"ReplaceUnhealthyInstances"`: Indicates whether EC2 Fleet should replace unhealthy Spot
Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet
health checks in the Amazon EC2 User Guide.
- `"SpotOptions"`: Describes the configuration of Spot Instances in an EC2 Fleet.
- `"TagSpecification"`: The key-value pair for tagging the EC2 Fleet request on creation.
For more information, see Tag your resources. If the fleet type is instant, specify a
resource type of fleet to tag the fleet or instance to tag the instances at launch. If the
fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You
cannot specify a resource type of instance. To tag instances at launch, specify the tags in
a launch template.
- `"TerminateInstancesWithExpiration"`: Indicates whether running instances should be
terminated when the EC2 Fleet expires.
- `"Type"`: The fleet type. The default value is maintain. maintain - The EC2 Fleet
places an asynchronous request for your desired capacity, and continues to maintain your
desired Spot capacity by replenishing interrupted Spot Instances. request - The EC2
Fleet places an asynchronous one-time request for your desired capacity, but does submit
Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not
maintain Spot capacity if Spot Instances are interrupted. instant - The EC2 Fleet places
a synchronous one-time request for your desired capacity, and returns errors for any
instances that could not be launched. For more information, see EC2 Fleet request types
in the Amazon EC2 User Guide.
- `"ValidFrom"`: The start date and time of the request, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
- `"ValidUntil"`: The end date and time of the request, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to
fulfill the request. If no value is specified, the request remains until you cancel it.
"""
function create_fleet(
TargetCapacitySpecification, item; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateFleet",
Dict{String,Any}(
"TargetCapacitySpecification" => TargetCapacitySpecification, "item" => item
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fleet(
TargetCapacitySpecification,
item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TargetCapacitySpecification" => TargetCapacitySpecification,
"item" => item,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_flow_logs(resource_id, resource_type)
create_flow_logs(resource_id, resource_type, params::Dict{String,<:Any})
Creates one or more flow logs to capture information about IP traffic for a specific
network interface, subnet, or VPC. Flow log data for a monitored network interface is
recorded as flow log records, which are log events consisting of fields that describe the
traffic flow. For more information, see Flow log records in the Amazon VPC User Guide. When
publishing to CloudWatch Logs, flow log records are published to a log group, and each
network interface has a unique log stream in the log group. When publishing to Amazon S3,
flow log records for all of the monitored network interfaces are published to a single log
file object that is stored in the specified bucket. For more information, see VPC Flow Logs
in the Amazon VPC User Guide.
# Arguments
- `resource_id`: The IDs of the resources to monitor. For example, if the resource type is
VPC, specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway resource
types. Maximum of 1000 for the other resource types.
- `resource_type`: The type of resource to monitor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `"DeliverCrossAccountRole"`: The ARN of the IAM role that allows Amazon EC2 to publish
flow logs across accounts.
- `"DeliverLogsPermissionArn"`: The ARN of the IAM role that allows Amazon EC2 to publish
flow logs to the log destination. This parameter is required if the destination type is
cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery
stream and the resources to monitor are in different accounts.
- `"DestinationOptions"`: The destination options.
- `"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.
- `"LogDestination"`: The destination for the flow log data. The meaning of this parameter
depends on the destination type. If the destination type is cloud-watch-logs, specify the
ARN of a CloudWatch Logs log group. For example:
arn:aws:logs:region:account_id:log-group:my_group Alternatively, use the LogGroupName
parameter. If the destination type is s3, specify the ARN of an S3 bucket. For example:
arn:aws:s3:::my_bucket/my_subfolder/ The subfolder is optional. Note that you can't use
AWSLogs as a subfolder name. If the destination type is kinesis-data-firehose, specify
the ARN of a Kinesis Data Firehose delivery stream. For example:
arn:aws:firehose:region:account_id:deliverystream:my_stream
- `"LogDestinationType"`: The type of destination for the flow log data. Default:
cloud-watch-logs
- `"LogFormat"`: The fields to include in the flow log record. List the fields in the order
in which they should appear. If you omit this parameter, the flow log is created using the
default format. If you specify this parameter, you must include at least one field. For
more information about the available fields, see Flow log records in the Amazon VPC User
Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide.
Specify the fields using the {field-id} format, separated by spaces.
- `"LogGroupName"`: The name of a new or existing CloudWatch Logs log group where Amazon
EC2 publishes your flow logs. This parameter is valid only if the destination type is
cloud-watch-logs.
- `"MaxAggregationInterval"`: The maximum interval of time during which a flow of packets
is captured and aggregated into a flow log record. The possible values are 60 seconds (1
minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway
resource types. When a network interface is attached to a Nitro-based instance, the
aggregation interval is always 60 seconds or less, regardless of the value that you
specify. Default: 600
- `"TagSpecification"`: The tags to apply to the flow logs.
- `"TrafficType"`: The type of traffic to monitor (accepted traffic, rejected traffic, or
all traffic). This parameter is not supported for transit gateway resource types. It is
required for the other resource types.
"""
function create_flow_logs(
ResourceId, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateFlowLogs",
Dict{String,Any}("ResourceId" => ResourceId, "ResourceType" => ResourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_flow_logs(
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateFlowLogs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceId" => ResourceId, "ResourceType" => ResourceType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_fpga_image(input_storage_location)
create_fpga_image(input_storage_location, params::Dict{String,<:Any})
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP). The create
operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely
deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon
Web Services FPGA Hardware Development Kit.
# Arguments
- `input_storage_location`: The location of the encrypted design checkpoint in Amazon S3.
The input must be a tarball.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring Idempotency.
- `"Description"`: A description for the AFI.
- `"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.
- `"LogsStorageLocation"`: The location in Amazon S3 for the output logs.
- `"Name"`: A name for the AFI.
- `"TagSpecification"`: The tags to apply to the FPGA image during creation.
"""
function create_fpga_image(
InputStorageLocation; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateFpgaImage",
Dict{String,Any}("InputStorageLocation" => InputStorageLocation);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fpga_image(
InputStorageLocation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateFpgaImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InputStorageLocation" => InputStorageLocation),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_image(instance_id, name)
create_image(instance_id, name, params::Dict{String,<:Any})
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running
or stopped. If you customized your instance with instance store volumes or Amazon EBS
volumes in addition to the root device volume, the new AMI contains block device mapping
information for those volumes. When you launch an instance from this new AMI, the instance
automatically launches with those additional volumes. For more information, see Create an
Amazon EBS-backed Linux AMI in the Amazon Elastic Compute Cloud User Guide.
# Arguments
- `instance_id`: The ID of the instance.
- `name`: A name for the new image. Constraints: 3-128 alphanumeric characters, parentheses
(()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes
('), at-signs (@), or underscores(_)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagSpecification"`: The tags to apply to the AMI and snapshots on creation. You can tag
the AMI, the snapshots, or both. To tag the AMI, the value for ResourceType must be
image. To tag the snapshots that are created of the root volume and of other Amazon EBS
volumes that are attached to the instance, the value for ResourceType must be snapshot. The
same tag is applied to all of the snapshots that are created. If you specify other values
for ResourceType, the request fails. To tag an AMI or snapshot after it has been created,
see CreateTags.
- `"blockDeviceMapping"`: The block device mappings. When using the CreateImage action:
You can't change the volume size using the VolumeSize parameter. If you want a different
volume size, you must first change the volume size of the source instance. You can't
modify the encryption status of existing volumes or snapshots. To create an AMI with
volumes or snapshots that have a different encryption status (for example, where the source
volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes
or snapshots), use the CopyImage action. The only option that can be changed for existing
mappings or snapshots is DeleteOnTermination.
- `"description"`: A description for the new image.
- `"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.
- `"noReboot"`: Indicates whether or not the instance should be automatically rebooted
before creating the image. Specify one of the following values: true - The instance is
not rebooted before creating the image. This creates crash-consistent snapshots that
include only the data that has been written to the volumes at the time the snapshots are
created. Buffered data and data in memory that has not yet been written to the volumes is
not included in the snapshots. false - The instance is rebooted before creating the
image. This ensures that all buffered data and data in memory is written to the volumes
before the snapshots are created. Default: false
"""
function create_image(instanceId, name; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateImage",
Dict{String,Any}("instanceId" => instanceId, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_image(
instanceId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateImage",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("instanceId" => instanceId, "name" => name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance_connect_endpoint(subnet_id)
create_instance_connect_endpoint(subnet_id, params::Dict{String,<:Any})
Creates an EC2 Instance Connect Endpoint. An EC2 Instance Connect Endpoint allows you to
connect to an instance, without requiring the instance to have a public IPv4 address. For
more information, see Connect to your instances without requiring a public IPv4 address
using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.
# Arguments
- `subnet_id`: The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"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.
- `"PreserveClientIp"`: Indicates whether your client's IP address is preserved as the
source. The value is true or false. If true, your client's IP address is used when you
connect to a resource. If false, the elastic network interface IP address is used when
you connect to a resource. Default: true
- `"SecurityGroupId"`: One or more security groups to associate with the endpoint. If you
don't specify a security group, the default security group for your VPC will be associated
with the endpoint.
- `"TagSpecification"`: The tags to apply to the EC2 Instance Connect Endpoint during
creation.
"""
function create_instance_connect_endpoint(
SubnetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateInstanceConnectEndpoint",
Dict{String,Any}("SubnetId" => SubnetId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instance_connect_endpoint(
SubnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateInstanceConnectEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SubnetId" => SubnetId, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance_event_window()
create_instance_event_window(params::Dict{String,<:Any})
Creates an event window in which scheduled events for the associated Amazon EC2 instances
can run. You can define either a set of time ranges or a cron expression when creating the
event window, but not both. All event window times are in UTC. You can create up to 200
event windows per Amazon Web Services Region. When you create the event window, targets
(instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that
the event window can be used, you must associate one or more targets with it by using the
AssociateInstanceEventWindow API. Event windows are applicable only for scheduled events
that stop, reboot, or terminate instances. Event windows are not applicable for:
Expedited scheduled events and network maintenance events. Unscheduled maintenance such
as AutoRecovery and unplanned reboots. For more information, see Define event windows
for scheduled events in the Amazon EC2 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CronExpression"`: The cron expression for the event window, for example, * 0-4,20-23 *
* 1,5. If you specify a cron expression, you can't specify a time range. Constraints:
Only hour and day of the week values are supported. For day of the week values, you can
specify either integers 0 through 6, or alternative single values SUN through SAT. The
minute, month, and year must be specified by *. The hour value must be one or a multiple
range, for example, 0-4 or 0-4,20-23. Each hour range must be >= 2 hours, for example,
0-2 or 20-23. The event window must be >= 4 hours. The combined total time ranges in
the event window must be >= 4 hours. For more information about cron expressions, see
cron on the Wikipedia website.
- `"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.
- `"Name"`: The name of the event window.
- `"TagSpecification"`: The tags to apply to the event window.
- `"TimeRange"`: The time range for the event window. If you specify a time range, you
can't specify a cron expression.
"""
function create_instance_event_window(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateInstanceEventWindow"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_instance_event_window(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateInstanceEventWindow",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance_export_task(export_to_s3, instance_id, target_environment)
create_instance_export_task(export_to_s3, instance_id, target_environment, params::Dict{String,<:Any})
Exports a running or stopped instance to an Amazon S3 bucket. For information about the
prerequisites for your Amazon S3 bucket, supported operating systems, image formats, and
known limitations for the types of instances you can export, see Exporting an instance as a
VM Using VM Import/Export in the VM Import/Export User Guide.
# Arguments
- `export_to_s3`: The format and location for an export instance task.
- `instance_id`: The ID of the instance.
- `target_environment`: The target virtualization environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagSpecification"`: The tags to apply to the export instance task during creation.
- `"description"`: A description for the conversion task or the resource being exported.
The maximum length is 255 characters.
"""
function create_instance_export_task(
exportToS3,
instanceId,
targetEnvironment;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateInstanceExportTask",
Dict{String,Any}(
"exportToS3" => exportToS3,
"instanceId" => instanceId,
"targetEnvironment" => targetEnvironment,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instance_export_task(
exportToS3,
instanceId,
targetEnvironment,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateInstanceExportTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"exportToS3" => exportToS3,
"instanceId" => instanceId,
"targetEnvironment" => targetEnvironment,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_internet_gateway()
create_internet_gateway(params::Dict{String,<:Any})
Creates an internet gateway for use with a VPC. After creating the internet gateway, you
attach it to a VPC using AttachInternetGateway. For more information, see Internet gateways
in the Amazon VPC User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagSpecification"`: The tags to assign to the internet gateway.
- `"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.
"""
function create_internet_gateway(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateInternetGateway"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_internet_gateway(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateInternetGateway",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ipam()
create_ipam(params::Dict{String,<:Any})
Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to
automate your IP address management workflows including assigning, tracking,
troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts
throughout your Amazon Web Services Organization. For more information, see Create an IPAM
in the Amazon VPC IPAM 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 provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the IPAM.
- `"DryRun"`: A check for 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.
- `"OperatingRegion"`: The operating Regions for the IPAM. Operating Regions are Amazon Web
Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers
and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM
User Guide.
- `"TagSpecification"`: The key/value combination of a tag assigned to the resource. Use
the tag key in the filter name and the tag value as the filter value. For example, to find
all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for
the filter name and TeamA for the filter value.
- `"Tier"`: IPAM is offered in a Free Tier and an Advanced Tier. For more information about
the features available in each tier and the costs associated with the tiers, see Amazon VPC
pricing > IPAM tab.
"""
function create_ipam(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateIpam",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ipam(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateIpam",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ipam_pool(address_family, ipam_scope_id)
create_ipam_pool(address_family, ipam_scope_id, params::Dict{String,<:Any})
Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a
collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses
according to your routing and security needs. For example, if you have separate routing and
security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
# Arguments
- `address_family`: The IP protocol assigned to this IPAM pool. You must choose either IPv4
or IPv6 protocol for a pool.
- `ipam_scope_id`: The ID of the scope in which you would like to create the IPAM pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocationDefaultNetmaskLength"`: The default netmask length for allocations added to
this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16
here, new allocations will default to 10.0.0.0/16.
- `"AllocationMaxNetmaskLength"`: The maximum netmask length possible for CIDR allocations
in this IPAM pool to be compliant. The maximum netmask length must be greater than the
minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible
netmask lengths for IPv6 addresses are 0 - 128.
- `"AllocationMinNetmaskLength"`: The minimum netmask length required for CIDR allocations
in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum
netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask
lengths for IPv6 addresses are 0 - 128.
- `"AllocationResourceTag"`: Tags that are required for resources that use CIDRs from this
IPAM pool. Resources that do not have these tags will not be allowed to allocate space from
the pool. If the resources have their tags changed after they have allocated space or if
the allocation tagging requirements are changed on the pool, the resource may be marked as
noncompliant.
- `"AutoImport"`: If selected, IPAM will continuously look for resources within the CIDR
range of this pool and automatically import them as allocations into your IPAM. The CIDRs
that will be allocated for these resources must not already be allocated to other resources
in order for the import to succeed. IPAM will import a CIDR regardless of its compliance
with the pool's allocation rules, so a resource might be imported and subsequently marked
as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the
largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly
import one of them only. A locale must be set on the pool for this feature to work.
- `"AwsService"`: Limits which service in Amazon Web Services that the pool can be used in.
\"ec2\", for example, allows users to use space for Elastic IP addresses and VPCs.
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the IPAM pool.
- `"DryRun"`: A check for 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.
- `"Locale"`: In IPAM, the locale is the Amazon Web Services Region where you want to make
an IPAM pool available for allocations. Only resources in the same Region as the locale of
the pool can get IP address allocations from the pool. You can only allocate a CIDR for a
VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that
once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale,
resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
- `"PublicIpSource"`: The IP address source for pools in the public scope. Only used for
provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more
information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can
add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is
amazon. For information on increasing the default limit, see Quotas for your IPAM in the
Amazon VPC IPAM User Guide.
- `"PubliclyAdvertisable"`: Determines if the pool is publicly advertisable. This option is
not available for pools with AddressFamily set to ipv4.
- `"SourceIpamPoolId"`: The ID of the source IPAM pool. Use this option to create a pool
within an existing pool. Note that the CIDR you provision for the pool within the source
pool must be available in the source pool's CIDR range.
- `"SourceResource"`: The resource used to provision CIDRs to a resource planning pool.
- `"TagSpecification"`: The key/value combination of a tag assigned to the resource. Use
the tag key in the filter name and the tag value as the filter value. For example, to find
all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for
the filter name and TeamA for the filter value.
"""
function create_ipam_pool(
AddressFamily, IpamScopeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateIpamPool",
Dict{String,Any}(
"AddressFamily" => AddressFamily,
"IpamScopeId" => IpamScopeId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ipam_pool(
AddressFamily,
IpamScopeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateIpamPool",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AddressFamily" => AddressFamily,
"IpamScopeId" => IpamScopeId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ipam_resource_discovery()
create_ipam_resource_discovery(params::Dict{String,<:Any})
Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables
IPAM to manage and monitor resources that belong to the owning account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A client token for the IPAM resource discovery.
- `"Description"`: A description for the IPAM resource discovery.
- `"DryRun"`: A check for 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.
- `"OperatingRegion"`: Operating Regions for the IPAM resource discovery. Operating Regions
are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM
only discovers and monitors resources in the Amazon Web Services Regions you select as
operating Regions.
- `"TagSpecification"`: Tag specifications for the IPAM resource discovery.
"""
function create_ipam_resource_discovery(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateIpamResourceDiscovery",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ipam_resource_discovery(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateIpamResourceDiscovery",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ipam_scope(ipam_id)
create_ipam_scope(ipam_id, params::Dict{String,<:Any})
Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM
contains two default scopes. Each scope represents the IP space for a single network. The
private scope is intended for all private IP address space. The public scope is intended
for all public IP address space. Scopes enable you to reuse IP addresses across multiple
unconnected networks without causing IP address overlap or conflict. For more information,
see Add a scope in the Amazon VPC IPAM User Guide.
# Arguments
- `ipam_id`: The ID of the IPAM for which you're creating this scope.
# 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 Ensuring idempotency.
- `"Description"`: A description for the scope you're creating.
- `"DryRun"`: A check for 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.
- `"TagSpecification"`: The key/value combination of a tag assigned to the resource. Use
the tag key in the filter name and the tag value as the filter value. For example, to find
all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for
the filter name and TeamA for the filter value.
"""
function create_ipam_scope(IpamId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateIpamScope",
Dict{String,Any}("IpamId" => IpamId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ipam_scope(
IpamId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateIpamScope",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IpamId" => IpamId, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_key_pair(key_name)
create_key_pair(key_name, params::Dict{String,<:Any})
Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified
PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to
save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private
key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the
specified name already exists, Amazon EC2 returns an error. The key pair returned to you is
available only in the Amazon Web Services Region in which you create it. If you prefer, you
can create your own key pair using a third-party tool and upload it to any Region using
ImportKeyPair. You can have up to 5,000 key pairs per Amazon Web Services Region. For more
information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
# Arguments
- `key_name`: A unique name for the key pair. Constraints: Up to 255 ASCII characters
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KeyFormat"`: The format of the key pair. Default: pem
- `"KeyType"`: The type of key pair. Note that ED25519 keys are not supported for Windows
instances. Default: rsa
- `"TagSpecification"`: The tags to apply to the new key pair.
- `"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.
"""
function create_key_pair(KeyName; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateKeyPair",
Dict{String,Any}("KeyName" => KeyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_key_pair(
KeyName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateKeyPair",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("KeyName" => KeyName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_launch_template(launch_template_data, launch_template_name)
create_launch_template(launch_template_data, launch_template_name, params::Dict{String,<:Any})
Creates a launch template. A launch template contains the parameters to launch an instance.
When you launch an instance using RunInstances, you can specify a launch template instead
of providing the launch parameters in the request. For more information, see Launch an
instance from a launch template in the Amazon EC2 User Guide. To clone an existing launch
template as the basis for a new launch template, use the Amazon EC2 console. The API, SDKs,
and CLI do not support cloning a template. For more information, see Create a launch
template from an existing launch template in the Amazon EC2 User Guide.
# Arguments
- `launch_template_data`: The information for the launch template.
- `launch_template_name`: A name for the launch template.
# 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. For more information, see Ensuring idempotency. Constraint: Maximum 128
ASCII characters.
- `"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.
- `"TagSpecification"`: The tags to apply to the launch template on creation. To tag the
launch template, the resource type must be launch-template. To specify the tags for the
resources that are created when an instance is launched, you must use the TagSpecifications
parameter in the launch template data structure.
- `"VersionDescription"`: A description for the first version of the launch template.
"""
function create_launch_template(
LaunchTemplateData,
LaunchTemplateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateLaunchTemplate",
Dict{String,Any}(
"LaunchTemplateData" => LaunchTemplateData,
"LaunchTemplateName" => LaunchTemplateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_launch_template(
LaunchTemplateData,
LaunchTemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateLaunchTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LaunchTemplateData" => LaunchTemplateData,
"LaunchTemplateName" => LaunchTemplateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_launch_template_version(launch_template_data)
create_launch_template_version(launch_template_data, params::Dict{String,<:Any})
Creates a new version of a launch template. You must specify an existing launch template,
either by name or ID. You can determine whether the new version inherits parameters from a
source version, and add or overwrite parameters as needed. Launch template versions are
numbered in the order in which they are created. You can't specify, change, or replace the
numbering of launch template versions. Launch templates are immutable; after you create a
launch template, you can't modify it. Instead, you can create a new version of the launch
template that includes the changes that you require. For more information, see Modify a
launch template (manage launch template versions) in the Amazon EC2 User Guide.
# Arguments
- `launch_template_data`: The information for the launch template.
# 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. For more information, see Ensuring idempotency. Constraint: Maximum 128
ASCII characters.
- `"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.
- `"LaunchTemplateId"`: The ID of the launch template. You must specify either the launch
template ID or the launch template name, but not both.
- `"LaunchTemplateName"`: The name of the launch template. You must specify either the
launch template ID or the launch template name, but not both.
- `"ResolveAlias"`: If true, and if a Systems Manager parameter is specified for ImageId,
the AMI ID is displayed in the response for imageID. For more information, see Use a
Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide. Default: false
- `"SourceVersion"`: The version of the launch template on which to base the new version.
Snapshots applied to the block device mapping are ignored when creating a new version
unless they are explicitly included. If you specify this parameter, the new version
inherits the launch parameters from the source version. If you specify additional launch
parameters for the new version, they overwrite any corresponding launch parameters
inherited from the source version. If you omit this parameter, the new version contains
only the launch parameters that you specify for the new version.
- `"VersionDescription"`: A description for the version of the launch template.
"""
function create_launch_template_version(
LaunchTemplateData; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateLaunchTemplateVersion",
Dict{String,Any}("LaunchTemplateData" => LaunchTemplateData);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_launch_template_version(
LaunchTemplateData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateLaunchTemplateVersion",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LaunchTemplateData" => LaunchTemplateData), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_local_gateway_route(local_gateway_route_table_id)
create_local_gateway_route(local_gateway_route_table_id, params::Dict{String,<:Any})
Creates a static route for the specified local gateway route table. You must specify one of
the following targets: LocalGatewayVirtualInterfaceGroupId NetworkInterfaceId
# Arguments
- `local_gateway_route_table_id`: The ID of the local gateway route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationCidrBlock"`: The CIDR range used for destination matches. Routing decisions
are based on the most specific match.
- `"DestinationPrefixListId"`: The ID of the prefix list. Use a prefix list in place of
DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in
the same request.
- `"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.
- `"LocalGatewayVirtualInterfaceGroupId"`: The ID of the virtual interface group.
- `"NetworkInterfaceId"`: The ID of the network interface.
"""
function create_local_gateway_route(
LocalGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateLocalGatewayRoute",
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_local_gateway_route(
LocalGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateLocalGatewayRoute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_local_gateway_route_table(local_gateway_id)
create_local_gateway_route_table(local_gateway_id, params::Dict{String,<:Any})
Creates a local gateway route table.
# Arguments
- `local_gateway_id`: The ID of the local gateway.
# 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.
- `"Mode"`: The mode of the local gateway route table.
- `"TagSpecification"`: The tags assigned to the local gateway route table.
"""
function create_local_gateway_route_table(
LocalGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateLocalGatewayRouteTable",
Dict{String,Any}("LocalGatewayId" => LocalGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_local_gateway_route_table(
LocalGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateLocalGatewayRouteTable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocalGatewayId" => LocalGatewayId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_local_gateway_route_table_virtual_interface_group_association(local_gateway_route_table_id, local_gateway_virtual_interface_group_id)
create_local_gateway_route_table_virtual_interface_group_association(local_gateway_route_table_id, local_gateway_virtual_interface_group_id, params::Dict{String,<:Any})
Creates a local gateway route table virtual interface group association.
# Arguments
- `local_gateway_route_table_id`: The ID of the local gateway route table.
- `local_gateway_virtual_interface_group_id`: The ID of the local gateway route table
virtual interface group association.
# 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.
- `"TagSpecification"`: The tags assigned to the local gateway route table virtual
interface group association.
"""
function create_local_gateway_route_table_virtual_interface_group_association(
LocalGatewayRouteTableId,
LocalGatewayVirtualInterfaceGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation",
Dict{String,Any}(
"LocalGatewayRouteTableId" => LocalGatewayRouteTableId,
"LocalGatewayVirtualInterfaceGroupId" => LocalGatewayVirtualInterfaceGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_local_gateway_route_table_virtual_interface_group_association(
LocalGatewayRouteTableId,
LocalGatewayVirtualInterfaceGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LocalGatewayRouteTableId" => LocalGatewayRouteTableId,
"LocalGatewayVirtualInterfaceGroupId" =>
LocalGatewayVirtualInterfaceGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_local_gateway_route_table_vpc_association(local_gateway_route_table_id, vpc_id)
create_local_gateway_route_table_vpc_association(local_gateway_route_table_id, vpc_id, params::Dict{String,<:Any})
Associates the specified VPC with the specified local gateway route table.
# Arguments
- `local_gateway_route_table_id`: The ID of the local gateway route table.
- `vpc_id`: The ID of the VPC.
# 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.
- `"TagSpecification"`: The tags to assign to the local gateway route table VPC association.
"""
function create_local_gateway_route_table_vpc_association(
LocalGatewayRouteTableId, VpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateLocalGatewayRouteTableVpcAssociation",
Dict{String,Any}(
"LocalGatewayRouteTableId" => LocalGatewayRouteTableId, "VpcId" => VpcId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_local_gateway_route_table_vpc_association(
LocalGatewayRouteTableId,
VpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateLocalGatewayRouteTableVpcAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LocalGatewayRouteTableId" => LocalGatewayRouteTableId, "VpcId" => VpcId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_managed_prefix_list(address_family, max_entries, prefix_list_name)
create_managed_prefix_list(address_family, max_entries, prefix_list_name, params::Dict{String,<:Any})
Creates a managed prefix list. You can specify one or more entries for the prefix list.
Each entry consists of a CIDR block and an optional description.
# Arguments
- `address_family`: The IP address type. Valid Values: IPv4 | IPv6
- `max_entries`: The maximum number of entries for the prefix list.
- `prefix_list_name`: A name for the prefix list. Constraints: Up to 255 characters in
length. The name cannot start with com.amazonaws.
# 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. For more information, see Ensuring idempotency. Constraints: Up to 255
UTF-8 characters in length.
- `"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.
- `"Entry"`: One or more entries for the prefix list.
- `"TagSpecification"`: The tags to apply to the prefix list during creation.
"""
function create_managed_prefix_list(
AddressFamily,
MaxEntries,
PrefixListName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateManagedPrefixList",
Dict{String,Any}(
"AddressFamily" => AddressFamily,
"MaxEntries" => MaxEntries,
"PrefixListName" => PrefixListName,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_managed_prefix_list(
AddressFamily,
MaxEntries,
PrefixListName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateManagedPrefixList",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AddressFamily" => AddressFamily,
"MaxEntries" => MaxEntries,
"PrefixListName" => PrefixListName,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_nat_gateway(subnet_id)
create_nat_gateway(subnet_id, params::Dict{String,<:Any})
Creates a NAT gateway in the specified subnet. This action creates a network interface in
the specified subnet with a private IP address from the IP address range of the subnet. You
can create either a public NAT gateway or a private NAT gateway. With a public NAT gateway,
internet-bound traffic from a private subnet can be routed to the NAT gateway, so that
instances in a private subnet can connect to the internet. With a private NAT gateway,
private communication is routed across VPCs and on-premises networks through a transit
gateway or virtual private gateway. Common use cases include running large workloads behind
a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and
communicating between overlapping networks. For more information, see NAT gateways in the
Amazon VPC User Guide. When you create a public NAT gateway and assign it an EIP or
secondary EIPs, the network border group of the EIPs must match the network border group of
the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT
gateway will fail to launch. You can see the network border group for the subnet's AZ by
viewing the details of the subnet. Similarly, you can view the network border group of an
EIP by viewing the details of the EIP address. For more information about network border
groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.
# Arguments
- `subnet_id`: The ID of the subnet in which to create the NAT gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocationId"`: [Public NAT gateways only] The allocation ID of an Elastic IP address
to associate with the NAT gateway. You cannot specify an Elastic IP address with a private
NAT gateway. If the Elastic IP address is associated with another resource, you must first
disassociate it.
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency. Constraint:
Maximum 64 ASCII characters.
- `"ConnectivityType"`: Indicates whether the NAT gateway supports public or private
connectivity. The default is public connectivity.
- `"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.
- `"PrivateIpAddress"`: The private IPv4 address to assign to the NAT gateway. If you don't
provide an address, a private IPv4 address will be automatically assigned.
- `"SecondaryAllocationId"`: Secondary EIP allocation IDs. For more information, see Create
a NAT gateway in the Amazon VPC User Guide.
- `"SecondaryPrivateIpAddress"`: Secondary private IPv4 addresses. For more information
about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.
- `"SecondaryPrivateIpAddressCount"`: [Private NAT gateway only] The number of secondary
private IPv4 addresses you want to assign to the NAT gateway. For more information about
secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.
- `"TagSpecification"`: The tags to assign to the NAT gateway.
"""
function create_nat_gateway(SubnetId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateNatGateway",
Dict{String,Any}("SubnetId" => SubnetId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_nat_gateway(
SubnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateNatGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SubnetId" => SubnetId, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network_acl(vpc_id)
create_network_acl(vpc_id, params::Dict{String,<:Any})
Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in
addition to security groups) for the instances in your VPC. For more information, see
Network ACLs in the Amazon VPC User Guide.
# Arguments
- `vpc_id`: The ID of the VPC.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"TagSpecification"`: The tags to assign to the network ACL.
- `"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.
"""
function create_network_acl(vpcId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateNetworkAcl",
Dict{String,Any}("vpcId" => vpcId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network_acl(
vpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateNetworkAcl",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("vpcId" => vpcId, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network_acl_entry(egress, network_acl_id, protocol, rule_action, rule_number)
create_network_acl_entry(egress, network_acl_id, protocol, rule_action, rule_number, params::Dict{String,<:Any})
Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL
has a set of numbered ingress rules and a separate set of numbered egress rules. When
determining whether a packet should be allowed in or out of a subnet associated with the
ACL, we process the entries in the ACL according to the rule numbers, in ascending order.
Each network ACL has a set of ingress rules and a separate set of egress rules. We
recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...),
and not number them one right after the other (for example, 101, 102, 103, ...). This makes
it easier to add a rule between existing ones without having to renumber the rules. After
you add an entry, you can't modify it; you must either replace it, or create an entry and
delete the old one. For more information about network ACLs, see Network ACLs in the Amazon
VPC User Guide.
# Arguments
- `egress`: Indicates whether this is an egress rule (rule is applied to traffic leaving
the subnet).
- `network_acl_id`: The ID of the network ACL.
- `protocol`: The protocol number. A value of \"-1\" means all protocols. If you specify
\"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic
on all ports is allowed, regardless of any ports or ICMP types or codes that you specify.
If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all
ICMP types and codes allowed, regardless of any that you specify. If you specify protocol
\"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
- `rule_action`: Indicates whether to allow or deny the traffic that matches the rule.
- `rule_number`: The rule number for the entry (for example, 100). ACL entries are
processed in ascending order by rule number. Constraints: Positive integer from 1 to 32766.
The range 32767 to 65535 is reserved for internal use.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Icmp"`: ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying
protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
- `"cidrBlock"`: The IPv4 network range to allow or deny, in CIDR notation (for example
172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if
you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
- `"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.
- `"ipv6CidrBlock"`: The IPv6 network range to allow or deny, in CIDR notation (for example
2001:db8:1234:1a00::/64).
- `"portRange"`: TCP or UDP protocols: The range of ports the rule applies to. Required if
specifying protocol 6 (TCP) or 17 (UDP).
"""
function create_network_acl_entry(
egress,
networkAclId,
protocol,
ruleAction,
ruleNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateNetworkAclEntry",
Dict{String,Any}(
"egress" => egress,
"networkAclId" => networkAclId,
"protocol" => protocol,
"ruleAction" => ruleAction,
"ruleNumber" => ruleNumber,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network_acl_entry(
egress,
networkAclId,
protocol,
ruleAction,
ruleNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateNetworkAclEntry",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"egress" => egress,
"networkAclId" => networkAclId,
"protocol" => protocol,
"ruleAction" => ruleAction,
"ruleNumber" => ruleNumber,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network_insights_access_scope(client_token)
create_network_insights_access_scope(client_token, params::Dict{String,<:Any})
Creates a Network Access Scope. Amazon Web Services Network Access Analyzer enables cloud
networking and cloud operations teams to verify that their networks on Amazon Web Services
conform to their network security and governance objectives. For more information, see the
Amazon Web Services Network Access Analyzer Guide.
# Arguments
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
# 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.
- `"ExcludePath"`: The paths to exclude.
- `"MatchPath"`: The paths to match.
- `"TagSpecification"`: The tags to apply.
"""
function create_network_insights_access_scope(
ClientToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateNetworkInsightsAccessScope",
Dict{String,Any}("ClientToken" => ClientToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network_insights_access_scope(
ClientToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateNetworkInsightsAccessScope",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => ClientToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network_insights_path(client_token, protocol, source)
create_network_insights_path(client_token, protocol, source, params::Dict{String,<:Any})
Creates a path to analyze for reachability. Reachability Analyzer enables you to analyze
and debug network reachability between two resources in your virtual private cloud (VPC).
For more information, see the Reachability Analyzer Guide.
# Arguments
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `protocol`: The protocol.
- `source`: The ID or ARN of the source. If the resource is in another account, you must
specify an ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Destination"`: The ID or ARN of the destination. If the resource is in another account,
you must specify an ARN.
- `"DestinationIp"`: The IP address of the destination.
- `"DestinationPort"`: The destination port.
- `"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.
- `"FilterAtDestination"`: Scopes the analysis to network paths that match specific filters
at the destination. If you specify this parameter, you can't specify the parameter for the
destination IP address.
- `"FilterAtSource"`: Scopes the analysis to network paths that match specific filters at
the source. If you specify this parameter, you can't specify the parameters for the source
IP address or the destination port.
- `"SourceIp"`: The IP address of the source.
- `"TagSpecification"`: The tags to add to the path.
"""
function create_network_insights_path(
ClientToken, Protocol, Source; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateNetworkInsightsPath",
Dict{String,Any}(
"ClientToken" => ClientToken, "Protocol" => Protocol, "Source" => Source
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network_insights_path(
ClientToken,
Protocol,
Source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateNetworkInsightsPath",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken, "Protocol" => Protocol, "Source" => Source
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network_interface(subnet_id)
create_network_interface(subnet_id, params::Dict{String,<:Any})
Creates a network interface in the specified subnet. The number of IP addresses you can
assign to a network interface varies by instance type. For more information about network
interfaces, see Elastic network interfaces in the Amazon EC2 User Guide.
# Arguments
- `subnet_id`: The ID of the subnet to associate with the network interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"ConnectionTrackingSpecification"`: A connection tracking specification for the network
interface.
- `"EnablePrimaryIpv6"`: If you’re creating a network interface in a dual-stack or
IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6
address is an IPv6 GUA address associated with an ENI that you have enabled to use a
primary IPv6 address. Use this option if the instance that this ENI will be attached to
relies on its IPv6 address not changing. Amazon Web Services will automatically assign an
IPv6 address associated with the ENI attached to your instance to be the primary IPv6
address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it.
When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made
the primary IPv6 address until the instance is terminated or the network interface is
detached. If you have multiple IPv6 addresses associated with an ENI attached to your
instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with
the ENI becomes the primary IPv6 address.
- `"InterfaceType"`: The type of network interface. The default is interface. The only
supported values are interface, efa, and trunk.
- `"Ipv4Prefix"`: The IPv4 prefixes assigned to the network interface. You can't specify
IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific
private IPv4 addresses, or a count of private IPv4 addresses.
- `"Ipv4PrefixCount"`: The number of IPv4 prefixes that Amazon Web Services automatically
assigns to the network interface. You can't specify a count of IPv4 prefixes if you've
specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or
a count of private IPv4 addresses.
- `"Ipv6Prefix"`: The IPv6 prefixes assigned to the network interface. You can't specify
IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific
IPv6 addresses, or a count of IPv6 addresses.
- `"Ipv6PrefixCount"`: The number of IPv6 prefixes that Amazon Web Services automatically
assigns to the network interface. You can't specify a count of IPv6 prefixes if you've
specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count
of IPv6 addresses.
- `"SecurityGroupId"`: The IDs of one or more security groups.
- `"TagSpecification"`: The tags to apply to the new network interface.
- `"description"`: A description for the network interface.
- `"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.
- `"ipv6AddressCount"`: The number of IPv6 addresses to assign to a network interface.
Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't
specify a count of IPv6 addresses using this parameter if you've specified one of the
following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes. If
your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that
setting by specifying 0 as the IPv6 address count.
- `"ipv6Addresses"`: The IPv6 addresses from the IPv6 CIDR block range of your subnet. You
can't specify IPv6 addresses using this parameter if you've specified one of the following:
a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
- `"privateIpAddress"`: The primary private IPv4 address of the network interface. If you
don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR
range. If you specify an IP address, you cannot indicate any IP addresses specified in
privateIpAddresses as primary (only one IP address can be designated as primary).
- `"privateIpAddresses"`: The private IPv4 addresses. You can't specify private IPv4
addresses if you've specified one of the following: a count of private IPv4 addresses,
specific IPv4 prefixes, or a count of IPv4 prefixes.
- `"secondaryPrivateIpAddressCount"`: The number of secondary private IPv4 addresses to
assign to a network interface. When you specify a number of secondary IPv4 addresses,
Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't
specify this option and specify more than one private IP address using privateIpAddresses.
You can't specify a count of private IPv4 addresses if you've specified one of the
following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4
prefixes.
"""
function create_network_interface(
subnetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateNetworkInterface",
Dict{String,Any}("subnetId" => subnetId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network_interface(
subnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateNetworkInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("subnetId" => subnetId, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network_interface_permission(network_interface_id, permission)
create_network_interface_permission(network_interface_id, permission, params::Dict{String,<:Any})
Grants an Amazon Web Services-authorized account permission to attach the specified network
interface to an instance in their account. You can grant permission to a single Amazon Web
Services account only, and only one account at a time.
# Arguments
- `network_interface_id`: The ID of the network interface.
- `permission`: The type of permission to grant.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AwsAccountId"`: The Amazon Web Services account ID.
- `"AwsService"`: The Amazon Web Service. Currently not supported.
- `"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.
"""
function create_network_interface_permission(
NetworkInterfaceId, Permission; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateNetworkInterfacePermission",
Dict{String,Any}(
"NetworkInterfaceId" => NetworkInterfaceId, "Permission" => Permission
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network_interface_permission(
NetworkInterfaceId,
Permission,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateNetworkInterfacePermission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NetworkInterfaceId" => NetworkInterfaceId, "Permission" => Permission
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_placement_group()
create_placement_group(params::Dict{String,<:Any})
Creates a placement group in which to launch instances. The strategy of the placement group
determines how the instances are organized within the group. A cluster placement group is
a logical grouping of instances within a single Availability Zone that benefit from low
network latency, high network throughput. A spread placement group places instances on
distinct hardware. A partition placement group places groups of instances in different
partitions, where instances in one partition do not share the same hardware with instances
in another partition. For more information, see Placement groups in the Amazon EC2 User
Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PartitionCount"`: The number of partitions. Valid only when Strategy is set to
partition.
- `"SpreadLevel"`: Determines how placement groups spread instances. Host – You can
use host only with Outpost placement groups. Rack – No usage restrictions.
- `"TagSpecification"`: The tags to apply to the new placement group.
- `"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.
- `"groupName"`: A name for the placement group. Must be unique within the scope of your
account for the Region. Constraints: Up to 255 ASCII characters
- `"strategy"`: The placement strategy.
"""
function create_placement_group(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreatePlacementGroup"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_placement_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreatePlacementGroup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_public_ipv4_pool()
create_public_ipv4_pool(params::Dict{String,<:Any})
Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required
for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with
IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To
monitor the status of pool creation, use DescribePublicIpv4Pools.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"TagSpecification"`: The key/value combination of a tag assigned to the resource. Use
the tag key in the filter name and the tag value as the filter value. For example, to find
all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for
the filter name and TeamA for the filter value.
"""
function create_public_ipv4_pool(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreatePublicIpv4Pool"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_public_ipv4_pool(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreatePublicIpv4Pool",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_replace_root_volume_task(instance_id)
create_replace_root_volume_task(instance_id, params::Dict{String,<:Any})
Replaces the EBS-backed root volume for a running instance with a new volume that is
restored to the original root volume's launch state, that is restored to a specific
snapshot taken from the original root volume, or that is restored from an AMI that has the
same key characteristics as that of the instance. For more information, see Replace a root
volume in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The ID of the instance for which to replace the root volume.
# 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. If you do not specify a client token, a randomly generated token is used
for the request to ensure idempotency. For more information, see Ensuring idempotency.
- `"DeleteReplacedRootVolume"`: Indicates whether to automatically delete the original root
volume after the root volume replacement task completes. To delete the original root
volume, specify true. If you choose to keep the original root volume after the replacement
task completes, you must manually delete it when you no longer need it.
- `"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.
- `"ImageId"`: The ID of the AMI to use to restore the root volume. The specified AMI must
have the same product code, billing information, architecture type, and virtualization type
as that of the instance. If you want to restore the replacement volume from a specific
snapshot, or if you want to restore it to its launch state, omit this parameter.
- `"SnapshotId"`: The ID of the snapshot from which to restore the replacement root volume.
The specified snapshot must be a snapshot that you previously created from the original
root volume. If you want to restore the replacement root volume to the initial launch
state, or if you want to restore the replacement root volume from an AMI, omit this
parameter.
- `"TagSpecification"`: The tags to apply to the root volume replacement task.
"""
function create_replace_root_volume_task(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateReplaceRootVolumeTask",
Dict{String,Any}("InstanceId" => InstanceId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replace_root_volume_task(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateReplaceRootVolumeTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceId" => InstanceId, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_reserved_instances_listing(client_token, instance_count, price_schedules, reserved_instances_id)
create_reserved_instances_listing(client_token, instance_count, price_schedules, reserved_instances_id, params::Dict{String,<:Any})
Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved
Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To
get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances
operation. Only Standard Reserved Instances can be sold in the Reserved Instance
Marketplace. Convertible Reserved Instances cannot be sold. The Reserved Instance
Marketplace matches sellers who want to resell Standard Reserved Instance capacity that
they no longer need with buyers who want to purchase additional capacity. Reserved
Instances bought and sold through the Reserved Instance Marketplace work like any other
Reserved Instances. To sell your Standard Reserved Instances, you must first register as a
seller in the Reserved Instance Marketplace. After completing the registration process, you
can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved
Instances, and specify the upfront price to receive for them. Your Standard Reserved
Instance listings then become available for purchase. To view the details of your Standard
Reserved Instance listing, you can use the DescribeReservedInstancesListings operation. For
more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User
Guide.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
your listings. This helps avoid duplicate listings. For more information, see Ensuring
Idempotency.
- `instance_count`: The number of instances that are a part of a Reserved Instance account
to be listed in the Reserved Instance Marketplace. This number should be less than or equal
to the instance count associated with the Reserved Instance ID specified in this call.
- `price_schedules`: A list specifying the price of the Standard Reserved Instance for each
month remaining in the Reserved Instance term.
- `reserved_instances_id`: The ID of the active Standard Reserved Instance.
"""
function create_reserved_instances_listing(
clientToken,
instanceCount,
priceSchedules,
reservedInstancesId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateReservedInstancesListing",
Dict{String,Any}(
"clientToken" => clientToken,
"instanceCount" => instanceCount,
"priceSchedules" => priceSchedules,
"reservedInstancesId" => reservedInstancesId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_reserved_instances_listing(
clientToken,
instanceCount,
priceSchedules,
reservedInstancesId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateReservedInstancesListing",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"instanceCount" => instanceCount,
"priceSchedules" => priceSchedules,
"reservedInstancesId" => reservedInstancesId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_restore_image_task(bucket, object_key)
create_restore_image_task(bucket, object_key, params::Dict{String,<:Any})
Starts a task that restores an AMI from an Amazon S3 object that was previously created by
using CreateStoreImageTask. To use this API, you must have the required permissions. For
more information, see Permissions for storing and restoring AMIs using Amazon S3 in the
Amazon EC2 User Guide. For more information, see Store and restore an AMI using Amazon S3
in the Amazon EC2 User Guide.
# Arguments
- `bucket`: The name of the Amazon S3 bucket that contains the stored AMI object.
- `object_key`: The name of the stored AMI object in the bucket.
# 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.
- `"Name"`: The name for the restored AMI. The name must be unique for AMIs in the Region
for this account. If you do not provide a name, the new AMI gets the same name as the
original AMI.
- `"TagSpecification"`: The tags to apply to the AMI and snapshots on restoration. You can
tag the AMI, the snapshots, or both. To tag the AMI, the value for ResourceType must be
image. To tag the snapshots, the value for ResourceType must be snapshot. The same tag is
applied to all of the snapshots that are created.
"""
function create_restore_image_task(
Bucket, ObjectKey; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateRestoreImageTask",
Dict{String,Any}("Bucket" => Bucket, "ObjectKey" => ObjectKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_restore_image_task(
Bucket,
ObjectKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateRestoreImageTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Bucket" => Bucket, "ObjectKey" => ObjectKey),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_route(route_table_id)
create_route(route_table_id, params::Dict{String,<:Any})
Creates a route in a route table within a VPC. You must specify either a destination CIDR
block or a prefix list ID. You must also specify exactly one of the resources from the
parameter list. When determining how to route traffic, we use the route with the most
specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the
route table includes the following two IPv4 routes: 192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B) Both routes apply to the traffic destined for
192.0.2.3. However, the second route in the list covers a smaller number of IP addresses
and is therefore more specific, so we use that route to determine where to target the
traffic. For more information about route tables, see Route tables in the Amazon VPC User
Guide.
# Arguments
- `route_table_id`: The ID of the route table for the route.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CarrierGatewayId"`: The ID of the carrier gateway. You can only use this option when
the VPC contains a subnet which is associated with a Wavelength Zone.
- `"CoreNetworkArn"`: The Amazon Resource Name (ARN) of the core network.
- `"DestinationPrefixListId"`: The ID of a prefix list used for the destination match.
- `"LocalGatewayId"`: The ID of the local gateway.
- `"TransitGatewayId"`: The ID of a transit gateway.
- `"VpcEndpointId"`: The ID of a VPC endpoint. Supported for Gateway Load Balancer
endpoints only.
- `"destinationCidrBlock"`: The IPv4 CIDR address block used for the destination match.
Routing decisions are based on the most specific match. We modify the specified CIDR block
to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to
100.68.0.0/18.
- `"destinationIpv6CidrBlock"`: The IPv6 CIDR block used for the destination match. Routing
decisions are based on the most specific match.
- `"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.
- `"egressOnlyInternetGatewayId"`: [IPv6 traffic only] The ID of an egress-only internet
gateway.
- `"gatewayId"`: The ID of an internet gateway or virtual private gateway attached to your
VPC.
- `"instanceId"`: The ID of a NAT instance in your VPC. The operation fails if you specify
an instance ID unless exactly one network interface is attached.
- `"natGatewayId"`: [IPv4 traffic only] The ID of a NAT gateway.
- `"networkInterfaceId"`: The ID of a network interface.
- `"vpcPeeringConnectionId"`: The ID of a VPC peering connection.
"""
function create_route(routeTableId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateRoute",
Dict{String,Any}("routeTableId" => routeTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_route(
routeTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateRoute",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("routeTableId" => routeTableId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_route_table(vpc_id)
create_route_table(vpc_id, params::Dict{String,<:Any})
Creates a route table for the specified VPC. After you create a route table, you can add
routes and associate the table with a subnet. For more information, see Route tables in the
Amazon VPC User Guide.
# Arguments
- `vpc_id`: The ID of the VPC.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"TagSpecification"`: The tags to assign to the route table.
- `"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.
"""
function create_route_table(vpcId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateRouteTable",
Dict{String,Any}("vpcId" => vpcId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_route_table(
vpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateRouteTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("vpcId" => vpcId, "ClientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_security_group(group_description, group_name)
create_security_group(group_description, group_name, params::Dict{String,<:Any})
Creates a security group. A security group acts as a virtual firewall for your instance to
control inbound and outbound traffic. For more information, see Amazon EC2 security groups
in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the
Amazon Virtual Private Cloud User Guide. When you create a security group, you specify a
friendly name of your choice. You can't have two security groups for the same VPC with the
same name. You have a default security group for use in your VPC. If you don't specify a
security group when you launch an instance, the instance is launched into the appropriate
default security group. A default security group includes a default rule that grants
instances unrestricted network access to each other. You can add or remove rules from your
security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress,
RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress. For more information about VPC
security group limits, see Amazon VPC Limits.
# Arguments
- `group_description`: A description for the security group. Constraints: Up to 255
characters in length Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!*
- `group_name`: The name of the security group. Constraints: Up to 255 characters in
length. Cannot start with sg-. Valid characters: a-z, A-Z, 0-9, spaces, and
._-:/()#,@[]+=&;{}!*
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagSpecification"`: The tags to assign to the security group.
- `"VpcId"`: The ID of the VPC. Required for a nondefault VPC.
- `"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.
"""
function create_security_group(
GroupDescription, GroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateSecurityGroup",
Dict{String,Any}("GroupDescription" => GroupDescription, "GroupName" => GroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_security_group(
GroupDescription,
GroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateSecurityGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupDescription" => GroupDescription, "GroupName" => GroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot(volume_id)
create_snapshot(volume_id, params::Dict{String,<:Any})
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for
backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a
snapshot of a volume in a Region, the snapshot must be stored in the same Region as the
volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on
the same Outpost as the volume, or in the Region for that Outpost. When a snapshot is
created, any Amazon Web Services Marketplace product codes that are associated with the
source volume are propagated to the snapshot. You can take a snapshot of an attached volume
that is in use. However, snapshots only capture data that has been written to your Amazon
EBS volume at the time the snapshot command is issued; this might exclude any data that has
been cached by any applications or the operating system. If you can pause any file systems
on the volume long enough to take a snapshot, your snapshot should be complete. However, if
you cannot pause all file writes to the volume, you should unmount the volume from within
the instance, issue the snapshot command, and then remount the volume to ensure a
consistent and complete snapshot. You may remount and use your volume while the snapshot
status is pending. When you create a snapshot for an EBS volume that serves as a root
device, we recommend that you stop the instance before taking the snapshot. Snapshots that
are taken from encrypted volumes are automatically encrypted. Volumes that are created from
encrypted snapshots are also automatically encrypted. Your encrypted volumes and any
associated snapshots always remain protected. You can tag your snapshots during creation.
For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide. For
more information, see Amazon EBS and Amazon EBS encryption in the Amazon EBS User Guide.
# Arguments
- `volume_id`: The ID of the Amazon EBS volume.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the snapshot.
- `"OutpostArn"`: The Amazon Resource Name (ARN) of the Outpost on which to create a local
snapshot. To create a snapshot of a volume in a Region, omit this parameter. The snapshot
is created in the same Region as the volume. To create a snapshot of a volume on an
Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created
in the Region for the Outpost. To create a snapshot of a volume on an Outpost and store
the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must
be created on the same Outpost as the volume. For more information, see Create local
snapshots from volumes on an Outpost in the Amazon EBS User Guide.
- `"TagSpecification"`: The tags to apply to the snapshot during creation.
- `"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.
"""
function create_snapshot(VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateSnapshot",
Dict{String,Any}("VolumeId" => VolumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeId" => VolumeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshots(instance_specification)
create_snapshots(instance_specification, params::Dict{String,<:Any})
Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.
Volumes are chosen by specifying an instance. Any attached volumes will produce one
snapshot each that is crash-consistent across the instance. You can include all of the
volumes currently attached to the instance, or you can exclude the root volume or specific
data (non-root) volumes from the multi-volume snapshot set. You can create multi-volume
snapshots of instances in a Region and instances on an Outpost. If you create snapshots
from an instance in a Region, the snapshots must be stored in the same Region as the
instance. If you create snapshots from an instance on an Outpost, the snapshots can be
stored on the same Outpost as the instance, or in the Region for that Outpost.
# Arguments
- `instance_specification`: The instance to specify which volumes should be included in the
snapshots.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CopyTagsFromSource"`: Copies the tags from the specified volume to corresponding
snapshot.
- `"Description"`: A description propagated to every snapshot specified by the instance.
- `"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.
- `"OutpostArn"`: The Amazon Resource Name (ARN) of the Outpost on which to create the
local snapshots. To create snapshots from an instance in a Region, omit this parameter.
The snapshots are created in the same Region as the instance. To create snapshots from an
instance on an Outpost and store the snapshots in the Region, omit this parameter. The
snapshots are created in the Region for the Outpost. To create snapshots from an instance
on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination
Outpost. The snapshots must be created on the same Outpost as the instance. For more
information, see Create multi-volume local snapshots from instances on an Outpost in the
Amazon EBS User Guide.
- `"TagSpecification"`: Tags to apply to every snapshot specified by the instance.
"""
function create_snapshots(
InstanceSpecification; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateSnapshots",
Dict{String,Any}("InstanceSpecification" => InstanceSpecification);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshots(
InstanceSpecification,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateSnapshots",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceSpecification" => InstanceSpecification),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_spot_datafeed_subscription(bucket)
create_spot_datafeed_subscription(bucket, params::Dict{String,<:Any})
Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You
can create one data feed per Amazon Web Services account. For more information, see Spot
Instance data feed in the Amazon EC2 User Guide.
# Arguments
- `bucket`: The name of the Amazon S3 bucket in which to store the Spot Instance data feed.
For more information about bucket names, see Rules for bucket naming in the Amazon S3
Developer Guide.
# 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.
- `"prefix"`: The prefix for the data feed file names.
"""
function create_spot_datafeed_subscription(
bucket; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateSpotDatafeedSubscription",
Dict{String,Any}("bucket" => bucket);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_spot_datafeed_subscription(
bucket, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateSpotDatafeedSubscription",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("bucket" => bucket), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_store_image_task(bucket, image_id)
create_store_image_task(bucket, image_id, params::Dict{String,<:Any})
Stores an AMI as a single object in an Amazon S3 bucket. To use this API, you must have the
required permissions. For more information, see Permissions for storing and restoring AMIs
using Amazon S3 in the Amazon EC2 User Guide. For more information, see Store and restore
an AMI using Amazon S3 in the Amazon EC2 User Guide.
# Arguments
- `bucket`: The name of the Amazon S3 bucket in which the AMI object will be stored. The
bucket must be in the Region in which the request is being made. The AMI object appears in
the bucket only after the upload task has completed.
- `image_id`: The ID of the AMI.
# 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.
- `"S3ObjectTag"`: The tags to apply to the AMI object that will be stored in the Amazon S3
bucket.
"""
function create_store_image_task(
Bucket, ImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateStoreImageTask",
Dict{String,Any}("Bucket" => Bucket, "ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_store_image_task(
Bucket,
ImageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateStoreImageTask",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Bucket" => Bucket, "ImageId" => ImageId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subnet(vpc_id)
create_subnet(vpc_id, params::Dict{String,<:Any})
Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block.
If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack
subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack
subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block. A subnet CIDR block must
not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you
can't change its CIDR block. The allowed size for an IPv4 subnet is between a /28 netmask
(16 IP addresses) and a /16 netmask (65,536 IP addresses). Amazon Web Services reserves
both the first four and the last IPv4 address in each subnet's CIDR block. They're not
available for your use. If you've associated an IPv6 CIDR block with your VPC, you can
associate an IPv6 CIDR block with a subnet when you create it. If you add more than one
subnet to a VPC, they're set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore
possible to have a subnet with no running instances (they're all stopped), but no remaining
IP addresses available. For more information, see Subnets in the Amazon VPC User Guide.
# Arguments
- `vpc_id`: The ID of the VPC.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZone"`: The Availability Zone or Local Zone for the subnet. Default: Amazon
Web Services selects one for you. If you create more than one subnet in your VPC, we do not
necessarily select a different zone for each subnet. To create a subnet in a Local Zone,
set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about
the Regions that support Local Zones, see Available Local Zones. To create a subnet in an
Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost
ARN.
- `"AvailabilityZoneId"`: The AZ ID or the Local Zone ID of the subnet.
- `"CidrBlock"`: The IPv4 network range for the subnet, in CIDR notation. For example,
10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you
specify 100.68.0.18/18, we modify it to 100.68.0.0/18. This parameter is not supported for
an IPv6 only subnet.
- `"Ipv4IpamPoolId"`: An IPv4 IPAM pool ID for the subnet.
- `"Ipv4NetmaskLength"`: An IPv4 netmask length for the subnet.
- `"Ipv6CidrBlock"`: The IPv6 network range for the subnet, in CIDR notation. This
parameter is required for an IPv6 only subnet.
- `"Ipv6IpamPoolId"`: An IPv6 IPAM pool ID for the subnet.
- `"Ipv6Native"`: Indicates whether to create an IPv6 only subnet.
- `"Ipv6NetmaskLength"`: An IPv6 netmask length for the subnet.
- `"OutpostArn"`: The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost
ARN, you must also specify the Availability Zone of the Outpost subnet.
- `"TagSpecification"`: The tags to assign to the subnet.
- `"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.
"""
function create_subnet(VpcId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateSubnet",
Dict{String,Any}("VpcId" => VpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subnet(
VpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateSubnet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("VpcId" => VpcId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subnet_cidr_reservation(cidr, reservation_type, subnet_id)
create_subnet_cidr_reservation(cidr, reservation_type, subnet_id, params::Dict{String,<:Any})
Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations in
the Amazon VPC User Guide and Assign prefixes to network interfaces in the Amazon EC2 User
Guide.
# Arguments
- `cidr`: The IPv4 or IPV6 CIDR range to reserve.
- `reservation_type`: The type of reservation. The reservation type determines how the
reserved IP addresses are assigned to resources. prefix - Amazon Web Services assigns
the reserved IP addresses to network interfaces. explicit - You assign the reserved IP
addresses to network interfaces.
- `subnet_id`: The ID of the subnet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description to assign to the subnet CIDR reservation.
- `"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.
- `"TagSpecification"`: The tags to assign to the subnet CIDR reservation.
"""
function create_subnet_cidr_reservation(
Cidr, ReservationType, SubnetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateSubnetCidrReservation",
Dict{String,Any}(
"Cidr" => Cidr, "ReservationType" => ReservationType, "SubnetId" => SubnetId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subnet_cidr_reservation(
Cidr,
ReservationType,
SubnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateSubnetCidrReservation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Cidr" => Cidr,
"ReservationType" => ReservationType,
"SubnetId" => SubnetId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tags(resource_id, tag)
create_tags(resource_id, tag, params::Dict{String,<:Any})
Adds or overwrites only the specified tags for the specified Amazon EC2 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. Tag keys must be unique per resource. For more information about tags, see Tag your
Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information
about creating IAM policies that control users' access to resources based on tags, see
Supported resource-level permissions for Amazon EC2 API actions in the Amazon Elastic
Compute Cloud User Guide.
# Arguments
- `resource_id`: The IDs of the resources, separated by spaces. Constraints: Up to 1000
resource IDs. We recommend breaking up this request into smaller batches.
- `tag`: The tags. The value parameter is required, but if you don't want the tag to have a
value, specify the parameter with no value, and we set the value to an empty string.
# 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.
"""
function create_tags(ResourceId, Tag; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateTags",
Dict{String,Any}("ResourceId" => ResourceId, "Tag" => Tag);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tags(
ResourceId,
Tag,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTags",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ResourceId" => ResourceId, "Tag" => Tag), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_traffic_mirror_filter()
create_traffic_mirror_filter(params::Dict{String,<:Any})
Creates a Traffic Mirror filter. A Traffic Mirror filter is a set of rules that defines the
traffic to mirror. By default, no traffic is mirrored. To mirror traffic, use
CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add
define what traffic gets mirrored. You can also use
ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `"Description"`: The description of the Traffic Mirror filter.
- `"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.
- `"TagSpecification"`: The tags to assign to a Traffic Mirror filter.
"""
function create_traffic_mirror_filter(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateTrafficMirrorFilter",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_traffic_mirror_filter(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateTrafficMirrorFilter",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_traffic_mirror_filter_rule(destination_cidr_block, rule_action, rule_number, source_cidr_block, traffic_direction, traffic_mirror_filter_id)
create_traffic_mirror_filter_rule(destination_cidr_block, rule_action, rule_number, source_cidr_block, traffic_direction, traffic_mirror_filter_id, params::Dict{String,<:Any})
Creates a Traffic Mirror filter rule. A Traffic Mirror rule defines the Traffic Mirror
source traffic to mirror. You need the Traffic Mirror filter ID when you create the rule.
# Arguments
- `destination_cidr_block`: The destination CIDR block to assign to the Traffic Mirror rule.
- `rule_action`: The action to take on the filtered traffic.
- `rule_number`: The number of the Traffic Mirror rule. This number must be unique for each
Traffic Mirror rule in a given direction. The rules are processed in ascending order by
rule number.
- `source_cidr_block`: The source CIDR block to assign to the Traffic Mirror rule.
- `traffic_direction`: The type of traffic.
- `traffic_mirror_filter_id`: The ID of the filter that this rule is associated with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `"Description"`: The description of the Traffic Mirror rule.
- `"DestinationPortRange"`: The destination port range.
- `"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.
- `"Protocol"`: The protocol, for example UDP, to assign to the Traffic Mirror rule. For
information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers
Authority (IANA) website.
- `"SourcePortRange"`: The source port range.
- `"TagSpecification"`: Traffic Mirroring tags specifications.
"""
function create_traffic_mirror_filter_rule(
DestinationCidrBlock,
RuleAction,
RuleNumber,
SourceCidrBlock,
TrafficDirection,
TrafficMirrorFilterId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTrafficMirrorFilterRule",
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"RuleAction" => RuleAction,
"RuleNumber" => RuleNumber,
"SourceCidrBlock" => SourceCidrBlock,
"TrafficDirection" => TrafficDirection,
"TrafficMirrorFilterId" => TrafficMirrorFilterId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_traffic_mirror_filter_rule(
DestinationCidrBlock,
RuleAction,
RuleNumber,
SourceCidrBlock,
TrafficDirection,
TrafficMirrorFilterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTrafficMirrorFilterRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"RuleAction" => RuleAction,
"RuleNumber" => RuleNumber,
"SourceCidrBlock" => SourceCidrBlock,
"TrafficDirection" => TrafficDirection,
"TrafficMirrorFilterId" => TrafficMirrorFilterId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_traffic_mirror_session(network_interface_id, session_number, traffic_mirror_filter_id, traffic_mirror_target_id)
create_traffic_mirror_session(network_interface_id, session_number, traffic_mirror_filter_id, traffic_mirror_target_id, params::Dict{String,<:Any})
Creates a Traffic Mirror session. A Traffic Mirror session actively copies packets from a
Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to
the session to define a subset of the traffic to mirror, for example all TCP traffic. The
Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the
same VPC, or in a different VPC connected via VPC peering or a transit gateway. By
default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that
specify the traffic to mirror.
# Arguments
- `network_interface_id`: The ID of the source network interface.
- `session_number`: The session number determines the order in which sessions are evaluated
when an interface is used by multiple sessions. The first session with a matching filter is
the one that mirrors the packets. Valid values are 1-32766.
- `traffic_mirror_filter_id`: The ID of the Traffic Mirror filter.
- `traffic_mirror_target_id`: The ID of the Traffic Mirror target.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `"Description"`: The description of the Traffic Mirror session.
- `"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.
- `"PacketLength"`: The number of bytes in each packet to mirror. These are bytes after the
VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To
mirror a subset of the packet, set this to the length (in bytes) that you want to mirror.
For example, if you set this value to 100, then the first 100 bytes that meet the filter
criteria are copied to the target. If you do not want to mirror the entire packet, use the
PacketLength parameter to specify the number of bytes in each packet to mirror. For
sessions with Network Load Balancer (NLB) Traffic Mirror targets the default PacketLength
will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will
result in an error response.
- `"TagSpecification"`: The tags to assign to a Traffic Mirror session.
- `"VirtualNetworkId"`: The VXLAN ID for the Traffic Mirror session. For more information
about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId, an
account-wide unique ID is chosen at random.
"""
function create_traffic_mirror_session(
NetworkInterfaceId,
SessionNumber,
TrafficMirrorFilterId,
TrafficMirrorTargetId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTrafficMirrorSession",
Dict{String,Any}(
"NetworkInterfaceId" => NetworkInterfaceId,
"SessionNumber" => SessionNumber,
"TrafficMirrorFilterId" => TrafficMirrorFilterId,
"TrafficMirrorTargetId" => TrafficMirrorTargetId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_traffic_mirror_session(
NetworkInterfaceId,
SessionNumber,
TrafficMirrorFilterId,
TrafficMirrorTargetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTrafficMirrorSession",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NetworkInterfaceId" => NetworkInterfaceId,
"SessionNumber" => SessionNumber,
"TrafficMirrorFilterId" => TrafficMirrorFilterId,
"TrafficMirrorTargetId" => TrafficMirrorTargetId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_traffic_mirror_target()
create_traffic_mirror_target(params::Dict{String,<:Any})
Creates a target for your Traffic Mirror session. A Traffic Mirror target is the
destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target
(monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC
peering or a transit gateway. A Traffic Mirror target can be a network interface, a Network
Load Balancer, or a Gateway Load Balancer endpoint. To use the target in a Traffic Mirror
session, use CreateTrafficMirrorSession.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `"Description"`: The description of the Traffic Mirror target.
- `"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.
- `"GatewayLoadBalancerEndpointId"`: The ID of the Gateway Load Balancer endpoint.
- `"NetworkInterfaceId"`: The network interface ID that is associated with the target.
- `"NetworkLoadBalancerArn"`: The Amazon Resource Name (ARN) of the Network Load Balancer
that is associated with the target.
- `"TagSpecification"`: The tags to assign to the Traffic Mirror target.
"""
function create_traffic_mirror_target(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateTrafficMirrorTarget",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_traffic_mirror_target(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateTrafficMirrorTarget",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway()
create_transit_gateway(params::Dict{String,<:Any})
Creates a transit gateway. You can use a transit gateway to interconnect your virtual
private clouds (VPC) and on-premises networks. After the transit gateway enters the
available state, you can attach your VPCs and VPN connections to the transit gateway. To
attach your VPCs, use CreateTransitGatewayVpcAttachment. To attach a VPN connection, use
CreateCustomerGateway to create a customer gateway and specify the ID of the customer
gateway and the ID of the transit gateway in a call to CreateVpnConnection. When you create
a transit gateway, we create a default transit gateway route table and use it as the
default association route table and the default propagation route table. You can use
CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you
disable automatic route propagation, we do not create a default transit gateway route
table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a
resource attachment to a transit gateway route table. If you disable automatic
associations, you can use AssociateTransitGatewayRouteTable to associate a resource
attachment with a transit gateway route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the transit gateway.
- `"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.
- `"Options"`: The transit gateway options.
- `"TagSpecification"`: The tags to apply to the transit gateway.
"""
function create_transit_gateway(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateTransitGateway"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_transit_gateway(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateTransitGateway",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_connect(options, transport_transit_gateway_attachment_id)
create_transit_gateway_connect(options, transport_transit_gateway_attachment_id, params::Dict{String,<:Any})
Creates a Connect attachment from a specified transit gateway attachment. A Connect
attachment is a GRE-based tunnel attachment that you can use to establish a connection
between a transit gateway and an appliance. A Connect attachment uses an existing VPC or
Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
# Arguments
- `options`: The Connect attachment options.
- `transport_transit_gateway_attachment_id`: The ID of the transit gateway attachment. You
can specify a VPC attachment or Amazon Web Services Direct Connect attachment.
# 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.
- `"TagSpecification"`: The tags to apply to the Connect attachment.
"""
function create_transit_gateway_connect(
Options,
TransportTransitGatewayAttachmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayConnect",
Dict{String,Any}(
"Options" => Options,
"TransportTransitGatewayAttachmentId" => TransportTransitGatewayAttachmentId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_connect(
Options,
TransportTransitGatewayAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayConnect",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Options" => Options,
"TransportTransitGatewayAttachmentId" =>
TransportTransitGatewayAttachmentId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_connect_peer(peer_address, transit_gateway_attachment_id, item)
create_transit_gateway_connect_peer(peer_address, transit_gateway_attachment_id, item, params::Dict{String,<:Any})
Creates a Connect peer for a specified transit gateway Connect attachment between a transit
gateway and an appliance. The peer address and transit gateway address must be the same IP
address family (IPv4 or IPv6). For more information, see Connect peers in the Amazon Web
Services Transit Gateways Guide.
# Arguments
- `peer_address`: The peer IP address (GRE outer IP address) on the appliance side of the
Connect peer.
- `transit_gateway_attachment_id`: The ID of the Connect attachment.
- `item`: The range of inside IP addresses that are used for BGP peering. You must specify
a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range
must be configured on the appliance as the BGP IP address. You can also optionally specify
a size /125 IPv6 CIDR block from the fd00::/8 range.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BgpOptions"`: The BGP options for the Connect peer.
- `"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.
- `"InsideCidrBlocks"`: The range of inside IP addresses that are used for BGP peering. You
must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address
from the range must be configured on the appliance as the BGP IP address. You can also
optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.
- `"TagSpecification"`: The tags to apply to the Connect peer.
- `"TransitGatewayAddress"`: The peer IP address (GRE outer IP address) on the transit
gateway side of the Connect peer, which must be specified from a transit gateway CIDR
block. If not specified, Amazon automatically assigns the first available IP address from
the transit gateway CIDR block.
"""
function create_transit_gateway_connect_peer(
PeerAddress,
TransitGatewayAttachmentId,
item;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayConnectPeer",
Dict{String,Any}(
"PeerAddress" => PeerAddress,
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"item" => item,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_connect_peer(
PeerAddress,
TransitGatewayAttachmentId,
item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayConnectPeer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PeerAddress" => PeerAddress,
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"item" => item,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_multicast_domain(transit_gateway_id)
create_transit_gateway_multicast_domain(transit_gateway_id, params::Dict{String,<:Any})
Creates a multicast domain using the specified transit gateway. The transit gateway must be
in the available state before you create a domain. Use DescribeTransitGateways to see the
state of transit gateway.
# Arguments
- `transit_gateway_id`: The ID of the transit gateway.
# 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.
- `"Options"`: The options for the transit gateway multicast domain.
- `"TagSpecification"`: The tags for the transit gateway multicast domain.
"""
function create_transit_gateway_multicast_domain(
TransitGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateTransitGatewayMulticastDomain",
Dict{String,Any}("TransitGatewayId" => TransitGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_multicast_domain(
TransitGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayMulticastDomain",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TransitGatewayId" => TransitGatewayId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_peering_attachment(peer_account_id, peer_region, peer_transit_gateway_id, transit_gateway_id)
create_transit_gateway_peering_attachment(peer_account_id, peer_region, peer_transit_gateway_id, transit_gateway_id, params::Dict{String,<:Any})
Requests a transit gateway peering attachment between the specified transit gateway
(requester) and a peer transit gateway (accepter). The peer transit gateway can be in your
account or a different Amazon Web Services account. After you create the peering
attachment, the owner of the accepter transit gateway must accept the attachment request.
# Arguments
- `peer_account_id`: The ID of the Amazon Web Services account that owns the peer transit
gateway.
- `peer_region`: The Region where the peer transit gateway is located.
- `peer_transit_gateway_id`: The ID of the peer transit gateway with which to create the
peering attachment.
- `transit_gateway_id`: The ID of the transit gateway.
# 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.
- `"Options"`: Requests a transit gateway peering attachment.
- `"TagSpecification"`: The tags to apply to the transit gateway peering attachment.
"""
function create_transit_gateway_peering_attachment(
PeerAccountId,
PeerRegion,
PeerTransitGatewayId,
TransitGatewayId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayPeeringAttachment",
Dict{String,Any}(
"PeerAccountId" => PeerAccountId,
"PeerRegion" => PeerRegion,
"PeerTransitGatewayId" => PeerTransitGatewayId,
"TransitGatewayId" => TransitGatewayId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_peering_attachment(
PeerAccountId,
PeerRegion,
PeerTransitGatewayId,
TransitGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayPeeringAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PeerAccountId" => PeerAccountId,
"PeerRegion" => PeerRegion,
"PeerTransitGatewayId" => PeerTransitGatewayId,
"TransitGatewayId" => TransitGatewayId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_policy_table(transit_gateway_id)
create_transit_gateway_policy_table(transit_gateway_id, params::Dict{String,<:Any})
Creates a transit gateway policy table.
# Arguments
- `transit_gateway_id`: The ID of the transit gateway used for the policy table.
# 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.
- `"TagSpecifications"`: The tags specification for the transit gateway policy table
created during the request.
"""
function create_transit_gateway_policy_table(
TransitGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateTransitGatewayPolicyTable",
Dict{String,Any}("TransitGatewayId" => TransitGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_policy_table(
TransitGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayPolicyTable",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TransitGatewayId" => TransitGatewayId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id)
create_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Creates a reference (route) to a prefix list in a specified transit gateway route table.
# Arguments
- `prefix_list_id`: The ID of the prefix list that is used for destination matches.
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Blackhole"`: Indicates whether to drop traffic that matches this route.
- `"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.
- `"TransitGatewayAttachmentId"`: The ID of the attachment to which traffic is routed.
"""
function create_transit_gateway_prefix_list_reference(
PrefixListId,
TransitGatewayRouteTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayPrefixListReference",
Dict{String,Any}(
"PrefixListId" => PrefixListId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_prefix_list_reference(
PrefixListId,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayPrefixListReference",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PrefixListId" => PrefixListId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id)
create_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id, params::Dict{String,<:Any})
Creates a static route for the specified transit gateway route table.
# Arguments
- `destination_cidr_block`: The CIDR range used for destination matches. Routing decisions
are based on the most specific match.
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Blackhole"`: Indicates whether to drop traffic that matches this route.
- `"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.
- `"TransitGatewayAttachmentId"`: The ID of the attachment.
"""
function create_transit_gateway_route(
DestinationCidrBlock,
TransitGatewayRouteTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayRoute",
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_route(
DestinationCidrBlock,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayRoute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_route_table(transit_gateway_id)
create_transit_gateway_route_table(transit_gateway_id, params::Dict{String,<:Any})
Creates a route table for the specified transit gateway.
# Arguments
- `transit_gateway_id`: The ID of the transit gateway.
# 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.
- `"TagSpecifications"`: The tags to apply to the transit gateway route table.
"""
function create_transit_gateway_route_table(
TransitGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateTransitGatewayRouteTable",
Dict{String,Any}("TransitGatewayId" => TransitGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_route_table(
TransitGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayRouteTable",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TransitGatewayId" => TransitGatewayId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_route_table_announcement(peering_attachment_id, transit_gateway_route_table_id)
create_transit_gateway_route_table_announcement(peering_attachment_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Advertises a new transit gateway route table.
# Arguments
- `peering_attachment_id`: The ID of the peering attachment.
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# 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.
- `"TagSpecification"`: The tags specifications applied to the transit gateway route table
announcement.
"""
function create_transit_gateway_route_table_announcement(
PeeringAttachmentId,
TransitGatewayRouteTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayRouteTableAnnouncement",
Dict{String,Any}(
"PeeringAttachmentId" => PeeringAttachmentId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_route_table_announcement(
PeeringAttachmentId,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayRouteTableAnnouncement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PeeringAttachmentId" => PeeringAttachmentId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_transit_gateway_vpc_attachment(transit_gateway_id, vpc_id, item)
create_transit_gateway_vpc_attachment(transit_gateway_id, vpc_id, item, params::Dict{String,<:Any})
Attaches the specified VPC to the specified transit gateway. If you attach a VPC with a
CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR
range is not propagated to the default propagation route table. To send VPC traffic to an
attached transit gateway, add a route to the VPC route table using CreateRoute.
# Arguments
- `transit_gateway_id`: The ID of the transit gateway.
- `vpc_id`: The ID of the VPC.
- `item`: The IDs of one or more subnets. You can specify only one subnet per Availability
Zone. You must specify at least one subnet, but we recommend that you specify two subnets
for better availability. The transit gateway uses one IP address from each specified subnet.
# 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.
- `"Options"`: The VPC attachment options.
- `"SubnetIds"`: The IDs of one or more subnets. You can specify only one subnet per
Availability Zone. You must specify at least one subnet, but we recommend that you specify
two subnets for better availability. The transit gateway uses one IP address from each
specified subnet.
- `"TagSpecifications"`: The tags to apply to the VPC attachment.
"""
function create_transit_gateway_vpc_attachment(
TransitGatewayId, VpcId, item; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateTransitGatewayVpcAttachment",
Dict{String,Any}(
"TransitGatewayId" => TransitGatewayId, "VpcId" => VpcId, "item" => item
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_transit_gateway_vpc_attachment(
TransitGatewayId,
VpcId,
item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateTransitGatewayVpcAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayId" => TransitGatewayId, "VpcId" => VpcId, "item" => item
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_verified_access_endpoint(application_domain, attachment_type, domain_certificate_arn, endpoint_domain_prefix, endpoint_type, verified_access_group_id)
create_verified_access_endpoint(application_domain, attachment_type, domain_certificate_arn, endpoint_domain_prefix, endpoint_type, verified_access_group_id, params::Dict{String,<:Any})
An Amazon Web Services Verified Access endpoint is where you define your application along
with an optional endpoint-level access policy.
# Arguments
- `application_domain`: The DNS name for users to reach your application.
- `attachment_type`: The type of attachment.
- `domain_certificate_arn`: The ARN of the public TLS/SSL certificate in Amazon Web
Services Certificate Manager to associate with the endpoint. The CN in the certificate must
match the DNS name your end users will use to reach your application.
- `endpoint_domain_prefix`: A custom identifier that is prepended to the DNS name that is
generated for the endpoint.
- `endpoint_type`: The type of Verified Access endpoint to create.
- `verified_access_group_id`: The ID of the Verified Access group to associate the endpoint
with.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the Verified Access endpoint.
- `"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.
- `"LoadBalancerOptions"`: The load balancer details. This parameter is required if the
endpoint type is load-balancer.
- `"NetworkInterfaceOptions"`: The network interface details. This parameter is required if
the endpoint type is network-interface.
- `"PolicyDocument"`: The Verified Access policy document.
- `"SecurityGroupId"`: The IDs of the security groups to associate with the Verified Access
endpoint. Required if AttachmentType is set to vpc.
- `"SseSpecification"`: The options for server side encryption.
- `"TagSpecification"`: The tags to assign to the Verified Access endpoint.
"""
function create_verified_access_endpoint(
ApplicationDomain,
AttachmentType,
DomainCertificateArn,
EndpointDomainPrefix,
EndpointType,
VerifiedAccessGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateVerifiedAccessEndpoint",
Dict{String,Any}(
"ApplicationDomain" => ApplicationDomain,
"AttachmentType" => AttachmentType,
"DomainCertificateArn" => DomainCertificateArn,
"EndpointDomainPrefix" => EndpointDomainPrefix,
"EndpointType" => EndpointType,
"VerifiedAccessGroupId" => VerifiedAccessGroupId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_verified_access_endpoint(
ApplicationDomain,
AttachmentType,
DomainCertificateArn,
EndpointDomainPrefix,
EndpointType,
VerifiedAccessGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateVerifiedAccessEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationDomain" => ApplicationDomain,
"AttachmentType" => AttachmentType,
"DomainCertificateArn" => DomainCertificateArn,
"EndpointDomainPrefix" => EndpointDomainPrefix,
"EndpointType" => EndpointType,
"VerifiedAccessGroupId" => VerifiedAccessGroupId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_verified_access_group(verified_access_instance_id)
create_verified_access_group(verified_access_instance_id, params::Dict{String,<:Any})
An Amazon Web Services Verified Access group is a collection of Amazon Web Services
Verified Access endpoints who's associated applications have similar security requirements.
Each instance within a Verified Access group shares an Verified Access policy. For example,
you can group all Verified Access instances associated with \"sales\" applications together
and use one common Verified Access policy.
# Arguments
- `verified_access_instance_id`: The ID of the Verified Access instance.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the Verified Access group.
- `"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.
- `"PolicyDocument"`: The Verified Access policy document.
- `"SseSpecification"`: The options for server side encryption.
- `"TagSpecification"`: The tags to assign to the Verified Access group.
"""
function create_verified_access_group(
VerifiedAccessInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVerifiedAccessGroup",
Dict{String,Any}(
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_verified_access_group(
VerifiedAccessInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateVerifiedAccessGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_verified_access_instance()
create_verified_access_instance(params::Dict{String,<:Any})
An Amazon Web Services Verified Access instance is a regional entity that evaluates
application requests and grants access only when your security requirements are met.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the Verified Access instance.
- `"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.
- `"FIPSEnabled"`: Enable or disable support for Federal Information Processing Standards
(FIPS) on the instance.
- `"TagSpecification"`: The tags to assign to the Verified Access instance.
"""
function create_verified_access_instance(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVerifiedAccessInstance",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_verified_access_instance(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVerifiedAccessInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_verified_access_trust_provider(policy_reference_name, trust_provider_type)
create_verified_access_trust_provider(policy_reference_name, trust_provider_type, params::Dict{String,<:Any})
A trust provider is a third-party entity that creates, maintains, and manages identity
information for users and devices. When an application request is made, the identity
information sent by the trust provider is evaluated by Verified Access before allowing or
denying the application request.
# Arguments
- `policy_reference_name`: The identifier to be used when working with policy rules.
- `trust_provider_type`: The type of trust provider.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the Verified Access trust provider.
- `"DeviceOptions"`: The options for a device-based trust provider. This parameter is
required when the provider type is device.
- `"DeviceTrustProviderType"`: The type of device-based trust provider. This parameter is
required when the provider type is device.
- `"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.
- `"OidcOptions"`: The options for a OpenID Connect-compatible user-identity trust
provider. This parameter is required when the provider type is user.
- `"SseSpecification"`: The options for server side encryption.
- `"TagSpecification"`: The tags to assign to the Verified Access trust provider.
- `"UserTrustProviderType"`: The type of user-based trust provider. This parameter is
required when the provider type is user.
"""
function create_verified_access_trust_provider(
PolicyReferenceName,
TrustProviderType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateVerifiedAccessTrustProvider",
Dict{String,Any}(
"PolicyReferenceName" => PolicyReferenceName,
"TrustProviderType" => TrustProviderType,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_verified_access_trust_provider(
PolicyReferenceName,
TrustProviderType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateVerifiedAccessTrustProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PolicyReferenceName" => PolicyReferenceName,
"TrustProviderType" => TrustProviderType,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_volume(availability_zone)
create_volume(availability_zone, params::Dict{String,<:Any})
Creates an EBS volume that can be attached to an instance in the same Availability Zone.
You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web
Services Marketplace product codes from the snapshot are propagated to the volume. You can
create encrypted volumes. Encrypted volumes must be attached to instances that support
Amazon EBS encryption. Volumes that are created from encrypted snapshots are also
automatically encrypted. For more information, see Amazon EBS encryption in the Amazon EBS
User Guide. You can tag your volumes during creation. For more information, see Tag your
Amazon EC2 resources in the Amazon EC2 User Guide. For more information, see Create an
Amazon EBS volume in the Amazon EBS User Guide.
# Arguments
- `availability_zone`: The ID of the Availability Zone in which to create the volume. For
example, us-east-1a.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensure Idempotency.
- `"Iops"`: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,
this represents the number of IOPS that are provisioned for the volume. For gp2 volumes,
this represents the baseline performance of the volume and the rate at which the volume
accumulates I/O credits for bursting. The following are the supported values for each
volume type: gp3: 3,000 - 16,000 IOPS io1: 100 - 64,000 IOPS io2: 100 - 256,000
IOPS For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro
System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter
is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This
parameter is not supported for gp2, st1, sc1, or standard volumes.
- `"KmsKeyId"`: The identifier of the KMS key to use for Amazon EBS encryption. If this
parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified,
the encrypted state must be true. You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. For example,
alias/ExampleAlias. Key ARN. For example,
arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN.
For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. Amazon Web Services
authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN
that is not valid, the action can appear to complete, but eventually fails.
- `"MultiAttachEnabled"`: Indicates whether to enable Amazon EBS Multi-Attach. If you
enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro
System in the same Availability Zone. This parameter is supported with io1 and io2 volumes
only. For more information, see Amazon EBS Multi-Attach in the Amazon EBS User Guide.
- `"OutpostArn"`: The Amazon Resource Name (ARN) of the Outpost.
- `"Size"`: The size of the volume, in GiBs. You must specify either a snapshot ID or a
volume size. If you specify a snapshot, the default is the snapshot size. You can specify a
volume size that is equal to or larger than the snapshot size. The following are the
supported volumes sizes for each volume type: gp2 and gp3: 1 - 16,384 GiB io1: 4 -
16,384 GiB io2: 4 - 65,536 GiB st1 and sc1: 125 - 16,384 GiB standard: 1 - 1024
GiB
- `"SnapshotId"`: The snapshot from which to create the volume. You must specify either a
snapshot ID or a volume size.
- `"TagSpecification"`: The tags to apply to the volume during creation.
- `"Throughput"`: The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes. Valid Range: Minimum value of 125. Maximum
value of 1000.
- `"VolumeType"`: The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3 Provisioned IOPS SSD: io1 | io2 Throughput Optimized
HDD: st1 Cold HDD: sc1 Magnetic: standard Throughput Optimized HDD (st1) and Cold
HDD (sc1) volumes can't be used as boot volumes. For more information, see Amazon EBS
volume types in the Amazon EBS User Guide. Default: gp2
- `"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.
- `"encrypted"`: Indicates whether the volume should be encrypted. The effect of setting
the encryption state to true depends on the volume origin (new or from a snapshot),
starting encryption state, ownership, and whether encryption by default is enabled. For
more information, see Encryption by default in the Amazon EBS User Guide. Encrypted Amazon
EBS volumes must be attached to instances that support Amazon EBS encryption. For more
information, see Supported instance types.
"""
function create_volume(AvailabilityZone; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateVolume",
Dict{String,Any}(
"AvailabilityZone" => AvailabilityZone, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_volume(
AvailabilityZone,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateVolume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AvailabilityZone" => AvailabilityZone, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpc()
create_vpc(params::Dict{String,<:Any})
Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for
your VPCs and subnets in the Amazon VPC User Guide. You can optionally request an IPv6 CIDR
block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of
IPv6 addresses or an IPv6 CIDR block from an IPv6 address pool that you provisioned through
bring your own IP addresses (BYOIP). By default, each instance that you launch in the VPC
has the default DHCP options, which include only a default DNS server that we provide
(AmazonProvidedDNS). For more information, see DHCP option sets in the Amazon VPC User
Guide. You can specify the instance tenancy value for the VPC when you create it. You can't
change this value for the VPC after you create it. For more information, see Dedicated
Instances in the Amazon EC2 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CidrBlock"`: The IPv4 network range for the VPC, in CIDR notation. For example,
10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you
specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
- `"Ipv4IpamPoolId"`: The ID of an IPv4 IPAM pool you want to use for allocating this VPC's
CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
- `"Ipv4NetmaskLength"`: The netmask length of the IPv4 CIDR you want to allocate to this
VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see
What is IPAM? in the Amazon VPC IPAM User Guide.
- `"Ipv6CidrBlock"`: The IPv6 CIDR block from the IPv6 address pool. You must also specify
Ipv6Pool in the request. To let Amazon choose the IPv6 CIDR block for you, omit this
parameter.
- `"Ipv6CidrBlockNetworkBorderGroup"`: The name of the location from which we advertise the
IPV6 CIDR block. Use this parameter to limit the address to this location. You must set
AmazonProvidedIpv6CidrBlock to true to use this parameter.
- `"Ipv6IpamPoolId"`: The ID of an IPv6 IPAM pool which will be used to allocate this VPC
an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management
workflows including assigning, tracking, troubleshooting, and auditing IP addresses across
Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
- `"Ipv6NetmaskLength"`: The netmask length of the IPv6 CIDR you want to allocate to this
VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see
What is IPAM? in the Amazon VPC IPAM User Guide.
- `"Ipv6Pool"`: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
- `"TagSpecification"`: The tags to assign to the VPC.
- `"amazonProvidedIpv6CidrBlock"`: Requests an Amazon-provided IPv6 CIDR block with a /56
prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the
CIDR block.
- `"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.
- `"instanceTenancy"`: The tenancy options for instances launched into the VPC. For
default, instances are launched with shared tenancy by default. You can launch instances
with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as
dedicated tenancy instances by default. You can only launch instances with a tenancy of
dedicated or host into a dedicated tenancy VPC. Important: The host value cannot be used
with this parameter. Use the default or dedicated values only. Default: default
"""
function create_vpc(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("CreateVpc"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_vpc(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2("CreateVpc", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
create_vpc_endpoint(service_name, vpc_id)
create_vpc_endpoint(service_name, vpc_id, params::Dict{String,<:Any})
Creates a VPC endpoint. A VPC endpoint provides a private connection between the specified
VPC and the specified endpoint service. You can use an endpoint service provided by Amazon
Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services
account. For more information, see the Amazon Web Services PrivateLink User Guide.
# Arguments
- `service_name`: The name of the endpoint service.
- `vpc_id`: The ID of the VPC.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `"DnsOptions"`: The DNS options for the endpoint.
- `"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.
- `"IpAddressType"`: The IP address type for the endpoint.
- `"PolicyDocument"`: (Interface and gateway endpoints) A policy to attach to the endpoint
that controls access to the service. The policy must be in valid JSON format. If this
parameter is not specified, we attach a default policy that allows full access to the
service.
- `"PrivateDnsEnabled"`: (Interface endpoint) Indicates whether to associate a private
hosted zone with the specified VPC. The private hosted zone contains a record set for the
default public DNS name for the service for the Region (for example,
kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the
endpoint network interfaces in the VPC. This enables you to make requests to the default
public DNS name for the service instead of the public DNS names that are automatically
generated by the VPC endpoint service. To use a private hosted zone, you must set the
following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use
ModifyVpcAttribute to set the VPC attributes. Default: true
- `"RouteTableId"`: (Gateway endpoint) The route table IDs.
- `"SecurityGroupId"`: (Interface endpoint) The IDs of the security groups to associate
with the endpoint network interfaces. If this parameter is not specified, we use the
default security group for the VPC.
- `"SubnetConfiguration"`: The subnet configurations for the endpoint.
- `"SubnetId"`: (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in
which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can
specify only one subnet.
- `"TagSpecification"`: The tags to associate with the endpoint.
- `"VpcEndpointType"`: The type of endpoint. Default: Gateway
"""
function create_vpc_endpoint(
ServiceName, VpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVpcEndpoint",
Dict{String,Any}("ServiceName" => ServiceName, "VpcId" => VpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpc_endpoint(
ServiceName,
VpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateVpcEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServiceName" => ServiceName, "VpcId" => VpcId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpc_endpoint_connection_notification(connection_notification_arn, item)
create_vpc_endpoint_connection_notification(connection_notification_arn, item, params::Dict{String,<:Any})
Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A
connection notification notifies you of specific endpoint events. You must create an SNS
topic to receive notifications. For more information, see Creating an Amazon SNS topic in
the Amazon SNS Developer Guide. You can create a connection notification for interface
endpoints only.
# Arguments
- `connection_notification_arn`: The ARN of the SNS topic for the notifications.
- `item`: The endpoint events for which to receive notifications. Valid values are Accept,
Connect, Delete, and Reject.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `"ConnectionEvents"`: The endpoint events for which to receive notifications. Valid
values are Accept, Connect, Delete, and Reject.
- `"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.
- `"ServiceId"`: The ID of the endpoint service.
- `"VpcEndpointId"`: The ID of the endpoint.
"""
function create_vpc_endpoint_connection_notification(
ConnectionNotificationArn, item; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVpcEndpointConnectionNotification",
Dict{String,Any}(
"ConnectionNotificationArn" => ConnectionNotificationArn, "item" => item
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpc_endpoint_connection_notification(
ConnectionNotificationArn,
item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateVpcEndpointConnectionNotification",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectionNotificationArn" => ConnectionNotificationArn, "item" => item
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpc_endpoint_service_configuration()
create_vpc_endpoint_service_configuration(params::Dict{String,<:Any})
Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,
users, and IAM roles) can connect. Before you create an endpoint service, you must create
one of the following for your service: A Network Load Balancer. Service consumers connect
to your service using an interface endpoint. A Gateway Load Balancer. Service consumers
connect to your service using a Gateway Load Balancer endpoint. If you set the private
DNS name, you must prove that you own the private DNS domain name. For more information,
see the Amazon Web Services PrivateLink Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptanceRequired"`: Indicates whether requests from service consumers to create an
endpoint to your service must be accepted manually.
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `"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.
- `"GatewayLoadBalancerArn"`: The Amazon Resource Names (ARNs) of the Gateway Load
Balancers.
- `"NetworkLoadBalancerArn"`: The Amazon Resource Names (ARNs) of the Network Load
Balancers.
- `"PrivateDnsName"`: (Interface endpoint configuration) The private DNS name to assign to
the VPC endpoint service.
- `"SupportedIpAddressType"`: The supported IP address types. The possible values are ipv4
and ipv6.
- `"TagSpecification"`: The tags to associate with the service.
"""
function create_vpc_endpoint_service_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVpcEndpointServiceConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpc_endpoint_service_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVpcEndpointServiceConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpc_peering_connection(vpc_id)
create_vpc_peering_connection(vpc_id, params::Dict{String,<:Any})
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an
accepter VPC with which to create the connection. The accepter VPC can belong to another
Amazon Web Services account and can be in a different Region to the requester VPC. The
requester VPC and accepter VPC cannot have overlapping CIDR blocks. Limitations and rules
apply to a VPC peering connection. For more information, see the VPC peering limitations in
the VPC Peering Guide. The owner of the accepter VPC must accept the peering request to
activate the peering connection. The VPC peering connection request expires after 7 days,
after which it cannot be accepted or rejected. If you create a VPC peering connection
request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status
of failed.
# Arguments
- `vpc_id`: The ID of the requester VPC. You must specify this parameter in the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PeerRegion"`: The Region code for the accepter VPC, if the accepter VPC is located in a
Region other than the Region in which you make the request. Default: The Region in which
you make the request.
- `"TagSpecification"`: The tags to assign to the peering connection.
- `"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.
- `"peerOwnerId"`: The Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
- `"peerVpcId"`: The ID of the VPC with which you are creating the VPC peering connection.
You must specify this parameter in the request.
"""
function create_vpc_peering_connection(
vpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVpcPeeringConnection",
Dict{String,Any}("vpcId" => vpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpc_peering_connection(
vpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVpcPeeringConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("vpcId" => vpcId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpn_connection(customer_gateway_id, type)
create_vpn_connection(customer_gateway_id, type, params::Dict{String,<:Any})
Creates a VPN connection between an existing virtual private gateway or transit gateway and
a customer gateway. The supported connection type is ipsec.1. The response includes
information that you need to give to your network administrator to configure your customer
gateway. We strongly recommend that you use HTTPS when calling this operation because the
response contains sensitive cryptographic information for configuring your customer gateway
device. If you decide to shut down your VPN connection for any reason and later create a
new VPN connection, you must reconfigure your customer gateway with the new information
returned from this call. This is an idempotent operation. If you perform the operation more
than once, Amazon EC2 doesn't return an error. For more information, see Amazon Web
Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
# Arguments
- `customer_gateway_id`: The ID of the customer gateway.
- `type`: The type of VPN connection (ipsec.1).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagSpecification"`: The tags to apply to the VPN connection.
- `"TransitGatewayId"`: The ID of the transit gateway. If you specify a transit gateway,
you cannot specify a virtual private gateway.
- `"VpnGatewayId"`: The ID of the virtual private gateway. If you specify a virtual private
gateway, you cannot specify a transit gateway.
- `"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.
- `"options"`: The options for the VPN connection.
"""
function create_vpn_connection(
CustomerGatewayId, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVpnConnection",
Dict{String,Any}("CustomerGatewayId" => CustomerGatewayId, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpn_connection(
CustomerGatewayId,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateVpnConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CustomerGatewayId" => CustomerGatewayId, "Type" => Type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpn_connection_route(destination_cidr_block, vpn_connection_id)
create_vpn_connection_route(destination_cidr_block, vpn_connection_id, params::Dict{String,<:Any})
Creates a static route associated with a VPN connection between an existing virtual private
gateway and a VPN customer gateway. The static route allows traffic to be routed from the
virtual private gateway to the VPN customer gateway. For more information, see Amazon Web
Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
# Arguments
- `destination_cidr_block`: The CIDR block associated with the local subnet of the customer
network.
- `vpn_connection_id`: The ID of the VPN connection.
"""
function create_vpn_connection_route(
DestinationCidrBlock, VpnConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVpnConnectionRoute",
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"VpnConnectionId" => VpnConnectionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpn_connection_route(
DestinationCidrBlock,
VpnConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"CreateVpnConnectionRoute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"VpnConnectionId" => VpnConnectionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpn_gateway(type)
create_vpn_gateway(type, params::Dict{String,<:Any})
Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC
side of your VPN connection. You can create a virtual private gateway before creating the
VPC itself. For more information, see Amazon Web Services Site-to-Site VPN in the Amazon
Web Services Site-to-Site VPN User Guide.
# Arguments
- `type`: The type of VPN connection this virtual private gateway supports.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AmazonSideAsn"`: A private Autonomous System Number (ASN) for the Amazon side of a BGP
session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're
using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range. Default: 64512
- `"AvailabilityZone"`: The Availability Zone for the virtual private gateway.
- `"TagSpecification"`: The tags to apply to the virtual private gateway.
- `"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.
"""
function create_vpn_gateway(Type; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"CreateVpnGateway",
Dict{String,Any}("Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpn_gateway(
Type, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"CreateVpnGateway",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Type" => Type), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_carrier_gateway(carrier_gateway_id)
delete_carrier_gateway(carrier_gateway_id, params::Dict{String,<:Any})
Deletes a carrier gateway. If you do not delete the route that contains the carrier
gateway as the Target, the route is a blackhole route. For information about how to delete
a route, see DeleteRoute.
# Arguments
- `carrier_gateway_id`: The ID of the carrier gateway.
# 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.
"""
function delete_carrier_gateway(
CarrierGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteCarrierGateway",
Dict{String,Any}("CarrierGatewayId" => CarrierGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_carrier_gateway(
CarrierGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteCarrierGateway",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CarrierGatewayId" => CarrierGatewayId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_client_vpn_endpoint(client_vpn_endpoint_id)
delete_client_vpn_endpoint(client_vpn_endpoint_id, params::Dict{String,<:Any})
Deletes the specified Client VPN endpoint. You must disassociate all target networks before
you can delete a Client VPN endpoint.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN to be deleted.
# 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.
"""
function delete_client_vpn_endpoint(
ClientVpnEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteClientVpnEndpoint",
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_client_vpn_endpoint(
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteClientVpnEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_client_vpn_route(client_vpn_endpoint_id, destination_cidr_block)
delete_client_vpn_route(client_vpn_endpoint_id, destination_cidr_block, params::Dict{String,<:Any})
Deletes a route from a Client VPN endpoint. You can only delete routes that you manually
added using the CreateClientVpnRoute action. You cannot delete routes that were
automatically added when associating a subnet. To remove routes that have been
automatically added, disassociate the target subnet from the Client VPN endpoint.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint from which the route is to be
deleted.
- `destination_cidr_block`: The IPv4 address range, in CIDR notation, of the route to be
deleted.
# 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.
- `"TargetVpcSubnetId"`: The ID of the target subnet used by the route.
"""
function delete_client_vpn_route(
ClientVpnEndpointId,
DestinationCidrBlock;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteClientVpnRoute",
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"DestinationCidrBlock" => DestinationCidrBlock,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_client_vpn_route(
ClientVpnEndpointId,
DestinationCidrBlock,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteClientVpnRoute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"DestinationCidrBlock" => DestinationCidrBlock,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_coip_cidr(cidr, coip_pool_id)
delete_coip_cidr(cidr, coip_pool_id, params::Dict{String,<:Any})
Deletes a range of customer-owned IP addresses.
# Arguments
- `cidr`: A customer-owned IP address range that you want to delete.
- `coip_pool_id`: The ID of the customer-owned address pool.
# 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.
"""
function delete_coip_cidr(
Cidr, CoipPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteCoipCidr",
Dict{String,Any}("Cidr" => Cidr, "CoipPoolId" => CoipPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_coip_cidr(
Cidr,
CoipPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteCoipCidr",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Cidr" => Cidr, "CoipPoolId" => CoipPoolId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_coip_pool(coip_pool_id)
delete_coip_pool(coip_pool_id, params::Dict{String,<:Any})
Deletes a pool of customer-owned IP (CoIP) addresses.
# Arguments
- `coip_pool_id`: The ID of the CoIP pool that you want to delete.
# 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.
"""
function delete_coip_pool(CoipPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteCoipPool",
Dict{String,Any}("CoipPoolId" => CoipPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_coip_pool(
CoipPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteCoipPool",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CoipPoolId" => CoipPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_customer_gateway(customer_gateway_id)
delete_customer_gateway(customer_gateway_id, params::Dict{String,<:Any})
Deletes the specified customer gateway. You must delete the VPN connection before you can
delete the customer gateway.
# Arguments
- `customer_gateway_id`: The ID of the customer gateway.
# 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.
"""
function delete_customer_gateway(
CustomerGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteCustomerGateway",
Dict{String,Any}("CustomerGatewayId" => CustomerGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_customer_gateway(
CustomerGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteCustomerGateway",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CustomerGatewayId" => CustomerGatewayId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dhcp_options(dhcp_options_id)
delete_dhcp_options(dhcp_options_id, params::Dict{String,<:Any})
Deletes the specified set of DHCP options. You must disassociate the set of DHCP options
before you can delete it. You can disassociate the set of DHCP options by associating
either a new set of options or the default set of options with the VPC.
# Arguments
- `dhcp_options_id`: The ID of the DHCP options set.
# 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.
"""
function delete_dhcp_options(
DhcpOptionsId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteDhcpOptions",
Dict{String,Any}("DhcpOptionsId" => DhcpOptionsId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dhcp_options(
DhcpOptionsId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteDhcpOptions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DhcpOptionsId" => DhcpOptionsId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_egress_only_internet_gateway(egress_only_internet_gateway_id)
delete_egress_only_internet_gateway(egress_only_internet_gateway_id, params::Dict{String,<:Any})
Deletes an egress-only internet gateway.
# Arguments
- `egress_only_internet_gateway_id`: The ID of the egress-only internet gateway.
# 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.
"""
function delete_egress_only_internet_gateway(
EgressOnlyInternetGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteEgressOnlyInternetGateway",
Dict{String,Any}("EgressOnlyInternetGatewayId" => EgressOnlyInternetGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_egress_only_internet_gateway(
EgressOnlyInternetGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteEgressOnlyInternetGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EgressOnlyInternetGatewayId" => EgressOnlyInternetGatewayId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fleets(fleet_id, terminate_instances)
delete_fleets(fleet_id, terminate_instances, params::Dict{String,<:Any})
Deletes the specified EC2 Fleets. After you delete an EC2 Fleet, it launches no new
instances. You must also specify whether a deleted EC2 Fleet should terminate its
instances. If you choose to terminate the instances, the EC2 Fleet enters the
deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and
the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. Up to
1000 instances can be terminated in a single request to delete instant fleets. A deleted
instant fleet with running instances is not supported. Restrictions You can delete up
to 25 fleets of type instant in a single request. You can delete up to 100 fleets of type
maintain or request in a single request. You can delete up to 125 fleets in a single
request, provided you do not exceed the quota for each fleet type, as specified above. If
you exceed the specified number of fleets to delete, no fleets are deleted. For more
information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
# Arguments
- `fleet_id`: The IDs of the EC2 Fleets. Constraints: In a single request, you can specify
up to 25 instant fleet IDs and up to 100 maintain or request fleet IDs.
- `terminate_instances`: Indicates whether to terminate the associated instances when the
EC2 Fleet is deleted. The default is to terminate the instances. To let the instances
continue to run after the EC2 Fleet is deleted, specify no-terminate-instances. Supported
only for fleets of type maintain and request. For instant fleets, you cannot specify
NoTerminateInstances. A deleted instant fleet with running instances is not supported.
# 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.
"""
function delete_fleets(
FleetId, TerminateInstances; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteFleets",
Dict{String,Any}("FleetId" => FleetId, "TerminateInstances" => TerminateInstances);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fleets(
FleetId,
TerminateInstances,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteFleets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FleetId" => FleetId, "TerminateInstances" => TerminateInstances
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_flow_logs(flow_log_id)
delete_flow_logs(flow_log_id, params::Dict{String,<:Any})
Deletes one or more flow logs.
# Arguments
- `flow_log_id`: One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs.
# 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.
"""
function delete_flow_logs(FlowLogId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteFlowLogs",
Dict{String,Any}("FlowLogId" => FlowLogId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_flow_logs(
FlowLogId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteFlowLogs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FlowLogId" => FlowLogId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fpga_image(fpga_image_id)
delete_fpga_image(fpga_image_id, params::Dict{String,<:Any})
Deletes the specified Amazon FPGA Image (AFI).
# Arguments
- `fpga_image_id`: The ID of the AFI.
# 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.
"""
function delete_fpga_image(FpgaImageId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteFpgaImage",
Dict{String,Any}("FpgaImageId" => FpgaImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fpga_image(
FpgaImageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteFpgaImage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FpgaImageId" => FpgaImageId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance_connect_endpoint(instance_connect_endpoint_id)
delete_instance_connect_endpoint(instance_connect_endpoint_id, params::Dict{String,<:Any})
Deletes the specified EC2 Instance Connect Endpoint.
# Arguments
- `instance_connect_endpoint_id`: The ID of the EC2 Instance Connect Endpoint to delete.
# 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.
"""
function delete_instance_connect_endpoint(
InstanceConnectEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteInstanceConnectEndpoint",
Dict{String,Any}("InstanceConnectEndpointId" => InstanceConnectEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance_connect_endpoint(
InstanceConnectEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteInstanceConnectEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceConnectEndpointId" => InstanceConnectEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance_event_window(instance_event_window_id)
delete_instance_event_window(instance_event_window_id, params::Dict{String,<:Any})
Deletes the specified event window. For more information, see Define event windows for
scheduled events in the Amazon EC2 User Guide.
# Arguments
- `instance_event_window_id`: The ID of the event window.
# 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.
- `"ForceDelete"`: Specify true to force delete the event window. Use the force delete
parameter if the event window is currently associated with targets.
"""
function delete_instance_event_window(
InstanceEventWindowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteInstanceEventWindow",
Dict{String,Any}("InstanceEventWindowId" => InstanceEventWindowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance_event_window(
InstanceEventWindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteInstanceEventWindow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceEventWindowId" => InstanceEventWindowId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_internet_gateway(internet_gateway_id)
delete_internet_gateway(internet_gateway_id, params::Dict{String,<:Any})
Deletes the specified internet gateway. You must detach the internet gateway from the VPC
before you can delete it.
# Arguments
- `internet_gateway_id`: The ID of the internet gateway.
# 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.
"""
function delete_internet_gateway(
internetGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteInternetGateway",
Dict{String,Any}("internetGatewayId" => internetGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_internet_gateway(
internetGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteInternetGateway",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("internetGatewayId" => internetGatewayId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ipam(ipam_id)
delete_ipam(ipam_id, params::Dict{String,<:Any})
Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM
including the historical data for CIDRs. For more information, see Delete an IPAM in the
Amazon VPC IPAM User Guide.
# Arguments
- `ipam_id`: The ID of the IPAM to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Cascade"`: Enables you to quickly delete an IPAM, private scopes, pools in private
scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with
this option if there is a pool in your public scope. If you use this option, IPAM does the
following: Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in
private scopes. No VPC resources are deleted as a result of enabling this option. The CIDR
associated with the resource will no longer be allocated from an IPAM pool, but the CIDR
itself will remain unchanged. Deprovisions all IPv4 CIDRs provisioned to IPAM pools in
private scopes. Deletes all IPAM pools in private scopes. Deletes all non-default
private scopes in the IPAM. Deletes the default public and private scopes and the IPAM.
- `"DryRun"`: A check for 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.
"""
function delete_ipam(IpamId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteIpam",
Dict{String,Any}("IpamId" => IpamId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ipam(
IpamId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteIpam",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IpamId" => IpamId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ipam_pool(ipam_pool_id)
delete_ipam_pool(ipam_pool_id, params::Dict{String,<:Any})
Delete an IPAM pool. You cannot delete an IPAM pool if there are allocations in it or
CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To
deprovision pool CIDRs, see DeprovisionIpamPoolCidr. For more information, see Delete a
pool in the Amazon VPC IPAM User Guide.
# Arguments
- `ipam_pool_id`: The ID of the pool to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Cascade"`: Enables you to quickly delete an IPAM pool and all resources within that
pool, including provisioned CIDRs, allocations, and other pools. You can only use this
option to delete pools in the private scope or pools in the public scope with a source
resource. A source resource is a resource used to provision CIDRs to a resource planning
pool.
- `"DryRun"`: A check for 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.
"""
function delete_ipam_pool(IpamPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteIpamPool",
Dict{String,Any}("IpamPoolId" => IpamPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ipam_pool(
IpamPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteIpamPool",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IpamPoolId" => IpamPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ipam_resource_discovery(ipam_resource_discovery_id)
delete_ipam_resource_discovery(ipam_resource_discovery_id, params::Dict{String,<:Any})
Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables
IPAM to manage and monitor resources that belong to the owning account.
# Arguments
- `ipam_resource_discovery_id`: The IPAM resource discovery ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
"""
function delete_ipam_resource_discovery(
IpamResourceDiscoveryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteIpamResourceDiscovery",
Dict{String,Any}("IpamResourceDiscoveryId" => IpamResourceDiscoveryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ipam_resource_discovery(
IpamResourceDiscoveryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteIpamResourceDiscovery",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IpamResourceDiscoveryId" => IpamResourceDiscoveryId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ipam_scope(ipam_scope_id)
delete_ipam_scope(ipam_scope_id, params::Dict{String,<:Any})
Delete the scope for an IPAM. You cannot delete the default scopes. For more information,
see Delete a scope in the Amazon VPC IPAM User Guide.
# Arguments
- `ipam_scope_id`: The ID of the scope to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
"""
function delete_ipam_scope(IpamScopeId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteIpamScope",
Dict{String,Any}("IpamScopeId" => IpamScopeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ipam_scope(
IpamScopeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteIpamScope",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IpamScopeId" => IpamScopeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_key_pair()
delete_key_pair(params::Dict{String,<:Any})
Deletes the specified key pair, by removing the public key from Amazon EC2.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KeyName"`: The name of the key pair.
- `"KeyPairId"`: The ID of the key pair.
- `"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.
"""
function delete_key_pair(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DeleteKeyPair"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function delete_key_pair(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteKeyPair", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
delete_launch_template()
delete_launch_template(params::Dict{String,<:Any})
Deletes a launch template. Deleting a launch template deletes all of its versions.
# 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.
- `"LaunchTemplateId"`: The ID of the launch template. You must specify either the launch
template ID or the launch template name, but not both.
- `"LaunchTemplateName"`: The name of the launch template. You must specify either the
launch template ID or the launch template name, but not both.
"""
function delete_launch_template(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteLaunchTemplate"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_launch_template(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteLaunchTemplate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_launch_template_versions(launch_template_version)
delete_launch_template_versions(launch_template_version, params::Dict{String,<:Any})
Deletes one or more versions of a launch template. You can't delete the default version of
a launch template; you must first assign a different version as the default. If the default
version is the only version for the launch template, you must delete the entire launch
template using DeleteLaunchTemplate. You can delete up to 200 launch template versions in a
single request. To delete more than 200 versions in a single request, use
DeleteLaunchTemplate, which deletes the launch template and all of its versions. For more
information, see Delete a launch template version in the Amazon EC2 User Guide.
# Arguments
- `launch_template_version`: The version numbers of one or more launch template versions to
delete. You can specify up to 200 launch template version numbers.
# 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.
- `"LaunchTemplateId"`: The ID of the launch template. You must specify either the launch
template ID or the launch template name, but not both.
- `"LaunchTemplateName"`: The name of the launch template. You must specify either the
launch template ID or the launch template name, but not both.
"""
function delete_launch_template_versions(
LaunchTemplateVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteLaunchTemplateVersions",
Dict{String,Any}("LaunchTemplateVersion" => LaunchTemplateVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_launch_template_versions(
LaunchTemplateVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteLaunchTemplateVersions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LaunchTemplateVersion" => LaunchTemplateVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_local_gateway_route(local_gateway_route_table_id)
delete_local_gateway_route(local_gateway_route_table_id, params::Dict{String,<:Any})
Deletes the specified route from the specified local gateway route table.
# Arguments
- `local_gateway_route_table_id`: The ID of the local gateway route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationCidrBlock"`: The CIDR range for the route. This must match the CIDR for the
route exactly.
- `"DestinationPrefixListId"`: Use a prefix list in place of DestinationCidrBlock. You
cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.
- `"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.
"""
function delete_local_gateway_route(
LocalGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteLocalGatewayRoute",
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_local_gateway_route(
LocalGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteLocalGatewayRoute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_local_gateway_route_table(local_gateway_route_table_id)
delete_local_gateway_route_table(local_gateway_route_table_id, params::Dict{String,<:Any})
Deletes a local gateway route table.
# Arguments
- `local_gateway_route_table_id`: The ID of the local gateway route table.
# 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.
"""
function delete_local_gateway_route_table(
LocalGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteLocalGatewayRouteTable",
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_local_gateway_route_table(
LocalGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteLocalGatewayRouteTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_local_gateway_route_table_virtual_interface_group_association(local_gateway_route_table_virtual_interface_group_association_id)
delete_local_gateway_route_table_virtual_interface_group_association(local_gateway_route_table_virtual_interface_group_association_id, params::Dict{String,<:Any})
Deletes a local gateway route table virtual interface group association.
# Arguments
- `local_gateway_route_table_virtual_interface_group_association_id`: The ID of the local
gateway route table virtual interface group association.
# 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.
"""
function delete_local_gateway_route_table_virtual_interface_group_association(
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation",
Dict{String,Any}(
"LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" =>
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_local_gateway_route_table_virtual_interface_group_association(
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" =>
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_local_gateway_route_table_vpc_association(local_gateway_route_table_vpc_association_id)
delete_local_gateway_route_table_vpc_association(local_gateway_route_table_vpc_association_id, params::Dict{String,<:Any})
Deletes the specified association between a VPC and local gateway route table.
# Arguments
- `local_gateway_route_table_vpc_association_id`: The ID of the association.
# 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.
"""
function delete_local_gateway_route_table_vpc_association(
LocalGatewayRouteTableVpcAssociationId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteLocalGatewayRouteTableVpcAssociation",
Dict{String,Any}(
"LocalGatewayRouteTableVpcAssociationId" =>
LocalGatewayRouteTableVpcAssociationId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_local_gateway_route_table_vpc_association(
LocalGatewayRouteTableVpcAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteLocalGatewayRouteTableVpcAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LocalGatewayRouteTableVpcAssociationId" =>
LocalGatewayRouteTableVpcAssociationId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_managed_prefix_list(prefix_list_id)
delete_managed_prefix_list(prefix_list_id, params::Dict{String,<:Any})
Deletes the specified managed prefix list. You must first remove all references to the
prefix list in your resources.
# Arguments
- `prefix_list_id`: The ID of the prefix list.
# 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.
"""
function delete_managed_prefix_list(
PrefixListId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteManagedPrefixList",
Dict{String,Any}("PrefixListId" => PrefixListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_managed_prefix_list(
PrefixListId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteManagedPrefixList",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PrefixListId" => PrefixListId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_nat_gateway(nat_gateway_id)
delete_nat_gateway(nat_gateway_id, params::Dict{String,<:Any})
Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic
IP address, but does not release the address from your account. Deleting a NAT gateway does
not delete any NAT gateway routes in your route tables.
# Arguments
- `nat_gateway_id`: The ID of the NAT gateway.
# 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.
"""
function delete_nat_gateway(NatGatewayId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteNatGateway",
Dict{String,Any}("NatGatewayId" => NatGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_nat_gateway(
NatGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteNatGateway",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("NatGatewayId" => NatGatewayId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_acl(network_acl_id)
delete_network_acl(network_acl_id, params::Dict{String,<:Any})
Deletes the specified network ACL. You can't delete the ACL if it's associated with any
subnets. You can't delete the default network ACL.
# Arguments
- `network_acl_id`: The ID of the network ACL.
# 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.
"""
function delete_network_acl(networkAclId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteNetworkAcl",
Dict{String,Any}("networkAclId" => networkAclId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_acl(
networkAclId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteNetworkAcl",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("networkAclId" => networkAclId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_acl_entry(egress, network_acl_id, rule_number)
delete_network_acl_entry(egress, network_acl_id, rule_number, params::Dict{String,<:Any})
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
# Arguments
- `egress`: Indicates whether the rule is an egress rule.
- `network_acl_id`: The ID of the network ACL.
- `rule_number`: The rule number of the entry to delete.
# 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.
"""
function delete_network_acl_entry(
egress, networkAclId, ruleNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteNetworkAclEntry",
Dict{String,Any}(
"egress" => egress, "networkAclId" => networkAclId, "ruleNumber" => ruleNumber
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_acl_entry(
egress,
networkAclId,
ruleNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteNetworkAclEntry",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"egress" => egress,
"networkAclId" => networkAclId,
"ruleNumber" => ruleNumber,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_insights_access_scope(network_insights_access_scope_id)
delete_network_insights_access_scope(network_insights_access_scope_id, params::Dict{String,<:Any})
Deletes the specified Network Access Scope.
# Arguments
- `network_insights_access_scope_id`: The ID of the Network Access Scope.
# 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.
"""
function delete_network_insights_access_scope(
NetworkInsightsAccessScopeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteNetworkInsightsAccessScope",
Dict{String,Any}("NetworkInsightsAccessScopeId" => NetworkInsightsAccessScopeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_insights_access_scope(
NetworkInsightsAccessScopeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteNetworkInsightsAccessScope",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NetworkInsightsAccessScopeId" => NetworkInsightsAccessScopeId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_insights_access_scope_analysis(network_insights_access_scope_analysis_id)
delete_network_insights_access_scope_analysis(network_insights_access_scope_analysis_id, params::Dict{String,<:Any})
Deletes the specified Network Access Scope analysis.
# Arguments
- `network_insights_access_scope_analysis_id`: The ID of the Network Access Scope analysis.
# 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.
"""
function delete_network_insights_access_scope_analysis(
NetworkInsightsAccessScopeAnalysisId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteNetworkInsightsAccessScopeAnalysis",
Dict{String,Any}(
"NetworkInsightsAccessScopeAnalysisId" => NetworkInsightsAccessScopeAnalysisId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_insights_access_scope_analysis(
NetworkInsightsAccessScopeAnalysisId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteNetworkInsightsAccessScopeAnalysis",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NetworkInsightsAccessScopeAnalysisId" =>
NetworkInsightsAccessScopeAnalysisId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_insights_analysis(network_insights_analysis_id)
delete_network_insights_analysis(network_insights_analysis_id, params::Dict{String,<:Any})
Deletes the specified network insights analysis.
# Arguments
- `network_insights_analysis_id`: The ID of the network insights analysis.
# 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.
"""
function delete_network_insights_analysis(
NetworkInsightsAnalysisId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteNetworkInsightsAnalysis",
Dict{String,Any}("NetworkInsightsAnalysisId" => NetworkInsightsAnalysisId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_insights_analysis(
NetworkInsightsAnalysisId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteNetworkInsightsAnalysis",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NetworkInsightsAnalysisId" => NetworkInsightsAnalysisId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_insights_path(network_insights_path_id)
delete_network_insights_path(network_insights_path_id, params::Dict{String,<:Any})
Deletes the specified path.
# Arguments
- `network_insights_path_id`: The ID of the path.
# 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.
"""
function delete_network_insights_path(
NetworkInsightsPathId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteNetworkInsightsPath",
Dict{String,Any}("NetworkInsightsPathId" => NetworkInsightsPathId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_insights_path(
NetworkInsightsPathId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteNetworkInsightsPath",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NetworkInsightsPathId" => NetworkInsightsPathId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_interface(network_interface_id)
delete_network_interface(network_interface_id, params::Dict{String,<:Any})
Deletes the specified network interface. You must detach the network interface before you
can delete it.
# Arguments
- `network_interface_id`: The ID of the network interface.
# 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.
"""
function delete_network_interface(
networkInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteNetworkInterface",
Dict{String,Any}("networkInterfaceId" => networkInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_interface(
networkInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteNetworkInterface",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("networkInterfaceId" => networkInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_interface_permission(network_interface_permission_id)
delete_network_interface_permission(network_interface_permission_id, params::Dict{String,<:Any})
Deletes a permission for a network interface. By default, you cannot delete the permission
if the account for which you're removing the permission has attached the network interface
to an instance. However, you can force delete the permission, regardless of any attachment.
# Arguments
- `network_interface_permission_id`: The ID of the network interface permission.
# 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.
- `"Force"`: Specify true to remove the permission even if the network interface is
attached to an instance.
"""
function delete_network_interface_permission(
NetworkInterfacePermissionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteNetworkInterfacePermission",
Dict{String,Any}("NetworkInterfacePermissionId" => NetworkInterfacePermissionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_interface_permission(
NetworkInterfacePermissionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteNetworkInterfacePermission",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NetworkInterfacePermissionId" => NetworkInterfacePermissionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_placement_group(group_name)
delete_placement_group(group_name, params::Dict{String,<:Any})
Deletes the specified placement group. You must terminate all instances in the placement
group before you can delete the placement group. For more information, see Placement groups
in the Amazon EC2 User Guide.
# Arguments
- `group_name`: The name of the placement group.
# 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.
"""
function delete_placement_group(
groupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeletePlacementGroup",
Dict{String,Any}("groupName" => groupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_placement_group(
groupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeletePlacementGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("groupName" => groupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_public_ipv4_pool(pool_id)
delete_public_ipv4_pool(pool_id, params::Dict{String,<:Any})
Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the
public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6
addresses you bring to Amazon Web Services, however, use IPAM pools only.
# Arguments
- `pool_id`: The ID of the public IPv4 pool you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
"""
function delete_public_ipv4_pool(PoolId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeletePublicIpv4Pool",
Dict{String,Any}("PoolId" => PoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_public_ipv4_pool(
PoolId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeletePublicIpv4Pool",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PoolId" => PoolId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_queued_reserved_instances(reserved_instances_id)
delete_queued_reserved_instances(reserved_instances_id, params::Dict{String,<:Any})
Deletes the queued purchases for the specified Reserved Instances.
# Arguments
- `reserved_instances_id`: The IDs of the Reserved Instances.
# 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.
"""
function delete_queued_reserved_instances(
ReservedInstancesId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteQueuedReservedInstances",
Dict{String,Any}("ReservedInstancesId" => ReservedInstancesId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_queued_reserved_instances(
ReservedInstancesId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteQueuedReservedInstances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ReservedInstancesId" => ReservedInstancesId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_route(route_table_id)
delete_route(route_table_id, params::Dict{String,<:Any})
Deletes the specified route from the specified route table.
# Arguments
- `route_table_id`: The ID of the route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationPrefixListId"`: The ID of the prefix list for the route.
- `"destinationCidrBlock"`: The IPv4 CIDR range for the route. The value you specify must
match the CIDR for the route exactly.
- `"destinationIpv6CidrBlock"`: The IPv6 CIDR range for the route. The value you specify
must match the CIDR for the route exactly.
- `"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.
"""
function delete_route(routeTableId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteRoute",
Dict{String,Any}("routeTableId" => routeTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_route(
routeTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteRoute",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("routeTableId" => routeTableId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_route_table(route_table_id)
delete_route_table(route_table_id, params::Dict{String,<:Any})
Deletes the specified route table. You must disassociate the route table from any subnets
before you can delete it. You can't delete the main route table.
# Arguments
- `route_table_id`: The ID of the route table.
# 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.
"""
function delete_route_table(routeTableId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteRouteTable",
Dict{String,Any}("routeTableId" => routeTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_route_table(
routeTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteRouteTable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("routeTableId" => routeTableId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_security_group()
delete_security_group(params::Dict{String,<:Any})
Deletes a security group. If you attempt to delete a security group that is associated with
an instance or network interface or is referenced by another security group, the operation
fails with DependencyViolation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GroupId"`: The ID of the security group.
- `"GroupName"`: [Default VPC] The name of the security group. You can specify either the
security group name or the security group ID. For security groups in a nondefault VPC, you
must specify the security group ID.
- `"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.
"""
function delete_security_group(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteSecurityGroup"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_security_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteSecurityGroup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_snapshot(snapshot_id)
delete_snapshot(snapshot_id, params::Dict{String,<:Any})
Deletes the specified snapshot. When you make periodic snapshots of a volume, 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
volume. You cannot delete a snapshot of the root device of an EBS volume used by a
registered AMI. You must first de-register the AMI before you can delete the snapshot. For
more information, see Delete an Amazon EBS snapshot in the Amazon EBS User Guide.
# Arguments
- `snapshot_id`: The ID of the EBS snapshot.
# 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.
"""
function delete_snapshot(SnapshotId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteSnapshot",
Dict{String,Any}("SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_snapshot(
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotId" => SnapshotId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_spot_datafeed_subscription()
delete_spot_datafeed_subscription(params::Dict{String,<:Any})
Deletes the data feed for Spot Instances.
# 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.
"""
function delete_spot_datafeed_subscription(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteSpotDatafeedSubscription";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_spot_datafeed_subscription(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteSpotDatafeedSubscription",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subnet(subnet_id)
delete_subnet(subnet_id, params::Dict{String,<:Any})
Deletes the specified subnet. You must terminate all running instances in the subnet before
you can delete the subnet.
# Arguments
- `subnet_id`: The ID of the subnet.
# 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.
"""
function delete_subnet(SubnetId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteSubnet",
Dict{String,Any}("SubnetId" => SubnetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_subnet(
SubnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteSubnet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SubnetId" => SubnetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subnet_cidr_reservation(subnet_cidr_reservation_id)
delete_subnet_cidr_reservation(subnet_cidr_reservation_id, params::Dict{String,<:Any})
Deletes a subnet CIDR reservation.
# Arguments
- `subnet_cidr_reservation_id`: The ID of the subnet CIDR reservation.
# 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.
"""
function delete_subnet_cidr_reservation(
SubnetCidrReservationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteSubnetCidrReservation",
Dict{String,Any}("SubnetCidrReservationId" => SubnetCidrReservationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_subnet_cidr_reservation(
SubnetCidrReservationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteSubnetCidrReservation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SubnetCidrReservationId" => SubnetCidrReservationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tags(resource_id)
delete_tags(resource_id, params::Dict{String,<:Any})
Deletes the specified set of tags from the specified set of resources. To list the current
tags, use DescribeTags. For more information about tags, see Tag your Amazon EC2 resources
in the Amazon Elastic Compute Cloud User Guide.
# Arguments
- `resource_id`: The IDs of the resources, separated by spaces. Constraints: Up to 1000
resource IDs. We recommend breaking up this request into smaller batches.
# 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.
- `"tag"`: The tags to delete. Specify a tag key and an optional tag value to delete
specific tags. If you specify a tag key without a tag value, we delete any tag with this
key regardless of its value. If you specify a tag key with an empty string as the tag
value, we delete the tag only if its value is an empty string. If you omit this parameter,
we delete all user-defined tags for the specified resources. We do not delete Amazon Web
Services-generated tags (tags that have the aws: prefix). Constraints: Up to 1000 tags.
"""
function delete_tags(resourceId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteTags",
Dict{String,Any}("resourceId" => resourceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tags(
resourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceId" => resourceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_traffic_mirror_filter(traffic_mirror_filter_id)
delete_traffic_mirror_filter(traffic_mirror_filter_id, params::Dict{String,<:Any})
Deletes the specified Traffic Mirror filter. You cannot delete a Traffic Mirror filter that
is in use by a Traffic Mirror session.
# Arguments
- `traffic_mirror_filter_id`: The ID of the Traffic Mirror filter.
# 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.
"""
function delete_traffic_mirror_filter(
TrafficMirrorFilterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTrafficMirrorFilter",
Dict{String,Any}("TrafficMirrorFilterId" => TrafficMirrorFilterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_traffic_mirror_filter(
TrafficMirrorFilterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTrafficMirrorFilter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TrafficMirrorFilterId" => TrafficMirrorFilterId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_traffic_mirror_filter_rule(traffic_mirror_filter_rule_id)
delete_traffic_mirror_filter_rule(traffic_mirror_filter_rule_id, params::Dict{String,<:Any})
Deletes the specified Traffic Mirror rule.
# Arguments
- `traffic_mirror_filter_rule_id`: The ID of the Traffic Mirror rule.
# 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.
"""
function delete_traffic_mirror_filter_rule(
TrafficMirrorFilterRuleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTrafficMirrorFilterRule",
Dict{String,Any}("TrafficMirrorFilterRuleId" => TrafficMirrorFilterRuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_traffic_mirror_filter_rule(
TrafficMirrorFilterRuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTrafficMirrorFilterRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TrafficMirrorFilterRuleId" => TrafficMirrorFilterRuleId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_traffic_mirror_session(traffic_mirror_session_id)
delete_traffic_mirror_session(traffic_mirror_session_id, params::Dict{String,<:Any})
Deletes the specified Traffic Mirror session.
# Arguments
- `traffic_mirror_session_id`: The ID of the Traffic Mirror session.
# 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.
"""
function delete_traffic_mirror_session(
TrafficMirrorSessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTrafficMirrorSession",
Dict{String,Any}("TrafficMirrorSessionId" => TrafficMirrorSessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_traffic_mirror_session(
TrafficMirrorSessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTrafficMirrorSession",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TrafficMirrorSessionId" => TrafficMirrorSessionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_traffic_mirror_target(traffic_mirror_target_id)
delete_traffic_mirror_target(traffic_mirror_target_id, params::Dict{String,<:Any})
Deletes the specified Traffic Mirror target. You cannot delete a Traffic Mirror target that
is in use by a Traffic Mirror session.
# Arguments
- `traffic_mirror_target_id`: The ID of the Traffic Mirror target.
# 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.
"""
function delete_traffic_mirror_target(
TrafficMirrorTargetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTrafficMirrorTarget",
Dict{String,Any}("TrafficMirrorTargetId" => TrafficMirrorTargetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_traffic_mirror_target(
TrafficMirrorTargetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTrafficMirrorTarget",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TrafficMirrorTargetId" => TrafficMirrorTargetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway(transit_gateway_id)
delete_transit_gateway(transit_gateway_id, params::Dict{String,<:Any})
Deletes the specified transit gateway.
# Arguments
- `transit_gateway_id`: The ID of the transit gateway.
# 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.
"""
function delete_transit_gateway(
TransitGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTransitGateway",
Dict{String,Any}("TransitGatewayId" => TransitGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway(
TransitGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGateway",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TransitGatewayId" => TransitGatewayId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway_connect(transit_gateway_attachment_id)
delete_transit_gateway_connect(transit_gateway_attachment_id, params::Dict{String,<:Any})
Deletes the specified Connect attachment. You must first delete any Connect peers for the
attachment.
# Arguments
- `transit_gateway_attachment_id`: The ID of the Connect attachment.
# 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.
"""
function delete_transit_gateway_connect(
TransitGatewayAttachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTransitGatewayConnect",
Dict{String,Any}("TransitGatewayAttachmentId" => TransitGatewayAttachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway_connect(
TransitGatewayAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayConnect",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway_connect_peer(transit_gateway_connect_peer_id)
delete_transit_gateway_connect_peer(transit_gateway_connect_peer_id, params::Dict{String,<:Any})
Deletes the specified Connect peer.
# Arguments
- `transit_gateway_connect_peer_id`: The ID of the Connect peer.
# 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.
"""
function delete_transit_gateway_connect_peer(
TransitGatewayConnectPeerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTransitGatewayConnectPeer",
Dict{String,Any}("TransitGatewayConnectPeerId" => TransitGatewayConnectPeerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway_connect_peer(
TransitGatewayConnectPeerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayConnectPeer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayConnectPeerId" => TransitGatewayConnectPeerId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway_multicast_domain(transit_gateway_multicast_domain_id)
delete_transit_gateway_multicast_domain(transit_gateway_multicast_domain_id, params::Dict{String,<:Any})
Deletes the specified transit gateway multicast domain.
# Arguments
- `transit_gateway_multicast_domain_id`: The ID of the transit gateway multicast domain.
# 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.
"""
function delete_transit_gateway_multicast_domain(
TransitGatewayMulticastDomainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTransitGatewayMulticastDomain",
Dict{String,Any}(
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway_multicast_domain(
TransitGatewayMulticastDomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayMulticastDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway_peering_attachment(transit_gateway_attachment_id)
delete_transit_gateway_peering_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Deletes a transit gateway peering attachment.
# Arguments
- `transit_gateway_attachment_id`: The ID of the transit gateway peering attachment.
# 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.
"""
function delete_transit_gateway_peering_attachment(
TransitGatewayAttachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTransitGatewayPeeringAttachment",
Dict{String,Any}("TransitGatewayAttachmentId" => TransitGatewayAttachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway_peering_attachment(
TransitGatewayAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayPeeringAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway_policy_table(transit_gateway_policy_table_id)
delete_transit_gateway_policy_table(transit_gateway_policy_table_id, params::Dict{String,<:Any})
Deletes the specified transit gateway policy table.
# Arguments
- `transit_gateway_policy_table_id`: The transit gateway policy table to delete.
# 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.
"""
function delete_transit_gateway_policy_table(
TransitGatewayPolicyTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTransitGatewayPolicyTable",
Dict{String,Any}("TransitGatewayPolicyTableId" => TransitGatewayPolicyTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway_policy_table(
TransitGatewayPolicyTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayPolicyTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayPolicyTableId" => TransitGatewayPolicyTableId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id)
delete_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Deletes a reference (route) to a prefix list in a specified transit gateway route table.
# Arguments
- `prefix_list_id`: The ID of the prefix list.
- `transit_gateway_route_table_id`: The ID of the route table.
# 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.
"""
function delete_transit_gateway_prefix_list_reference(
PrefixListId,
TransitGatewayRouteTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayPrefixListReference",
Dict{String,Any}(
"PrefixListId" => PrefixListId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway_prefix_list_reference(
PrefixListId,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayPrefixListReference",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PrefixListId" => PrefixListId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id)
delete_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id, params::Dict{String,<:Any})
Deletes the specified route from the specified transit gateway route table.
# Arguments
- `destination_cidr_block`: The CIDR range for the route. This must match the CIDR for the
route exactly.
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# 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.
"""
function delete_transit_gateway_route(
DestinationCidrBlock,
TransitGatewayRouteTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayRoute",
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway_route(
DestinationCidrBlock,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayRoute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway_route_table(transit_gateway_route_table_id)
delete_transit_gateway_route_table(transit_gateway_route_table_id, params::Dict{String,<:Any})
Deletes the specified transit gateway route table. If there are any route tables associated
with the transit gateway route table, you must first run DisassociateRouteTable before you
can delete the transit gateway route table. This removes any route tables associated with
the transit gateway route table.
# Arguments
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# 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.
"""
function delete_transit_gateway_route_table(
TransitGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTransitGatewayRouteTable",
Dict{String,Any}("TransitGatewayRouteTableId" => TransitGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway_route_table(
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayRouteTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway_route_table_announcement(transit_gateway_route_table_announcement_id)
delete_transit_gateway_route_table_announcement(transit_gateway_route_table_announcement_id, params::Dict{String,<:Any})
Advertises to the transit gateway that a transit gateway route table is deleted.
# Arguments
- `transit_gateway_route_table_announcement_id`: The transit gateway route table ID that's
being deleted.
# 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.
"""
function delete_transit_gateway_route_table_announcement(
TransitGatewayRouteTableAnnouncementId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayRouteTableAnnouncement",
Dict{String,Any}(
"TransitGatewayRouteTableAnnouncementId" =>
TransitGatewayRouteTableAnnouncementId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway_route_table_announcement(
TransitGatewayRouteTableAnnouncementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayRouteTableAnnouncement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayRouteTableAnnouncementId" =>
TransitGatewayRouteTableAnnouncementId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_transit_gateway_vpc_attachment(transit_gateway_attachment_id)
delete_transit_gateway_vpc_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Deletes the specified VPC attachment.
# Arguments
- `transit_gateway_attachment_id`: The ID of the attachment.
# 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.
"""
function delete_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteTransitGatewayVpcAttachment",
Dict{String,Any}("TransitGatewayAttachmentId" => TransitGatewayAttachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteTransitGatewayVpcAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_verified_access_endpoint(verified_access_endpoint_id)
delete_verified_access_endpoint(verified_access_endpoint_id, params::Dict{String,<:Any})
Delete an Amazon Web Services Verified Access endpoint.
# Arguments
- `verified_access_endpoint_id`: The ID of the Verified Access endpoint.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"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.
"""
function delete_verified_access_endpoint(
VerifiedAccessEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVerifiedAccessEndpoint",
Dict{String,Any}(
"VerifiedAccessEndpointId" => VerifiedAccessEndpointId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_verified_access_endpoint(
VerifiedAccessEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVerifiedAccessEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessEndpointId" => VerifiedAccessEndpointId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_verified_access_group(verified_access_group_id)
delete_verified_access_group(verified_access_group_id, params::Dict{String,<:Any})
Delete an Amazon Web Services Verified Access group.
# Arguments
- `verified_access_group_id`: The ID of the Verified Access group.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"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.
"""
function delete_verified_access_group(
VerifiedAccessGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVerifiedAccessGroup",
Dict{String,Any}(
"VerifiedAccessGroupId" => VerifiedAccessGroupId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_verified_access_group(
VerifiedAccessGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVerifiedAccessGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessGroupId" => VerifiedAccessGroupId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_verified_access_instance(verified_access_instance_id)
delete_verified_access_instance(verified_access_instance_id, params::Dict{String,<:Any})
Delete an Amazon Web Services Verified Access instance.
# Arguments
- `verified_access_instance_id`: The ID of the Verified Access instance.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"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.
"""
function delete_verified_access_instance(
VerifiedAccessInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVerifiedAccessInstance",
Dict{String,Any}(
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_verified_access_instance(
VerifiedAccessInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVerifiedAccessInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_verified_access_trust_provider(verified_access_trust_provider_id)
delete_verified_access_trust_provider(verified_access_trust_provider_id, params::Dict{String,<:Any})
Delete an Amazon Web Services Verified Access trust provider.
# Arguments
- `verified_access_trust_provider_id`: The ID of the Verified Access trust provider.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"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.
"""
function delete_verified_access_trust_provider(
VerifiedAccessTrustProviderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVerifiedAccessTrustProvider",
Dict{String,Any}(
"VerifiedAccessTrustProviderId" => VerifiedAccessTrustProviderId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_verified_access_trust_provider(
VerifiedAccessTrustProviderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVerifiedAccessTrustProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessTrustProviderId" => VerifiedAccessTrustProviderId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_volume(volume_id)
delete_volume(volume_id, params::Dict{String,<:Any})
Deletes the specified EBS volume. The volume must be in the available state (not attached
to an instance). The volume can remain in the deleting state for several minutes. For more
information, see Delete an Amazon EBS volume in the Amazon EBS User Guide.
# Arguments
- `volume_id`: The ID of the volume.
# 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.
"""
function delete_volume(VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteVolume",
Dict{String,Any}("VolumeId" => VolumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_volume(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVolume",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeId" => VolumeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpc(vpc_id)
delete_vpc(vpc_id, params::Dict{String,<:Any})
Deletes the specified VPC. You must detach or delete all gateways and resources that are
associated with the VPC before you can delete it. For example, you must terminate all
instances running in the VPC, delete all security groups associated with the VPC (except
the default one), delete all route tables associated with the VPC (except the default one),
and so on. When you delete the VPC, it deletes the VPC's default security group, network
ACL, and route table.
# Arguments
- `vpc_id`: The ID of the VPC.
# 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.
"""
function delete_vpc(VpcId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteVpc",
Dict{String,Any}("VpcId" => VpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpc(
VpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVpc",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("VpcId" => VpcId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpc_endpoint_connection_notifications(connection_notification_id)
delete_vpc_endpoint_connection_notifications(connection_notification_id, params::Dict{String,<:Any})
Deletes the specified VPC endpoint connection notifications.
# Arguments
- `connection_notification_id`: The IDs of the notifications.
# 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.
"""
function delete_vpc_endpoint_connection_notifications(
ConnectionNotificationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVpcEndpointConnectionNotifications",
Dict{String,Any}("ConnectionNotificationId" => ConnectionNotificationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpc_endpoint_connection_notifications(
ConnectionNotificationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVpcEndpointConnectionNotifications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConnectionNotificationId" => ConnectionNotificationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpc_endpoint_service_configurations(service_id)
delete_vpc_endpoint_service_configurations(service_id, params::Dict{String,<:Any})
Deletes the specified VPC endpoint service configurations. Before you can delete an
endpoint service configuration, you must reject any Available or PendingAcceptance
interface endpoint connections that are attached to the service.
# Arguments
- `service_id`: The IDs of the services.
# 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.
"""
function delete_vpc_endpoint_service_configurations(
ServiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVpcEndpointServiceConfigurations",
Dict{String,Any}("ServiceId" => ServiceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpc_endpoint_service_configurations(
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVpcEndpointServiceConfigurations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceId" => ServiceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpc_endpoints(vpc_endpoint_id)
delete_vpc_endpoints(vpc_endpoint_id, params::Dict{String,<:Any})
Deletes the specified VPC endpoints. When you delete a gateway endpoint, we delete the
endpoint routes in the route tables for the endpoint. When you delete a Gateway Load
Balancer endpoint, we delete its endpoint network interfaces. You can only delete Gateway
Load Balancer endpoints when the routes that are associated with the endpoint are deleted.
When you delete an interface endpoint, we delete its endpoint network interfaces.
# Arguments
- `vpc_endpoint_id`: The IDs of the VPC endpoints.
# 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.
"""
function delete_vpc_endpoints(
VpcEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVpcEndpoints",
Dict{String,Any}("VpcEndpointId" => VpcEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpc_endpoints(
VpcEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVpcEndpoints",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VpcEndpointId" => VpcEndpointId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpc_peering_connection(vpc_peering_connection_id)
delete_vpc_peering_connection(vpc_peering_connection_id, params::Dict{String,<:Any})
Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the
accepter VPC can delete the VPC peering connection if it's in the active state. The owner
of the requester VPC can delete a VPC peering connection in the pending-acceptance state.
You cannot delete a VPC peering connection that's in the failed or rejected state.
# Arguments
- `vpc_peering_connection_id`: The ID of the VPC peering connection.
# 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.
"""
function delete_vpc_peering_connection(
vpcPeeringConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVpcPeeringConnection",
Dict{String,Any}("vpcPeeringConnectionId" => vpcPeeringConnectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpc_peering_connection(
vpcPeeringConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVpcPeeringConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("vpcPeeringConnectionId" => vpcPeeringConnectionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpn_connection(vpn_connection_id)
delete_vpn_connection(vpn_connection_id, params::Dict{String,<:Any})
Deletes the specified VPN connection. If you're deleting the VPC and its associated
components, we recommend that you detach the virtual private gateway from the VPC and
delete the VPC before deleting the VPN connection. If you believe that the tunnel
credentials for your VPN connection have been compromised, you can delete the VPN
connection and create a new one that has new keys, without needing to delete the VPC or
virtual private gateway. If you create a new VPN connection, you must reconfigure the
customer gateway device using the new configuration information returned with the new VPN
connection ID. For certificate-based authentication, delete all Certificate Manager (ACM)
private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN
connection before deleting the VPN connection.
# Arguments
- `vpn_connection_id`: The ID of the VPN connection.
# 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.
"""
function delete_vpn_connection(
VpnConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVpnConnection",
Dict{String,Any}("VpnConnectionId" => VpnConnectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpn_connection(
VpnConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVpnConnection",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("VpnConnectionId" => VpnConnectionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpn_connection_route(destination_cidr_block, vpn_connection_id)
delete_vpn_connection_route(destination_cidr_block, vpn_connection_id, params::Dict{String,<:Any})
Deletes the specified static route associated with a VPN connection between an existing
virtual private gateway and a VPN customer gateway. The static route allows traffic to be
routed from the virtual private gateway to the VPN customer gateway.
# Arguments
- `destination_cidr_block`: The CIDR block associated with the local subnet of the customer
network.
- `vpn_connection_id`: The ID of the VPN connection.
"""
function delete_vpn_connection_route(
DestinationCidrBlock, VpnConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeleteVpnConnectionRoute",
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"VpnConnectionId" => VpnConnectionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpn_connection_route(
DestinationCidrBlock,
VpnConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVpnConnectionRoute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"VpnConnectionId" => VpnConnectionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpn_gateway(vpn_gateway_id)
delete_vpn_gateway(vpn_gateway_id, params::Dict{String,<:Any})
Deletes the specified virtual private gateway. You must first detach the virtual private
gateway from the VPC. Note that you don't need to delete the virtual private gateway if you
plan to delete and recreate the VPN connection between your VPC and your network.
# Arguments
- `vpn_gateway_id`: The ID of the virtual private gateway.
# 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.
"""
function delete_vpn_gateway(VpnGatewayId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeleteVpnGateway",
Dict{String,Any}("VpnGatewayId" => VpnGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpn_gateway(
VpnGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeleteVpnGateway",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VpnGatewayId" => VpnGatewayId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprovision_byoip_cidr(cidr)
deprovision_byoip_cidr(cidr, params::Dict{String,<:Any})
Releases the specified address range that you provisioned for use with your Amazon Web
Services resources through bring your own IP addresses (BYOIP) and deletes the
corresponding address pool. Before you can release an address range, you must stop
advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated
from its address range.
# Arguments
- `cidr`: The address range, in CIDR notation. The prefix must be the same prefix that you
specified when you provisioned the address range.
# 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.
"""
function deprovision_byoip_cidr(Cidr; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeprovisionByoipCidr",
Dict{String,Any}("Cidr" => Cidr);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprovision_byoip_cidr(
Cidr, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeprovisionByoipCidr",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Cidr" => Cidr), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprovision_ipam_byoasn(asn, ipam_id)
deprovision_ipam_byoasn(asn, ipam_id, params::Dict{String,<:Any})
Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services account.
This action can only be called after any BYOIP CIDR associations are removed from your
Amazon Web Services account with DisassociateIpamByoasn. For more information, see
Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
# Arguments
- `asn`: An ASN.
- `ipam_id`: The IPAM ID.
# 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.
"""
function deprovision_ipam_byoasn(
Asn, IpamId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeprovisionIpamByoasn",
Dict{String,Any}("Asn" => Asn, "IpamId" => IpamId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprovision_ipam_byoasn(
Asn,
IpamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeprovisionIpamByoasn",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Asn" => Asn, "IpamId" => IpamId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprovision_ipam_pool_cidr(ipam_pool_id)
deprovision_ipam_pool_cidr(ipam_pool_id, params::Dict{String,<:Any})
Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool
that has a source pool, the CIDR is recycled back into the source pool. For more
information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.
# Arguments
- `ipam_pool_id`: The ID of the pool that has the CIDR you want to deprovision.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Cidr"`: The CIDR which you want to deprovision from the pool.
- `"DryRun"`: A check for 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.
"""
function deprovision_ipam_pool_cidr(
IpamPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeprovisionIpamPoolCidr",
Dict{String,Any}("IpamPoolId" => IpamPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprovision_ipam_pool_cidr(
IpamPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeprovisionIpamPoolCidr",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IpamPoolId" => IpamPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprovision_public_ipv4_pool_cidr(cidr, pool_id)
deprovision_public_ipv4_pool_cidr(cidr, pool_id, params::Dict{String,<:Any})
Deprovision a CIDR from a public IPv4 pool.
# Arguments
- `cidr`: The CIDR you want to deprovision from the pool. Enter the CIDR you want to
deprovision with a netmask of /32. You must rerun this command for each IP address in the
CIDR range. If your CIDR is a /24, you will have to run this command to deprovision each of
the 256 IP addresses in the /24 CIDR.
- `pool_id`: The ID of the pool that you want to deprovision the CIDR from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
"""
function deprovision_public_ipv4_pool_cidr(
Cidr, PoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeprovisionPublicIpv4PoolCidr",
Dict{String,Any}("Cidr" => Cidr, "PoolId" => PoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprovision_public_ipv4_pool_cidr(
Cidr,
PoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeprovisionPublicIpv4PoolCidr",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Cidr" => Cidr, "PoolId" => PoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_image(image_id)
deregister_image(image_id, params::Dict{String,<:Any})
Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new
instances. If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is
retained in the Recycle Bin for the specified retention period. For more information, see
Recycle Bin in the Amazon EC2 User Guide. When you deregister an AMI, it doesn't affect any
instances that you've already launched from the AMI. You'll continue to incur usage costs
for those instances until you terminate them. When you deregister an Amazon EBS-backed AMI,
it doesn't affect the snapshot that was created for the root volume of the instance during
the AMI creation process. When you deregister an instance store-backed AMI, it doesn't
affect the files that you uploaded to Amazon S3 when you created the AMI.
# Arguments
- `image_id`: The ID of the AMI.
# 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.
"""
function deregister_image(ImageId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DeregisterImage",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_image(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeregisterImage",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_instance_event_notification_attributes(instance_tag_attribute)
deregister_instance_event_notification_attributes(instance_tag_attribute, params::Dict{String,<:Any})
Deregisters tag keys to prevent tags that have the specified tag keys from being included
in scheduled event notifications for resources in the Region.
# Arguments
- `instance_tag_attribute`: Information about the tag keys to deregister.
# 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.
"""
function deregister_instance_event_notification_attributes(
InstanceTagAttribute; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeregisterInstanceEventNotificationAttributes",
Dict{String,Any}("InstanceTagAttribute" => InstanceTagAttribute);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_instance_event_notification_attributes(
InstanceTagAttribute,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DeregisterInstanceEventNotificationAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceTagAttribute" => InstanceTagAttribute),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_transit_gateway_multicast_group_members()
deregister_transit_gateway_multicast_group_members(params::Dict{String,<:Any})
Deregisters the specified members (network interfaces) from the transit gateway multicast
group.
# 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.
- `"GroupIpAddress"`: The IP address assigned to the transit gateway multicast group.
- `"NetworkInterfaceIds"`: The IDs of the group members' network interfaces.
- `"TransitGatewayMulticastDomainId"`: The ID of the transit gateway multicast domain.
"""
function deregister_transit_gateway_multicast_group_members(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeregisterTransitGatewayMulticastGroupMembers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_transit_gateway_multicast_group_members(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeregisterTransitGatewayMulticastGroupMembers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_transit_gateway_multicast_group_sources()
deregister_transit_gateway_multicast_group_sources(params::Dict{String,<:Any})
Deregisters the specified sources (network interfaces) from the transit gateway multicast
group.
# 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.
- `"GroupIpAddress"`: The IP address assigned to the transit gateway multicast group.
- `"NetworkInterfaceIds"`: The IDs of the group sources' network interfaces.
- `"TransitGatewayMulticastDomainId"`: The ID of the transit gateway multicast domain.
"""
function deregister_transit_gateway_multicast_group_sources(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeregisterTransitGatewayMulticastGroupSources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_transit_gateway_multicast_group_sources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DeregisterTransitGatewayMulticastGroupSources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_attributes()
describe_account_attributes(params::Dict{String,<:Any})
Describes attributes of your Amazon Web Services account. The following are the supported
account attributes: default-vpc: The ID of the default VPC for your account, or none.
max-instances: This attribute is no longer supported. The returned value does not reflect
your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand
Instance Limits in the Amazon Elastic Compute Cloud User Guide. max-elastic-ips: The
maximum number of Elastic IP addresses that you can allocate. supported-platforms: This
attribute is deprecated. vpc-max-elastic-ips: The maximum number of Elastic IP addresses
that you can allocate. vpc-max-security-groups-per-interface: The maximum number of
security groups that you can assign to a network interface. The order of the elements in
the response, including those within nested structures, might vary. Applications should not
assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributeName"`: The account attribute names.
- `"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.
"""
function describe_account_attributes(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"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 ec2(
"DescribeAccountAttributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_address_transfers()
describe_address_transfers(params::Dict{String,<:Any})
Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP
addresses in the Amazon VPC User Guide. When you transfer an Elastic IP address, there is a
two-step handshake between the source and transfer Amazon Web Services accounts. When the
source account starts the transfer, the transfer account has seven days to accept the
Elastic IP address transfer. During those seven days, the source account can view the
pending transfer by using this action. After seven days, the transfer expires and ownership
of the Elastic IP address returns to the source account. Accepted transfers are visible to
the source account for three days after the transfers have been accepted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocationId"`: The allocation IDs of Elastic IP addresses.
- `"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.
- `"MaxResults"`: The maximum number of address transfers to return in one page of results.
- `"NextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function describe_address_transfers(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeAddressTransfers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_address_transfers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeAddressTransfers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_addresses()
describe_addresses(params::Dict{String,<:Any})
Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocationId"`: Information about the allocation IDs.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
allocation-id - The allocation ID for the address. association-id - The association ID
for the address. instance-id - The ID of the instance the address is associated with, if
any. network-border-group - A unique set of Availability Zones, Local Zones, or
Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - The ID of the network interface that the address is associated with,
if any. network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address. tag:<key> - The
key/value combination of a tag assigned to the resource. Use the tag key in the filter name
and the tag value as the filter value. For example, to find all resources that have a tag
with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for
the filter value. tag-key - The key of a tag assigned to the resource. Use this filter
to find all resources assigned a tag with a specific key, regardless of the tag value.
- `"PublicIp"`: One or more Elastic IP addresses. Default: Describes all your Elastic IP
addresses.
- `"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.
"""
function describe_addresses(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeAddresses"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_addresses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeAddresses", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_addresses_attribute()
describe_addresses_attribute(params::Dict{String,<:Any})
Describes the attributes of the specified Elastic IP addresses. For requirements, see Using
reverse DNS for email applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocationId"`: [EC2-VPC] The allocation IDs.
- `"Attribute"`: The attribute of the IP address.
- `"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.
- `"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 describe_addresses_attribute(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeAddressesAttribute"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_addresses_attribute(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeAddressesAttribute",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_aggregate_id_format()
describe_aggregate_id_format(params::Dict{String,<:Any})
Describes the longer ID format settings for all resource types in a specific Region. This
request is useful for performing a quick audit to determine whether a specific Region is
fully opted in for longer IDs (17-character IDs). This request only returns information
about resource types that support longer IDs. The following resource types support longer
IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image | import-task | instance |
internet-gateway | network-acl | network-acl-association | network-interface |
network-interface-attachment | prefix-list | reservation | route-table |
route-table-association | security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway.
# 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.
"""
function describe_aggregate_id_format(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeAggregateIdFormat"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_aggregate_id_format(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeAggregateIdFormat",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_availability_zones()
describe_availability_zones(params::Dict{String,<:Any})
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to
you. If there is an event impacting a zone, you can use this request to view the state and
any provided messages for that zone. For more information about Availability Zones, Local
Zones, and Wavelength Zones, see Regions and zones in the Amazon EC2 User Guide. The order
of the elements in the response, including those within nested structures, might vary.
Applications should not assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllAvailabilityZones"`: Include all Availability Zones, Local Zones, and Wavelength
Zones regardless of your opt-in status. If you do not use this parameter, the results
include only the zones for the Regions where you have chosen the option to opt in.
- `"Filter"`: The filters. group-name - For Availability Zones, use the Region name. For
Local Zones, use the name of the group associated with the Local Zone (for example,
us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the
Wavelength Zone (for example, us-east-1-wl1). message - The Zone message.
opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).
parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone
control plane operations, such as API calls. parent-zone-name - The ID of the zone that
handles some of the Local Zone and Wavelength Zone control plane operations, such as API
calls. region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone
(available). zone-id - The ID of the Availability Zone (for example, use1-az1), the
Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example,
us-east-1-wl1-bos-wlz-1). zone-name - The name of the Availability Zone (for example,
us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for
example, us-east-1-wl1-bos-wlz-1). zone-type - The type of zone (availability-zone |
local-zone | wavelength-zone).
- `"ZoneId"`: The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
- `"ZoneName"`: The names of the Availability Zones, Local Zones, and Wavelength Zones.
- `"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.
"""
function describe_availability_zones(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeAvailabilityZones"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_availability_zones(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeAvailabilityZones",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_aws_network_performance_metric_subscriptions()
describe_aws_network_performance_metric_subscriptions(params::Dict{String,<:Any})
Describes the current Infrastructure Performance metric subscriptions.
# 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.
- `"Filter"`: One or more filters.
- `"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 describe_aws_network_performance_metric_subscriptions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeAwsNetworkPerformanceMetricSubscriptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_aws_network_performance_metric_subscriptions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeAwsNetworkPerformanceMetricSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_bundle_tasks()
describe_bundle_tasks(params::Dict{String,<:Any})
Describes the specified bundle tasks or all of your bundle tasks. Completed bundle tasks
are listed for only a limited time. If your bundle task is no longer in the list, you can
still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and
image manifest name you provided to the bundle task. The order of the elements in the
response, including those within nested structures, might vary. Applications should not
assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BundleId"`: The bundle task IDs. Default: Describes all your bundle tasks.
- `"Filter"`: The filters. bundle-id - The ID of the bundle task. error-code - If the
task failed, the error code returned. error-message - If the task failed, the error
message returned. instance-id - The ID of the instance. progress - The level of task
completion, as a percentage (for example, 20%). s3-bucket - The Amazon S3 bucket to
store the AMI. s3-prefix - The beginning of the AMI name. start-time - The time the
task started (for example, 2013-09-15T17:15:20.000Z). state - The state of the task
(pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
- `"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.
"""
function describe_bundle_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeBundleTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_bundle_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeBundleTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_byoip_cidrs(max_results)
describe_byoip_cidrs(max_results, params::Dict{String,<:Any})
Describes the IP address ranges that were specified in calls to ProvisionByoipCidr. To
describe the address pools that were created when you provisioned the address ranges, use
DescribePublicIpv4Pools or DescribeIpv6Pools.
# Arguments
- `max_results`: The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken value.
# 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.
- `"NextToken"`: The token for the next page of results.
"""
function describe_byoip_cidrs(MaxResults; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeByoipCidrs",
Dict{String,Any}("MaxResults" => MaxResults);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_byoip_cidrs(
MaxResults,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeByoipCidrs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MaxResults" => MaxResults), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_capacity_block_offerings(capacity_duration_hours, instance_count, instance_type)
describe_capacity_block_offerings(capacity_duration_hours, instance_count, instance_type, params::Dict{String,<:Any})
Describes Capacity Block offerings available for purchase in the Amazon Web Services Region
that you're currently using. With Capacity Blocks, you purchase a specific instance type
for a period of time.
# Arguments
- `capacity_duration_hours`: The number of hours for which to reserve Capacity Block.
- `instance_count`: The number of instances for which to reserve capacity.
- `instance_type`: The type of instance for which the Capacity Block offering reserves
capacity.
# 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.
- `"EndDateRange"`: The latest end date for the Capacity Block offering.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token to use to retrieve the next page of results.
- `"StartDateRange"`: The earliest start date for the Capacity Block offering.
"""
function describe_capacity_block_offerings(
CapacityDurationHours,
InstanceCount,
InstanceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeCapacityBlockOfferings",
Dict{String,Any}(
"CapacityDurationHours" => CapacityDurationHours,
"InstanceCount" => InstanceCount,
"InstanceType" => InstanceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_capacity_block_offerings(
CapacityDurationHours,
InstanceCount,
InstanceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeCapacityBlockOfferings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CapacityDurationHours" => CapacityDurationHours,
"InstanceCount" => InstanceCount,
"InstanceType" => InstanceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_capacity_reservation_fleets()
describe_capacity_reservation_fleets(params::Dict{String,<:Any})
Describes one or more Capacity Reservation Fleets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CapacityReservationFleetId"`: The IDs of the Capacity Reservation Fleets to describe.
- `"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.
- `"Filter"`: One or more filters. state - The state of the Fleet (submitted | modifying
| active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).
instance-match-criteria - The instance matching criteria for the Fleet. Only open is
supported. tenancy - The tenancy of the Fleet (default | dedicated).
allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is
supported.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token to use to retrieve the next page of results.
"""
function describe_capacity_reservation_fleets(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeCapacityReservationFleets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_capacity_reservation_fleets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeCapacityReservationFleets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_capacity_reservations()
describe_capacity_reservations(params::Dict{String,<:Any})
Describes one or more of your Capacity Reservations. The results describe only the Capacity
Reservations in the Amazon Web Services Region that you're currently using.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CapacityReservationId"`: The ID of the Capacity Reservation.
- `"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.
- `"Filter"`: One or more filters. instance-type - The type of instance for which the
Capacity Reservation reserves capacity. owner-id - The ID of the Amazon Web Services
account that owns the Capacity Reservation. instance-platform - The type of operating
system for which the Capacity Reservation reserves capacity. availability-zone - The
Availability Zone of the Capacity Reservation. tenancy - Indicates the tenancy of the
Capacity Reservation. A Capacity Reservation can have one of the following tenancy
settings: default - The Capacity Reservation is created on hardware that is shared with
other Amazon Web Services accounts. dedicated - The Capacity Reservation is created on
single-tenant hardware that is dedicated to a single Amazon Web Services account.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity
Reservation was created. state - The current state of the Capacity Reservation. A
Capacity Reservation can be in one of the following states: active- The Capacity
Reservation is active and the capacity is available for your use. expired - The Capacity
Reservation expired automatically at the date and time specified in your request. The
reserved capacity is no longer available for your use. cancelled - The Capacity
Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is
still pending. failed - The Capacity Reservation request has failed. A request might
fail due to invalid request parameters, capacity constraints, or instance limit
constraints. Failed requests are retained for 60 minutes. start-date - The date and
time at which the Capacity Reservation was started. end-date - The date and time at
which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved
capacity is released and you can no longer launch instances into it. The Capacity
Reservation's state changes to expired when it reaches its end date and time.
end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity
Reservation can have one of the following end types: unlimited - The Capacity
Reservation remains active until you explicitly cancel it. limited - The Capacity
Reservation expires automatically at a specified date and time.
instance-match-criteria - Indicates the type of instance launches that the Capacity
Reservation accepts. The options include: open - The Capacity Reservation accepts all
instances that have matching attributes (instance type, platform, and Availability Zone).
Instances that have matching attributes launch into the Capacity Reservation automatically
without specifying any additional parameters. targeted - The Capacity Reservation only
accepts instances that have matching attributes (instance type, platform, and Availability
Zone), and explicitly target the Capacity Reservation. This ensures that only permitted
instances can use the reserved capacity. placement-group-arn - The ARN of the cluster
placement group in which the Capacity Reservation was created.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token to use to retrieve the next page of results.
"""
function describe_capacity_reservations(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeCapacityReservations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_capacity_reservations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeCapacityReservations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_carrier_gateways()
describe_carrier_gateways(params::Dict{String,<:Any})
Describes one or more of your carrier gateways.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CarrierGatewayId"`: One or more carrier gateway IDs.
- `"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.
- `"Filter"`: One or more filters. carrier-gateway-id - The ID of the carrier gateway.
state - The state of the carrier gateway (pending | failed | available | deleting |
deleted). owner-id - The Amazon Web Services account ID of the owner of the carrier
gateway. tag:<key> - The key/value combination of a tag assigned to the resource.
Use the tag key in the filter name and the tag value as the filter value. For example, to
find all resources that have a tag with the key Owner and the value TeamA, specify
tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag
assigned to the resource. Use this filter to find all resources assigned a tag with a
specific key, regardless of the tag value. vpc-id - The ID of the VPC associated with
the carrier gateway.
- `"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 describe_carrier_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeCarrierGateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_carrier_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeCarrierGateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_classic_link_instances()
describe_classic_link_instances(params::Dict{String,<:Any})
This action is deprecated. Describes your linked EC2-Classic instances. This request only
returns information about EC2-Classic instances linked to a VPC through ClassicLink. You
cannot use this request to return information about other instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. group-id - The ID of a VPC security group that's associated
with the instance. instance-id - The ID of the instance. tag:<key> - The
key/value combination of a tag assigned to the resource. Use the tag key in the filter name
and the tag value as the filter value. For example, to find all resources that have a tag
with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for
the filter value. tag-key - The key of a tag assigned to the resource. Use this filter
to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
- `"InstanceId"`: The instance IDs. Must be instances linked to a VPC through ClassicLink.
- `"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.
- `"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. For more
information, see Pagination. Constraint: If the value is greater than 1000, we return only
1000 items.
- `"nextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_classic_link_instances(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeClassicLinkInstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_classic_link_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeClassicLinkInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_client_vpn_authorization_rules(client_vpn_endpoint_id)
describe_client_vpn_authorization_rules(client_vpn_endpoint_id, params::Dict{String,<:Any})
Describes the authorization rules for a specified Client VPN endpoint.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint.
# 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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
description - The description of the authorization rule. destination-cidr - The CIDR of
the network to which the authorization rule applies. group-id - The ID of the Active
Directory group to which the authorization rule grants access.
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results can be seen by sending another request with the nextToken value.
- `"NextToken"`: The token to retrieve the next page of results.
"""
function describe_client_vpn_authorization_rules(
ClientVpnEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeClientVpnAuthorizationRules",
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_client_vpn_authorization_rules(
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeClientVpnAuthorizationRules",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_client_vpn_connections(client_vpn_endpoint_id)
describe_client_vpn_connections(client_vpn_endpoint_id, params::Dict{String,<:Any})
Describes active client connections and connections that have been terminated within the
last 60 minutes for the specified Client VPN endpoint.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint.
# 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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
connection-id - The ID of the connection. username - For Active Directory client
authentication, the user name of the client who established the client connection.
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results can be seen by sending another request with the nextToken value.
- `"NextToken"`: The token to retrieve the next page of results.
"""
function describe_client_vpn_connections(
ClientVpnEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeClientVpnConnections",
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_client_vpn_connections(
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeClientVpnConnections",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_client_vpn_endpoints()
describe_client_vpn_endpoints(params::Dict{String,<:Any})
Describes one or more Client VPN endpoints in the account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientVpnEndpointId"`: The ID of the Client VPN endpoint.
- `"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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
endpoint-id - The ID of the Client VPN endpoint. transport-protocol - The transport
protocol (tcp | udp).
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results can be seen by sending another request with the nextToken value.
- `"NextToken"`: The token to retrieve the next page of results.
"""
function describe_client_vpn_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeClientVpnEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_client_vpn_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeClientVpnEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_client_vpn_routes(client_vpn_endpoint_id)
describe_client_vpn_routes(client_vpn_endpoint_id, params::Dict{String,<:Any})
Describes the routes for the specified Client VPN endpoint.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint.
# 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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
destination-cidr - The CIDR of the route destination. origin - How the route was
associated with the Client VPN endpoint (associate | add-route). target-subnet - The ID
of the subnet through which traffic is routed.
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results can be seen by sending another request with the nextToken value.
- `"NextToken"`: The token to retrieve the next page of results.
"""
function describe_client_vpn_routes(
ClientVpnEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeClientVpnRoutes",
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_client_vpn_routes(
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeClientVpnRoutes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_client_vpn_target_networks(client_vpn_endpoint_id)
describe_client_vpn_target_networks(client_vpn_endpoint_id, params::Dict{String,<:Any})
Describes the target networks associated with the specified Client VPN endpoint.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationIds"`: The IDs of the target network associations.
- `"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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
association-id - The ID of the association. target-network-id - The ID of the subnet
specified as the target network. vpc-id - The ID of the VPC in which the target network
is located.
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results can be seen by sending another request with the nextToken value.
- `"NextToken"`: The token to retrieve the next page of results.
"""
function describe_client_vpn_target_networks(
ClientVpnEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeClientVpnTargetNetworks",
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_client_vpn_target_networks(
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeClientVpnTargetNetworks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_coip_pools()
describe_coip_pools(params::Dict{String,<:Any})
Describes the specified customer-owned address pools or all of your customer-owned address
pools.
# 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.
- `"Filter"`: One or more filters. coip-pool.local-gateway-route-table-id - The ID of
the local gateway route table. coip-pool.pool-id - The ID of the address pool.
- `"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.
- `"PoolId"`: The IDs of the address pools.
"""
function describe_coip_pools(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeCoipPools"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_coip_pools(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeCoipPools", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_conversion_tasks()
describe_conversion_tasks(params::Dict{String,<:Any})
Describes the specified conversion tasks or all your conversion tasks. For more
information, see the VM Import/Export User Guide. For information about the import manifest
referenced by this API action, see VM Import Manifest.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"conversionTaskId"`: The conversion task IDs.
- `"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.
"""
function describe_conversion_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeConversionTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_conversion_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeConversionTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_customer_gateways()
describe_customer_gateways(params::Dict{String,<:Any})
Describes one or more of your VPN customer gateways. For more information, see Amazon Web
Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomerGatewayId"`: One or more customer gateway IDs. Default: Describes all your
customer gateways.
- `"Filter"`: One or more filters. bgp-asn - The customer gateway's Border Gateway
Protocol (BGP) Autonomous System Number (ASN). customer-gateway-id - The ID of the
customer gateway. ip-address - The IP address of the customer gateway device's external
interface. state - The state of the customer gateway (pending | available | deleting |
deleted). type - The type of customer gateway. Currently, the only supported type is
ipsec.1. tag:<key> - The key/value combination of a tag assigned to the resource.
Use the tag key in the filter name and the tag value as the filter value. For example, to
find all resources that have a tag with the key Owner and the value TeamA, specify
tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag
assigned to the resource. Use this filter to find all resources assigned a tag with a
specific key, regardless of the tag value.
- `"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.
"""
function describe_customer_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeCustomerGateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_customer_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeCustomerGateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dhcp_options()
describe_dhcp_options(params::Dict{String,<:Any})
Describes your DHCP option sets. The default is to describe all your DHCP option sets.
Alternatively, you can specify specific DHCP option set IDs or filter the results to
include only the DHCP option sets that match specific criteria. For more information, see
DHCP option sets in the Amazon VPC User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DhcpOptionsId"`: The IDs of DHCP option sets.
- `"Filter"`: The filters. dhcp-options-id - The ID of a DHCP options set. key - The
key for one of the options (for example, domain-name). value - The value for one of the
options. owner-id - The ID of the Amazon Web Services account that owns the DHCP options
set. tag:<key> - The key/value combination of a tag assigned to the resource. Use
the tag key in the filter name and the tag value as the filter value. For example, to find
all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for
the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to
the resource. Use this filter to find all resources assigned a tag with a specific key,
regardless of the tag value.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"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.
"""
function describe_dhcp_options(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeDhcpOptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dhcp_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeDhcpOptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_egress_only_internet_gateways()
describe_egress_only_internet_gateways(params::Dict{String,<:Any})
Describes your egress-only internet gateways. The default is to describe all your
egress-only internet gateways. Alternatively, you can specify specific egress-only internet
gateway IDs or filter the results to include only the egress-only internet gateways that
match specific criteria.
# 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.
- `"EgressOnlyInternetGatewayId"`: The IDs of the egress-only internet gateways.
- `"Filter"`: The filters. tag:<key> - The key/value combination of a tag assigned
to the resource. Use the tag key in the filter name and the tag value as the filter value.
For example, to find all resources that have a tag with the key Owner and the value TeamA,
specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key
of a tag assigned to the resource. Use this filter to find all resources assigned a tag
with a specific key, regardless of the tag value.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_egress_only_internet_gateways(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeEgressOnlyInternetGateways";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_egress_only_internet_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeEgressOnlyInternetGateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_elastic_gpus()
describe_elastic_gpus(params::Dict{String,<:Any})
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require
graphics acceleration, we recommend that you use Amazon EC2 G4, G5, or G6 instances.
Describes the Elastic Graphics accelerator associated with your instances.
# 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.
- `"ElasticGpuId"`: The Elastic Graphics accelerator IDs.
- `"Filter"`: The filters. availability-zone - The Availability Zone in which the
Elastic Graphics accelerator resides. elastic-gpu-health - The status of the Elastic
Graphics accelerator (OK | IMPAIRED). elastic-gpu-state - The state of the Elastic
Graphics accelerator (ATTACHED). elastic-gpu-type - The type of Elastic Graphics
accelerator; for example, eg1.medium. instance-id - The ID of the instance to which the
Elastic Graphics accelerator is associated.
- `"MaxResults"`: The maximum number of results to return in a single call. To retrieve the
remaining results, make another call with the returned NextToken value. This value can be
between 5 and 1000.
- `"NextToken"`: The token to request the next page of results.
"""
function describe_elastic_gpus(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeElasticGpus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_elastic_gpus(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeElasticGpus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_export_image_tasks()
describe_export_image_tasks(params::Dict{String,<:Any})
Describes the specified export image tasks or all of your export image tasks.
# 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.
- `"ExportImageTaskId"`: The IDs of the export image tasks.
- `"Filter"`: Filter tasks using the task-state filter and one of the following values:
active, completed, deleting, or deleted.
- `"MaxResults"`: The maximum number of results to return in a single call.
- `"NextToken"`: A token that indicates the next page of results.
"""
function describe_export_image_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeExportImageTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_export_image_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeExportImageTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_export_tasks()
describe_export_tasks(params::Dict{String,<:Any})
Describes the specified export instance tasks or all of your export instance tasks.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: the filters for the export tasks.
- `"exportTaskId"`: The export task IDs.
"""
function describe_export_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeExportTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_export_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeExportTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fast_launch_images()
describe_fast_launch_images(params::Dict{String,<:Any})
Describe details for Windows AMIs that are configured for Windows fast launch.
# 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.
- `"Filter"`: Use the following filters to streamline results. resource-type - The
resource type for pre-provisioning. owner-id - The owner ID for the pre-provisioning
resource. state - The current state of fast launching for the Windows AMI.
- `"ImageId"`: Specify one or more Windows AMI image IDs for the request.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_fast_launch_images(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeFastLaunchImages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_fast_launch_images(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeFastLaunchImages",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fast_snapshot_restores()
describe_fast_snapshot_restores(params::Dict{String,<:Any})
Describes the state of fast snapshot restores for your snapshots.
# 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.
- `"Filter"`: The filters. The possible values are: availability-zone: The Availability
Zone of the snapshot. owner-id: The ID of the Amazon Web Services account that enabled
fast snapshot restore on the snapshot. snapshot-id: The ID of the snapshot. state:
The state of fast snapshot restores for the snapshot (enabling | optimizing | enabled |
disabling | disabled).
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_fast_snapshot_restores(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeFastSnapshotRestores";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fast_snapshot_restores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeFastSnapshotRestores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_history(fleet_id, start_time)
describe_fleet_history(fleet_id, start_time, params::Dict{String,<:Any})
Describes the events for the specified EC2 Fleet during the specified time. EC2 Fleet
events are delayed by up to 30 seconds before they can be described. This ensures that you
can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are
available for 48 hours. For more information, see Monitor fleet events using Amazon
EventBridge in the Amazon EC2 User Guide.
# Arguments
- `fleet_id`: The ID of the EC2 Fleet.
- `start_time`: The start date and time for the events, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ).
# 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.
- `"EventType"`: The type of events to describe. By default, all events are described.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_fleet_history(
FleetId, StartTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeFleetHistory",
Dict{String,Any}("FleetId" => FleetId, "StartTime" => StartTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_history(
FleetId,
StartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeFleetHistory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FleetId" => FleetId, "StartTime" => StartTime),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_instances(fleet_id)
describe_fleet_instances(fleet_id, params::Dict{String,<:Any})
Describes the running instances for the specified EC2 Fleet. Currently,
DescribeFleetInstances does not support fleets of type instant. Instead, use
DescribeFleets, specifying the instant fleet ID in the request. For more information, see
Describe your EC2 Fleet in the Amazon EC2 User Guide.
# Arguments
- `fleet_id`: The ID of the EC2 Fleet.
# 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.
- `"Filter"`: The filters. instance-type - The instance type.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_fleet_instances(
FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeFleetInstances",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_instances(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeFleetInstances",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleets()
describe_fleets(params::Dict{String,<:Any})
Describes the specified EC2 Fleet or all of your EC2 Fleets. If a fleet is of type
instant, you must specify the fleet ID in the request, otherwise the fleet does not appear
in the response. For more information, see Describe your EC2 Fleet in the Amazon EC2 User
Guide.
# 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.
- `"Filter"`: The filters. activity-status - The progress of the EC2 Fleet ( error |
pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to terminate running instances if
the target capacity is decreased below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed |
deleted-running | deleted-terminating | modifying). replace-unhealthy-instances -
Indicates whether EC2 Fleet should replace unhealthy instances (true | false). type -
The type of request (instant | request | maintain).
- `"FleetId"`: The IDs of the EC2 Fleets. If a fleet is of type instant, you must specify
the fleet ID, otherwise it does not appear in the response.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_fleets(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeFleets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_fleets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeFleets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_flow_logs()
describe_flow_logs(params::Dict{String,<:Any})
Describes one or more flow logs. To view the published flow log records, you must view the
log destination. For example, the CloudWatch Logs log group, the Amazon S3 bucket, or the
Kinesis Data Firehose delivery stream.
# 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.
- `"Filter"`: One or more filters. deliver-log-status - The status of the logs delivery
(SUCCESS | FAILED). log-destination-type - The type of destination for the flow log data
(cloud-watch-logs | s3 | kinesis-data-firehose). flow-log-id - The ID of the flow log.
log-group-name - The name of the log group. resource-id - The ID of the VPC, subnet, or
network interface. traffic-type - The type of traffic (ACCEPT | REJECT | ALL).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
key in the filter name and the tag value as the filter value. For example, to find all
resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the
filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the
resource. Use this filter to find all resources assigned a tag with a specific key,
regardless of the tag value.
- `"FlowLogId"`: One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token to request the next page of items. Pagination continues from the
end of the items returned by the previous request.
"""
function describe_flow_logs(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeFlowLogs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_flow_logs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeFlowLogs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_fpga_image_attribute(attribute, fpga_image_id)
describe_fpga_image_attribute(attribute, fpga_image_id, params::Dict{String,<:Any})
Describes the specified attribute of the specified Amazon FPGA Image (AFI).
# Arguments
- `attribute`: The AFI attribute.
- `fpga_image_id`: The ID of the AFI.
# 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.
"""
function describe_fpga_image_attribute(
Attribute, FpgaImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeFpgaImageAttribute",
Dict{String,Any}("Attribute" => Attribute, "FpgaImageId" => FpgaImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fpga_image_attribute(
Attribute,
FpgaImageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeFpgaImageAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Attribute" => Attribute, "FpgaImageId" => FpgaImageId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fpga_images()
describe_fpga_images(params::Dict{String,<:Any})
Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs,
private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which
you have load permissions.
# 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.
- `"Filter"`: The filters. create-time - The creation time of the AFI. fpga-image-id
- The FPGA image identifier (AFI ID). fpga-image-global-id - The global FPGA image
identifier (AGFI ID). name - The name of the AFI. owner-id - The Amazon Web Services
account ID of the AFI owner. product-code - The product code. shell-version - The
version of the Amazon Web Services Shell that was used to create the bitstream. state -
The state of the AFI (pending | failed | available | unavailable). tag:<key> - The
key/value combination of a tag assigned to the resource. Use the tag key in the filter name
and the tag value as the filter value. For example, to find all resources that have a tag
with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for
the filter value. tag-key - The key of a tag assigned to the resource. Use this filter
to find all resources assigned a tag with a specific key, regardless of the tag value.
update-time - The time of the most recent update.
- `"FpgaImageId"`: The AFI IDs.
- `"MaxResults"`: The maximum number of results to return in a single call.
- `"NextToken"`: The token to retrieve the next page of results.
- `"Owner"`: Filters the AFI by owner. Specify an Amazon Web Services account ID, self
(owner is the sender of the request), or an Amazon Web Services owner alias (valid values
are amazon | aws-marketplace).
"""
function describe_fpga_images(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeFpgaImages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_fpga_images(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeFpgaImages", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_host_reservation_offerings()
describe_host_reservation_offerings(params::Dict{String,<:Any})
Describes the Dedicated Host reservations that are available to purchase. The results
describe all of the Dedicated Host reservation offerings, including offerings that might
not match the instance family and Region of your Dedicated Hosts. When purchasing an
offering, ensure that the instance family and Region of the offering matches that of the
Dedicated Hosts with which it is to be associated. For more information about supported
instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. instance-family - The instance family of the offering (for
example, m4). payment-option - The payment option (NoUpfront | PartialUpfront |
AllUpfront).
- `"MaxDuration"`: This is the maximum duration of the reservation to purchase, specified
in seconds. Reservations are available in one-year and three-year terms. The number of
seconds specified must be the number of seconds in a year (365x24x60x60) times one of the
supported durations (1 or 3). For example, specify 94608000 for three years.
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results can be seen by sending another request with the returned nextToken
value. This value can be between 5 and 500. If maxResults is given a larger value than 500,
you receive an error.
- `"MinDuration"`: This is the minimum duration of the reservation you'd like to purchase,
specified in seconds. Reservations are available in one-year and three-year terms. The
number of seconds specified must be the number of seconds in a year (365x24x60x60) times
one of the supported durations (1 or 3). For example, specify 31536000 for one year.
- `"NextToken"`: The token to use to retrieve the next page of results.
- `"OfferingId"`: The ID of the reservation offering.
"""
function describe_host_reservation_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeHostReservationOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_host_reservation_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeHostReservationOfferings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_host_reservations()
describe_host_reservations(params::Dict{String,<:Any})
Describes reservations that are associated with Dedicated Hosts in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. instance-family - The instance family (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront). state -
The state of the reservation (payment-pending | payment-failed | active | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
key in the filter name and the tag value as the filter value. For example, to find all
resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the
filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the
resource. Use this filter to find all resources assigned a tag with a specific key,
regardless of the tag value.
- `"HostReservationIdSet"`: The host reservation IDs.
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results can be seen by sending another request with the returned nextToken
value. This value can be between 5 and 500. If maxResults is given a larger value than 500,
you receive an error.
- `"NextToken"`: The token to use to retrieve the next page of results.
"""
function describe_host_reservations(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeHostReservations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_host_reservations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeHostReservations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_hosts()
describe_hosts(params::Dict{String,<:Any})
Describes the specified Dedicated Hosts or all your Dedicated Hosts. The results describe
only the Dedicated Hosts in the Region you're currently using. All listed instances consume
capacity on your Dedicated Host. Dedicated Hosts that have recently been released are
listed with the state released.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: The filters. auto-placement - Whether auto-placement is enabled or
disabled (on | off). availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host. instance-type -
The instance type size that the Dedicated Host is configured to support. state - The
allocation state of the Dedicated Host (available | under-assessment | permanent-failure |
released | released-permanent-failure). tag-key - The key of a tag assigned to the
resource. Use this filter to find all resources assigned a tag with a specific key,
regardless of the tag value.
- `"hostId"`: The IDs of the Dedicated Hosts. The IDs are used for targeted instance
launches.
- `"maxResults"`: The maximum number of results to return for the request in a single page.
The remaining results can be seen by sending another request with the returned nextToken
value. This value can be between 5 and 500. If maxResults is given a larger value than 500,
you receive an error. You cannot specify this parameter and the host IDs parameter in the
same request.
- `"nextToken"`: The token to use to retrieve the next page of results.
"""
function describe_hosts(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeHosts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_hosts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeHosts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_iam_instance_profile_associations()
describe_iam_instance_profile_associations(params::Dict{String,<:Any})
Describes your IAM instance profile associations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationId"`: The IAM instance profile associations.
- `"Filter"`: The filters. instance-id - The ID of the instance. state - The state of
the association (associating | associated | disassociating).
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_iam_instance_profile_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIamInstanceProfileAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_iam_instance_profile_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIamInstanceProfileAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_id_format()
describe_id_format(params::Dict{String,<:Any})
Describes the ID format settings for your resources on a per-Region basis, for example, to
view which resource types are enabled for longer IDs. This request only returns information
about resource types whose ID formats can be modified; it does not return information about
other resource types. The following resource types support longer IDs: bundle |
conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image | import-task | instance |
internet-gateway | network-acl | network-acl-association | network-interface |
network-interface-attachment | prefix-list | reservation | route-table |
route-table-association | security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway. These settings apply to the IAM
user who makes the request; they do not apply to the entire Amazon Web Services account. By
default, an IAM user defaults to the same settings as the root user, unless they explicitly
override the settings by running the ModifyIdFormat command. Resources created with longer
IDs are visible to all IAM users, regardless of these settings and provided that they have
permission to use the relevant Describe command for the resource type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Resource"`: The type of resource: bundle | conversion-task | customer-gateway |
dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log |
image | import-task | instance | internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list | reservation | route-table
| route-table-association | security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway
"""
function describe_id_format(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeIdFormat"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_id_format(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIdFormat", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_identity_id_format(principal_arn)
describe_identity_id_format(principal_arn, params::Dict{String,<:Any})
Describes the ID format settings for resources for the specified IAM user, IAM role, or
root user. For example, you can view the resource types that are enabled for longer IDs.
This request only returns information about resource types whose ID formats can be
modified; it does not return information about other resource types. For more information,
see Resource IDs in the Amazon Elastic Compute Cloud User Guide. The following resource
types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options |
elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list | reservation | route-table
| route-table-association | security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway. These settings apply to the
principal specified in the request. They do not apply to the principal that makes the
request.
# Arguments
- `principal_arn`: The ARN of the principal, which can be an IAM role, IAM user, or the
root user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"resource"`: The type of resource: bundle | conversion-task | customer-gateway |
dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log |
image | import-task | instance | internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list | reservation | route-table
| route-table-association | security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway
"""
function describe_identity_id_format(
principalArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIdentityIdFormat",
Dict{String,Any}("principalArn" => principalArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_identity_id_format(
principalArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeIdentityIdFormat",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("principalArn" => principalArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_image_attribute(attribute, image_id)
describe_image_attribute(attribute, image_id, params::Dict{String,<:Any})
Describes the specified attribute of the specified AMI. You can specify only one attribute
at a time. The order of the elements in the response, including those within nested
structures, might vary. Applications should not assume the elements appear in a particular
order.
# Arguments
- `attribute`: The AMI attribute. Note: The blockDeviceMapping attribute is deprecated.
Using this attribute returns the Client.AuthFailure error. To get information about the
block device mappings for an AMI, use the DescribeImages action.
- `image_id`: The ID of the AMI.
# 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.
"""
function describe_image_attribute(
Attribute, ImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeImageAttribute",
Dict{String,Any}("Attribute" => Attribute, "ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_image_attribute(
Attribute,
ImageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeImageAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Attribute" => Attribute, "ImageId" => ImageId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_images()
describe_images(params::Dict{String,<:Any})
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images
available to you. The images available to you include public images, private images that
you own, and private images owned by other Amazon Web Services accounts for which you have
explicit launch permissions. Recently deregistered images appear in the returned results
for a short interval and then return empty results. After all instances that reference a
deregistered AMI are terminated, specifying the ID of the image will eventually return an
error indicating that the AMI ID cannot be found. We strongly recommend using only
paginated requests. Unpaginated requests are susceptible to throttling and timeouts. The
order of the elements in the response, including those within nested structures, might
vary. Applications should not assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExecutableBy"`: Scopes the images by users with explicit launch permissions. Specify an
Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs shared
with that specific Amazon Web Services account ID are returned. However, AMIs that are
shared with the account’s organization or organizational unit (OU) are not returned. If
you specify self or your own Amazon Web Services account ID, AMIs shared with your account
are returned. In addition, AMIs that are shared with the organization or OU of which you
are member are also returned. If you specify all, all public AMIs are returned.
- `"Filter"`: The filters. architecture - The image architecture (i386 | x86_64 | arm64
| x86_64_mac | arm64_mac). block-device-mapping.delete-on-termination - A Boolean value
that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping
(for example, /dev/sdh or xvdh). block-device-mapping.snapshot-id - The ID of the
snapshot used for the Amazon EBS volume. block-device-mapping.volume-size - The volume
size of the Amazon EBS volume, in GiB. block-device-mapping.volume-type - The volume
type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is
encrypted. creation-date - The time when the image was created, in the ISO 8601 format
in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You
can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
description - The description of the image (provided during image creation). ena-support
- A Boolean that indicates whether enhanced networking with ENA is enabled. hypervisor -
The hypervisor type (ovm | xen). image-id - The ID of the image. image-type - The
image type (machine | kernel | ramdisk). is-public - A Boolean that indicates whether
the image is public. kernel-id - The kernel ID. manifest-location - The location of
the image manifest. name - The name of the AMI (provided during image creation).
owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in
an Amazon-maintained list. This is not the Amazon Web Services account alias that can be
set using the IAM console. We recommend that you use the Owner request parameter instead of
this filter. owner-id - The Amazon Web Services account ID of the owner. We recommend
that you use the Owner request parameter instead of this filter. platform - The
platform. The only supported value is windows. product-code - The product code.
product-code.type - The type of the product code (marketplace). ramdisk-id - The RAM
disk ID. root-device-name - The device name of the root device volume (for example,
/dev/sda1). root-device-type - The type of the root device volume (ebs |
instance-store). source-instance-id - The ID of the instance that the AMI was created
from if the AMI was created using CreateImage. This filter is applicable only if the AMI
was created using CreateImage. state - The state of the image (available | pending |
failed). state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change. sriov-net-support - A value of
simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
key in the filter name and the tag value as the filter value. For example, to find all
resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the
filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the
resource. Use this filter to find all resources assigned a tag with a specific key,
regardless of the tag value. virtualization-type - The virtualization type (paravirtual
| hvm).
- `"ImageId"`: The image IDs. Default: Describes all images available to you.
- `"IncludeDeprecated"`: Specifies whether to include deprecated AMIs. Default: No
deprecated AMIs are included in the response. If you are the AMI owner, all deprecated
AMIs appear in the response regardless of what you specify for this parameter.
- `"IncludeDisabled"`: Specifies whether to include disabled AMIs. Default: No disabled
AMIs are included in the response.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"Owner"`: Scopes the results to images with the specified owners. You can specify a
combination of Amazon Web Services account IDs, self, amazon, and aws-marketplace. If you
omit this parameter, the results include all images for which you have launch permissions,
regardless of ownership.
- `"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.
"""
function describe_images(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeImages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_images(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeImages", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_import_image_tasks()
describe_import_image_tasks(params::Dict{String,<:Any})
Displays details about an import virtual machine or import snapshot tasks that are already
created.
# 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.
- `"Filters"`: Filter tasks using the task-state filter and one of the following values:
active, completed, deleting, or deleted.
- `"ImportTaskId"`: The IDs of the import image tasks.
- `"MaxResults"`: The maximum number of results to return in a single call.
- `"NextToken"`: A token that indicates the next page of results.
"""
function describe_import_image_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeImportImageTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_import_image_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeImportImageTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_import_snapshot_tasks()
describe_import_snapshot_tasks(params::Dict{String,<:Any})
Describes your import snapshot tasks.
# 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.
- `"Filters"`: The filters.
- `"ImportTaskId"`: A list of import snapshot task IDs.
- `"MaxResults"`: The maximum number of results to return in a single call. To retrieve the
remaining results, make another call with the returned NextToken value.
- `"NextToken"`: A token that indicates the next page of results.
"""
function describe_import_snapshot_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeImportSnapshotTasks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_import_snapshot_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeImportSnapshotTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_attribute(attribute, instance_id)
describe_instance_attribute(attribute, instance_id, params::Dict{String,<:Any})
Describes the specified attribute of the specified instance. You can specify only one
attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData
| disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName |
blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized |
sriovNetSupport
# Arguments
- `attribute`: The instance attribute. Note: The enaSupport attribute is not supported at
this time.
- `instance_id`: The ID of the instance.
# 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.
"""
function describe_instance_attribute(
attribute, instanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceAttribute",
Dict{String,Any}("attribute" => attribute, "instanceId" => instanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_attribute(
attribute,
instanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeInstanceAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("attribute" => attribute, "instanceId" => instanceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_connect_endpoints()
describe_instance_connect_endpoints(params::Dict{String,<:Any})
Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect
Endpoints.
# 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.
- `"Filter"`: One or more filters. instance-connect-endpoint-id - The ID of the EC2
Instance Connect Endpoint. state - The state of the EC2 Instance Connect Endpoint
(create-in-progress | create-complete | create-failed | delete-in-progress |
delete-complete | delete-failed). subnet-id - The ID of the subnet in which the EC2
Instance Connect Endpoint was created. tag:<key> - The key/value combination of a
tag assigned to the resource. Use the tag key in the filter name and the tag value as the
filter value. For example, to find all resources that have a tag with the key Owner and the
value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
assigned a tag with a specific key, regardless of the tag value. tag-value - The value
of a tag assigned to the resource. Use this filter to find all resources that have a tag
with a specific value, regardless of tag key. vpc-id - The ID of the VPC in which the
EC2 Instance Connect Endpoint was created.
- `"InstanceConnectEndpointId"`: One or more EC2 Instance Connect Endpoint IDs.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_instance_connect_endpoints(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceConnectEndpoints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_connect_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceConnectEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_credit_specifications()
describe_instance_credit_specifications(params::Dict{String,<:Any})
Describes the credit option for CPU usage of the specified burstable performance instances.
The credit options are standard and unlimited. If you do not specify an instance ID, Amazon
EC2 returns burstable performance instances with the unlimited credit option, as well as
instances that were previously configured as T2, T3, and T3a with the unlimited credit
option. For example, if you resize a T2 instance, while it is configured as unlimited, to
an M4 instance, Amazon EC2 returns the M4 instance. If you specify one or more instance
IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If
you specify an instance ID that is not valid, such as an instance that is not a burstable
performance instance, an error is returned. Recently terminated instances might appear in
the returned results. This interval is usually less than one hour. If an Availability Zone
is experiencing a service disruption and you specify instance IDs in the affected zone, or
do not specify any instance IDs at all, the call fails. If you specify only instance IDs in
an unaffected zone, the call works normally. For more information, see Burstable
performance instances in the Amazon EC2 User Guide.
# 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.
- `"Filter"`: The filters. instance-id - The ID of the instance.
- `"InstanceId"`: The instance IDs. Default: Describes all your instances. Constraints:
Maximum 1000 explicitly specified instance IDs.
- `"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. For more
information, see Pagination. You cannot specify this parameter and the instance IDs
parameter in the same call.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_instance_credit_specifications(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceCreditSpecifications";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_credit_specifications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceCreditSpecifications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_event_notification_attributes()
describe_instance_event_notification_attributes(params::Dict{String,<:Any})
Describes the tag keys that are registered to appear in scheduled event notifications for
resources in the current Region.
# 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.
"""
function describe_instance_event_notification_attributes(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceEventNotificationAttributes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_event_notification_attributes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceEventNotificationAttributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_event_windows()
describe_instance_event_windows(params::Dict{String,<:Any})
Describes the specified event windows or all event windows. If you specify event window
IDs, the output includes information for only the specified event windows. If you specify
filters, the output includes information for only those event windows that meet the filter
criteria. If you do not specify event windows IDs or filters, the output includes
information for all event windows, which can affect performance. We recommend that you use
pagination to ensure that the operation returns quickly and successfully. For more
information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
# 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.
- `"Filter"`: One or more filters. dedicated-host-id - The event windows associated with
the specified Dedicated Host ID. event-window-name - The event windows associated with
the specified names. instance-id - The event windows associated with the specified
instance ID. instance-tag - The event windows associated with the specified tag and
value. instance-tag-key - The event windows associated with the specified tag key,
regardless of the value. instance-tag-value - The event windows associated with the
specified tag value, regardless of the key. tag:<key> - The key/value combination
of a tag assigned to the event window. Use the tag key in the filter name and the tag value
as the filter value. For example, to find all resources that have a tag with the key Owner
and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
tag-key - The key of a tag assigned to the event window. Use this filter to find all event
windows that have a tag with a specific key, regardless of the tag value. tag-value -
The value of a tag assigned to the event window. Use this filter to find all event windows
that have a tag with a specific value, regardless of the tag key.
- `"InstanceEventWindowId"`: The IDs of the event windows.
- `"MaxResults"`: The maximum number of results to return in a single call. To retrieve the
remaining results, make another call with the returned NextToken value. This value can be
between 20 and 500. You cannot specify this parameter and the event window IDs parameter in
the same call.
- `"NextToken"`: The token to request the next page of results.
"""
function describe_instance_event_windows(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceEventWindows";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_event_windows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceEventWindows",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_status()
describe_instance_status(params::Dict{String,<:Any})
Describes the status of the specified instances or all of your instances. By default, only
running instances are described, unless you specifically indicate to return the status of
all instances. Instance status includes the following components: Status checks - Amazon
EC2 performs status checks on running EC2 instances to identify hardware and software
issues. For more information, see Status checks for your instances and Troubleshoot
instances with failed status checks in the Amazon EC2 User Guide. Scheduled events -
Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances
related to hardware issues, software updates, or system maintenance. For more information,
see Scheduled events for your instances in the Amazon EC2 User Guide. Instance state -
You can manage your instances from the moment you launch them through their termination.
For more information, see Instance lifecycle in the Amazon EC2 User Guide. The order of
the elements in the response, including those within nested structures, might vary.
Applications should not assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot |
system-maintenance | instance-retirement | instance-stop). event.description - A
description of the event. event.instance-event-id - The ID of the event whose date and
time you are modifying. event.not-after - The latest end time for the scheduled event
(for example, 2014-09-15T17:15:20.000Z). event.not-before - The earliest start time for
the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before-deadline -
The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The
high byte is used for internal purposes and should be ignored. The low byte is set based on
the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down),
48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the
instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability
(passed | failed | initializing | insufficient-data). instance-status.status - The
status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability
(passed | failed | initializing | insufficient-data). system-status.status - The system
status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
- `"InstanceId"`: The instance IDs. Default: Describes all your instances. Constraints:
Maximum 100 explicitly specified instance IDs.
- `"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. For more
information, see Pagination. You cannot specify this parameter and the instance IDs
parameter in the same request.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"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.
- `"includeAllInstances"`: When true, includes the health status for all instances. When
false, includes the health status for running instances only. Default: false
"""
function describe_instance_status(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeInstanceStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_instance_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_topology()
describe_instance_topology(params::Dict{String,<:Any})
Describes a tree-based hierarchy that represents the physical host placement of your EC2
instances within an Availability Zone or Local Zone. You can use this information to
determine the relative proximity of your EC2 instances within the Amazon Web Services
network to support your tightly coupled workloads. Limitations Supported zones
Availability Zone Local Zone Supported instance types hpc6a.48xlarge |
hpc6id.32xlarge | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge |
hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge p3dn.24xlarge | p4d.24xlarge |
p4de.24xlarge | p5.48xlarge trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge For more
information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
# 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.
- `"Filter"`: The filters. availability-zone - The name of the Availability Zone (for
example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the instance is in.
instance-type - The instance type (for example, p4d.24xlarge) or instance family (for
example, p4d*). You can use the * wildcard to match zero or more characters, or the ?
wildcard to match zero or one character. zone-id - The ID of the Availability Zone (for
example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) that the instance is in.
- `"GroupName"`: The name of the placement group that each instance is in. Constraints:
Maximum 100 explicitly specified placement group names.
- `"InstanceId"`: The instance IDs. Default: Describes all your instances. Constraints:
Maximum 100 explicitly specified instance IDs.
- `"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. For more
information, see Pagination. You can't specify this parameter and the instance IDs
parameter in the same request. Default: 20
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_instance_topology(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeInstanceTopology"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_instance_topology(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceTopology",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_type_offerings()
describe_instance_type_offerings(params::Dict{String,<:Any})
Lists the instance types that are offered for the specified location. If no location is
specified, the default is to list the instance types that are offered in the current Region.
# 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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
instance-type - The instance type. For a list of possible values, see Instance. location
- The location. For a list of possible identifiers, see Regions and Zones.
- `"LocationType"`: The location type. availability-zone - The Availability Zone. When
you specify a location filter, it must be an Availability Zone for the current Region.
availability-zone-id - The AZ ID. When you specify a location filter, it must be an AZ ID
for the current Region. outpost - The Outpost ARN. When you specify a location filter,
it must be an Outpost ARN for the current Region. region - The current Region. If you
specify a location filter, it must match the current Region.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_instance_type_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceTypeOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_type_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceTypeOfferings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_types()
describe_instance_types(params::Dict{String,<:Any})
Describes the specified instance types. By default, all instance types for the current
Region are described. Alternatively, you can filter the results.
# 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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is
supported (true | false). bare-metal - Indicates whether it is a bare metal instance
type (true | false). burstable-performance-supported - Indicates whether the instance
type is a burstable performance T instance type (true | false). current-generation -
Indicates whether this instance type is the latest generation instance type of an instance
family (true | false). ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The
baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations
per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput
performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance
for an EBS-optimized instance type, in Mbps. ebs-info.ebs-optimized-info.maximum-iops -
The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput
performance for an EBS-optimized instance type, in MB/s. ebs-info.ebs-optimized-support
- Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported |
unsupported). ebs-info.nvme-support - Indicates whether non-volatile memory express
(NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free
tier (true | false). hibernation-supported - Indicates whether On-Demand hibernation is
supported (true | false). hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in
GB. instance-storage-info.disk.type - The storage technology for the local instance
storage disks (hdd | ssd). instance-storage-info.encryption-support - Indicates whether
data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe)
is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all
local instance storage, in GB. instance-storage-supported - Indicates whether the
instance type has local instance storage (true | false). instance-type - The instance
type (for example c5.2xlarge or c5*). memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric
Adapters (EFAs) per instance. network-info.efa-supported - Indicates whether the
instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or
required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type
automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses
per network interface. network-info.ipv6-addresses-per-interface - The maximum number of
private IPv6 addresses per network interface. network-info.ipv6-supported - Indicates
whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per
instance. network-info.network-performance - The network performance (for example, \"25
Gigabit\"). nitro-enclaves-support - Indicates whether Nitro Enclaves is supported
(supported | unsupported). nitro-tpm-support - Indicates whether NitroTPM is supported
(supported | unsupported). nitro-tpm-info.supported-versions - The supported NitroTPM
version (2.0). processor-info.supported-architecture - The CPU architecture (arm64 |
i386 | x86_64). processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in
GHz. processor-info.supported-features - The supported CPU features (amd-sev-snp).
supported-boot-mode - The boot mode (legacy-bios | uefi). supported-root-device-type -
The root device type (ebs | instance-store). supported-usage-class - The usage class
(on-demand | spot). supported-virtualization-type - The virtualization type (hvm |
paravirtual). vcpu-info.default-cores - The default number of cores for the instance
type. vcpu-info.default-threads-per-core - The default number of threads per core for
the instance type. vcpu-info.default-vcpus - The default number of vCPUs for the
instance type. vcpu-info.valid-cores - The number of cores that can be configured for
the instance type. vcpu-info.valid-threads-per-core - The number of threads per core
that can be configured for the instance type. For example, \"1\" or \"1,2\".
- `"InstanceType"`: The instance types.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_instance_types(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeInstanceTypes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_instance_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstanceTypes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instances()
describe_instances(params::Dict{String,<:Any})
Describes the specified instances or all instances. If you specify instance IDs, the output
includes information for only the specified instances. If you specify filters, the output
includes information for only those instances that meet the filter criteria. If you do not
specify instance IDs or filters, the output includes information for all instances, which
can affect performance. We recommend that you use pagination to ensure that the operation
returns quickly and successfully. If you specify an instance ID that is not valid, an error
is returned. If you specify an instance that you do not own, it is not included in the
output. Recently terminated instances might appear in the returned results. This interval
is usually less than one hour. If you describe instances in the rare case where an
Availability Zone is experiencing a service disruption and you specify instance IDs that
are in the affected zone, or do not specify any instance IDs at all, the call fails. If you
describe instances and specify only instance IDs that are in an unaffected zone, the call
works normally. We strongly recommend using only paginated requests. Unpaginated requests
are susceptible to throttling and timeouts. The order of the elements in the response,
including those within nested structures, might vary. Applications should not assume the
elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. affinity - The affinity setting for an instance running on a
Dedicated Host (default | host). architecture - The instance architecture (i386 | x86_64
| arm64). availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the
instance, for example, 2022-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS
volume is deleted on instance termination. block-device-mapping.device-name - The device
name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached |
detaching | detached). block-device-mapping.volume-id - The volume ID of the EBS volume.
boot-mode - The boot mode that was specified by the AMI (legacy-bios | uefi |
uefi-preferred). capacity-reservation-id - The ID of the Capacity Reservation into which
the instance was launched.
capacity-reservation-specification.capacity-reservation-preference - The instance's
Capacity Reservation preference (open | none).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id -
The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource
-group-arn - The ARN of the targeted Capacity Reservation group. client-token - The
idempotency token you provided when you launched the instance.
current-instance-boot-mode - The boot mode that is used to launch the instance at launch or
start (legacy-bios | uefi). dns-name - The public DNS name of the instance.
ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS
I/O. ena-support - A Boolean that indicates whether the instance is enabled for enhanced
networking with ENA. enclave-options.enabled - A Boolean that indicates whether the
instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled
for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for
both Xen and Nitro hypervisors. iam-instance-profile.arn - The instance profile
associated with the instance. Specified as an ARN. iam-instance-profile.id - The
instance profile associated with the instance. Specified as an ID.
iam-instance-profile.name - The instance profile associated with the instance. Specified as
an name. image-id - The ID of the image used to launch the instance. instance-id -
The ID of the instance. instance-lifecycle - Indicates whether this is a Spot Instance,
a Scheduled Instance, or a Capacity Block (spot | scheduled | capacity-block).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high
byte is used for internal purposes and should be ignored. The low byte is set based on the
state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48
(terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the
instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro). instance.group-id - The ID
of the security group for the instance. instance.group-name - The name of the security
group for the instance. ip-address - The public IPv4 address of the instance.
ipv6-address - The IPv6 address of the instance. kernel-id - The kernel ID. key-name
- The name of the key pair used when the instance was launched. launch-index - When
launching multiple instances, this is the index for the instance in the launch group (for
example, 0, 1, 2, and so on). launch-time - The time when the instance was launched, in
the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,
2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which
matches an entire day. maintenance-options.auto-recovery - The current automatic
recovery behavior of the instance (disabled | default). metadata-options.http-endpoint -
The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled
(disabled | enabled). metadata-options.http-protocol-ipv6 - Indicates whether the IPv6
endpoint is enabled (disabled | enabled). metadata-options.http-put-response-hop-limit -
The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-tokens - The metadata request authorization state (optional |
required) metadata-options.instance-metadata-tags - The status of access to instance
tags from the instance metadata (enabled | disabled) metadata-options.state - The state
of the metadata option changes (pending | applied). monitoring-state - Indicates whether
detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.association.allocation-id - The allocation ID.
network-interface.addresses.association.association-id - The association ID.
network-interface.addresses.association.carrier-ip - The carrier IP address.
network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4
address associated with the network interface.
network-interface.addresses.association.public-dns-name - The public DNS name.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic
IP address (IPv4) with a network interface. network-interface.addresses.primary -
Specifies whether the IPv4 address of the network interface is the primary private IPv4
address. network-interface.addresses.private-dns-name - The private DNS name.
network-interface.addresses.private-ip-address - The private IPv4 address associated with
the network interface. network-interface.association.allocation-id - The allocation ID
returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network
interface was associated with an IPv4 address. network-interface.association.carrier-ip
- The customer-owned IP address. network-interface.association.customer-owned-ip - The
customer-owned IP address. network-interface.association.ip-owner-id - The owner of the
Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name - The public DNS name.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4)
bound to the network interface. network-interface.attachment.attach-time - The time that
the network interface was attached to an instance.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is
deleted when an instance is terminated. network-interface.attachment.device-index - The
device index to which the network interface is attached.
network-interface.attachment.instance-id - The ID of the instance to which the network
interface is attached. network-interface.attachment.instance-owner-id - The owner ID of
the instance to which the network interface is attached.
network-interface.attachment.network-card-index - The index of the network card.
network-interface.attachment.status - The status of the attachment (attaching | attached |
detaching | detached). network-interface.availability-zone - The Availability Zone for
the network interface. network-interface.deny-all-igw-traffic - A Boolean that indicates
whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network
interface. network-interface.group-name - The name of a security group associated with
the network interface. network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes
that are assigned to the network interface. network-interface.ipv6-address - The IPv6
address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the
network interface. network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that
indicates whether this is the primary IPv6 address. network-interface.ipv6-native - A
Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network
interface. network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.outpost-arn - The ARN of the Outpost. network-interface.owner-id - The
ID of the owner of the network interface. network-interface.private-dns-name - The
private DNS name of the network interface. network-interface.private-ip-address - The
private IPv4 address. network-interface.public-dns-name - The public DNS name.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being
managed by Amazon Web Services. network-interface.status - The status of the network
interface (available) | in-use). network-interface.source-dest-check - Whether the
network interface performs source/destination checking. A value of true means that checking
is enabled, and false means that checking is disabled. The value must be false for the
network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.tag-key - The key of a tag assigned to the network interface.
network-interface.tag-value - The value of a tag assigned to the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface. outpost-arn -
The Amazon Resource Name (ARN) of the Outpost. owner-id - The Amazon Web Services
account ID of the instance owner. placement-group-name - The name of the placement group
for the instance. placement-partition-number - The partition in which the instance is
located. platform - The platform. To list only Windows instances, use windows.
platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux | Red Hat Enterprise
Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with SQL Server
Standard and HA | Red Hat Enterprise Linux with SQL Server Enterprise and HA | Red Hat
Enterprise Linux with SQL Server Standard | Red Hat Enterprise Linux with SQL Server Web |
Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server
Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with
SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web).
private-dns-name - The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates
whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates
whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type - The type of hostname (ip-name | resource-name).
private-ip-address - The private IPv4 address of the instance. This can only be used to
filter by the primary IP address of the network interface attached to the instance. To
filter by additional IP addresses assigned to the network interface, use the filter
network-interface.addresses.private-ip-address. product-code - The product code
associated with the AMI used to launch the instance. product-code.type - The type of
product code (devpay | marketplace). ramdisk-id - The RAM disk ID. reason - The
reason for the current state of the instance (for example, shows \"User Initiated [date]\"
when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example,
Amazon Web Services Management Console, Auto Scaling, and so on). reservation-id - The
ID of the instance's reservation. A reservation ID is created any time you launch an
instance. A reservation ID has a one-to-one relationship with an instance launch request,
but can be associated with more than one instance if you launch multiple instances using
the same launch request. For example, if you launch one instance, you get one reservation
ID. If you launch ten instances using the same launch request, you also get one reservation
ID. root-device-name - The device name of the root device volume (for example,
/dev/sda1). root-device-type - The type of the root device volume (ebs |
instance-store). source-dest-check - Indicates whether the instance performs
source/destination checking. A value of true means that checking is enabled, and false
means that checking is disabled. The value must be false for the instance to perform
network address translation (NAT) in your VPC. spot-instance-request-id - The ID of the
Spot Instance request. state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change. subnet-id - The ID of
the subnet for the instance. tag:<key> - The key/value combination of a tag
assigned to the resource. Use the tag key in the filter name and the tag value as the
filter value. For example, to find all resources that have a tag with the key Owner and the
value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
that have a tag with a specific key, regardless of the tag value. tenancy - The tenancy
of an instance (dedicated | default | host). tpm-support - Indicates if the instance is
configured for NitroTPM support (v2.0). usage-operation - The usage operation value for
the instance (RunInstances | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 |
RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 |
RunInstances:0110 | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 |
RunInstances:000g | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 |
RunInstances:0102 | RunInstances:0006 | RunInstances:0202). usage-operation-update-time
- The time that the usage operation was last updated, for example,
2022-09-15T17:15:20.000Z. virtualization-type - The virtualization type of the instance
(paravirtual | hvm). vpc-id - The ID of the VPC that the instance is running in.
- `"InstanceId"`: The instance IDs. Default: Describes all your instances.
- `"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.
- `"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. For more
information, see Pagination. You cannot specify this parameter and the instance IDs
parameter in the same request.
- `"nextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInstances", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_internet_gateways()
describe_internet_gateways(params::Dict{String,<:Any})
Describes your internet gateways. The default is to describe all your internet gateways.
Alternatively, you can specify specific internet gateway IDs or filter the results to
include only the internet gateways that match specific criteria.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. attachment.state - The current state of the attachment
between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC. internet-gateway-id - The ID of the
Internet gateway. owner-id - The ID of the Amazon Web Services account that owns the
internet gateway. tag:<key> - The key/value combination of a tag assigned to the
resource. Use the tag key in the filter name and the tag value as the filter value. For
example, to find all resources that have a tag with the key Owner and the value TeamA,
specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key
of a tag assigned to the resource. Use this filter to find all resources assigned a tag
with a specific key, regardless of the tag value.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"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.
- `"internetGatewayId"`: The IDs of the internet gateways. Default: Describes all your
internet gateways.
"""
function describe_internet_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeInternetGateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_internet_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeInternetGateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ipam_byoasn()
describe_ipam_byoasn(params::Dict{String,<:Any})
Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP
CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to
IPAM in the Amazon VPC IPAM guide.
# 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.
- `"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 describe_ipam_byoasn(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeIpamByoasn"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_ipam_byoasn(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIpamByoasn", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_ipam_pools()
describe_ipam_pools(params::Dict{String,<:Any})
Get information about your IPAM pools.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: One or more filters for the request. For more information about filtering,
see Filtering CLI output.
- `"IpamPoolId"`: The IDs of the IPAM pools you would like information on.
- `"MaxResults"`: The maximum number of results to return in the request.
- `"NextToken"`: The token for the next page of results.
"""
function describe_ipam_pools(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeIpamPools"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_ipam_pools(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIpamPools", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_ipam_resource_discoveries()
describe_ipam_resource_discoveries(params::Dict{String,<:Any})
Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables
IPAM to manage and monitor resources that belong to the owning account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: The resource discovery filters.
- `"IpamResourceDiscoveryId"`: The IPAM resource discovery IDs.
- `"MaxResults"`: The maximum number of resource discoveries to return in one page of
results.
- `"NextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function describe_ipam_resource_discoveries(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIpamResourceDiscoveries";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_ipam_resource_discoveries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIpamResourceDiscoveries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ipam_resource_discovery_associations()
describe_ipam_resource_discovery_associations(params::Dict{String,<:Any})
Describes resource discovery association with an Amazon VPC IPAM. An associated resource
discovery is a resource discovery that has been associated with an IPAM..
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: The resource discovery association filters.
- `"IpamResourceDiscoveryAssociationId"`: The resource discovery association IDs.
- `"MaxResults"`: The maximum number of resource discovery associations to return in one
page of results.
- `"NextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function describe_ipam_resource_discovery_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIpamResourceDiscoveryAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_ipam_resource_discovery_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIpamResourceDiscoveryAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ipam_scopes()
describe_ipam_scopes(params::Dict{String,<:Any})
Get information about your IPAM scopes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: One or more filters for the request. For more information about filtering,
see Filtering CLI output.
- `"IpamScopeId"`: The IDs of the scopes you want information on.
- `"MaxResults"`: The maximum number of results to return in the request.
- `"NextToken"`: The token for the next page of results.
"""
function describe_ipam_scopes(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeIpamScopes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_ipam_scopes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIpamScopes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_ipams()
describe_ipams(params::Dict{String,<:Any})
Get information about your IPAM pools. For more information, see What is IPAM? in the
Amazon VPC IPAM User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: One or more filters for the request. For more information about filtering,
see Filtering CLI output.
- `"IpamId"`: The IDs of the IPAMs you want information on.
- `"MaxResults"`: The maximum number of results to return in the request.
- `"NextToken"`: The token for the next page of results.
"""
function describe_ipams(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeIpams"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_ipams(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIpams", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_ipv6_pools()
describe_ipv6_pools(params::Dict{String,<:Any})
Describes your IPv6 address pools.
# 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.
- `"Filter"`: One or more filters. tag:<key> - The key/value combination of a tag
assigned to the resource. Use the tag key in the filter name and the tag value as the
filter value. For example, to find all resources that have a tag with the key Owner and the
value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
assigned a tag with a specific key, regardless of the tag value.
- `"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.
- `"PoolId"`: The IDs of the IPv6 address pools.
"""
function describe_ipv6_pools(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeIpv6Pools"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_ipv6_pools(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeIpv6Pools", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_key_pairs()
describe_key_pairs(params::Dict{String,<:Any})
Describes the specified key pairs or all of your key pairs. For more information about key
pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. key-pair-id - The ID of the key pair. fingerprint - The
fingerprint of the key pair. key-name - The name of the key pair. tag-key - The key
of a tag assigned to the resource. Use this filter to find all resources assigned a tag
with a specific key, regardless of the tag value. tag:<key> - The key/value
combination of a tag assigned to the resource. Use the tag key in the filter name and the
tag value as the filter value. For example, to find all resources that have a tag with the
key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the
filter value.
- `"IncludePublicKey"`: If true, the public key material is included in the response.
Default: false
- `"KeyName"`: The key pair names. Default: Describes all of your key pairs.
- `"KeyPairId"`: The IDs of the key pairs.
- `"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.
"""
function describe_key_pairs(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeKeyPairs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_key_pairs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeKeyPairs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_launch_template_versions()
describe_launch_template_versions(params::Dict{String,<:Any})
Describes one or more versions of a specified launch template. You can describe all
versions, individual versions, or a range of versions. You can also describe all the latest
versions or all the default versions of all the launch templates in your account.
# 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.
- `"Filter"`: One or more filters. create-time - The time the launch template version
was created. ebs-optimized - A boolean that indicates whether the instance is optimized
for Amazon EBS I/O. http-endpoint - Indicates whether the HTTP metadata endpoint on your
instances is enabled (enabled | disabled). http-protocol-ipv4 - Indicates whether the
IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
host-resource-group-arn - The ARN of the host resource group in which to launch the
instances. http-tokens - The state of token usage for your instance metadata requests
(optional | required). iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI. instance-type - The instance type. is-default-version -
A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID. license-configuration-arn - The ARN of the license
configuration. network-card-index - The index of the network card. ram-disk-id - The
RAM disk ID.
- `"LaunchTemplateId"`: The ID of the launch template. To describe one or more versions of
a specified launch template, you must specify either the launch template ID or the launch
template name, but not both. To describe all the latest or default launch template versions
in your account, you must omit this parameter.
- `"LaunchTemplateName"`: The name of the launch template. To describe one or more versions
of a specified launch template, you must specify either the launch template name or the
launch template ID, but not both. To describe all the latest or default launch template
versions in your account, you must omit this parameter.
- `"LaunchTemplateVersion"`: One or more versions of the launch template. Valid values
depend on whether you are describing a specified launch template (by ID or name) or all
launch templates in your account. To describe one or more versions of a specified launch
template, valid values are Latest, Default, and numbers. To describe all launch templates
in your account that are defined as the latest version, the valid value is Latest. To
describe all launch templates in your account that are defined as the default version, the
valid value is Default. You can specify Latest and Default in the same request. You cannot
specify numbers.
- `"MaxResults"`: The maximum number of results to return in a single call. To retrieve the
remaining results, make another call with the returned NextToken value. This value can be
between 1 and 200.
- `"MaxVersion"`: The version number up to which to describe launch template versions.
- `"MinVersion"`: The version number after which to describe launch template versions.
- `"NextToken"`: The token to request the next page of results.
- `"ResolveAlias"`: If true, and if a Systems Manager parameter is specified for ImageId,
the AMI ID is displayed in the response for imageId. If false, and if a Systems Manager
parameter is specified for ImageId, the parameter is displayed in the response for imageId.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the
Amazon EC2 User Guide. Default: false
"""
function describe_launch_template_versions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLaunchTemplateVersions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_launch_template_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLaunchTemplateVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_launch_templates()
describe_launch_templates(params::Dict{String,<:Any})
Describes one or more launch templates.
# 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.
- `"Filter"`: One or more filters. create-time - The time the launch template was
created. launch-template-name - The name of the launch template. tag:<key> -
The key/value combination of a tag assigned to the resource. Use the tag key in the filter
name and the tag value as the filter value. For example, to find all resources that have a
tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA
for the filter value. tag-key - The key of a tag assigned to the resource. Use this
filter to find all resources assigned a tag with a specific key, regardless of the tag
value.
- `"LaunchTemplateId"`: One or more launch template IDs.
- `"LaunchTemplateName"`: One or more launch template names.
- `"MaxResults"`: The maximum number of results to return in a single call. To retrieve the
remaining results, make another call with the returned NextToken value. This value can be
between 1 and 200.
- `"NextToken"`: The token to request the next page of results.
"""
function describe_launch_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeLaunchTemplates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_launch_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLaunchTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_local_gateway_route_table_virtual_interface_group_associations()
describe_local_gateway_route_table_virtual_interface_group_associations(params::Dict{String,<:Any})
Describes the associations between virtual interface groups and local gateway route tables.
# 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.
- `"Filter"`: One or more filters. local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route
table for the virtual interface group. local-gateway-route-table-id - The ID of the
local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id - The ID of the
association. local-gateway-route-table-virtual-interface-group-id - The ID of the
virtual interface group. owner-id - The ID of the Amazon Web Services account that owns
the local gateway virtual interface group association. state - The state of the
association.
- `"LocalGatewayRouteTableVirtualInterfaceGroupAssociationId"`: The IDs of the associations.
- `"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 describe_local_gateway_route_table_virtual_interface_group_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_local_gateway_route_table_virtual_interface_group_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_local_gateway_route_table_vpc_associations()
describe_local_gateway_route_table_vpc_associations(params::Dict{String,<:Any})
Describes the specified associations between VPCs and local gateway route tables.
# 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.
- `"Filter"`: One or more filters. local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route
table for the association. local-gateway-route-table-id - The ID of the local gateway
route table. local-gateway-route-table-vpc-association-id - The ID of the association.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route
table for the association. state - The state of the association. vpc-id - The ID of
the VPC.
- `"LocalGatewayRouteTableVpcAssociationId"`: The IDs of the associations.
- `"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 describe_local_gateway_route_table_vpc_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGatewayRouteTableVpcAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_local_gateway_route_table_vpc_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGatewayRouteTableVpcAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_local_gateway_route_tables()
describe_local_gateway_route_tables(params::Dict{String,<:Any})
Describes one or more local gateway route tables. By default, all local gateway route
tables are described. Alternatively, you can filter the results.
# 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.
- `"Filter"`: One or more filters. local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route
table. local-gateway-route-table-id - The ID of a local gateway route table.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost. owner-id - The ID of the
Amazon Web Services account that owns the local gateway route table. state - The state
of the local gateway route table.
- `"LocalGatewayRouteTableId"`: The IDs of the local gateway route tables.
- `"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 describe_local_gateway_route_tables(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGatewayRouteTables";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_local_gateway_route_tables(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGatewayRouteTables",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_local_gateway_virtual_interface_groups()
describe_local_gateway_virtual_interface_groups(params::Dict{String,<:Any})
Describes the specified local gateway virtual interface groups.
# 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.
- `"Filter"`: One or more filters. local-gateway-id - The ID of a local gateway.
local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
local-gateway-virtual-interface-id - The ID of the virtual interface. owner-id - The ID
of the Amazon Web Services account that owns the local gateway virtual interface group.
- `"LocalGatewayVirtualInterfaceGroupId"`: The IDs of the virtual interface groups.
- `"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 describe_local_gateway_virtual_interface_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGatewayVirtualInterfaceGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_local_gateway_virtual_interface_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGatewayVirtualInterfaceGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_local_gateway_virtual_interfaces()
describe_local_gateway_virtual_interfaces(params::Dict{String,<:Any})
Describes the specified local gateway virtual interfaces.
# 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.
- `"Filter"`: One or more filters. local-address - The local address. local-bgp-asn -
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
local-gateway-id - The ID of the local gateway. local-gateway-virtual-interface-id - The
ID of the virtual interface. owner-id - The ID of the Amazon Web Services account that
owns the local gateway virtual interface. peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN. vlan - The ID of the VLAN.
- `"LocalGatewayVirtualInterfaceId"`: The IDs of the virtual interfaces.
- `"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 describe_local_gateway_virtual_interfaces(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGatewayVirtualInterfaces";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_local_gateway_virtual_interfaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGatewayVirtualInterfaces",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_local_gateways()
describe_local_gateways(params::Dict{String,<:Any})
Describes one or more local gateways. By default, all local gateways are described.
Alternatively, you can filter the results.
# 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.
- `"Filter"`: One or more filters. local-gateway-id - The ID of a local gateway.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost. owner-id - The ID of the
Amazon Web Services account that owns the local gateway. state - The state of the
association.
- `"LocalGatewayId"`: The IDs of the local gateways.
- `"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 describe_local_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeLocalGateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_local_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLocalGateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_locked_snapshots()
describe_locked_snapshots(params::Dict{String,<:Any})
Describes the lock status for a snapshot.
# 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.
- `"Filter"`: The filters. lock-state - The state of the snapshot lock
(compliance-cooloff | governance | compliance | expired).
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"SnapshotId"`: The IDs of the snapshots for which to view the lock status.
"""
function describe_locked_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeLockedSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_locked_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeLockedSnapshots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_mac_hosts()
describe_mac_hosts(params::Dict{String,<:Any})
Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. availability-zone - The Availability Zone of the EC2 Mac
Dedicated Host. instance-type - The instance type size that the EC2 Mac Dedicated Host
is configured to support.
- `"HostId"`: The IDs of the EC2 Mac Dedicated Hosts.
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results can be seen by sending another request with the returned nextToken
value. This value can be between 5 and 500. If maxResults is given a larger value than 500,
you receive an error.
- `"NextToken"`: The token to use to retrieve the next page of results.
"""
function describe_mac_hosts(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeMacHosts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_mac_hosts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeMacHosts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_managed_prefix_lists()
describe_managed_prefix_lists(params::Dict{String,<:Any})
Describes your managed prefix lists and any Amazon Web Services-managed prefix lists. To
view the entries for your prefix list, use GetManagedPrefixListEntries.
# 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.
- `"Filter"`: One or more filters. owner-id - The ID of the prefix list owner.
prefix-list-id - The ID of the prefix list. prefix-list-name - The name of the prefix
list.
- `"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.
- `"PrefixListId"`: One or more prefix list IDs.
"""
function describe_managed_prefix_lists(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeManagedPrefixLists"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_managed_prefix_lists(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeManagedPrefixLists",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_moving_addresses()
describe_moving_addresses(params::Dict{String,<:Any})
This action is deprecated. Describes your Elastic IP addresses that are being moved from
or being restored to the EC2-Classic platform. This request does not return information
about any other Elastic IP addresses in your account.
# 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.
- `"filter"`: One or more filters. moving-status - The status of the Elastic IP address
(MovingToVpc | RestoringToClassic).
- `"maxResults"`: The maximum number of results to return for the request in a single page.
The remaining results of the initial request can be seen by sending another request with
the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given
a value outside of this range, an error is returned. Default: If no value is provided, the
default is 1000.
- `"nextToken"`: The token for the next page of results.
- `"publicIp"`: One or more Elastic IP addresses.
"""
function describe_moving_addresses(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeMovingAddresses"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_moving_addresses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeMovingAddresses",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_nat_gateways()
describe_nat_gateways(params::Dict{String,<:Any})
Describes your NAT gateways. The default is to describe all your NAT gateways.
Alternatively, you can specify specific NAT gateway IDs or filter the results to include
only the NAT gateways that match specific criteria.
# 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.
- `"Filter"`: The filters. nat-gateway-id - The ID of the NAT gateway. state - The
state of the NAT gateway (pending | failed | available | deleting | deleted). subnet-id
- The ID of the subnet in which the NAT gateway resides. tag:<key> - The key/value
combination of a tag assigned to the resource. Use the tag key in the filter name and the
tag value as the filter value. For example, to find all resources that have a tag with the
key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the
filter value. tag-key - The key of a tag assigned to the resource. Use this filter to
find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
- `"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. For more
information, see Pagination.
- `"NatGatewayId"`: The IDs of the NAT gateways.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_nat_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeNatGateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_nat_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNatGateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_network_acls()
describe_network_acls(params::Dict{String,<:Any})
Describes your network ACLs. The default is to describe all your network ACLs.
Alternatively, you can specify specific network ACL IDs or filter the results to include
only the network ACLs that match specific criteria. For more information, see Network ACLs
in the Amazon VPC User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. association.association-id - The ID of an association ID for
the ACL. association.network-acl-id - The ID of the network ACL involved in the
association. association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC. entry.cidr
- The IPv4 CIDR range specified in the entry. entry.icmp.code - The ICMP code specified
in the entry, if any. entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry. entry.port-range.from -
The start of the port range specified in the entry. entry.port-range.to - The end of
the port range specified in the entry. entry.protocol - The protocol specified in the
entry (tcp | udp | icmp or a protocol number). entry.rule-action - Allows or denies the
matching traffic (allow | deny). entry.egress - A Boolean that indicates the type of
rule. Specify true for egress rules, or false for ingress rules. entry.rule-number - The
number of an entry (in other words, rule) in the set of ACL entries. network-acl-id -
The ID of the network ACL. owner-id - The ID of the Amazon Web Services account that
owns the network ACL. tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value as the filter value. For
example, to find all resources that have a tag with the key Owner and the value TeamA,
specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key
of a tag assigned to the resource. Use this filter to find all resources assigned a tag
with a specific key, regardless of the tag value. vpc-id - The ID of the VPC for the
network ACL.
- `"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. For more
information, see Pagination.
- `"NetworkAclId"`: The IDs of the network ACLs.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"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.
"""
function describe_network_acls(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeNetworkAcls"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_network_acls(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkAcls",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_network_insights_access_scope_analyses()
describe_network_insights_access_scope_analyses(params::Dict{String,<:Any})
Describes the specified Network Access Scope analyses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalysisStartTimeBegin"`: Filters the results based on the start time. The analysis
must have started on or after this time.
- `"AnalysisStartTimeEnd"`: Filters the results based on the start time. The analysis must
have started on or before this time.
- `"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.
- `"Filter"`: There are no supported filters.
- `"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.
- `"NetworkInsightsAccessScopeAnalysisId"`: The IDs of the Network Access Scope analyses.
- `"NetworkInsightsAccessScopeId"`: The ID of the Network Access Scope.
- `"NextToken"`: The token for the next page of results.
"""
function describe_network_insights_access_scope_analyses(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInsightsAccessScopeAnalyses";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_network_insights_access_scope_analyses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInsightsAccessScopeAnalyses",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_network_insights_access_scopes()
describe_network_insights_access_scopes(params::Dict{String,<:Any})
Describes the specified Network Access Scopes.
# 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.
- `"Filter"`: There are no supported filters.
- `"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.
- `"NetworkInsightsAccessScopeId"`: The IDs of the Network Access Scopes.
- `"NextToken"`: The token for the next page of results.
"""
function describe_network_insights_access_scopes(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInsightsAccessScopes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_network_insights_access_scopes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInsightsAccessScopes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_network_insights_analyses()
describe_network_insights_analyses(params::Dict{String,<:Any})
Describes one or more of your network insights analyses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnalysisEndTime"`: The time when the network insights analyses ended.
- `"AnalysisStartTime"`: The time when the network insights analyses started.
- `"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.
- `"Filter"`: The filters. The following are the possible values: path-found - A Boolean
value that indicates whether a feasible path is found. status - The status of the
analysis (running | succeeded | failed).
- `"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.
- `"NetworkInsightsAnalysisId"`: The ID of the network insights analyses. You must specify
either analysis IDs or a path ID.
- `"NetworkInsightsPathId"`: The ID of the path. You must specify either a path ID or
analysis IDs.
- `"NextToken"`: The token for the next page of results.
"""
function describe_network_insights_analyses(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInsightsAnalyses";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_network_insights_analyses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInsightsAnalyses",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_network_insights_paths()
describe_network_insights_paths(params::Dict{String,<:Any})
Describes one or more of your paths.
# 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.
- `"Filter"`: The filters. The following are the possible values: destination - The ID of
the resource. filter-at-source.source-address - The source IPv4 address at the source.
filter-at-source.source-port-range - The source port range at the source.
filter-at-source.destination-address - The destination IPv4 address at the source.
filter-at-source.destination-port-range - The destination port range at the source.
filter-at-destination.source-address - The source IPv4 address at the destination.
filter-at-destination.source-port-range - The source port range at the destination.
filter-at-destination.destination-address - The destination IPv4 address at the
destination. filter-at-destination.destination-port-range - The destination port range at
the destination. protocol - The protocol. source - The ID of the resource.
- `"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.
- `"NetworkInsightsPathId"`: The IDs of the paths.
- `"NextToken"`: The token for the next page of results.
"""
function describe_network_insights_paths(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInsightsPaths";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_network_insights_paths(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInsightsPaths",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_network_interface_attribute(network_interface_id)
describe_network_interface_attribute(network_interface_id, params::Dict{String,<:Any})
Describes a network interface attribute. You can specify only one attribute at a time.
# Arguments
- `network_interface_id`: The ID of the network interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attribute"`: The attribute of the network interface. This parameter is required.
- `"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.
"""
function describe_network_interface_attribute(
networkInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInterfaceAttribute",
Dict{String,Any}("networkInterfaceId" => networkInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_network_interface_attribute(
networkInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeNetworkInterfaceAttribute",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("networkInterfaceId" => networkInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_network_interface_permissions()
describe_network_interface_permissions(params::Dict{String,<:Any})
Describes the permissions for your network interfaces.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: One or more filters.
network-interface-permission.network-interface-permission-id - The ID of the permission.
network-interface-permission.network-interface-id - The ID of the network interface.
network-interface-permission.aws-account-id - The Amazon Web Services account ID.
network-interface-permission.aws-service - The Amazon Web Service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH |
EIP-ASSOCIATE).
- `"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. If this
parameter is not specified, up to 50 results are returned by default. For more information,
see Pagination.
- `"NetworkInterfacePermissionId"`: The network interface permission IDs.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_network_interface_permissions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInterfacePermissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_network_interface_permissions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInterfacePermissions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_network_interfaces()
describe_network_interfaces(params::Dict{String,<:Any})
Describes one or more of your network interfaces. If you have a large number of network
interfaces, the operation fails unless you use pagination or one of the following filters:
group-id, mac-address, private-dns-name, private-ip-address, private-dns-name, subnet-id,
or vpc-id. We strongly recommend using only paginated requests. Unpaginated requests are
susceptible to throttling and timeouts.
# 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. You cannot
specify this parameter and the network interface IDs parameter in the same request. For
more information, see Pagination.
- `"NetworkInterfaceId"`: The network interface IDs. Default: Describes all your network
interfaces.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"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.
- `"filter"`: One or more filters. association.allocation-id - The allocation ID
returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.association-id - The association ID returned when the network interface was
associated with an IPv4 address. addresses.association.owner-id - The owner ID of the
addresses associated with the network interface. addresses.association.public-ip - The
association ID returned when the network interface was associated with the Elastic IP
address (IPv4). addresses.primary - Whether the private IPv4 address is the primary IP
address associated with the network interface. addresses.private-ip-address - The
private IPv4 addresses associated with the network interface. association.ip-owner-id -
The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network
interface. association.public-dns-name - The public DNS name for the network interface
(IPv4). attachment.attach-time - The time that the network interface was attached to an
instance. attachment.attachment-id - The ID of the interface attachment.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an
instance is terminated. attachment.device-index - The device index to which the network
interface is attached. attachment.instance-id - The ID of the instance to which the
network interface is attached. attachment.instance-owner-id - The owner ID of the
instance to which the network interface is attached. attachment.status - The status of
the attachment (attaching | attached | detaching | detached). availability-zone - The
Availability Zone of the network interface. description - The description of the network
interface. group-id - The ID of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed |
aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efs |
gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed |
interface | iot_rules_managed | lambda | load_balancer | nat_gateway |
network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface. network-interface-id - The ID of
the network interface. owner-id - The Amazon Web Services account ID of the network
interface owner. private-dns-name - The private DNS name of the network interface
(IPv4). private-ip-address - The private IPv4 address or addresses of the network
interface. requester-id - The alias or Amazon Web Services account ID of the principal
or service that created the network interface. requester-managed - Indicates whether the
network interface is being managed by an Amazon Web Service (for example, Amazon Web
Services Management Console, Auto Scaling, and so on). source-dest-check - Indicates
whether the network interface performs source/destination checking. A value of true means
checking is enabled, and false means checking is disabled. The value must be false for the
network interface to perform network address translation (NAT) in your VPC. status -
The status of the network interface. If the network interface is not attached to an
instance, the status is available; if a network interface is attached to an instance the
status is in-use. subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
key in the filter name and the tag value as the filter value. For example, to find all
resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the
filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the
resource. Use this filter to find all resources assigned a tag with a specific key,
regardless of the tag value. vpc-id - The ID of the VPC for the network interface.
"""
function describe_network_interfaces(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeNetworkInterfaces"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_network_interfaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeNetworkInterfaces",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_placement_groups()
describe_placement_groups(params::Dict{String,<:Any})
Describes the specified placement groups or all of your placement groups. For more
information, see Placement groups in the Amazon EC2 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. group-name - The name of the placement group. group-arn -
The Amazon Resource Name (ARN) of the placement group. spread-level - The spread level
for the placement group (host | rack). state - The state of the placement group
(pending | available | deleting | deleted). strategy - The strategy of the placement
group (cluster | spread | partition). tag:<key> - The key/value combination of a
tag assigned to the resource. Use the tag key in the filter name and the tag value as the
filter value. For example, to find all resources that have a tag with the key Owner and the
value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
that have a tag with a specific key, regardless of the tag value.
- `"GroupId"`: The IDs of the placement groups.
- `"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.
- `"groupName"`: The names of the placement groups. Default: Describes all your placement
groups, or only those otherwise specified.
"""
function describe_placement_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribePlacementGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_placement_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribePlacementGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_prefix_lists()
describe_prefix_lists(params::Dict{String,<:Any})
Describes available Amazon Web Services services in a prefix list format, which includes
the prefix list name and prefix list ID of the service and the IP address range for the
service. We recommend that you use DescribeManagedPrefixLists instead.
# 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.
- `"Filter"`: One or more filters. prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.
- `"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.
- `"PrefixListId"`: One or more prefix list IDs.
"""
function describe_prefix_lists(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribePrefixLists"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_prefix_lists(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribePrefixLists",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_principal_id_format()
describe_principal_id_format(params::Dict{String,<:Any})
Describes the ID format settings for the root user and all IAM roles and IAM users that
have explicitly specified a longer ID (17-character ID) preference. By default, all IAM
roles and IAM users default to the same ID settings as the root user, unless they
explicitly override the settings. This request is useful for identifying those IAM users
and IAM roles that have overridden the default ID settings. The following resource types
support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options |
elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list | reservation | route-table
| route-table-association | security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway.
# 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.
- `"MaxResults"`: The maximum number of results to return in a single call. To retrieve the
remaining results, make another call with the returned NextToken value.
- `"NextToken"`: The token to request the next page of results.
- `"Resource"`: The type of resource: bundle | conversion-task | customer-gateway |
dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log |
image | import-task | instance | internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list | reservation | route-table
| route-table-association | security-group | snapshot | subnet |
subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway
"""
function describe_principal_id_format(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribePrincipalIdFormat"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_principal_id_format(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribePrincipalIdFormat",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_public_ipv4_pools()
describe_public_ipv4_pools(params::Dict{String,<:Any})
Describes the specified IPv4 address pools.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: One or more filters. tag:<key> - The key/value combination of a tag
assigned to the resource. Use the tag key in the filter name and the tag value as the
filter value. For example, to find all resources that have a tag with the key Owner and the
value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
assigned a tag with a specific key, regardless of the tag value.
- `"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.
- `"PoolId"`: The IDs of the address pools.
"""
function describe_public_ipv4_pools(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribePublicIpv4Pools"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_public_ipv4_pools(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribePublicIpv4Pools",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_regions()
describe_regions(params::Dict{String,<:Any})
Describes the Regions that are enabled for your account, or all Regions. For a list of the
Regions supported by Amazon EC2, see Amazon EC2 service endpoints. For information about
enabling and disabling Regions for your account, see Specify which Amazon Web Services
Regions your account can use in the Amazon Web Services Account Management Reference Guide.
The order of the elements in the response, including those within nested structures, might
vary. Applications should not assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllRegions"`: Indicates whether to display all Regions, including Regions that are
disabled for your account.
- `"Filter"`: The filters. endpoint - The endpoint of the Region (for example,
ec2.us-east-1.amazonaws.com). opt-in-status - The opt-in status of the Region
(opt-in-not-required | opted-in | not-opted-in). region-name - The name of the Region
(for example, us-east-1).
- `"RegionName"`: The names of the Regions. You can specify any Regions, whether they are
enabled and disabled for your account.
- `"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.
"""
function describe_regions(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeRegions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_regions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeRegions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_replace_root_volume_tasks()
describe_replace_root_volume_tasks(params::Dict{String,<:Any})
Describes a root volume replacement task. For more information, see Replace a root volume
in the Amazon EC2 User Guide.
# 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.
- `"Filter"`: Filter to use: instance-id - The ID of the instance for which the root
volume replacement task was created.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"ReplaceRootVolumeTaskId"`: The ID of the root volume replacement task to view.
"""
function describe_replace_root_volume_tasks(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeReplaceRootVolumeTasks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replace_root_volume_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeReplaceRootVolumeTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_instances()
describe_reserved_instances(params::Dict{String,<:Any})
Describes one or more of the Reserved Instances that you purchased. For more information
about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide. The order
of the elements in the response, including those within nested structures, might vary.
Applications should not assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: One or more filters. availability-zone - The Availability Zone where the
Reserved Instance can be used. duration - The duration of the Reserved Instance (one
year or three years), in seconds (31536000 | 94608000). end - The time when the Reserved
Instance expires (for example, 2015-08-07T11:54:42.000Z). fixed-price - The purchase
price of the Reserved Instance (for example, 9800.0). instance-type - The instance type
that is covered by the reservation. scope - The scope of the Reserved Instance (Region
or Availability Zone). product-description - The Reserved Instance product platform
description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web |
Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat
Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL
Server Web | Windows with SQL Server Enterprise). reserved-instances-id - The ID of the
Reserved Instance. start - The time at which the Reserved Instance purchase request was
placed (for example, 2014-08-07T11:54:42.000Z). state - The state of the Reserved
Instance (payment-pending | active | payment-failed | retired). tag:<key> - The
key/value combination of a tag assigned to the resource. Use the tag key in the filter name
and the tag value as the filter value. For example, to find all resources that have a tag
with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for
the filter value. tag-key - The key of a tag assigned to the resource. Use this filter
to find all resources assigned a tag with a specific key, regardless of the tag value.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
- `"OfferingClass"`: Describes whether the Reserved Instance is Standard or Convertible.
- `"ReservedInstancesId"`: One or more Reserved Instance IDs. Default: Describes all your
Reserved Instances, or only those otherwise specified.
- `"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.
- `"offeringType"`: The Reserved Instance offering type. If you are using tools that
predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved
Instance offering type.
"""
function describe_reserved_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeReservedInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_reserved_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeReservedInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_instances_listings()
describe_reserved_instances_listings(params::Dict{String,<:Any})
Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance
capacity that they no longer need with buyers who want to purchase additional capacity.
Reserved Instances bought and sold through the Reserved Instance Marketplace work like any
other Reserved Instances. As a seller, you choose to list some or all of your Reserved
Instances, and you specify the upfront price to receive for them. Your Reserved Instances
are then listed in the Reserved Instance Marketplace and are available for purchase. As a
buyer, you specify the configuration of the Reserved Instance to purchase, and the
Marketplace matches what you're searching for with what's available. The Marketplace first
sells the lowest priced Reserved Instances to you, and continues to sell available Reserved
Instance listings to you until your demand is met. You are charged based on the total price
of all of the listings that you purchase. For more information, see Sell in the Reserved
Instance Marketplace in the Amazon EC2 User Guide. The order of the elements in the
response, including those within nested structures, might vary. Applications should not
assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: One or more filters. reserved-instances-id - The ID of the Reserved
Instances. reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled |
closed). status-message - The reason for the status.
- `"reservedInstancesId"`: One or more Reserved Instance IDs.
- `"reservedInstancesListingId"`: One or more Reserved Instance listing IDs.
"""
function describe_reserved_instances_listings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeReservedInstancesListings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_instances_listings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeReservedInstancesListings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_instances_modifications()
describe_reserved_instances_modifications(params::Dict{String,<:Any})
Describes the modifications made to your Reserved Instances. If no parameter is specified,
information about all your Reserved Instances modification requests is returned. If a
modification ID is specified, only information about the specific modification is returned.
For more information, see Modify Reserved Instances in the Amazon EC2 User Guide. The
order of the elements in the response, including those within nested structures, might
vary. Applications should not assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: One or more filters. client-token - The idempotency token for the
modification request. create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as
part of the modification request. This ID is only available when the status of the
modification is fulfilled. modification-result.target-configuration.availability-zone -
The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved
Instances. modification-result.target-configuration.instance-type - The instance type of
the new Reserved Instances. reserved-instances-id - The ID of the Reserved Instances
modified. reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled
| failed). status-message - The reason for the status. update-date - The time when
the modification request was last updated.
- `"ReservedInstancesModificationId"`: IDs for the submitted modification request.
- `"nextToken"`: The token to retrieve the next page of results.
"""
function describe_reserved_instances_modifications(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeReservedInstancesModifications";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_instances_modifications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeReservedInstancesModifications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_instances_offerings()
describe_reserved_instances_offerings(params::Dict{String,<:Any})
Describes Reserved Instance offerings that are available for purchase. With Reserved
Instances, you purchase the right to launch instances for a period of time. During that
time period, you do not receive insufficient capacity errors, and you pay a lower usage
rate than the rate charged for On-Demand instances for the actual time used. If you have
listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will
be excluded from these results. This is to ensure that you do not purchase your own
Reserved Instances. For more information, see Sell in the Reserved Instance Marketplace in
the Amazon EC2 User Guide. The order of the elements in the response, including those
within nested structures, might vary. Applications should not assume the elements appear in
a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZone"`: The Availability Zone in which the Reserved Instance can be used.
- `"Filter"`: One or more filters. availability-zone - The Availability Zone where the
Reserved Instance can be used. duration - The duration of the Reserved Instance (for
example, one year or three years), in seconds (31536000 | 94608000). fixed-price - The
purchase price of the Reserved Instance (for example, 9800.0). instance-type - The
instance type that is covered by the reservation. marketplace - Set to true to show only
Reserved Instance Marketplace offerings. When this filter is not used, which is the default
behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace
are listed. product-description - The Reserved Instance product platform description
(Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL
Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with
HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows
with SQL Server Enterprise). reserved-instances-offering-id - The Reserved Instances
offering ID. scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
- `"IncludeMarketplace"`: Include Reserved Instance Marketplace offerings in the response.
- `"InstanceType"`: The instance type that the reservation will cover (for example,
m1.small). For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.
- `"MaxDuration"`: The maximum duration (in seconds) to filter when searching for
offerings. Default: 94608000 (3 years)
- `"MaxInstanceCount"`: The maximum number of instances to filter when searching for
offerings. Default: 20
- `"MinDuration"`: The minimum duration (in seconds) to filter when searching for
offerings. Default: 2592000 (1 month)
- `"OfferingClass"`: The offering class of the Reserved Instance. Can be standard or
convertible.
- `"ProductDescription"`: The Reserved Instance product platform description. Instances
that include (Amazon VPC) in the description are for use with Amazon VPC.
- `"ReservedInstancesOfferingId"`: One or more Reserved Instances offering IDs.
- `"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.
- `"instanceTenancy"`: The tenancy of the instances covered by the reservation. A Reserved
Instance with a tenancy of dedicated is applied to instances that run in a VPC on
single-tenant hardware (i.e., Dedicated Instances). Important: The host value cannot be
used with this parameter. Use the default or dedicated values only. Default: default
- `"maxResults"`: The maximum number of results to return for the request in a single page.
The remaining results of the initial request can be seen by sending another request with
the returned NextToken value. The maximum is 100. Default: 100
- `"nextToken"`: The token to retrieve the next page of results.
- `"offeringType"`: The Reserved Instance offering type. If you are using tools that
predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved
Instance offering type.
"""
function describe_reserved_instances_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeReservedInstancesOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_instances_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeReservedInstancesOfferings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_route_tables()
describe_route_tables(params::Dict{String,<:Any})
Describes your route tables. The default is to describe all your route tables.
Alternatively, you can specify specific route table IDs or filter the results to include
only the route tables that match specific criteria. Each subnet in your VPC must be
associated with a route table. If a subnet is not explicitly associated with any route
table, it is implicitly associated with the main route table. This command does not return
the subnet ID for implicit associations. For more information, see Route tables in the
Amazon VPC User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. association.gateway-id - The ID of the gateway involved in
the association. association.route-table-association-id - The ID of an association ID
for the route table. association.route-table-id - The ID of the route table involved in
the association. association.subnet-id - The ID of the subnet involved in the
association. association.main - Indicates whether the route table is the main route
table for the VPC (true | false). Route tables that do not have an association ID are not
returned in the response. owner-id - The ID of the Amazon Web Services account that owns
the route table. route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route
table. route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service
specified in a route in the table. route.egress-only-internet-gateway-id - The ID of an
egress-only Internet gateway specified in a route in the route table. route.gateway-id -
The ID of a gateway specified in a route in the table. route.instance-id - The ID of an
instance specified in a route in the table. route.nat-gateway-id - The ID of a NAT
gateway. route.transit-gateway-id - The ID of a transit gateway. route.origin -
Describes how the route was created. CreateRouteTable indicates that the route was
automatically created when the route table was created; CreateRoute indicates that the
route was manually added to the route table; EnableVgwRoutePropagation indicates that the
route was propagated by route propagation. route.state - The state of a route in the
route table (active | blackhole). The blackhole state indicates that the route's target
isn't available (for example, the specified gateway isn't attached to the VPC, the
specified NAT instance has been terminated, and so on). route.vpc-peering-connection-id
- The ID of a VPC peering connection specified in a route in the table. tag:<key>
- The key/value combination of a tag assigned to the resource. Use the tag key in the
filter name and the tag value as the filter value. For example, to find all resources that
have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name
and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use
this filter to find all resources assigned a tag with a specific key, regardless of the tag
value. vpc-id - The ID of the VPC for the route table.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"RouteTableId"`: The IDs of the route tables.
- `"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.
"""
function describe_route_tables(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeRouteTables"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_route_tables(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeRouteTables",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_scheduled_instance_availability(first_slot_start_time_range, recurrence)
describe_scheduled_instance_availability(first_slot_start_time_range, recurrence, params::Dict{String,<:Any})
Finds available schedules that meet the specified criteria. You can search for an available
schedule no more than 3 months in advance. You must meet the minimum required duration of
1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum
weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours. After you find
a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled
Instances with that schedule.
# Arguments
- `first_slot_start_time_range`: The time period for the first schedule to start.
- `recurrence`: The schedule recurrence.
# 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.
- `"Filter"`: The filters. availability-zone - The Availability Zone (for example,
us-west-2a). instance-type - The instance type (for example, c4.large). platform -
The platform (Linux/UNIX or Windows).
- `"MaxResults"`: The maximum number of results to return in a single call. This value can
be between 5 and 300. The default value is 300. To retrieve the remaining results, make
another call with the returned NextToken value.
- `"MaxSlotDurationInHours"`: The maximum available duration, in hours. This value must be
greater than MinSlotDurationInHours and less than 1,720.
- `"MinSlotDurationInHours"`: The minimum available duration, in hours. The minimum
required duration is 1,200 hours per year. For example, the minimum daily schedule is 4
hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100
hours.
- `"NextToken"`: The token for the next set of results.
"""
function describe_scheduled_instance_availability(
FirstSlotStartTimeRange, Recurrence; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeScheduledInstanceAvailability",
Dict{String,Any}(
"FirstSlotStartTimeRange" => FirstSlotStartTimeRange, "Recurrence" => Recurrence
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_scheduled_instance_availability(
FirstSlotStartTimeRange,
Recurrence,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeScheduledInstanceAvailability",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirstSlotStartTimeRange" => FirstSlotStartTimeRange,
"Recurrence" => Recurrence,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_scheduled_instances()
describe_scheduled_instances(params::Dict{String,<:Any})
Describes the specified Scheduled Instances or all your Scheduled Instances.
# 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.
- `"Filter"`: The filters. availability-zone - The Availability Zone (for example,
us-west-2a). instance-type - The instance type (for example, c4.large). platform -
The platform (Linux/UNIX or Windows).
- `"MaxResults"`: The maximum number of results to return in a single call. This value can
be between 5 and 300. The default value is 100. To retrieve the remaining results, make
another call with the returned NextToken value.
- `"NextToken"`: The token for the next set of results.
- `"ScheduledInstanceId"`: The Scheduled Instance IDs.
- `"SlotStartTimeRange"`: The time period for the first schedule to start.
"""
function describe_scheduled_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeScheduledInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_scheduled_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeScheduledInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_security_group_references(item)
describe_security_group_references(item, params::Dict{String,<:Any})
Describes the VPCs on the other side of a VPC peering connection that are referencing the
security groups you've specified in this request.
# Arguments
- `item`: The IDs of the security groups in your account.
# 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.
- `"GroupId"`: The IDs of the security groups in your account.
"""
function describe_security_group_references(
item; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSecurityGroupReferences",
Dict{String,Any}("item" => item);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_security_group_references(
item, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSecurityGroupReferences",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("item" => item), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_security_group_rules()
describe_security_group_rules(params::Dict{String,<:Any})
Describes one or more of your security group rules.
# 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.
- `"Filter"`: One or more filters. group-id - The ID of the security group.
security-group-rule-id - The ID of the security group rule. tag:<key> - The
key/value combination of a tag assigned to the resource. Use the tag key in the filter name
and the tag value as the filter value. For example, to find all resources that have a tag
with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for
the filter value.
- `"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. This value can
be between 5 and 1000. If this parameter is not specified, then all items are returned. For
more information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"SecurityGroupRuleId"`: The IDs of the security group rules.
"""
function describe_security_group_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeSecurityGroupRules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_security_group_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSecurityGroupRules",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_security_groups()
describe_security_groups(params::Dict{String,<:Any})
Describes the specified security groups or all of your security groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. If using multiple filters for rules, the results include
security groups for which any combination of rules - not necessarily a single rule - match
all filters. description - The description of the security group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP
and UDP protocols, or an ICMP type number. egress.ip-permission.group-id - The ID of a
security group that has been referenced in an outbound security group rule.
egress.ip-permission.group-name - The name of a security group that is referenced in an
outbound security group rule. egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an
outbound security group rule. egress.ip-permission.prefix-list-id - The ID of a prefix
list to which a security group rule allows outbound access.
egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp |
udp | icmp, a protocol number, or -1 for all protocols). egress.ip-permission.to-port -
For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been
referenced in an outbound security group rule. group-id - The ID of the security group.
group-name - The name of the security group. ip-permission.cidr - An IPv4 CIDR block
for an inbound security group rule. ip-permission.from-port - For an inbound rule, the
start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound
security group rule. ip-permission.group-name - The name of a security group that is
referenced in an inbound security group rule. ip-permission.ipv6-cidr - An IPv6 CIDR
block for an inbound security group rule. ip-permission.prefix-list-id - The ID of a
prefix list from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp |
icmp, a protocol number, or -1 for all protocols). ip-permission.to-port - For an
inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced
in an inbound security group rule. owner-id - The Amazon Web Services account ID of the
owner of the security group. tag:<key> - The key/value combination of a tag
assigned to the resource. Use the tag key in the filter name and the tag value as the
filter value. For example, to find all resources that have a tag with the key Owner and the
value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the
VPC specified when the security group was created.
- `"GroupId"`: The IDs of the security groups. Required for security groups in a nondefault
VPC. Default: Describes all of your security groups.
- `"GroupName"`: [Default VPC] The names of the security groups. You can specify either the
security group name or the security group ID. Default: Describes all of your security
groups.
- `"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. This value can
be between 5 and 1000. If this parameter is not specified, then all items are returned. For
more information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"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.
"""
function describe_security_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeSecurityGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_security_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSecurityGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshot_attribute(attribute, snapshot_id)
describe_snapshot_attribute(attribute, snapshot_id, params::Dict{String,<:Any})
Describes the specified attribute of the specified snapshot. You can specify only one
attribute at a time. For more information about EBS snapshots, see Amazon EBS snapshots in
the Amazon EBS User Guide.
# Arguments
- `attribute`: The snapshot attribute you would like to view.
- `snapshot_id`: The ID of the EBS snapshot.
# 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.
"""
function describe_snapshot_attribute(
Attribute, SnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSnapshotAttribute",
Dict{String,Any}("Attribute" => Attribute, "SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_snapshot_attribute(
Attribute,
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeSnapshotAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Attribute" => Attribute, "SnapshotId" => SnapshotId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshot_tier_status()
describe_snapshot_tier_status(params::Dict{String,<:Any})
Describes the storage tier status of one or more Amazon EBS snapshots.
# 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.
- `"Filter"`: The filters. snapshot-id - The snapshot ID. volume-id - The ID of the
volume the snapshot is for. last-tiering-operation - The state of the last archive or
restore action. (archival-in-progress | archival-completed | archival-failed |
permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed |
temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_snapshot_tier_status(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeSnapshotTierStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_snapshot_tier_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSnapshotTierStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshots()
describe_snapshots(params::Dict{String,<:Any})
Describes the specified EBS snapshots available to you or all of the EBS snapshots
available to you. The snapshots available to you include public snapshots, private
snapshots that you own, and private snapshots owned by other Amazon Web Services accounts
for which you have explicit create volume permissions. The create volume permissions fall
into the following categories: public: The owner of the snapshot granted create volume
permissions for the snapshot to the all group. All Amazon Web Services accounts have create
volume permissions for these snapshots. explicit: The owner of the snapshot granted
create volume permissions to a specific Amazon Web Services account. implicit: An Amazon
Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners,
or Amazon Web Services accounts with create volume permissions. If no options are
specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are
returned. If you specify an invalid snapshot ID, an error is returned. If you specify a
snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from
the specified owners and for which you have access are returned. The results can include
the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by
Amazon, or self for snapshots that you own. If you specify a list of restorable users, only
snapshots with create snapshot permissions for those users are returned. You can specify
Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which
you own or have explicit permissions, or all for public snapshots. If you are describing a
long list of snapshots, we recommend that you paginate the output to make the list more
manageable. For more information, see Pagination. To get the state of fast snapshot
restores for a snapshot, use DescribeFastSnapshotRestores. For more information about EBS
snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide. We strongly recommend
using only paginated requests. Unpaginated requests are susceptible to throttling and
timeouts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. description - A description of the snapshot. encrypted -
Indicates whether the snapshot is encrypted (true | false) owner-alias - The owner
alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web
Services account alias set using the IAM console. We recommend that you use the related
parameter instead of this filter. owner-id - The Amazon Web Services account ID of the
owner. We recommend that you use the related parameter instead of this filter. progress
- The progress of the snapshot, as a percentage (for example, 80%). snapshot-id - The
snapshot ID. start-time - The time stamp when the snapshot was initiated. status -
The status of the snapshot (pending | completed | error). storage-tier - The storage
tier of the snapshot (archive | standard). tag:<key> - The key/value combination
of a tag assigned to the resource. Use the tag key in the filter name and the tag value as
the filter value. For example, to find all resources that have a tag with the key Owner and
the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
assigned a tag with a specific key, regardless of the tag value. volume-id - The ID of
the volume the snapshot is for. volume-size - The size of the volume, in GiB.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"Owner"`: Scopes the results to snapshots with the specified owners. You can specify a
combination of Amazon Web Services account IDs, self, and amazon.
- `"RestorableBy"`: The IDs of the Amazon Web Services accounts that can create volumes
from the snapshot.
- `"SnapshotId"`: The snapshot IDs. Default: Describes the snapshots for which you have
create volume permissions.
- `"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.
"""
function describe_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSnapshots", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_spot_datafeed_subscription()
describe_spot_datafeed_subscription(params::Dict{String,<:Any})
Describes the data feed for Spot Instances. For more information, see Spot Instance data
feed in the Amazon EC2 User Guide.
# 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.
"""
function describe_spot_datafeed_subscription(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSpotDatafeedSubscription";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_spot_datafeed_subscription(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSpotDatafeedSubscription",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_spot_fleet_instances(spot_fleet_request_id)
describe_spot_fleet_instances(spot_fleet_request_id, params::Dict{String,<:Any})
Describes the running instances for the specified Spot Fleet.
# Arguments
- `spot_fleet_request_id`: The ID of the Spot Fleet request.
# 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.
- `"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. For more
information, see Pagination.
- `"nextToken"`: The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
"""
function describe_spot_fleet_instances(
spotFleetRequestId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSpotFleetInstances",
Dict{String,Any}("spotFleetRequestId" => spotFleetRequestId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_spot_fleet_instances(
spotFleetRequestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeSpotFleetInstances",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("spotFleetRequestId" => spotFleetRequestId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_spot_fleet_request_history(spot_fleet_request_id, start_time)
describe_spot_fleet_request_history(spot_fleet_request_id, start_time, params::Dict{String,<:Any})
Describes the events for the specified Spot Fleet request during the specified time. Spot
Fleet events are delayed by up to 30 seconds before they can be described. This ensures
that you can query by the last evaluated time and not miss a recorded event. Spot Fleet
events are available for 48 hours. For more information, see Monitor fleet events using
Amazon EventBridge in the Amazon EC2 User Guide.
# Arguments
- `spot_fleet_request_id`: The ID of the Spot Fleet request.
- `start_time`: The starting date and time for the events, in UTC format (for example,
YYYY-MM-DDTHH:MM:SSZ).
# 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.
- `"eventType"`: The type of events to describe. By default, all events are described.
- `"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. For more
information, see Pagination.
- `"nextToken"`: The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
"""
function describe_spot_fleet_request_history(
spotFleetRequestId, startTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSpotFleetRequestHistory",
Dict{String,Any}(
"spotFleetRequestId" => spotFleetRequestId, "startTime" => startTime
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_spot_fleet_request_history(
spotFleetRequestId,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeSpotFleetRequestHistory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"spotFleetRequestId" => spotFleetRequestId, "startTime" => startTime
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_spot_fleet_requests()
describe_spot_fleet_requests(params::Dict{String,<:Any})
Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are
canceled and their instances are terminated.
# 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.
- `"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. For more
information, see Pagination.
- `"nextToken"`: The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
- `"spotFleetRequestId"`: The IDs of the Spot Fleet requests.
"""
function describe_spot_fleet_requests(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeSpotFleetRequests"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_spot_fleet_requests(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSpotFleetRequests",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_spot_instance_requests()
describe_spot_instance_requests(params::Dict{String,<:Any})
Describes the specified Spot Instance requests. You can use DescribeSpotInstanceRequests to
find a running Spot Instance by examining the response. If the status of the Spot Instance
is fulfilled, the instance ID appears in the response and contains the identifier of the
instance. Alternatively, you can use DescribeInstances with a filter to look for instances
where the instance lifecycle is spot. We recommend that you set MaxResults to a value
between 5 and 1000 to limit the number of items returned. This paginates the output, which
makes the list more manageable and returns the items faster. If the list of items exceeds
your MaxResults value, then that number of items is returned along with a NextToken value
that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the
remaining items. Spot Instance requests are deleted four hours after they are canceled and
their instances are terminated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created. fault-code -
The fault code related to the request. fault-message - The fault message related to the
request. instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is
deleted on instance termination. launch.block-device-mapping.device-name - The device
name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 or gp3 for General
Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for
Cold HDD, or standard for Magnetic. launch.group-id - The ID of the security group for
the instance. launch.group-name - The name of the security group for the instance.
launch.image-id - The ID of the AMI. launch.instance-type - The type of instance (for
example, m3.medium). launch.kernel-id - The kernel ID. launch.key-name - The name of
the key pair the instance launched with. launch.monitoring-enabled - Whether detailed
monitoring is enabled for the Spot Instance. launch.ramdisk-id - The RAM disk ID.
launched-availability-zone - The Availability Zone in which the request is launched.
network-interface.addresses.primary - Indicates whether the IP address is the primary
private IP address. network-interface.delete-on-termination - Indicates whether the
network interface is deleted when the instance is terminated.
network-interface.description - A description of the network interface.
network-interface.device-index - The index of the device for the network interface
attachment on the instance. network-interface.group-id - The ID of the security group
associated with the network interface. network-interface.network-interface-id - The ID
of the network interface. network-interface.private-ip-address - The primary private IP
address of the network interface. network-interface.subnet-id - The ID of the subnet for
the instance. product-description - The product description associated with the instance
(Linux/UNIX | Windows). spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the
request. state - The state of the Spot Instance request (open | active | closed |
cancelled | failed). Spot request status information can help you track your Amazon EC2
Spot Instance requests. For more information, see Spot request status in the Amazon EC2
User Guide. status-code - The short code describing the most recent evaluation of your
Spot Instance request. status-message - The message explaining the status of the Spot
Instance request. tag:<key> - The key/value combination of a tag assigned to the
resource. Use the tag key in the filter name and the tag value as the filter value. For
example, to find all resources that have a tag with the key Owner and the value TeamA,
specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key
of a tag assigned to the resource. Use this filter to find all resources assigned a tag
with a specific key, regardless of the tag value. type - The type of Spot Instance
request (one-time | persistent). valid-from - The start date of the request.
valid-until - The end date of the request.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"SpotInstanceRequestId"`: The IDs of the Spot Instance requests.
- `"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.
"""
function describe_spot_instance_requests(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSpotInstanceRequests";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_spot_instance_requests(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSpotInstanceRequests",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_spot_price_history()
describe_spot_price_history(params::Dict{String,<:Any})
Describes the Spot price history. For more information, see Spot Instance pricing history
in the Amazon EC2 User Guide. When you specify a start and end time, the operation returns
the prices of the instance types within that time range. It also returns the last price
change before the start time, which is the effective price as of the start time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. availability-zone - The Availability Zone for which prices
should be returned. instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | Red Hat
Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise
Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)). spot-price - The
Spot price. The value must match exactly (or use wildcards; greater than or less than
comparison is not supported). timestamp - The time stamp of the Spot price history, in
UTC format (for example, ddd MMM dd HH:mm:ss UTC YYYY). You can use wildcards (* and ?).
Greater than or less than comparison is not supported.
- `"InstanceType"`: Filters the results by the specified instance types.
- `"ProductDescription"`: Filters the results by the specified basic product descriptions.
- `"availabilityZone"`: Filters the results by the specified Availability Zone.
- `"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.
- `"endTime"`: The date and time, up to the current date, from which to stop retrieving the
price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
- `"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. For more
information, see Pagination.
- `"nextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"startTime"`: The date and time, up to the past 90 days, from which to start retrieving
the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
"""
function describe_spot_price_history(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeSpotPriceHistory"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_spot_price_history(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSpotPriceHistory",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_stale_security_groups(vpc_id)
describe_stale_security_groups(vpc_id, params::Dict{String,<:Any})
Describes the stale security group rules for security groups in a specified VPC. Rules are
stale when they reference a deleted security group in the same VPC or peered VPC. Rules can
also be stale if they reference a security group in a peer VPC for which the VPC peering
connection has been deleted.
# Arguments
- `vpc_id`: The ID of the VPC.
# 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.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_stale_security_groups(
VpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeStaleSecurityGroups",
Dict{String,Any}("VpcId" => VpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_stale_security_groups(
VpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeStaleSecurityGroups",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("VpcId" => VpcId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_store_image_tasks()
describe_store_image_tasks(params::Dict{String,<:Any})
Describes the progress of the AMI store tasks. You can describe the store tasks for
specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from
the last 31 days. For each AMI task, the response indicates if the task is InProgress,
Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a
percentage. Tasks are listed in reverse chronological order. Currently, only tasks from the
past 31 days can be viewed. To use this API, you must have the required permissions. For
more information, see Permissions for storing and restoring AMIs using Amazon S3 in the
Amazon EC2 User Guide. For more information, see Store and restore an AMI using Amazon S3
in the Amazon EC2 User Guide.
# 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.
- `"Filter"`: The filters. task-state - Returns tasks in a certain state (InProgress |
Completed | Failed) bucket - Returns task information for tasks that targeted a specific
bucket. For the filter value, specify the bucket name. When you specify the ImageIds
parameter, any filters that you specify are ignored. To use the filters, you must remove
the ImageIds parameter.
- `"ImageId"`: The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in
a request.
- `"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. For more
information, see Pagination. You cannot specify this parameter and the ImageIds parameter
in the same call.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_store_image_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeStoreImageTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_store_image_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeStoreImageTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_subnets()
describe_subnets(params::Dict{String,<:Any})
Describes your subnets. The default is to describe all your subnets. Alternatively, you can
specify specific subnet IDs or filter the results to include only the subnets that match
specific criteria. For more information, see Subnets in the Amazon VPC User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. availability-zone - The Availability Zone for the subnet. You
can also use availabilityZone as the filter name. availability-zone-id - The ID of the
Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are
available. cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify
must exactly match the subnet's CIDR block for information to be returned for the subnet.
You can also use cidr or cidrBlock as the filter names. customer-owned-ipv4-pool - The
customer-owned IPv4 address pool associated with the subnet. default-for-az - Indicates
whether this is the default subnet for the Availability Zone (true | false). You can also
use defaultForAz as the filter name. enable-dns64 - Indicates whether DNS queries made
to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses
for IPv4-only destinations. enable-lni-at-device-index - Indicates the device position
for local network interfaces in this subnet. For example, 1 indicates local network
interfaces in this subnet are the secondary network interface (eth1).
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the
subnet. ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR
block associated with the subnet. ipv6-cidr-block-association.state - The state of an
IPv6 CIDR block associated with the subnet. ipv6-native - Indicates whether this is an
IPv6 only subnet (true | false). map-customer-owned-ip-on-launch - Indicates whether a
network interface created in this subnet (including a network interface created by
RunInstances) receives a customer-owned IPv4 address. map-public-ip-on-launch -
Indicates whether instances launched in this subnet receive a public IPv4 address.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost. owner-id - The ID of the
Amazon Web Services account that owns the subnet.
private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to
instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an
instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID
(resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance
ID (resource-name). private-dns-name-options-on-launch.enable-resource-name-dns-a-record
- Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether
to respond to DNS queries for instance hostnames with DNS AAAA records. state - The
state of the subnet (pending | available). subnet-arn - The Amazon Resource Name (ARN)
of the subnet. subnet-id - The ID of the subnet. tag:<key> - The key/value
combination of a tag assigned to the resource. Use the tag key in the filter name and the
tag value as the filter value. For example, to find all resources that have a tag with the
key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the
filter value. tag-key - The key of a tag assigned to the resource. Use this filter to
find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the subnet.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"SubnetId"`: The IDs of the subnets. Default: Describes all your subnets.
- `"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.
"""
function describe_subnets(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeSubnets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_subnets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeSubnets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_tags()
describe_tags(params::Dict{String,<:Any})
Describes the specified tags for your EC2 resources. For more information about tags, see
Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. We strongly
recommend using only paginated requests. Unpaginated requests are susceptible to throttling
and timeouts. The order of the elements in the response, including those within nested
structures, might vary. Applications should not assume the elements appear in a particular
order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. key - The tag key. resource-id - The ID of the resource.
resource-type - The resource type. For a list of possible values, see TagSpecification.
tag:<key> - The key/value combination of the tag. For example, specify \"tag:Owner\"
for the filter name and \"TeamA\" for the filter value to find resources with the tag
\"Owner=TeamA\". value - The tag value.
- `"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.
- `"maxResults"`: The maximum number of items to return for this request. This value can be
between 5 and 1000. To get the next page of items, make another request with the token
returned in the output. For more information, see Pagination.
- `"nextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_tags(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeTags"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_tags(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTags", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_traffic_mirror_filter_rules()
describe_traffic_mirror_filter_rules(params::Dict{String,<:Any})
Describe traffic mirror filters that determine the traffic that is mirrored.
# 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.
- `"Filter"`: Traffic mirror filters. traffic-mirror-filter-rule-id: The ID of the
Traffic Mirror rule. traffic-mirror-filter-id: The ID of the filter that this rule is
associated with. rule-number: The number of the Traffic Mirror rule. rule-action: The
action taken on the filtered traffic. Possible actions are accept and reject.
traffic-direction: The traffic direction. Possible directions are ingress and egress.
protocol: The protocol, for example UDP, assigned to the Traffic Mirror rule.
source-cidr-block: The source CIDR block assigned to the Traffic Mirror rule.
destination-cidr-block: The destination CIDR block assigned to the Traffic Mirror rule.
description: The description of the Traffic Mirror rule.
- `"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.
- `"TrafficMirrorFilterId"`: Traffic filter ID.
- `"TrafficMirrorFilterRuleId"`: Traffic filter rule IDs.
"""
function describe_traffic_mirror_filter_rules(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTrafficMirrorFilterRules";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_traffic_mirror_filter_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTrafficMirrorFilterRules",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_traffic_mirror_filters()
describe_traffic_mirror_filters(params::Dict{String,<:Any})
Describes one or more Traffic Mirror filters.
# 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.
- `"Filter"`: One or more filters. The possible values are: description: The Traffic
Mirror filter description. traffic-mirror-filter-id: The ID of the Traffic Mirror
filter.
- `"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.
- `"TrafficMirrorFilterId"`: The ID of the Traffic Mirror filter.
"""
function describe_traffic_mirror_filters(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTrafficMirrorFilters";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_traffic_mirror_filters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTrafficMirrorFilters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_traffic_mirror_sessions()
describe_traffic_mirror_sessions(params::Dict{String,<:Any})
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are
described. Alternatively, you can filter the results.
# 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.
- `"Filter"`: One or more filters. The possible values are: description: The Traffic
Mirror session description. network-interface-id: The ID of the Traffic Mirror session
network interface. owner-id: The ID of the account that owns the Traffic Mirror session.
packet-length: The assigned number of packets to mirror. session-number: The
assigned session number. traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
traffic-mirror-session-id: The ID of the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target. virtual-network-id: The
virtual network ID of the Traffic Mirror session.
- `"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.
- `"TrafficMirrorSessionId"`: The ID of the Traffic Mirror session.
"""
function describe_traffic_mirror_sessions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTrafficMirrorSessions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_traffic_mirror_sessions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTrafficMirrorSessions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_traffic_mirror_targets()
describe_traffic_mirror_targets(params::Dict{String,<:Any})
Information about one or more Traffic Mirror targets.
# 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.
- `"Filter"`: One or more filters. The possible values are: description: The Traffic
Mirror target description. network-interface-id: The ID of the Traffic Mirror session
network interface. network-load-balancer-arn: The Amazon Resource Name (ARN) of the
Network Load Balancer that is associated with the session. owner-id: The ID of the
account that owns the Traffic Mirror session. traffic-mirror-target-id: The ID of the
Traffic Mirror target.
- `"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.
- `"TrafficMirrorTargetId"`: The ID of the Traffic Mirror targets.
"""
function describe_traffic_mirror_targets(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTrafficMirrorTargets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_traffic_mirror_targets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTrafficMirrorTargets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transit_gateway_attachments()
describe_transit_gateway_attachments(params::Dict{String,<:Any})
Describes one or more attachments between resources and transit gateways. By default, all
attachments are described. Alternatively, you can filter the results by attachment ID,
attachment state, resource ID, or resource owner.
# 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.
- `"Filter"`: One or more filters. The possible values are: association.state - The
state of the association (associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit
gateway. resource-id - The ID of the resource. resource-owner-id - The ID of the
Amazon Web Services account that owns the resource. resource-type - The resource type.
Valid values are vpc | vpn | direct-connect-gateway | peering | connect. state - The
state of the attachment. Valid values are available | deleted | deleting | failed | failing
| initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected |
rejecting. transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway. transit-gateway-owner-id - The ID of
the Amazon Web Services account that owns the transit gateway.
- `"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.
- `"TransitGatewayAttachmentIds"`: The IDs of the attachments.
"""
function describe_transit_gateway_attachments(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayAttachments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transit_gateway_attachments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayAttachments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transit_gateway_connect_peers()
describe_transit_gateway_connect_peers(params::Dict{String,<:Any})
Describes one or more Connect peers.
# 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.
- `"Filter"`: One or more filters. The possible values are: state - The state of the
Connect peer (pending | available | deleting | deleted). transit-gateway-attachment-id -
The ID of the attachment. transit-gateway-connect-peer-id - The ID of the Connect peer.
- `"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.
- `"TransitGatewayConnectPeerIds"`: The IDs of the Connect peers.
"""
function describe_transit_gateway_connect_peers(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayConnectPeers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transit_gateway_connect_peers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayConnectPeers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transit_gateway_connects()
describe_transit_gateway_connects(params::Dict{String,<:Any})
Describes one or more Connect attachments.
# 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.
- `"Filter"`: One or more filters. The possible values are: options.protocol - The
tunnel protocol (gre). state - The state of the attachment (initiating |
initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying |
deleting | deleted | failed | rejected | rejecting | failing).
transit-gateway-attachment-id - The ID of the Connect attachment. transit-gateway-id -
The ID of the transit gateway. transport-transit-gateway-attachment-id - The ID of the
transit gateway attachment from which the Connect attachment was created.
- `"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.
- `"TransitGatewayAttachmentIds"`: The IDs of the attachments.
"""
function describe_transit_gateway_connects(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayConnects";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transit_gateway_connects(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayConnects",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transit_gateway_multicast_domains()
describe_transit_gateway_multicast_domains(params::Dict{String,<:Any})
Describes one or more transit gateway multicast domains.
# 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.
- `"Filter"`: One or more filters. The possible values are: state - The state of the
transit gateway multicast domain. Valid values are pending | available | deleting |
deleted. transit-gateway-id - The ID of the transit gateway.
transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
- `"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.
- `"TransitGatewayMulticastDomainIds"`: The ID of the transit gateway multicast domain.
"""
function describe_transit_gateway_multicast_domains(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayMulticastDomains";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transit_gateway_multicast_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayMulticastDomains",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transit_gateway_peering_attachments()
describe_transit_gateway_peering_attachments(params::Dict{String,<:Any})
Describes your transit gateway peering attachments.
# 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.
- `"Filter"`: One or more filters. The possible values are:
transit-gateway-attachment-id - The ID of the transit gateway attachment. local-owner-id
- The ID of your Amazon Web Services account. remote-owner-id - The ID of the Amazon Web
Services account in the remote Region that owns the transit gateway. state - The state
of the peering attachment. Valid values are available | deleted | deleting | failed |
failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack |
rejected | rejecting). tag:<key> - The key/value combination of a tag assigned to
the resource. Use the tag key in the filter name and the tag value as the filter value. For
example, to find all resources that have a tag with the key Owner and the value TeamA,
specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key
of a tag assigned to the resource. Use this filter to find all resources that have a tag
with a specific key, regardless of the tag value. transit-gateway-id - The ID of the
transit gateway.
- `"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.
- `"TransitGatewayAttachmentIds"`: One or more IDs of the transit gateway peering
attachments.
"""
function describe_transit_gateway_peering_attachments(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayPeeringAttachments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transit_gateway_peering_attachments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayPeeringAttachments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transit_gateway_policy_tables()
describe_transit_gateway_policy_tables(params::Dict{String,<:Any})
Describes one or more transit gateway route policy tables.
# 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.
- `"Filter"`: The filters associated with the transit gateway policy table.
- `"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.
- `"TransitGatewayPolicyTableIds"`: The IDs of the transit gateway policy tables.
"""
function describe_transit_gateway_policy_tables(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayPolicyTables";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transit_gateway_policy_tables(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayPolicyTables",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transit_gateway_route_table_announcements()
describe_transit_gateway_route_table_announcements(params::Dict{String,<:Any})
Describes one or more transit gateway route table advertisements.
# 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.
- `"Filter"`: The filters associated with the transit gateway policy table.
- `"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.
- `"TransitGatewayRouteTableAnnouncementIds"`: The IDs of the transit gateway route tables
that are being advertised.
"""
function describe_transit_gateway_route_table_announcements(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayRouteTableAnnouncements";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transit_gateway_route_table_announcements(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayRouteTableAnnouncements",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transit_gateway_route_tables()
describe_transit_gateway_route_tables(params::Dict{String,<:Any})
Describes one or more transit gateway route tables. By default, all transit gateway route
tables are described. Alternatively, you can filter the results.
# 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.
- `"Filter"`: One or more filters. The possible values are:
default-association-route-table - Indicates whether this is the default association route
table for the transit gateway (true | false). default-propagation-route-table -
Indicates whether this is the default propagation route table for the transit gateway (true
| false). state - The state of the route table (available | deleting | deleted |
pending). transit-gateway-id - The ID of the transit gateway.
transit-gateway-route-table-id - The ID of the transit gateway route table.
- `"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.
- `"TransitGatewayRouteTableIds"`: The IDs of the transit gateway route tables.
"""
function describe_transit_gateway_route_tables(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayRouteTables";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transit_gateway_route_tables(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayRouteTables",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transit_gateway_vpc_attachments()
describe_transit_gateway_vpc_attachments(params::Dict{String,<:Any})
Describes one or more VPC attachments. By default, all VPC attachments are described.
Alternatively, you can filter the results.
# 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.
- `"Filter"`: One or more filters. The possible values are: state - The state of the
attachment. Valid values are available | deleted | deleting | failed | failing |
initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected |
rejecting. transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway. vpc-id - The ID of the VPC.
- `"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.
- `"TransitGatewayAttachmentIds"`: The IDs of the attachments.
"""
function describe_transit_gateway_vpc_attachments(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayVpcAttachments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_transit_gateway_vpc_attachments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGatewayVpcAttachments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_transit_gateways()
describe_transit_gateways(params::Dict{String,<:Any})
Describes one or more transit gateways. By default, all transit gateways are described.
Alternatively, you can filter the results.
# 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.
- `"Filter"`: One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance
of attachment requests (enable | disable). options.default-route-table-association -
Indicates whether resource attachments are automatically associated with the default
association route table (enable | disable). options.default-route-table-propagation -
Indicates whether resource attachments automatically propagate routes to the default
propagation route table (enable | disable). options.dns-support - Indicates whether DNS
support is enabled (enable | disable). options.vpn-ecmp-support - Indicates whether
Equal Cost Multipath Protocol support is enabled (enable | disable). owner-id - The ID
of the Amazon Web Services account that owns the transit gateway. state - The state of
the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway. tag-key - The key/value combination
of a tag assigned to the resource. Use the tag key in the filter name and the tag value as
the filter value. For example, to find all resources that have a tag with the key Owner and
the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- `"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.
- `"TransitGatewayIds"`: The IDs of the transit gateways.
"""
function describe_transit_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeTransitGateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_transit_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTransitGateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trunk_interface_associations()
describe_trunk_interface_associations(params::Dict{String,<:Any})
Describes one or more network interface trunk associations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationId"`: The IDs of the associations.
- `"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.
- `"Filter"`: One or more filters. gre-key - The ID of a trunk interface association.
interface-protocol - The interface protocol. Valid values are VLAN and GRE.
- `"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 describe_trunk_interface_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTrunkInterfaceAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_trunk_interface_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeTrunkInterfaceAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_verified_access_endpoints()
describe_verified_access_endpoints(params::Dict{String,<:Any})
Describes the specified Amazon Web Services Verified Access endpoints.
# 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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
- `"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.
- `"VerifiedAccessEndpointId"`: The ID of the Verified Access endpoint.
- `"VerifiedAccessGroupId"`: The ID of the Verified Access group.
- `"VerifiedAccessInstanceId"`: The ID of the Verified Access instance.
"""
function describe_verified_access_endpoints(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVerifiedAccessEndpoints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_verified_access_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVerifiedAccessEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_verified_access_groups()
describe_verified_access_groups(params::Dict{String,<:Any})
Describes the specified Verified Access groups.
# 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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
- `"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.
- `"VerifiedAccessGroupId"`: The ID of the Verified Access groups.
- `"VerifiedAccessInstanceId"`: The ID of the Verified Access instance.
"""
function describe_verified_access_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVerifiedAccessGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_verified_access_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVerifiedAccessGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_verified_access_instance_logging_configurations()
describe_verified_access_instance_logging_configurations(params::Dict{String,<:Any})
Describes the specified Amazon Web Services Verified Access instances.
# 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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
- `"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.
- `"VerifiedAccessInstanceId"`: The IDs of the Verified Access instances.
"""
function describe_verified_access_instance_logging_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVerifiedAccessInstanceLoggingConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_verified_access_instance_logging_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVerifiedAccessInstanceLoggingConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_verified_access_instances()
describe_verified_access_instances(params::Dict{String,<:Any})
Describes the specified Amazon Web Services Verified Access instances.
# 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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
- `"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.
- `"VerifiedAccessInstanceId"`: The IDs of the Verified Access instances.
"""
function describe_verified_access_instances(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVerifiedAccessInstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_verified_access_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVerifiedAccessInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_verified_access_trust_providers()
describe_verified_access_trust_providers(params::Dict{String,<:Any})
Describes the specified Amazon Web Services Verified Access trust providers.
# 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.
- `"Filter"`: One or more filters. Filter names and values are case-sensitive.
- `"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.
- `"VerifiedAccessTrustProviderId"`: The IDs of the Verified Access trust providers.
"""
function describe_verified_access_trust_providers(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVerifiedAccessTrustProviders";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_verified_access_trust_providers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVerifiedAccessTrustProviders",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_volume_attribute(attribute, volume_id)
describe_volume_attribute(attribute, volume_id, params::Dict{String,<:Any})
Describes the specified attribute of the specified volume. You can specify only one
attribute at a time. For more information about EBS volumes, see Amazon EBS volumes in the
Amazon EBS User Guide.
# Arguments
- `attribute`: The attribute of the volume. This parameter is required.
- `volume_id`: The ID of the volume.
# 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.
"""
function describe_volume_attribute(
Attribute, VolumeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVolumeAttribute",
Dict{String,Any}("Attribute" => Attribute, "VolumeId" => VolumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_volume_attribute(
Attribute,
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeVolumeAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Attribute" => Attribute, "VolumeId" => VolumeId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_volume_status()
describe_volume_status(params::Dict{String,<:Any})
Describes the status of the specified volumes. Volume status provides the result of the
checks performed on your volumes to determine events that can impair the performance of
your volumes. The performance of a volume can be affected if an issue occurs on the
volume's underlying host. If the volume's underlying host experiences a power outage or
system issue, after the system is restored, there could be data inconsistencies on the
volume. Volume events notify you if this occurs. Volume actions notify you if any action
needs to be taken in response to the event. The DescribeVolumeStatus operation provides the
following information about the specified volumes: Status: Reflects the current status of
the volume. The possible values are ok, impaired , warning, or insufficient-data. If all
checks pass, the overall status of the volume is ok. If the check fails, the overall status
is impaired. If the status is insufficient-data, then the checks might still be taking
place on your volume at the time. We recommend that you retry the request. For more
information about volume status, see Monitor the status of your volumes in the Amazon EBS
User Guide. Events: Reflect the cause of a volume status and might require you to take
action. For example, if your volume returns an impaired status, then the volume event might
be potential-data-inconsistency. This means that your volume has been affected by an issue
with the underlying host, has all I/O operations disabled, and might have inconsistent
data. Actions: Reflect the actions you might have to take in response to an event. For
example, if the status of the volume is impaired and the volume event shows
potential-data-inconsistency, then the action shows enable-volume-io. This means that you
may want to enable the I/O operations for the volume by calling the EnableVolumeIO action
and then check the volume for data consistency. Volume status is based on the volume status
checks, and does not reflect the volume state. Therefore, volume status does not indicate
volumes in the error state (for example, when a volume is incapable of accepting I/O.) The
order of the elements in the response, including those within nested structures, might
vary. Applications should not assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. action.code - The action code for the event (for example,
enable-volume-io). action.description - A description of the action. action.event-id
- The event ID associated with the action. availability-zone - The Availability Zone of
the instance. event.description - A description of the event. event.event-id - The
event ID. event.event-type - The event type (for io-enabled: passed | failed; for
io-performance: io-performance:degraded | io-performance:severely-degraded |
io-performance:stalled). event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event. volume-status.details-name -
The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled:
passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning |
insufficient-data).
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"VolumeId"`: The IDs of the volumes. Default: Describes all your volumes.
- `"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.
"""
function describe_volume_status(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeVolumeStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_volume_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVolumeStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_volumes()
describe_volumes(params::Dict{String,<:Any})
Describes the specified EBS volumes or all of your EBS volumes. If you are describing a
long list of volumes, we recommend that you paginate the output to make the list more
manageable. For more information, see Pagination. For more information about EBS volumes,
see Amazon EBS volumes in the Amazon EBS User Guide. We strongly recommend using only
paginated requests. Unpaginated requests are susceptible to throttling and timeouts. The
order of the elements in the response, including those within nested structures, might
vary. Applications should not assume the elements appear in a particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. attachment.attach-time - The time stamp when the attachment
initiated. attachment.delete-on-termination - Whether the volume is deleted on instance
termination. attachment.device - The device name specified in the block device mapping
(for example, /dev/sda1). attachment.instance-id - The ID of the instance the volume is
attached to. attachment.status - The attachment state (attaching | attached |
detaching). availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created. encrypted - Indicates whether
the volume is encrypted (true | false) multi-attach-enabled - Indicates whether the
volume is enabled for Multi-Attach (true | false) fast-restored - Indicates whether the
volume was created from a snapshot that is enabled for fast snapshot restore (true |
false). size - The size of the volume, in GiB. snapshot-id - The snapshot from which
the volume was created. status - The state of the volume (creating | available | in-use
| deleting | deleted | error). tag:<key> - The key/value combination of a tag
assigned to the resource. Use the tag key in the filter name and the tag value as the
filter value. For example, to find all resources that have a tag with the key Owner and the
value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
assigned a tag with a specific key, regardless of the tag value. volume-id - The volume
ID. volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1|
standard)
- `"VolumeId"`: The volume IDs.
- `"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.
- `"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. For more
information, see Pagination.
- `"nextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_volumes(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeVolumes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_volumes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVolumes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_volumes_modifications()
describe_volumes_modifications(params::Dict{String,<:Any})
Describes the most recent volume modification request for the specified EBS volumes. If a
volume has never been modified, some information in the output will be null. If a volume
has been modified more than once, the output includes only the most recent modification
request. For more information, see Monitor the progress of volume modifications in the
Amazon EBS User Guide.
# 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.
- `"Filter"`: The filters. modification-state - The current modification state
(modifying | optimizing | completed | failed). original-iops - The original IOPS rate of
the volume. original-size - The original size of the volume, in GiB.
original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 |
sc1 | st1). originalMultiAttachEnabled - Indicates whether Multi-Attach support was
enabled (true | false). start-time - The modification start time. target-iops - The
target IOPS rate of the volume. target-size - The target size of the volume, in GiB.
target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1
| st1). targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be
enabled (true | false). volume-id - The ID of the volume.
- `"MaxResults"`: The maximum number of results (up to a limit of 500) to be returned in a
paginated request. For more information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"VolumeId"`: The IDs of the volumes.
"""
function describe_volumes_modifications(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeVolumesModifications";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_volumes_modifications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVolumesModifications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_attribute(attribute, vpc_id)
describe_vpc_attribute(attribute, vpc_id, params::Dict{String,<:Any})
Describes the specified attribute of the specified VPC. You can specify only one attribute
at a time.
# Arguments
- `attribute`: The VPC attribute.
- `vpc_id`: The ID of the VPC.
# 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.
"""
function describe_vpc_attribute(
Attribute, VpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcAttribute",
Dict{String,Any}("Attribute" => Attribute, "VpcId" => VpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_attribute(
Attribute,
VpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeVpcAttribute",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Attribute" => Attribute, "VpcId" => VpcId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_classic_link()
describe_vpc_classic_link(params::Dict{String,<:Any})
This action is deprecated. Describes the ClassicLink status of the specified VPCs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. is-classic-link-enabled - Whether the VPC is enabled for
ClassicLink (true | false). tag:<key> - The key/value combination of a tag
assigned to the resource. Use the tag key in the filter name and the tag value as the
filter value. For example, to find all resources that have a tag with the key Owner and the
value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
assigned a tag with a specific key, regardless of the tag value.
- `"VpcId"`: The VPCs for which you want to describe the ClassicLink status.
- `"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.
"""
function describe_vpc_classic_link(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeVpcClassicLink"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_vpc_classic_link(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcClassicLink",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_classic_link_dns_support()
describe_vpc_classic_link_dns_support(params::Dict{String,<:Any})
This action is deprecated. Describes the ClassicLink DNS support status of one or more
VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private
IP address when addressed from an instance in the VPC to which it's linked. Similarly, the
DNS hostname of an instance in a VPC resolves to its private IP address when addressed from
a linked EC2-Classic instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"VpcIds"`: The IDs of the VPCs.
- `"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. For more
information, see Pagination.
- `"nextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function describe_vpc_classic_link_dns_support(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcClassicLinkDnsSupport";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_classic_link_dns_support(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcClassicLinkDnsSupport",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_endpoint_connection_notifications()
describe_vpc_endpoint_connection_notifications(params::Dict{String,<:Any})
Describes the connection notifications for VPC endpoints and VPC endpoint services.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionNotificationId"`: The ID of the notification.
- `"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.
- `"Filter"`: The filters. connection-notification-arn - The ARN of the SNS topic for
the notification. connection-notification-id - The ID of the notification.
connection-notification-state - The state of the notification (Enabled | Disabled).
connection-notification-type - The type of notification (Topic). service-id - The ID of
the endpoint service. vpc-endpoint-id - The ID of the VPC endpoint.
- `"MaxResults"`: The maximum number of results to return in a single call. To retrieve the
remaining results, make another request with the returned NextToken value.
- `"NextToken"`: The token to request the next page of results.
"""
function describe_vpc_endpoint_connection_notifications(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcEndpointConnectionNotifications";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_endpoint_connection_notifications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcEndpointConnectionNotifications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_endpoint_connections()
describe_vpc_endpoint_connections(params::Dict{String,<:Any})
Describes the VPC endpoint connections to your VPC endpoint services, including any
endpoints that are pending your acceptance.
# 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.
- `"Filter"`: The filters. ip-address-type - The IP address type (ipv4 | ipv6).
service-id - The ID of the service. vpc-endpoint-owner - The ID of the Amazon Web
Services account ID that owns the endpoint. vpc-endpoint-state - The state of the
endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected |
failed). vpc-endpoint-id - The ID of the endpoint.
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results of the initial request can be seen by sending another request with
the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given
a value larger than 1,000, only 1,000 results are returned.
- `"NextToken"`: The token to retrieve the next page of results.
"""
function describe_vpc_endpoint_connections(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcEndpointConnections";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_endpoint_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcEndpointConnections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_endpoint_service_configurations()
describe_vpc_endpoint_service_configurations(params::Dict{String,<:Any})
Describes the VPC endpoint service configurations in your account (your services).
# 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.
- `"Filter"`: The filters. service-name - The name of the service. service-id - The
ID of the service. service-state - The state of the service (Pending | Available |
Deleting | Deleted | Failed). supported-ip-address-types - The IP address type (ipv4 |
ipv6). tag:<key> - The key/value combination of a tag assigned to the resource.
Use the tag key in the filter name and the tag value as the filter value. For example, to
find all resources that have a tag with the key Owner and the value TeamA, specify
tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag
assigned to the resource. Use this filter to find all resources assigned a tag with a
specific key, regardless of the tag value.
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results of the initial request can be seen by sending another request with
the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given
a value larger than 1,000, only 1,000 results are returned.
- `"NextToken"`: The token to retrieve the next page of results.
- `"ServiceId"`: The IDs of the endpoint services.
"""
function describe_vpc_endpoint_service_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcEndpointServiceConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_endpoint_service_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcEndpointServiceConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_endpoint_service_permissions(service_id)
describe_vpc_endpoint_service_permissions(service_id, params::Dict{String,<:Any})
Describes the principals (service consumers) that are permitted to discover your VPC
endpoint service.
# Arguments
- `service_id`: The ID of the service.
# 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.
- `"Filter"`: The filters. principal - The ARN of the principal. principal-type - The
principal type (All | Service | OrganizationUnit | Account | User | Role).
- `"MaxResults"`: The maximum number of results to return for the request in a single page.
The remaining results of the initial request can be seen by sending another request with
the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given
a value larger than 1,000, only 1,000 results are returned.
- `"NextToken"`: The token to retrieve the next page of results.
"""
function describe_vpc_endpoint_service_permissions(
ServiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcEndpointServicePermissions",
Dict{String,Any}("ServiceId" => ServiceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_endpoint_service_permissions(
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DescribeVpcEndpointServicePermissions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceId" => ServiceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_endpoint_services()
describe_vpc_endpoint_services(params::Dict{String,<:Any})
Describes available services to which you can create a VPC endpoint. When the service
provider and the consumer have different accounts in multiple Availability Zones, and the
consumer views the VPC endpoint service information, the response only includes the common
Availability Zones. For example, when the service provider account uses us-east-1a and
us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC
endpoint services in the common Availability Zone, us-east-1a.
# 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.
- `"Filter"`: The filters. owner - The ID or alias of the Amazon Web Services account
that owns the service. service-name - The name of the service. service-type - The
type of service (Interface | Gateway | GatewayLoadBalancer). supported-ip-address-types
- The IP address type (ipv4 | ipv6). tag:<key> - The key/value combination of a
tag assigned to the resource. Use the tag key in the filter name and the tag value as the
filter value. For example, to find all resources that have a tag with the key Owner and the
value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
assigned a tag with a specific key, regardless of the tag value.
- `"MaxResults"`: The maximum number of items to return for this request. The request
returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a prior call.)
- `"ServiceName"`: The service names.
"""
function describe_vpc_endpoint_services(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeVpcEndpointServices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_endpoint_services(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcEndpointServices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_endpoints()
describe_vpc_endpoints(params::Dict{String,<:Any})
Describes your VPC endpoints. The default is to describe all your VPC endpoints.
Alternatively, you can specify specific VPC endpoint IDs or filter the results to include
only the VPC endpoints that match specific criteria.
# 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.
- `"Filter"`: The filters. ip-address-type - The IP address type (ipv4 | ipv6).
service-name - The name of the service. tag:<key> - The key/value combination of a
tag assigned to the resource. Use the tag key in the filter name and the tag value as the
filter value. For example, to find all resources that have a tag with the key Owner and the
value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the
VPC in which the endpoint resides. vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available |
deleting | deleted | rejected | failed). vpc-endpoint-type - The type of VPC endpoint
(Interface | Gateway | GatewayLoadBalancer).
- `"MaxResults"`: The maximum number of items to return for this request. The request
returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
- `"NextToken"`: The token for the next set of items to return. (You received this token
from a prior call.)
- `"VpcEndpointId"`: The IDs of the VPC endpoints.
"""
function describe_vpc_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeVpcEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_vpc_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_peering_connections()
describe_vpc_peering_connections(params::Dict{String,<:Any})
Describes your VPC peering connections. The default is to describe all your VPC peering
connections. Alternatively, you can specify specific VPC peering connection IDs or filter
the results to include only the VPC peering connections that match specific criteria.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. accepter-vpc-info.cidr-block - The IPv4 CIDR block of the
accepter VPC. accepter-vpc-info.owner-id - The ID of the Amazon Web Services account
that owns the accepter VPC. accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the
requester VPC. requester-vpc-info.vpc-id - The ID of the requester VPC. status-code -
The status of the VPC peering connection (pending-acceptance | failed | expired |
provisioning | active | deleting | deleted | rejected). status-message - A message that
provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
key in the filter name and the tag value as the filter value. For example, to find all
resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the
filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the
resource. Use this filter to find all resources assigned a tag with a specific key,
regardless of the tag value. vpc-peering-connection-id - The ID of the VPC peering
connection.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"VpcPeeringConnectionId"`: The IDs of the VPC peering connections. Default: Describes
all your VPC peering connections.
- `"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.
"""
function describe_vpc_peering_connections(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcPeeringConnections";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_peering_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcPeeringConnections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpcs()
describe_vpcs(params::Dict{String,<:Any})
Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can
specify specific VPC IDs or filter the results to include only the VPCs that match specific
criteria.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filters. cidr - The primary IPv4 CIDR block of the VPC. The CIDR block
you specify must exactly match the VPC's CIDR block for information to be returned for the
VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block
associated with the VPC. cidr-block-association.state - The state of an IPv4 CIDR block
associated with the VPC. dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the
IPv6 CIDR block is allocated. ipv6-cidr-block-association.association-id - The
association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the
VPC. is-default - Indicates whether the VPC is the default VPC. owner-id - The ID of
the Amazon Web Services account that owns the VPC. state - The state of the VPC (pending
| available). tag:<key> - The key/value combination of a tag assigned to the
resource. Use the tag key in the filter name and the tag value as the filter value. For
example, to find all resources that have a tag with the key Owner and the value TeamA,
specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key
of a tag assigned to the resource. Use this filter to find all resources assigned a tag
with a specific key, regardless of the tag value. vpc-id - The ID of the VPC.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"VpcId"`: The IDs of the VPCs.
- `"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.
"""
function describe_vpcs(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("DescribeVpcs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_vpcs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpcs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_vpn_connections()
describe_vpn_connections(params::Dict{String,<:Any})
Describes one or more of your VPN connections. For more information, see Amazon Web
Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: One or more filters. customer-gateway-configuration - The configuration
information for the customer gateway. customer-gateway-id - The ID of a customer gateway
associated with the VPN connection. state - The state of the VPN connection (pending |
available | deleting | deleted). option.static-routes-only - Indicates whether the
connection has static routes only. Used for devices that do not support Border Gateway
Protocol (BGP). route.destination-cidr-block - The destination CIDR block. This
corresponds to the subnet used in a customer data center. bgp-asn - The BGP Autonomous
System Number (ASN) associated with a BGP device. tag:<key> - The key/value
combination of a tag assigned to the resource. Use the tag key in the filter name and the
tag value as the filter value. For example, to find all resources that have a tag with the
key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the
filter value. tag-key - The key of a tag assigned to the resource. Use this filter to
find all resources assigned a tag with a specific key, regardless of the tag value. type
- The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection. vpn-gateway-id - The ID of a virtual
private gateway associated with the VPN connection. transit-gateway-id - The ID of a
transit gateway associated with the VPN connection.
- `"VpnConnectionId"`: One or more VPN connection IDs. Default: Describes your VPN
connections.
- `"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.
"""
function describe_vpn_connections(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeVpnConnections"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_vpn_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpnConnections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpn_gateways()
describe_vpn_gateways(params::Dict{String,<:Any})
Describes one or more of your virtual private gateways. For more information, see Amazon
Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: One or more filters. amazon-side-asn - The Autonomous System Number (ASN)
for the Amazon side of the gateway. attachment.state - The current state of the
attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC. availability-zone - The Availability
Zone for the virtual private gateway (if applicable). state - The state of the virtual
private gateway (pending | available | deleting | deleted). tag:<key> - The
key/value combination of a tag assigned to the resource. Use the tag key in the filter name
and the tag value as the filter value. For example, to find all resources that have a tag
with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for
the filter value. tag-key - The key of a tag assigned to the resource. Use this filter
to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
- `"VpnGatewayId"`: One or more virtual private gateway IDs. Default: Describes all your
virtual private gateways.
- `"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.
"""
function describe_vpn_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DescribeVpnGateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_vpn_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DescribeVpnGateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_classic_link_vpc(instance_id, vpc_id)
detach_classic_link_vpc(instance_id, vpc_id, params::Dict{String,<:Any})
This action is deprecated. Unlinks (detaches) a linked EC2-Classic instance from a VPC.
After the instance has been unlinked, the VPC security groups are no longer associated with
it. An instance is automatically unlinked from a VPC when it's stopped.
# Arguments
- `instance_id`: The ID of the instance to unlink from the VPC.
- `vpc_id`: The ID of the VPC to which the instance is linked.
# 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.
"""
function detach_classic_link_vpc(
instanceId, vpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DetachClassicLinkVpc",
Dict{String,Any}("instanceId" => instanceId, "vpcId" => vpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_classic_link_vpc(
instanceId,
vpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DetachClassicLinkVpc",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("instanceId" => instanceId, "vpcId" => vpcId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_internet_gateway(internet_gateway_id, vpc_id)
detach_internet_gateway(internet_gateway_id, vpc_id, params::Dict{String,<:Any})
Detaches an internet gateway from a VPC, disabling connectivity between the internet and
the VPC. The VPC must not contain any running instances with Elastic IP addresses or public
IPv4 addresses.
# Arguments
- `internet_gateway_id`: The ID of the internet gateway.
- `vpc_id`: The ID of the VPC.
# 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.
"""
function detach_internet_gateway(
internetGatewayId, vpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DetachInternetGateway",
Dict{String,Any}("internetGatewayId" => internetGatewayId, "vpcId" => vpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_internet_gateway(
internetGatewayId,
vpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DetachInternetGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"internetGatewayId" => internetGatewayId, "vpcId" => vpcId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_network_interface(attachment_id)
detach_network_interface(attachment_id, params::Dict{String,<:Any})
Detaches a network interface from an instance.
# Arguments
- `attachment_id`: The ID of the attachment.
# 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.
- `"force"`: Specifies whether to force a detachment. Use the Force parameter only as a
last resort to detach a network interface from a failed instance. If you use the Force
parameter to detach a network interface, you might not be able to attach a different
network interface to the same index on the instance without first stopping and starting the
instance. If you force the detachment of a network interface, the instance metadata might
not get updated. This means that the attributes associated with the detached network
interface might still be visible. The instance metadata will get updated when you stop and
start the instance.
"""
function detach_network_interface(
attachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DetachNetworkInterface",
Dict{String,Any}("attachmentId" => attachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_network_interface(
attachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DetachNetworkInterface",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("attachmentId" => attachmentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_verified_access_trust_provider(verified_access_instance_id, verified_access_trust_provider_id)
detach_verified_access_trust_provider(verified_access_instance_id, verified_access_trust_provider_id, params::Dict{String,<:Any})
Detaches the specified Amazon Web Services Verified Access trust provider from the
specified Amazon Web Services Verified Access instance.
# Arguments
- `verified_access_instance_id`: The ID of the Verified Access instance.
- `verified_access_trust_provider_id`: The ID of the Verified Access trust provider.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"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.
"""
function detach_verified_access_trust_provider(
VerifiedAccessInstanceId,
VerifiedAccessTrustProviderId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DetachVerifiedAccessTrustProvider",
Dict{String,Any}(
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"VerifiedAccessTrustProviderId" => VerifiedAccessTrustProviderId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_verified_access_trust_provider(
VerifiedAccessInstanceId,
VerifiedAccessTrustProviderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DetachVerifiedAccessTrustProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"VerifiedAccessTrustProviderId" => VerifiedAccessTrustProviderId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_volume(volume_id)
detach_volume(volume_id, params::Dict{String,<:Any})
Detaches an EBS volume from an instance. Make sure to unmount any file systems on the
device within your operating system before detaching the volume. Failure to do so can
result in the volume becoming stuck in the busy state while detaching. If this happens,
detachment can be delayed indefinitely until you unmount the volume, force detachment,
reboot the instance, or all three. If an EBS volume is the root device of an instance, it
can't be detached while the instance is running. To detach the root volume, stop the
instance first. When a volume with an Amazon Web Services Marketplace product code is
detached from an instance, the product code is no longer associated with the instance. You
can't detach or force detach volumes that are attached to Amazon ECS or Fargate tasks.
Attempting to do this results in the UnsupportedOperationException exception with the
Unable to detach volume attached to ECS tasks error message. For more information, see
Detach an Amazon EBS volume in the Amazon EBS User Guide.
# Arguments
- `volume_id`: The ID of the volume.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Device"`: The device name.
- `"Force"`: Forces detachment if the previous detachment attempt did not occur cleanly
(for example, logging into an instance, unmounting the volume, and detaching normally).
This option can lead to data loss or a corrupted file system. Use this option only as a
last resort to detach a volume from a failed instance. The instance won't have an
opportunity to flush file system caches or file system metadata. If you use this option,
you must perform file system check and repair procedures.
- `"InstanceId"`: The ID of the instance. If you are detaching a Multi-Attach enabled
volume, you must specify an instance ID.
- `"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.
"""
function detach_volume(VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DetachVolume",
Dict{String,Any}("VolumeId" => VolumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_volume(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DetachVolume",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeId" => VolumeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_vpn_gateway(vpc_id, vpn_gateway_id)
detach_vpn_gateway(vpc_id, vpn_gateway_id, params::Dict{String,<:Any})
Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off
the VPC and not use it anymore. You can confirm a virtual private gateway has been
completely detached from a VPC by describing the virtual private gateway (any attachments
to the virtual private gateway are also described). You must wait for the attachment's
state to switch to detached before you can delete the VPC or attach a different VPC to the
virtual private gateway.
# Arguments
- `vpc_id`: The ID of the VPC.
- `vpn_gateway_id`: The ID of the virtual private gateway.
# 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.
"""
function detach_vpn_gateway(
VpcId, VpnGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DetachVpnGateway",
Dict{String,Any}("VpcId" => VpcId, "VpnGatewayId" => VpnGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_vpn_gateway(
VpcId,
VpnGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DetachVpnGateway",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VpcId" => VpcId, "VpnGatewayId" => VpnGatewayId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_address_transfer(allocation_id)
disable_address_transfer(allocation_id, params::Dict{String,<:Any})
Disables Elastic IP address transfer. For more information, see Transfer Elastic IP
addresses in the Amazon VPC User Guide.
# Arguments
- `allocation_id`: The allocation ID of an Elastic IP address.
# 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.
"""
function disable_address_transfer(
AllocationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableAddressTransfer",
Dict{String,Any}("AllocationId" => AllocationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_address_transfer(
AllocationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisableAddressTransfer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AllocationId" => AllocationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_aws_network_performance_metric_subscription()
disable_aws_network_performance_metric_subscription(params::Dict{String,<:Any})
Disables Infrastructure Performance metric subscriptions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Destination"`: The target Region or Availability Zone that the metric subscription is
disabled for. For example, eu-north-1.
- `"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.
- `"Metric"`: The metric used for the disabled subscription.
- `"Source"`: The source Region or Availability Zone that the metric subscription is
disabled for. For example, us-east-1.
- `"Statistic"`: The statistic used for the disabled subscription.
"""
function disable_aws_network_performance_metric_subscription(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableAwsNetworkPerformanceMetricSubscription";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_aws_network_performance_metric_subscription(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableAwsNetworkPerformanceMetricSubscription",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_ebs_encryption_by_default()
disable_ebs_encryption_by_default(params::Dict{String,<:Any})
Disables EBS encryption by default for your account in the current Region. After you
disable encryption by default, you can still create encrypted volumes by enabling
encryption when you create each volume. Disabling encryption by default does not change the
encryption status of your existing volumes. For more information, see Amazon EBS encryption
in the Amazon EBS User Guide.
# 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.
"""
function disable_ebs_encryption_by_default(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableEbsEncryptionByDefault";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_ebs_encryption_by_default(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableEbsEncryptionByDefault",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_fast_launch(image_id)
disable_fast_launch(image_id, params::Dict{String,<:Any})
Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned
snapshots. After you disable Windows fast launch, the AMI uses the standard launch process
for each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can
enable Windows fast launch again. You can only change these settings for Windows AMIs that
you own or that have been shared with you.
# Arguments
- `image_id`: Specify the ID of the image for which to disable Windows fast launch.
# 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.
- `"Force"`: Forces the image settings to turn off Windows fast launch for your Windows
AMI. This parameter overrides any errors that are encountered while cleaning up resources
in your account.
"""
function disable_fast_launch(ImageId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DisableFastLaunch",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_fast_launch(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableFastLaunch",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_fast_snapshot_restores(availability_zone, source_snapshot_id)
disable_fast_snapshot_restores(availability_zone, source_snapshot_id, params::Dict{String,<:Any})
Disables fast snapshot restores for the specified snapshots in the specified Availability
Zones.
# Arguments
- `availability_zone`: One or more Availability Zones. For example, us-east-2a.
- `source_snapshot_id`: The IDs of one or more snapshots. For example,
snap-1234567890abcdef0.
# 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.
"""
function disable_fast_snapshot_restores(
AvailabilityZone, SourceSnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableFastSnapshotRestores",
Dict{String,Any}(
"AvailabilityZone" => AvailabilityZone, "SourceSnapshotId" => SourceSnapshotId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_fast_snapshot_restores(
AvailabilityZone,
SourceSnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisableFastSnapshotRestores",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AvailabilityZone" => AvailabilityZone,
"SourceSnapshotId" => SourceSnapshotId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_image(image_id)
disable_image(image_id, params::Dict{String,<:Any})
Sets the AMI state to disabled and removes all launch permissions from the AMI. A disabled
AMI can't be used for instance launches. A disabled AMI can't be shared. If an AMI was
public or previously shared, it is made private. If an AMI was shared with an Amazon Web
Services account, organization, or Organizational Unit, they lose access to the disabled
AMI. A disabled AMI does not appear in DescribeImages API calls by default. Only the AMI
owner can disable an AMI. You can re-enable a disabled AMI using EnableImage. For more
information, see Disable an AMI in the Amazon EC2 User Guide.
# Arguments
- `image_id`: The ID of the AMI.
# 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.
"""
function disable_image(ImageId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DisableImage",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_image(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableImage",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_image_block_public_access()
disable_image_block_public_access(params::Dict{String,<:Any})
Disables block public access for AMIs at the account level in the specified Amazon Web
Services Region. This removes the block public access restriction from your account. With
the restriction removed, you can publicly share your AMIs in the specified Amazon Web
Services Region. The API can take up to 10 minutes to configure this setting. During this
time, if you run GetImageBlockPublicAccessState, the response will be block-new-sharing.
When the API has completed the configuration, the response will be unblocked. For more
information, see Block public access to your AMIs in the Amazon EC2 User Guide.
# 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.
"""
function disable_image_block_public_access(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableImageBlockPublicAccess";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_image_block_public_access(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableImageBlockPublicAccess",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_image_deprecation(image_id)
disable_image_deprecation(image_id, params::Dict{String,<:Any})
Cancels the deprecation of the specified AMI. For more information, see Deprecate an AMI in
the Amazon EC2 User Guide.
# Arguments
- `image_id`: The ID of the AMI.
# 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.
"""
function disable_image_deprecation(
ImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableImageDeprecation",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_image_deprecation(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableImageDeprecation",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_image_deregistration_protection(image_id)
disable_image_deregistration_protection(image_id, params::Dict{String,<:Any})
Disables deregistration protection for an AMI. When deregistration protection is disabled,
the AMI can be deregistered. If you chose to include a 24-hour cooldown period when you
enabled deregistration protection for the AMI, then, when you disable deregistration
protection, you won’t immediately be able to deregister the AMI. For more information,
see Protect an AMI from deregistration in the Amazon EC2 User Guide.
# Arguments
- `image_id`: The ID of the AMI.
# 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.
"""
function disable_image_deregistration_protection(
ImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableImageDeregistrationProtection",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_image_deregistration_protection(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableImageDeregistrationProtection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_ipam_organization_admin_account(delegated_admin_account_id)
disable_ipam_organization_admin_account(delegated_admin_account_id, params::Dict{String,<:Any})
Disable the IPAM account. For more information, see Enable integration with Organizations
in the Amazon VPC IPAM User Guide.
# Arguments
- `delegated_admin_account_id`: The Organizations member account ID that you want to
disable as IPAM account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
"""
function disable_ipam_organization_admin_account(
DelegatedAdminAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableIpamOrganizationAdminAccount",
Dict{String,Any}("DelegatedAdminAccountId" => DelegatedAdminAccountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_ipam_organization_admin_account(
DelegatedAdminAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisableIpamOrganizationAdminAccount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DelegatedAdminAccountId" => DelegatedAdminAccountId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_serial_console_access()
disable_serial_console_access(params::Dict{String,<:Any})
Disables access to the EC2 serial console of all instances for your account. By default,
access to the EC2 serial console is disabled for your account. For more information, see
Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
# 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.
"""
function disable_serial_console_access(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DisableSerialConsoleAccess"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function disable_serial_console_access(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableSerialConsoleAccess",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_snapshot_block_public_access()
disable_snapshot_block_public_access(params::Dict{String,<:Any})
Disables the block public access for snapshots setting at the account level for the
specified Amazon Web Services Region. After you disable block public access for snapshots
in a Region, users can publicly share snapshots in that Region. If block public access is
enabled in block-all-sharing mode, and you disable block public access, all snapshots that
were previously publicly shared are no longer treated as private and they become publicly
accessible again. For more information, see Block public access for snapshots in the
Amazon EBS User Guide .
# 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.
"""
function disable_snapshot_block_public_access(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableSnapshotBlockPublicAccess";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_snapshot_block_public_access(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableSnapshotBlockPublicAccess",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_transit_gateway_route_table_propagation(transit_gateway_route_table_id)
disable_transit_gateway_route_table_propagation(transit_gateway_route_table_id, params::Dict{String,<:Any})
Disables the specified resource attachment from propagating routes to the specified
propagation route table.
# Arguments
- `transit_gateway_route_table_id`: The ID of the propagation route table.
# 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.
- `"TransitGatewayAttachmentId"`: The ID of the attachment.
- `"TransitGatewayRouteTableAnnouncementId"`: The ID of the route table announcement.
"""
function disable_transit_gateway_route_table_propagation(
TransitGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableTransitGatewayRouteTablePropagation",
Dict{String,Any}("TransitGatewayRouteTableId" => TransitGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_transit_gateway_route_table_propagation(
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisableTransitGatewayRouteTablePropagation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_vgw_route_propagation(gateway_id, route_table_id)
disable_vgw_route_propagation(gateway_id, route_table_id, params::Dict{String,<:Any})
Disables a virtual private gateway (VGW) from propagating routes to a specified route table
of a VPC.
# Arguments
- `gateway_id`: The ID of the virtual private gateway.
- `route_table_id`: The ID of the route table.
# 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.
"""
function disable_vgw_route_propagation(
GatewayId, RouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableVgwRoutePropagation",
Dict{String,Any}("GatewayId" => GatewayId, "RouteTableId" => RouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_vgw_route_propagation(
GatewayId,
RouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisableVgwRoutePropagation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GatewayId" => GatewayId, "RouteTableId" => RouteTableId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_vpc_classic_link(vpc_id)
disable_vpc_classic_link(vpc_id, params::Dict{String,<:Any})
This action is deprecated. Disables ClassicLink for a VPC. You cannot disable ClassicLink
for a VPC that has EC2-Classic instances linked to it.
# Arguments
- `vpc_id`: The ID of the VPC.
# 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.
"""
function disable_vpc_classic_link(vpcId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DisableVpcClassicLink",
Dict{String,Any}("vpcId" => vpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_vpc_classic_link(
vpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableVpcClassicLink",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("vpcId" => vpcId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_vpc_classic_link_dns_support()
disable_vpc_classic_link_dns_support(params::Dict{String,<:Any})
This action is deprecated. Disables ClassicLink DNS support for a VPC. If disabled, DNS
hostnames resolve to public IP addresses when addressed between a linked EC2-Classic
instance and instances in the VPC to which it's linked. You must specify a VPC ID in the
request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"VpcId"`: The ID of the VPC.
"""
function disable_vpc_classic_link_dns_support(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableVpcClassicLinkDnsSupport";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_vpc_classic_link_dns_support(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisableVpcClassicLinkDnsSupport",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_address()
disassociate_address(params::Dict{String,<:Any})
Disassociates an Elastic IP address from the instance or network interface it's associated
with. This is an idempotent operation. If you perform the operation more than once, Amazon
EC2 doesn't return an error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationId"`: The association ID. This parameter is required.
- `"PublicIp"`: Deprecated.
- `"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.
"""
function disassociate_address(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"DisassociateAddress"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function disassociate_address(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateAddress",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_client_vpn_target_network(association_id, client_vpn_endpoint_id)
disassociate_client_vpn_target_network(association_id, client_vpn_endpoint_id, params::Dict{String,<:Any})
Disassociates a target network from the specified Client VPN endpoint. When you
disassociate the last target network from a Client VPN, the following happens: The route
that was automatically added for the VPC is deleted All active client connections are
terminated New client connections are disallowed The Client VPN endpoint's status
changes to pending-associate
# Arguments
- `association_id`: The ID of the target network association.
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint from which to disassociate
the target network.
# 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.
"""
function disassociate_client_vpn_target_network(
AssociationId, ClientVpnEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateClientVpnTargetNetwork",
Dict{String,Any}(
"AssociationId" => AssociationId, "ClientVpnEndpointId" => ClientVpnEndpointId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_client_vpn_target_network(
AssociationId,
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateClientVpnTargetNetwork",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationId" => AssociationId,
"ClientVpnEndpointId" => ClientVpnEndpointId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_enclave_certificate_iam_role(certificate_arn, role_arn)
disassociate_enclave_certificate_iam_role(certificate_arn, role_arn, params::Dict{String,<:Any})
Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an
IAM role from an ACM certificate removes the Amazon S3 object that contains the
certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It
also revokes the IAM role's permission to use the KMS key used to encrypt the private key.
This effectively revokes the role's permission to use the certificate.
# Arguments
- `certificate_arn`: The ARN of the ACM certificate from which to disassociate the IAM role.
- `role_arn`: The ARN of the IAM role to disassociate.
# 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.
"""
function disassociate_enclave_certificate_iam_role(
CertificateArn, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateEnclaveCertificateIamRole",
Dict{String,Any}("CertificateArn" => CertificateArn, "RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_enclave_certificate_iam_role(
CertificateArn,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateEnclaveCertificateIamRole",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CertificateArn" => CertificateArn, "RoleArn" => RoleArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_iam_instance_profile(association_id)
disassociate_iam_instance_profile(association_id, params::Dict{String,<:Any})
Disassociates an IAM instance profile from a running or stopped instance. Use
DescribeIamInstanceProfileAssociations to get the association ID.
# Arguments
- `association_id`: The ID of the IAM instance profile association.
"""
function disassociate_iam_instance_profile(
AssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateIamInstanceProfile",
Dict{String,Any}("AssociationId" => AssociationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_iam_instance_profile(
AssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateIamInstanceProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AssociationId" => AssociationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_instance_event_window(association_target, instance_event_window_id)
disassociate_instance_event_window(association_target, instance_event_window_id, params::Dict{String,<:Any})
Disassociates one or more targets from an event window. For more information, see Define
event windows for scheduled events in the Amazon EC2 User Guide.
# Arguments
- `association_target`: One or more targets to disassociate from the specified event window.
- `instance_event_window_id`: The ID of the event window.
# 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.
"""
function disassociate_instance_event_window(
AssociationTarget,
InstanceEventWindowId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateInstanceEventWindow",
Dict{String,Any}(
"AssociationTarget" => AssociationTarget,
"InstanceEventWindowId" => InstanceEventWindowId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_instance_event_window(
AssociationTarget,
InstanceEventWindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateInstanceEventWindow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationTarget" => AssociationTarget,
"InstanceEventWindowId" => InstanceEventWindowId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_ipam_byoasn(asn, cidr)
disassociate_ipam_byoasn(asn, cidr, params::Dict{String,<:Any})
Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR. You
may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs.
For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
# Arguments
- `asn`: A public 2-byte or 4-byte ASN.
- `cidr`: A BYOIP CIDR.
# 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.
"""
function disassociate_ipam_byoasn(
Asn, Cidr; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateIpamByoasn",
Dict{String,Any}("Asn" => Asn, "Cidr" => Cidr);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_ipam_byoasn(
Asn,
Cidr,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateIpamByoasn",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Asn" => Asn, "Cidr" => Cidr), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_ipam_resource_discovery(ipam_resource_discovery_association_id)
disassociate_ipam_resource_discovery(ipam_resource_discovery_association_id, params::Dict{String,<:Any})
Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM
component that enables IPAM to manage and monitor resources that belong to the owning
account.
# Arguments
- `ipam_resource_discovery_association_id`: A resource discovery association ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
"""
function disassociate_ipam_resource_discovery(
IpamResourceDiscoveryAssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateIpamResourceDiscovery",
Dict{String,Any}(
"IpamResourceDiscoveryAssociationId" => IpamResourceDiscoveryAssociationId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_ipam_resource_discovery(
IpamResourceDiscoveryAssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateIpamResourceDiscovery",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IpamResourceDiscoveryAssociationId" =>
IpamResourceDiscoveryAssociationId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_nat_gateway_address(association_id, nat_gateway_id)
disassociate_nat_gateway_address(association_id, nat_gateway_id, params::Dict{String,<:Any})
Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. You cannot
disassociate your primary EIP. For more information, see Edit secondary IP address
associations in the Amazon VPC User Guide. While disassociating is in progress, you cannot
associate/disassociate additional EIPs while the connections are being drained. You are,
however, allowed to delete the NAT gateway. An EIP is released only at the end of
MaxDrainDurationSeconds. It stays associated and supports the existing connections but does
not support any new connections (new connections are distributed across the remaining
associated EIPs). As the existing connections drain out, the EIPs (and the corresponding
private IP addresses mapped to them) are released.
# Arguments
- `association_id`: The association IDs of EIPs that have been associated with the NAT
gateway.
- `nat_gateway_id`: The ID of the NAT gateway.
# 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.
- `"MaxDrainDurationSeconds"`: The maximum amount of time to wait (in seconds) before
forcibly releasing the IP addresses if connections are still in progress. Default value is
350 seconds.
"""
function disassociate_nat_gateway_address(
AssociationId, NatGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateNatGatewayAddress",
Dict{String,Any}("AssociationId" => AssociationId, "NatGatewayId" => NatGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_nat_gateway_address(
AssociationId,
NatGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateNatGatewayAddress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationId" => AssociationId, "NatGatewayId" => NatGatewayId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_route_table(association_id)
disassociate_route_table(association_id, params::Dict{String,<:Any})
Disassociates a subnet or gateway from a route table. After you perform this action, the
subnet no longer uses the routes in the route table. Instead, it uses the routes in the
VPC's main route table. For more information about route tables, see Route tables in the
Amazon VPC User Guide.
# Arguments
- `association_id`: The association ID representing the current association between the
route table and subnet or gateway.
# 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.
"""
function disassociate_route_table(
associationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateRouteTable",
Dict{String,Any}("associationId" => associationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_route_table(
associationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateRouteTable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("associationId" => associationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_subnet_cidr_block(association_id)
disassociate_subnet_cidr_block(association_id, params::Dict{String,<:Any})
Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR
block only. You must detach or delete all gateways and resources that are associated with
the CIDR block before you can disassociate it.
# Arguments
- `association_id`: The association ID for the CIDR block.
"""
function disassociate_subnet_cidr_block(
associationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateSubnetCidrBlock",
Dict{String,Any}("associationId" => associationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_subnet_cidr_block(
associationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateSubnetCidrBlock",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("associationId" => associationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_transit_gateway_multicast_domain(transit_gateway_attachment_id, transit_gateway_multicast_domain_id, item)
disassociate_transit_gateway_multicast_domain(transit_gateway_attachment_id, transit_gateway_multicast_domain_id, item, params::Dict{String,<:Any})
Disassociates the specified subnets from the transit gateway multicast domain.
# Arguments
- `transit_gateway_attachment_id`: The ID of the attachment.
- `transit_gateway_multicast_domain_id`: The ID of the transit gateway multicast domain.
- `item`: The IDs of the subnets;
# 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.
- `"SubnetIds"`: The IDs of the subnets;
"""
function disassociate_transit_gateway_multicast_domain(
TransitGatewayAttachmentId,
TransitGatewayMulticastDomainId,
item;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateTransitGatewayMulticastDomain",
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId,
"item" => item,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_transit_gateway_multicast_domain(
TransitGatewayAttachmentId,
TransitGatewayMulticastDomainId,
item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateTransitGatewayMulticastDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId,
"item" => item,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_transit_gateway_policy_table(transit_gateway_attachment_id, transit_gateway_policy_table_id)
disassociate_transit_gateway_policy_table(transit_gateway_attachment_id, transit_gateway_policy_table_id, params::Dict{String,<:Any})
Removes the association between an an attachment and a policy table.
# Arguments
- `transit_gateway_attachment_id`: The ID of the transit gateway attachment to disassociate
from the policy table.
- `transit_gateway_policy_table_id`: The ID of the disassociated policy table.
# 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.
"""
function disassociate_transit_gateway_policy_table(
TransitGatewayAttachmentId,
TransitGatewayPolicyTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateTransitGatewayPolicyTable",
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayPolicyTableId" => TransitGatewayPolicyTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_transit_gateway_policy_table(
TransitGatewayAttachmentId,
TransitGatewayPolicyTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateTransitGatewayPolicyTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayPolicyTableId" => TransitGatewayPolicyTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_transit_gateway_route_table(transit_gateway_attachment_id, transit_gateway_route_table_id)
disassociate_transit_gateway_route_table(transit_gateway_attachment_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Disassociates a resource attachment from a transit gateway route table.
# Arguments
- `transit_gateway_attachment_id`: The ID of the attachment.
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# 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.
"""
function disassociate_transit_gateway_route_table(
TransitGatewayAttachmentId,
TransitGatewayRouteTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateTransitGatewayRouteTable",
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_transit_gateway_route_table(
TransitGatewayAttachmentId,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateTransitGatewayRouteTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_trunk_interface(association_id)
disassociate_trunk_interface(association_id, params::Dict{String,<:Any})
Removes an association between a branch network interface with a trunk network interface.
# Arguments
- `association_id`: The ID of the association
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"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.
"""
function disassociate_trunk_interface(
AssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateTrunkInterface",
Dict{String,Any}(
"AssociationId" => AssociationId, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_trunk_interface(
AssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateTrunkInterface",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationId" => AssociationId, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_vpc_cidr_block(association_id)
disassociate_vpc_cidr_block(association_id, params::Dict{String,<:Any})
Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its
association ID. You can get the association ID by using DescribeVpcs. You must detach or
delete all gateways and resources that are associated with the CIDR block before you can
disassociate it. You cannot disassociate the CIDR block with which you originally created
the VPC (the primary CIDR block).
# Arguments
- `association_id`: The association ID for the CIDR block.
"""
function disassociate_vpc_cidr_block(
associationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"DisassociateVpcCidrBlock",
Dict{String,Any}("associationId" => associationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_vpc_cidr_block(
associationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"DisassociateVpcCidrBlock",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("associationId" => associationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_address_transfer(allocation_id, transfer_account_id)
enable_address_transfer(allocation_id, transfer_account_id, params::Dict{String,<:Any})
Enables Elastic IP address transfer. For more information, see Transfer Elastic IP
addresses in the Amazon VPC User Guide.
# Arguments
- `allocation_id`: The allocation ID of an Elastic IP address.
- `transfer_account_id`: The ID of the account that you want to transfer the Elastic IP
address to.
# 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.
"""
function enable_address_transfer(
AllocationId, TransferAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableAddressTransfer",
Dict{String,Any}(
"AllocationId" => AllocationId, "TransferAccountId" => TransferAccountId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_address_transfer(
AllocationId,
TransferAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"EnableAddressTransfer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AllocationId" => AllocationId, "TransferAccountId" => TransferAccountId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_aws_network_performance_metric_subscription()
enable_aws_network_performance_metric_subscription(params::Dict{String,<:Any})
Enables Infrastructure Performance subscriptions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Destination"`: The target Region (like us-east-2) or Availability Zone ID (like
use2-az2) that the metric subscription is enabled for. If you use Availability Zone IDs,
the Source and Destination Availability Zones must be in the same Region.
- `"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.
- `"Metric"`: The metric used for the enabled subscription.
- `"Source"`: The source Region (like us-east-1) or Availability Zone ID (like use1-az1)
that the metric subscription is enabled for. If you use Availability Zone IDs, the Source
and Destination Availability Zones must be in the same Region.
- `"Statistic"`: The statistic used for the enabled subscription.
"""
function enable_aws_network_performance_metric_subscription(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableAwsNetworkPerformanceMetricSubscription";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_aws_network_performance_metric_subscription(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableAwsNetworkPerformanceMetricSubscription",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_ebs_encryption_by_default()
enable_ebs_encryption_by_default(params::Dict{String,<:Any})
Enables EBS encryption by default for your account in the current Region. After you enable
encryption by default, the EBS volumes that you create are always encrypted, either using
the default KMS key or the KMS key that you specified when you created each volume. For
more information, see Amazon EBS encryption in the Amazon EBS User Guide. You can specify
the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or
ResetEbsDefaultKmsKeyId. Enabling encryption by default has no effect on the encryption
status of your existing volumes. After you enable encryption by default, you can no longer
launch instances using instance types that do not support encryption. For more information,
see Supported instance types.
# 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.
"""
function enable_ebs_encryption_by_default(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableEbsEncryptionByDefault";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_ebs_encryption_by_default(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableEbsEncryptionByDefault",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_fast_launch(image_id)
enable_fast_launch(image_id, params::Dict{String,<:Any})
When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, using
snapshots to launch instances up to 65% faster. To create the optimized Windows image,
Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then
it creates a set of reserved snapshots that are used for subsequent launches. The reserved
snapshots are automatically replenished as they are used, depending on your settings for
launch frequency. You can only change these settings for Windows AMIs that you own or that
have been shared with you.
# Arguments
- `image_id`: Specify the ID of the image for which to enable Windows fast launch.
# 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.
- `"LaunchTemplate"`: The launch template to use when launching Windows instances from
pre-provisioned snapshots. Launch template parameters can include either the name or ID of
the launch template, but not both.
- `"MaxParallelLaunches"`: The maximum number of instances that Amazon EC2 can launch at
the same time to create pre-provisioned snapshots for Windows fast launch. Value must be 6
or greater.
- `"ResourceType"`: The type of resource to use for pre-provisioning the AMI for Windows
fast launch. Supported values include: snapshot, which is the default value.
- `"SnapshotConfiguration"`: Configuration settings for creating and managing the snapshots
that are used for pre-provisioning the AMI for Windows fast launch. The associated
ResourceType must be snapshot.
"""
function enable_fast_launch(ImageId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"EnableFastLaunch",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_fast_launch(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableFastLaunch",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_fast_snapshot_restores(availability_zone, source_snapshot_id)
enable_fast_snapshot_restores(availability_zone, source_snapshot_id, params::Dict{String,<:Any})
Enables fast snapshot restores for the specified snapshots in the specified Availability
Zones. You get the full benefit of fast snapshot restores after they enter the enabled
state. To get the current state of fast snapshot restores, use
DescribeFastSnapshotRestores. To disable fast snapshot restores, use
DisableFastSnapshotRestores. For more information, see Amazon EBS fast snapshot restore in
the Amazon EBS User Guide.
# Arguments
- `availability_zone`: One or more Availability Zones. For example, us-east-2a.
- `source_snapshot_id`: The IDs of one or more snapshots. For example,
snap-1234567890abcdef0. You can specify a snapshot that was shared with you from another
Amazon Web Services account.
# 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.
"""
function enable_fast_snapshot_restores(
AvailabilityZone, SourceSnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableFastSnapshotRestores",
Dict{String,Any}(
"AvailabilityZone" => AvailabilityZone, "SourceSnapshotId" => SourceSnapshotId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_fast_snapshot_restores(
AvailabilityZone,
SourceSnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"EnableFastSnapshotRestores",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AvailabilityZone" => AvailabilityZone,
"SourceSnapshotId" => SourceSnapshotId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_image(image_id)
enable_image(image_id, params::Dict{String,<:Any})
Re-enables a disabled AMI. The re-enabled AMI is marked as available and can be used for
instance launches, appears in describe operations, and can be shared. Amazon Web Services
accounts, organizations, and Organizational Units that lost access to the AMI when it was
disabled do not regain access automatically. Once the AMI is available, it can be shared
with them again. Only the AMI owner can re-enable a disabled AMI. For more information, see
Disable an AMI in the Amazon EC2 User Guide.
# Arguments
- `image_id`: The ID of the AMI.
# 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.
"""
function enable_image(ImageId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"EnableImage",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_image(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableImage",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_image_block_public_access(image_block_public_access_state)
enable_image_block_public_access(image_block_public_access_state, params::Dict{String,<:Any})
Enables block public access for AMIs at the account level in the specified Amazon Web
Services Region. This prevents the public sharing of your AMIs. However, if you already
have public AMIs, they will remain publicly available. The API can take up to 10 minutes to
configure this setting. During this time, if you run GetImageBlockPublicAccessState, the
response will be unblocked. When the API has completed the configuration, the response will
be block-new-sharing. For more information, see Block public access to your AMIs in the
Amazon EC2 User Guide.
# Arguments
- `image_block_public_access_state`: Specify block-new-sharing to enable block public
access for AMIs at the account level in the specified Region. This will block any attempt
to publicly share your AMIs in the specified Region.
# 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.
"""
function enable_image_block_public_access(
ImageBlockPublicAccessState; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableImageBlockPublicAccess",
Dict{String,Any}("ImageBlockPublicAccessState" => ImageBlockPublicAccessState);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_image_block_public_access(
ImageBlockPublicAccessState,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"EnableImageBlockPublicAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ImageBlockPublicAccessState" => ImageBlockPublicAccessState
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_image_deprecation(deprecate_at, image_id)
enable_image_deprecation(deprecate_at, image_id, params::Dict{String,<:Any})
Enables deprecation of the specified AMI at the specified date and time. For more
information, see Deprecate an AMI in the Amazon EC2 User Guide.
# Arguments
- `deprecate_at`: The date and time to deprecate the AMI, in UTC, in the following format:
YYYY-MM-DDTHH:MM:SSZ. If you specify a value for seconds, Amazon EC2 rounds the seconds to
the nearest minute. You can’t specify a date in the past. The upper limit for DeprecateAt
is 10 years from now, except for public AMIs, where the upper limit is 2 years from the
creation date.
- `image_id`: The ID of the AMI.
# 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.
"""
function enable_image_deprecation(
DeprecateAt, ImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableImageDeprecation",
Dict{String,Any}("DeprecateAt" => DeprecateAt, "ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_image_deprecation(
DeprecateAt,
ImageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"EnableImageDeprecation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DeprecateAt" => DeprecateAt, "ImageId" => ImageId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_image_deregistration_protection(image_id)
enable_image_deregistration_protection(image_id, params::Dict{String,<:Any})
Enables deregistration protection for an AMI. When deregistration protection is enabled,
the AMI can't be deregistered. To allow the AMI to be deregistered, you must first disable
deregistration protection using DisableImageDeregistrationProtection. For more information,
see Protect an AMI from deregistration in the Amazon EC2 User Guide.
# Arguments
- `image_id`: The ID of the AMI.
# 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.
- `"WithCooldown"`: If true, enforces deregistration protection for 24 hours after
deregistration protection is disabled.
"""
function enable_image_deregistration_protection(
ImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableImageDeregistrationProtection",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_image_deregistration_protection(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableImageDeregistrationProtection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_ipam_organization_admin_account(delegated_admin_account_id)
enable_ipam_organization_admin_account(delegated_admin_account_id, params::Dict{String,<:Any})
Enable an Organizations member account as the IPAM admin account. You cannot select the
Organizations management account as the IPAM admin account. For more information, see
Enable integration with Organizations in the Amazon VPC IPAM User Guide.
# Arguments
- `delegated_admin_account_id`: The Organizations member account ID that you want to enable
as the IPAM account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
"""
function enable_ipam_organization_admin_account(
DelegatedAdminAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableIpamOrganizationAdminAccount",
Dict{String,Any}("DelegatedAdminAccountId" => DelegatedAdminAccountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_ipam_organization_admin_account(
DelegatedAdminAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"EnableIpamOrganizationAdminAccount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DelegatedAdminAccountId" => DelegatedAdminAccountId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_reachability_analyzer_organization_sharing()
enable_reachability_analyzer_organization_sharing(params::Dict{String,<:Any})
Establishes a trust relationship between Reachability Analyzer and Organizations. This
operation must be performed by the management account for the organization. After you
establish a trust relationship, a user in the management account or a delegated
administrator account can run a cross-account analysis using resources from the member
accounts.
# 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.
"""
function enable_reachability_analyzer_organization_sharing(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableReachabilityAnalyzerOrganizationSharing";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_reachability_analyzer_organization_sharing(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableReachabilityAnalyzerOrganizationSharing",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_serial_console_access()
enable_serial_console_access(params::Dict{String,<:Any})
Enables access to the EC2 serial console of all instances for your account. By default,
access to the EC2 serial console is disabled for your account. For more information, see
Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
# 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.
"""
function enable_serial_console_access(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"EnableSerialConsoleAccess"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function enable_serial_console_access(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableSerialConsoleAccess",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_snapshot_block_public_access(state)
enable_snapshot_block_public_access(state, params::Dict{String,<:Any})
Enables or modifies the block public access for snapshots setting at the account level for
the specified Amazon Web Services Region. After you enable block public access for
snapshots in a Region, users can no longer request public sharing for snapshots in that
Region. Snapshots that are already publicly shared are either treated as private or they
remain publicly shared, depending on the State that you specify. If block public access is
enabled in block-all-sharing mode, and you change the mode to block-new-sharing, all
snapshots that were previously publicly shared are no longer treated as private and they
become publicly accessible again. For more information, see Block public access for
snapshots in the Amazon EBS User Guide.
# Arguments
- `state`: The mode in which to enable block public access for snapshots for the Region.
Specify one of the following values: block-all-sharing - Prevents all public sharing of
snapshots in the Region. Users in the account will no longer be able to request new public
sharing. Additionally, snapshots that are already publicly shared are treated as private
and they are no longer publicly available. If you enable block public access for snapshots
in block-all-sharing mode, it does not change the permissions for snapshots that are
already publicly shared. Instead, it prevents these snapshots from be publicly visible and
publicly accessible. Therefore, the attributes for these snapshots still indicate that they
are publicly shared, even though they are not publicly available. block-new-sharing -
Prevents only new public sharing of snapshots in the Region. Users in the account will no
longer be able to request new public sharing. However, snapshots that are already publicly
shared, remain publicly available. unblocked is not a valid value for
EnableSnapshotBlockPublicAccess.
# 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.
"""
function enable_snapshot_block_public_access(
State; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableSnapshotBlockPublicAccess",
Dict{String,Any}("State" => State);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_snapshot_block_public_access(
State, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableSnapshotBlockPublicAccess",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("State" => State), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_transit_gateway_route_table_propagation(transit_gateway_route_table_id)
enable_transit_gateway_route_table_propagation(transit_gateway_route_table_id, params::Dict{String,<:Any})
Enables the specified attachment to propagate routes to the specified propagation route
table.
# Arguments
- `transit_gateway_route_table_id`: The ID of the propagation route table.
# 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.
- `"TransitGatewayAttachmentId"`: The ID of the attachment.
- `"TransitGatewayRouteTableAnnouncementId"`: The ID of the transit gateway route table
announcement.
"""
function enable_transit_gateway_route_table_propagation(
TransitGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableTransitGatewayRouteTablePropagation",
Dict{String,Any}("TransitGatewayRouteTableId" => TransitGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_transit_gateway_route_table_propagation(
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"EnableTransitGatewayRouteTablePropagation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_vgw_route_propagation(gateway_id, route_table_id)
enable_vgw_route_propagation(gateway_id, route_table_id, params::Dict{String,<:Any})
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of
a VPC.
# Arguments
- `gateway_id`: The ID of the virtual private gateway that is attached to a VPC. The
virtual private gateway must be attached to the same VPC that the routing tables are
associated with.
- `route_table_id`: The ID of the route table. The routing table must be associated with
the same VPC that the virtual private gateway is attached to.
# 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.
"""
function enable_vgw_route_propagation(
GatewayId, RouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableVgwRoutePropagation",
Dict{String,Any}("GatewayId" => GatewayId, "RouteTableId" => RouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_vgw_route_propagation(
GatewayId,
RouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"EnableVgwRoutePropagation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GatewayId" => GatewayId, "RouteTableId" => RouteTableId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_volume_io(volume_id)
enable_volume_io(volume_id, params::Dict{String,<:Any})
Enables I/O operations for a volume that had I/O operations disabled because the data on
the volume was potentially inconsistent.
# Arguments
- `volume_id`: The ID of the volume.
# 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.
"""
function enable_volume_io(volumeId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"EnableVolumeIO",
Dict{String,Any}("volumeId" => volumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_volume_io(
volumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"EnableVolumeIO",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("volumeId" => volumeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_vpc_classic_link(vpc_id)
enable_vpc_classic_link(vpc_id, params::Dict{String,<:Any})
This action is deprecated. Enables a VPC for ClassicLink. You can then link EC2-Classic
instances to your ClassicLink-enabled VPC to allow communication over private IP addresses.
You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing
routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes
for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges.
# Arguments
- `vpc_id`: The ID of the VPC.
# 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.
"""
function enable_vpc_classic_link(vpcId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"EnableVpcClassicLink",
Dict{String,Any}("vpcId" => vpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_vpc_classic_link(
vpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableVpcClassicLink",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("vpcId" => vpcId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_vpc_classic_link_dns_support()
enable_vpc_classic_link_dns_support(params::Dict{String,<:Any})
This action is deprecated. Enables a VPC to support DNS hostname resolution for
ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its
private IP address when addressed from an instance in the VPC to which it's linked.
Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when
addressed from a linked EC2-Classic instance. You must specify a VPC ID in the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"VpcId"`: The ID of the VPC.
"""
function enable_vpc_classic_link_dns_support(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableVpcClassicLinkDnsSupport";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_vpc_classic_link_dns_support(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"EnableVpcClassicLinkDnsSupport",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_client_vpn_client_certificate_revocation_list(client_vpn_endpoint_id)
export_client_vpn_client_certificate_revocation_list(client_vpn_endpoint_id, params::Dict{String,<:Any})
Downloads the client certificate revocation list for the specified Client VPN endpoint.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint.
# 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.
"""
function export_client_vpn_client_certificate_revocation_list(
ClientVpnEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ExportClientVpnClientCertificateRevocationList",
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_client_vpn_client_certificate_revocation_list(
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ExportClientVpnClientCertificateRevocationList",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_client_vpn_client_configuration(client_vpn_endpoint_id)
export_client_vpn_client_configuration(client_vpn_endpoint_id, params::Dict{String,<:Any})
Downloads the contents of the Client VPN endpoint configuration file for the specified
Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN
endpoint and certificate information clients need to establish a connection with the Client
VPN endpoint.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint.
# 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.
"""
function export_client_vpn_client_configuration(
ClientVpnEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ExportClientVpnClientConfiguration",
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_client_vpn_client_configuration(
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ExportClientVpnClientConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_image(disk_image_format, image_id, s3_export_location)
export_image(disk_image_format, image_id, s3_export_location, params::Dict{String,<:Any})
Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a
VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.
# Arguments
- `disk_image_format`: The disk image format.
- `image_id`: The ID of the image.
- `s3_export_location`: The Amazon S3 bucket for the destination image. The destination
bucket must exist.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Token to enable idempotency for export image requests.
- `"Description"`: A description of the image being exported. The maximum length is 255
characters.
- `"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.
- `"RoleName"`: The name of the role that grants VM Import/Export permission to export
images to your Amazon S3 bucket. If this parameter is not specified, the default role is
named 'vmimport'.
- `"TagSpecification"`: The tags to apply to the export image task during creation.
"""
function export_image(
DiskImageFormat,
ImageId,
S3ExportLocation;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ExportImage",
Dict{String,Any}(
"DiskImageFormat" => DiskImageFormat,
"ImageId" => ImageId,
"S3ExportLocation" => S3ExportLocation,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_image(
DiskImageFormat,
ImageId,
S3ExportLocation,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ExportImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DiskImageFormat" => DiskImageFormat,
"ImageId" => ImageId,
"S3ExportLocation" => S3ExportLocation,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_transit_gateway_routes(s3_bucket, transit_gateway_route_table_id)
export_transit_gateway_routes(s3_bucket, transit_gateway_route_table_id, params::Dict{String,<:Any})
Exports routes from the specified transit gateway route table to the specified S3 bucket.
By default, all routes are exported. Alternatively, you can filter by CIDR range. The
routes are saved to the specified bucket in a JSON file. For more information, see Export
route tables to Amazon S3 in the Amazon Web Services Transit Gateways Guide.
# Arguments
- `s3_bucket`: The name of the S3 bucket.
- `transit_gateway_route_table_id`: The ID of the route table.
# 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.
- `"Filter"`: One or more filters. The possible values are:
attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR
filter. route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR
filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and
you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29. state
- The state of the route (active | blackhole).
transit-gateway-route-destination-cidr-block - The CIDR range. type - The type of route
(propagated | static).
"""
function export_transit_gateway_routes(
S3Bucket, TransitGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ExportTransitGatewayRoutes",
Dict{String,Any}(
"S3Bucket" => S3Bucket,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_transit_gateway_routes(
S3Bucket,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ExportTransitGatewayRoutes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"S3Bucket" => S3Bucket,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_associated_enclave_certificate_iam_roles(certificate_arn)
get_associated_enclave_certificate_iam_roles(certificate_arn, params::Dict{String,<:Any})
Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also
returns the name of the Amazon S3 bucket and the Amazon S3 object key where the
certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of
the KMS key that's used to encrypt the private key.
# Arguments
- `certificate_arn`: The ARN of the ACM certificate for which to view the associated IAM
roles, encryption keys, and Amazon S3 object information.
# 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.
"""
function get_associated_enclave_certificate_iam_roles(
CertificateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetAssociatedEnclaveCertificateIamRoles",
Dict{String,Any}("CertificateArn" => CertificateArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_associated_enclave_certificate_iam_roles(
CertificateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetAssociatedEnclaveCertificateIamRoles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CertificateArn" => CertificateArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_associated_ipv6_pool_cidrs(pool_id)
get_associated_ipv6_pool_cidrs(pool_id, params::Dict{String,<:Any})
Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
# Arguments
- `pool_id`: The ID of the IPv6 address pool.
# 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.
- `"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 get_associated_ipv6_pool_cidrs(
PoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetAssociatedIpv6PoolCidrs",
Dict{String,Any}("PoolId" => PoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_associated_ipv6_pool_cidrs(
PoolId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetAssociatedIpv6PoolCidrs",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PoolId" => PoolId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_aws_network_performance_data()
get_aws_network_performance_data(params::Dict{String,<:Any})
Gets network performance data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataQuery"`: A list of network performance data queries.
- `"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.
- `"EndTime"`: The ending time for the performance data request. The end time must be
formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.
- `"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.
- `"StartTime"`: The starting time for the performance data request. The starting time must
be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.
"""
function get_aws_network_performance_data(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetAwsNetworkPerformanceData";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_aws_network_performance_data(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetAwsNetworkPerformanceData",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_capacity_reservation_usage(capacity_reservation_id)
get_capacity_reservation_usage(capacity_reservation_id, params::Dict{String,<:Any})
Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared,
it shows usage information for the Capacity Reservation owner and each Amazon Web Services
account that is currently using the shared capacity. If the Capacity Reservation is not
shared, it shows only the Capacity Reservation owner's usage.
# Arguments
- `capacity_reservation_id`: The ID of the Capacity Reservation.
# 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.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token to use to retrieve the next page of results.
"""
function get_capacity_reservation_usage(
CapacityReservationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetCapacityReservationUsage",
Dict{String,Any}("CapacityReservationId" => CapacityReservationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_capacity_reservation_usage(
CapacityReservationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetCapacityReservationUsage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CapacityReservationId" => CapacityReservationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_coip_pool_usage(pool_id)
get_coip_pool_usage(pool_id, params::Dict{String,<:Any})
Describes the allocations from the specified customer-owned address pool.
# Arguments
- `pool_id`: The ID of the address pool.
# 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.
- `"Filter"`: One or more filters. coip-address-usage.allocation-id - The allocation ID
of the address. coip-address-usage.aws-account-id - The ID of the Amazon Web Services
account that is using the customer-owned IP address. coip-address-usage.aws-service -
The Amazon Web Services service that is using the customer-owned IP address.
coip-address-usage.co-ip - The customer-owned IP address.
- `"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 get_coip_pool_usage(PoolId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"GetCoipPoolUsage",
Dict{String,Any}("PoolId" => PoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_coip_pool_usage(
PoolId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetCoipPoolUsage",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("PoolId" => PoolId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_console_output(instance_id)
get_console_output(instance_id, params::Dict{String,<:Any})
Gets the console output for the specified instance. For Linux instances, the instance
console output displays the exact console output that would normally be displayed on a
physical monitor attached to a computer. For Windows instances, the instance console output
includes the last three system event log errors. By default, the console output returns
buffered information that was posted shortly after an instance transition state (start,
stop, reboot, or terminate). This information is available for at least one hour after the
most recent post. Only the most recent 64 KB of console output is available. You can
optionally retrieve the latest serial console output at any time during the instance
lifecycle. This option is supported on instance types that use the Nitro hypervisor. For
more information, see Instance console output in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The ID of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Latest"`: When enabled, retrieves the latest console output for the instance. Default:
disabled (false)
- `"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.
"""
function get_console_output(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"GetConsoleOutput",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_console_output(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetConsoleOutput",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_console_screenshot(instance_id)
get_console_screenshot(instance_id, params::Dict{String,<:Any})
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The
returned content is Base64-encoded. For more information, see Instance console output in
the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The ID of the instance.
# 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.
- `"WakeUp"`: When set to true, acts as keystroke input and wakes up an instance that's in
standby or \"sleep\" mode.
"""
function get_console_screenshot(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetConsoleScreenshot",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_console_screenshot(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetConsoleScreenshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_default_credit_specification(instance_family)
get_default_credit_specification(instance_family, params::Dict{String,<:Any})
Describes the default credit option for CPU usage of a burstable performance instance
family. For more information, see Burstable performance instances in the Amazon EC2 User
Guide.
# Arguments
- `instance_family`: The instance family.
# 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.
"""
function get_default_credit_specification(
InstanceFamily; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetDefaultCreditSpecification",
Dict{String,Any}("InstanceFamily" => InstanceFamily);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_default_credit_specification(
InstanceFamily,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetDefaultCreditSpecification",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceFamily" => InstanceFamily), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ebs_default_kms_key_id()
get_ebs_default_kms_key_id(params::Dict{String,<:Any})
Describes the default KMS key for EBS encryption by default for your account in this
Region. You can change the default KMS key for encryption by default using
ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId. For more information, see Amazon EBS
encryption in the Amazon EBS User Guide.
# 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.
"""
function get_ebs_default_kms_key_id(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"GetEbsDefaultKmsKeyId"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_ebs_default_kms_key_id(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetEbsDefaultKmsKeyId",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ebs_encryption_by_default()
get_ebs_encryption_by_default(params::Dict{String,<:Any})
Describes whether EBS encryption by default is enabled for your account in the current
Region. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
# 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.
"""
function get_ebs_encryption_by_default(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"GetEbsEncryptionByDefault"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_ebs_encryption_by_default(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetEbsEncryptionByDefault",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_flow_logs_integration_template(config_delivery_s3_destination_arn, flow_log_id, integrate_service)
get_flow_logs_integration_template(config_delivery_s3_destination_arn, flow_log_id, integrate_service, params::Dict{String,<:Any})
Generates a CloudFormation template that streamlines and automates the integration of VPC
flow logs with Amazon Athena. This make it easier for you to query and gain insights from
VPC flow logs data. Based on the information that you provide, we configure resources in
the template to do the following: Create a table in Athena that maps fields to a custom
log format Create a Lambda function that updates the table with new partitions on a
daily, weekly, or monthly basis Create a table partitioned between two timestamps in the
past Create a set of named queries in Athena that you can use to get started quickly
GetFlowLogsIntegrationTemplate does not support integration between Amazon Web Services
Transit Gateway Flow Logs and Amazon Athena.
# Arguments
- `config_delivery_s3_destination_arn`: To store the CloudFormation template in Amazon S3,
specify the location in Amazon S3.
- `flow_log_id`: The ID of the flow log.
- `integrate_service`: Information about the service integration.
# 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.
"""
function get_flow_logs_integration_template(
ConfigDeliveryS3DestinationArn,
FlowLogId,
IntegrateService;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetFlowLogsIntegrationTemplate",
Dict{String,Any}(
"ConfigDeliveryS3DestinationArn" => ConfigDeliveryS3DestinationArn,
"FlowLogId" => FlowLogId,
"IntegrateService" => IntegrateService,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_flow_logs_integration_template(
ConfigDeliveryS3DestinationArn,
FlowLogId,
IntegrateService,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetFlowLogsIntegrationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigDeliveryS3DestinationArn" => ConfigDeliveryS3DestinationArn,
"FlowLogId" => FlowLogId,
"IntegrateService" => IntegrateService,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_groups_for_capacity_reservation(capacity_reservation_id)
get_groups_for_capacity_reservation(capacity_reservation_id, params::Dict{String,<:Any})
Lists the resource groups to which a Capacity Reservation has been added.
# Arguments
- `capacity_reservation_id`: The ID of the Capacity Reservation. If you specify a Capacity
Reservation that is shared with you, the operation returns only Capacity Reservation groups
that you own.
# 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.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token to use to retrieve the next page of results.
"""
function get_groups_for_capacity_reservation(
CapacityReservationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetGroupsForCapacityReservation",
Dict{String,Any}("CapacityReservationId" => CapacityReservationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_groups_for_capacity_reservation(
CapacityReservationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetGroupsForCapacityReservation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CapacityReservationId" => CapacityReservationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_host_reservation_purchase_preview(offering_id, item)
get_host_reservation_purchase_preview(offering_id, item, params::Dict{String,<:Any})
Preview a reservation purchase with configurations that match those of your Dedicated Host.
You must have active Dedicated Hosts in your account before you purchase a reservation.
This is a preview of the PurchaseHostReservation action and does not result in the offering
being purchased.
# Arguments
- `offering_id`: The offering ID of the reservation.
- `item`: The IDs of the Dedicated Hosts with which the reservation is associated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HostIdSet"`: The IDs of the Dedicated Hosts with which the reservation is associated.
"""
function get_host_reservation_purchase_preview(
OfferingId, item; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetHostReservationPurchasePreview",
Dict{String,Any}("OfferingId" => OfferingId, "item" => item);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_host_reservation_purchase_preview(
OfferingId,
item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetHostReservationPurchasePreview",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("OfferingId" => OfferingId, "item" => item), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_image_block_public_access_state()
get_image_block_public_access_state(params::Dict{String,<:Any})
Gets the current state of block public access for AMIs at the account level in the
specified Amazon Web Services Region. For more information, see Block public access to your
AMIs in the Amazon EC2 User Guide.
# 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.
"""
function get_image_block_public_access_state(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetImageBlockPublicAccessState";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_image_block_public_access_state(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetImageBlockPublicAccessState",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_metadata_defaults()
get_instance_metadata_defaults(params::Dict{String,<:Any})
Gets the default instance metadata service (IMDS) settings that are set at the account
level in the specified Amazon Web Services
 Region. For more information, see Order
of precedence for instance metadata options in the Amazon EC2 User Guide.
# 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.
"""
function get_instance_metadata_defaults(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"GetInstanceMetadataDefaults";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_metadata_defaults(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetInstanceMetadataDefaults",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_tpm_ek_pub(instance_id, key_format, key_type)
get_instance_tpm_ek_pub(instance_id, key_format, key_type, params::Dict{String,<:Any})
Gets the public endorsement key associated with the Nitro Trusted Platform Module
(NitroTPM) for the specified instance.
# Arguments
- `instance_id`: The ID of the instance for which to get the public endorsement key.
- `key_format`: The required public endorsement key format. Specify der for a DER-encoded
public key that is compatible with OpenSSL. Specify tpmt for a TPM 2.0 format that is
compatible with tpm2-tools. The returned key is base64 encoded.
- `key_type`: The required public endorsement key type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: Specify this parameter to verify whether the request will succeed, without
actually making the request. If the request will succeed, the response is DryRunOperation.
Otherwise, the response is UnauthorizedOperation.
"""
function get_instance_tpm_ek_pub(
InstanceId, KeyFormat, KeyType; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetInstanceTpmEkPub",
Dict{String,Any}(
"InstanceId" => InstanceId, "KeyFormat" => KeyFormat, "KeyType" => KeyType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_tpm_ek_pub(
InstanceId,
KeyFormat,
KeyType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetInstanceTpmEkPub",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceId" => InstanceId,
"KeyFormat" => KeyFormat,
"KeyType" => KeyType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_types_from_instance_requirements(architecture_type, instance_requirements, virtualization_type)
get_instance_types_from_instance_requirements(architecture_type, instance_requirements, virtualization_type, params::Dict{String,<:Any})
Returns a list of instance types with the specified instance attributes. You can use the
response to preview the instance types without launching instances. Note that the response
does not consider capacity. When you specify multiple parameters, you get instance types
that satisfy all of the specified parameters. If you specify multiple values for a
parameter, you get instance types that satisfy any of the specified values. For more
information, see Preview instance types with specified attributes, Attribute-based instance
type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and
Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using
attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
# Arguments
- `architecture_type`: The processor architecture type.
- `instance_requirements`: The attributes required for the instance types.
- `virtualization_type`: The virtualization type.
# 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.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function get_instance_types_from_instance_requirements(
ArchitectureType,
InstanceRequirements,
VirtualizationType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetInstanceTypesFromInstanceRequirements",
Dict{String,Any}(
"ArchitectureType" => ArchitectureType,
"InstanceRequirements" => InstanceRequirements,
"VirtualizationType" => VirtualizationType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_types_from_instance_requirements(
ArchitectureType,
InstanceRequirements,
VirtualizationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetInstanceTypesFromInstanceRequirements",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ArchitectureType" => ArchitectureType,
"InstanceRequirements" => InstanceRequirements,
"VirtualizationType" => VirtualizationType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_uefi_data(instance_id)
get_instance_uefi_data(instance_id, params::Dict{String,<:Any})
A binary representation of the UEFI variable store. Only non-volatile variables are stored.
This is a base64 encoded and zlib compressed binary value that must be properly encoded.
When you use register-image to create an AMI, you can create an exact copy of your variable
store by passing the UEFI data in the UefiData parameter. You can modify the UEFI data by
using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data
into a human-readable format (JSON), which you can inspect and modify, and then convert
back into the binary format to use with register-image. For more information, see UEFI
Secure Boot in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The ID of the instance from which to retrieve the UEFI data.
# 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.
"""
function get_instance_uefi_data(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetInstanceUefiData",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_uefi_data(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetInstanceUefiData",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipam_address_history(cidr, ipam_scope_id)
get_ipam_address_history(cidr, ipam_scope_id, params::Dict{String,<:Any})
Retrieve historical information about a CIDR within an IPAM scope. For more information,
see View the history of IP addresses in the Amazon VPC IPAM User Guide.
# Arguments
- `cidr`: The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address
range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will
not get records for any subnets within the /16 CIDR.
- `ipam_scope_id`: The ID of the IPAM scope that the CIDR is in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"EndTime"`: The end of the time period for which you are looking for history. If you
omit this option, it will default to the current time.
- `"MaxResults"`: The maximum number of historical results you would like returned per
page. Defaults to 100.
- `"NextToken"`: The token for the next page of results.
- `"StartTime"`: The start of the time period for which you are looking for history. If you
omit this option, it will default to the value of EndTime.
- `"VpcId"`: The ID of the VPC you want your history records filtered by.
"""
function get_ipam_address_history(
Cidr, IpamScopeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetIpamAddressHistory",
Dict{String,Any}("Cidr" => Cidr, "IpamScopeId" => IpamScopeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipam_address_history(
Cidr,
IpamScopeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetIpamAddressHistory",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Cidr" => Cidr, "IpamScopeId" => IpamScopeId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipam_discovered_accounts(discovery_region, ipam_resource_discovery_id)
get_ipam_discovered_accounts(discovery_region, ipam_resource_discovery_id, params::Dict{String,<:Any})
Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that
is monitored under a resource discovery. If you have integrated IPAM with Amazon Web
Services Organizations, all accounts in the organization are discovered accounts. Only the
IPAM account can get all discovered accounts in the organization.
# Arguments
- `discovery_region`: The Amazon Web Services Region that the account information is
returned from.
- `ipam_resource_discovery_id`: A resource discovery ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: Discovered account filters.
- `"MaxResults"`: The maximum number of discovered accounts to return in one page of
results.
- `"NextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function get_ipam_discovered_accounts(
DiscoveryRegion,
IpamResourceDiscoveryId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetIpamDiscoveredAccounts",
Dict{String,Any}(
"DiscoveryRegion" => DiscoveryRegion,
"IpamResourceDiscoveryId" => IpamResourceDiscoveryId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipam_discovered_accounts(
DiscoveryRegion,
IpamResourceDiscoveryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetIpamDiscoveredAccounts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DiscoveryRegion" => DiscoveryRegion,
"IpamResourceDiscoveryId" => IpamResourceDiscoveryId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipam_discovered_public_addresses(address_region, ipam_resource_discovery_id)
get_ipam_discovered_public_addresses(address_region, ipam_resource_discovery_id, params::Dict{String,<:Any})
Gets the public IP addresses that have been discovered by IPAM.
# Arguments
- `address_region`: The Amazon Web Services Region for the IP address.
- `ipam_resource_discovery_id`: An IPAM resource discovery ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: Filters.
- `"MaxResults"`: The maximum number of IPAM discovered public addresses to return in one
page of results.
- `"NextToken"`: The token for the next page of results.
"""
function get_ipam_discovered_public_addresses(
AddressRegion,
IpamResourceDiscoveryId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetIpamDiscoveredPublicAddresses",
Dict{String,Any}(
"AddressRegion" => AddressRegion,
"IpamResourceDiscoveryId" => IpamResourceDiscoveryId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipam_discovered_public_addresses(
AddressRegion,
IpamResourceDiscoveryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetIpamDiscoveredPublicAddresses",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AddressRegion" => AddressRegion,
"IpamResourceDiscoveryId" => IpamResourceDiscoveryId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipam_discovered_resource_cidrs(ipam_resource_discovery_id, resource_region)
get_ipam_discovered_resource_cidrs(ipam_resource_discovery_id, resource_region, params::Dict{String,<:Any})
Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered
resource is a resource CIDR monitored under a resource discovery. The following resources
can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.
# Arguments
- `ipam_resource_discovery_id`: A resource discovery ID.
- `resource_region`: A resource Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: Filters.
- `"MaxResults"`: The maximum number of discovered resource CIDRs to return in one page of
results.
- `"NextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function get_ipam_discovered_resource_cidrs(
IpamResourceDiscoveryId,
ResourceRegion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetIpamDiscoveredResourceCidrs",
Dict{String,Any}(
"IpamResourceDiscoveryId" => IpamResourceDiscoveryId,
"ResourceRegion" => ResourceRegion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipam_discovered_resource_cidrs(
IpamResourceDiscoveryId,
ResourceRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetIpamDiscoveredResourceCidrs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IpamResourceDiscoveryId" => IpamResourceDiscoveryId,
"ResourceRegion" => ResourceRegion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipam_pool_allocations(ipam_pool_id)
get_ipam_pool_allocations(ipam_pool_id, params::Dict{String,<:Any})
Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the
IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is
available for allocations. If you use this action after AllocateIpamPoolCidr or
ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency
model.
# Arguments
- `ipam_pool_id`: The ID of the IPAM pool you want to see the allocations for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: One or more filters for the request. For more information about filtering,
see Filtering CLI output.
- `"IpamPoolAllocationId"`: The ID of the allocation.
- `"MaxResults"`: The maximum number of results you would like returned per page.
- `"NextToken"`: The token for the next page of results.
"""
function get_ipam_pool_allocations(
IpamPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetIpamPoolAllocations",
Dict{String,Any}("IpamPoolId" => IpamPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipam_pool_allocations(
IpamPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetIpamPoolAllocations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IpamPoolId" => IpamPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipam_pool_cidrs(ipam_pool_id)
get_ipam_pool_cidrs(ipam_pool_id, params::Dict{String,<:Any})
Get the CIDRs provisioned to an IPAM pool.
# Arguments
- `ipam_pool_id`: The ID of the IPAM pool you want the CIDR for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: One or more filters for the request. For more information about filtering,
see Filtering CLI output.
- `"MaxResults"`: The maximum number of results to return in the request.
- `"NextToken"`: The token for the next page of results.
"""
function get_ipam_pool_cidrs(IpamPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"GetIpamPoolCidrs",
Dict{String,Any}("IpamPoolId" => IpamPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipam_pool_cidrs(
IpamPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetIpamPoolCidrs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IpamPoolId" => IpamPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipam_resource_cidrs(ipam_scope_id)
get_ipam_resource_cidrs(ipam_scope_id, params::Dict{String,<:Any})
Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more
than one resource discovery, the resource CIDRs across all of the resource discoveries is
returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor
resources that belong to the owning account.
# Arguments
- `ipam_scope_id`: The ID of the scope that the resource is in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
- `"Filter"`: One or more filters for the request. For more information about filtering,
see Filtering CLI output.
- `"IpamPoolId"`: The ID of the IPAM pool that the resource is in.
- `"MaxResults"`: The maximum number of results to return in the request.
- `"NextToken"`: The token for the next page of results.
- `"ResourceId"`: The ID of the resource.
- `"ResourceOwner"`: The ID of the Amazon Web Services account that owns the resource.
- `"ResourceTag"`: The resource tag.
- `"ResourceType"`: The resource type.
"""
function get_ipam_resource_cidrs(
IpamScopeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetIpamResourceCidrs",
Dict{String,Any}("IpamScopeId" => IpamScopeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipam_resource_cidrs(
IpamScopeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetIpamResourceCidrs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IpamScopeId" => IpamScopeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_launch_template_data(instance_id)
get_launch_template_data(instance_id, params::Dict{String,<:Any})
Retrieves the configuration data of the specified instance. You can use this data to create
a launch template. This action calls on other describe actions to get instance
information. Depending on your instance configuration, you may need to allow the following
actions in your IAM policy: DescribeSpotInstanceRequests,
DescribeInstanceCreditSpecifications, DescribeVolumes, and DescribeInstanceAttribute. Or,
you can allow describe* depending on your instance requirements.
# Arguments
- `instance_id`: The ID of the instance.
# 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.
"""
function get_launch_template_data(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetLaunchTemplateData",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_launch_template_data(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetLaunchTemplateData",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_managed_prefix_list_associations(prefix_list_id)
get_managed_prefix_list_associations(prefix_list_id, params::Dict{String,<:Any})
Gets information about the resources that are associated with the specified managed prefix
list.
# Arguments
- `prefix_list_id`: The ID of the prefix list.
# 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.
- `"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 get_managed_prefix_list_associations(
PrefixListId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetManagedPrefixListAssociations",
Dict{String,Any}("PrefixListId" => PrefixListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_managed_prefix_list_associations(
PrefixListId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetManagedPrefixListAssociations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PrefixListId" => PrefixListId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_managed_prefix_list_entries(prefix_list_id)
get_managed_prefix_list_entries(prefix_list_id, params::Dict{String,<:Any})
Gets information about the entries for a specified managed prefix list.
# Arguments
- `prefix_list_id`: The ID of the prefix list.
# 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.
- `"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.
- `"TargetVersion"`: The version of the prefix list for which to return the entries. The
default is the current version.
"""
function get_managed_prefix_list_entries(
PrefixListId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetManagedPrefixListEntries",
Dict{String,Any}("PrefixListId" => PrefixListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_managed_prefix_list_entries(
PrefixListId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetManagedPrefixListEntries",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PrefixListId" => PrefixListId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_insights_access_scope_analysis_findings(network_insights_access_scope_analysis_id)
get_network_insights_access_scope_analysis_findings(network_insights_access_scope_analysis_id, params::Dict{String,<:Any})
Gets the findings for the specified Network Access Scope analysis.
# Arguments
- `network_insights_access_scope_analysis_id`: The ID of the Network Access Scope analysis.
# 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.
- `"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 get_network_insights_access_scope_analysis_findings(
NetworkInsightsAccessScopeAnalysisId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetNetworkInsightsAccessScopeAnalysisFindings",
Dict{String,Any}(
"NetworkInsightsAccessScopeAnalysisId" => NetworkInsightsAccessScopeAnalysisId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_insights_access_scope_analysis_findings(
NetworkInsightsAccessScopeAnalysisId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetNetworkInsightsAccessScopeAnalysisFindings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NetworkInsightsAccessScopeAnalysisId" =>
NetworkInsightsAccessScopeAnalysisId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_insights_access_scope_content(network_insights_access_scope_id)
get_network_insights_access_scope_content(network_insights_access_scope_id, params::Dict{String,<:Any})
Gets the content for the specified Network Access Scope.
# Arguments
- `network_insights_access_scope_id`: The ID of the Network Access Scope.
# 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.
"""
function get_network_insights_access_scope_content(
NetworkInsightsAccessScopeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetNetworkInsightsAccessScopeContent",
Dict{String,Any}("NetworkInsightsAccessScopeId" => NetworkInsightsAccessScopeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_insights_access_scope_content(
NetworkInsightsAccessScopeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetNetworkInsightsAccessScopeContent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NetworkInsightsAccessScopeId" => NetworkInsightsAccessScopeId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_password_data(instance_id)
get_password_data(instance_id, params::Dict{String,<:Any})
Retrieves the encrypted administrator password for a running Windows instance. The Windows
password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server
2016 and later). This usually only happens the first time an instance is launched. For more
information, see EC2Config and EC2Launch in the Amazon EC2 User Guide. For the EC2Config
service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled
before bundling. The password is encrypted using the key pair that you specified when you
launched the instance. You must provide the corresponding key pair file. When you launch an
instance, password generation and encryption may take a few minutes. If you try to retrieve
the password before it's available, the output returns an empty string. We recommend that
you wait up to 15 minutes after launching an instance before trying to retrieve the
generated password.
# Arguments
- `instance_id`: The ID of the Windows instance.
# 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.
"""
function get_password_data(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"GetPasswordData",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_password_data(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetPasswordData",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_reserved_instances_exchange_quote(reserved_instance_id)
get_reserved_instances_exchange_quote(reserved_instance_id, params::Dict{String,<:Any})
Returns a quote and exchange information for exchanging one or more specified Convertible
Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be
performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote
to perform the exchange.
# Arguments
- `reserved_instance_id`: The IDs of the Convertible Reserved Instances to exchange.
# 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.
- `"TargetConfiguration"`: The configuration of the target Convertible Reserved Instance to
exchange for your current Convertible Reserved Instances.
"""
function get_reserved_instances_exchange_quote(
ReservedInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetReservedInstancesExchangeQuote",
Dict{String,Any}("ReservedInstanceId" => ReservedInstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_reserved_instances_exchange_quote(
ReservedInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetReservedInstancesExchangeQuote",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReservedInstanceId" => ReservedInstanceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_security_groups_for_vpc(vpc_id)
get_security_groups_for_vpc(vpc_id, params::Dict{String,<:Any})
Gets security groups that can be associated by the Amazon Web Services account making the
request with network interfaces in the specified VPC.
# Arguments
- `vpc_id`: The VPC ID where the security group can be used.
# 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.
- `"Filter"`: The filters. If using multiple filters, the results include security groups
which match all filters. group-id: The security group ID. description: The security
group's description. group-name: The security group name. owner-id: The security
group owner ID. primary-vpc-id: The VPC ID in which the security group was created.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function get_security_groups_for_vpc(
VpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetSecurityGroupsForVpc",
Dict{String,Any}("VpcId" => VpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_security_groups_for_vpc(
VpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetSecurityGroupsForVpc",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("VpcId" => VpcId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_serial_console_access_status()
get_serial_console_access_status(params::Dict{String,<:Any})
Retrieves the access status of your account to the EC2 serial console of all instances. By
default, access to the EC2 serial console is disabled for your account. For more
information, see Manage account access to the EC2 serial console in the Amazon EC2 User
Guide.
# 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.
"""
function get_serial_console_access_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetSerialConsoleAccessStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_serial_console_access_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetSerialConsoleAccessStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_snapshot_block_public_access_state()
get_snapshot_block_public_access_state(params::Dict{String,<:Any})
Gets the current state of block public access for snapshots setting for the account and
Region. For more information, see Block public access for snapshots in the Amazon EBS User
Guide.
# 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.
"""
function get_snapshot_block_public_access_state(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetSnapshotBlockPublicAccessState";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_snapshot_block_public_access_state(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetSnapshotBlockPublicAccessState",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_spot_placement_scores(target_capacity)
get_spot_placement_scores(target_capacity, params::Dict{String,<:Any})
Calculates the Spot placement score for a Region or Availability Zone based on the
specified target capacity and compute requirements. You can specify your compute
requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose
the optimal instance types to fulfill your Spot request, or you can specify the instance
types by using InstanceTypes. For more information, see Spot placement score in the Amazon
EC2 User Guide.
# Arguments
- `target_capacity`: The target capacity.
# 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.
- `"InstanceRequirementsWithMetadata"`: The attributes for the instance types. When you
specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadata, you can't specify InstanceTypes.
- `"InstanceType"`: The instance types. We recommend that you specify at least three
instance types. If you specify one or two instance types, or specify variations of a single
instance type (for example, an m3.xlarge with and without instance storage), the returned
placement score will always be low. If you specify InstanceTypes, you can't specify
InstanceRequirementsWithMetadata.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"RegionName"`: The Regions used to narrow down the list of Regions to be scored. Enter
the Region code, for example, us-east-1.
- `"SingleAvailabilityZone"`: Specify true so that the response returns a list of scored
Availability Zones. Otherwise, the response returns a list of scored Regions. A list of
scored Availability Zones is useful if you want to launch all of your Spot capacity into a
single Availability Zone.
- `"TargetCapacityUnitType"`: The unit for the target capacity.
"""
function get_spot_placement_scores(
TargetCapacity; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetSpotPlacementScores",
Dict{String,Any}("TargetCapacity" => TargetCapacity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_spot_placement_scores(
TargetCapacity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetSpotPlacementScores",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TargetCapacity" => TargetCapacity), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subnet_cidr_reservations(subnet_id)
get_subnet_cidr_reservations(subnet_id, params::Dict{String,<:Any})
Gets information about the subnet CIDR reservations.
# Arguments
- `subnet_id`: The ID of the subnet.
# 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.
- `"Filter"`: One or more filters. reservationType - The type of reservation (prefix |
explicit). subnet-id - The ID of the subnet. tag:<key> - The key/value
combination of a tag assigned to the resource. Use the tag key in the filter name and the
tag value as the filter value. For example, to find all resources that have a tag with the
key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the
filter value. tag-key - The key of a tag assigned to the resource. Use this filter to
find all resources assigned a tag with a specific key, regardless of the tag value.
- `"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 get_subnet_cidr_reservations(
SubnetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetSubnetCidrReservations",
Dict{String,Any}("SubnetId" => SubnetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_subnet_cidr_reservations(
SubnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetSubnetCidrReservations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SubnetId" => SubnetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_attachment_propagations(transit_gateway_attachment_id)
get_transit_gateway_attachment_propagations(transit_gateway_attachment_id, params::Dict{String,<:Any})
Lists the route tables to which the specified resource attachment propagates routes.
# Arguments
- `transit_gateway_attachment_id`: The ID of the attachment.
# 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.
- `"Filter"`: One or more filters. The possible values are:
transit-gateway-route-table-id - The ID of the transit gateway route table.
- `"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 get_transit_gateway_attachment_propagations(
TransitGatewayAttachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetTransitGatewayAttachmentPropagations",
Dict{String,Any}("TransitGatewayAttachmentId" => TransitGatewayAttachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_attachment_propagations(
TransitGatewayAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetTransitGatewayAttachmentPropagations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_multicast_domain_associations(transit_gateway_multicast_domain_id)
get_transit_gateway_multicast_domain_associations(transit_gateway_multicast_domain_id, params::Dict{String,<:Any})
Gets information about the associations for the transit gateway multicast domain.
# Arguments
- `transit_gateway_multicast_domain_id`: The ID of the transit gateway multicast domain.
# 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.
- `"Filter"`: One or more filters. The possible values are: resource-id - The ID of the
resource. resource-type - The type of resource. The valid value is: vpc. state - The
state of the subnet association. Valid values are associated | associating | disassociated
| disassociating. subnet-id - The ID of the subnet. transit-gateway-attachment-id -
The id of the transit gateway attachment.
- `"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 get_transit_gateway_multicast_domain_associations(
TransitGatewayMulticastDomainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetTransitGatewayMulticastDomainAssociations",
Dict{String,Any}(
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_multicast_domain_associations(
TransitGatewayMulticastDomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetTransitGatewayMulticastDomainAssociations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_policy_table_associations(transit_gateway_policy_table_id)
get_transit_gateway_policy_table_associations(transit_gateway_policy_table_id, params::Dict{String,<:Any})
Gets a list of the transit gateway policy table associations.
# Arguments
- `transit_gateway_policy_table_id`: The ID of the transit gateway policy table.
# 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.
- `"Filter"`: The filters associated with the transit gateway policy table.
- `"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 get_transit_gateway_policy_table_associations(
TransitGatewayPolicyTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetTransitGatewayPolicyTableAssociations",
Dict{String,Any}("TransitGatewayPolicyTableId" => TransitGatewayPolicyTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_policy_table_associations(
TransitGatewayPolicyTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetTransitGatewayPolicyTableAssociations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayPolicyTableId" => TransitGatewayPolicyTableId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_policy_table_entries(transit_gateway_policy_table_id)
get_transit_gateway_policy_table_entries(transit_gateway_policy_table_id, params::Dict{String,<:Any})
Returns a list of transit gateway policy table entries.
# Arguments
- `transit_gateway_policy_table_id`: The ID of the transit gateway policy table.
# 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.
- `"Filter"`: The filters associated with the transit gateway policy table.
- `"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 get_transit_gateway_policy_table_entries(
TransitGatewayPolicyTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetTransitGatewayPolicyTableEntries",
Dict{String,Any}("TransitGatewayPolicyTableId" => TransitGatewayPolicyTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_policy_table_entries(
TransitGatewayPolicyTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetTransitGatewayPolicyTableEntries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayPolicyTableId" => TransitGatewayPolicyTableId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_prefix_list_references(transit_gateway_route_table_id)
get_transit_gateway_prefix_list_references(transit_gateway_route_table_id, params::Dict{String,<:Any})
Gets information about the prefix list references in a specified transit gateway route
table.
# Arguments
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# 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.
- `"Filter"`: One or more filters. The possible values are: attachment.resource-id - The
ID of the resource for the attachment. attachment.resource-type - The type of resource
for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
attachment.transit-gateway-attachment-id - The ID of the attachment. is-blackhole -
Whether traffic matching the route is blocked (true | false). prefix-list-id - The ID of
the prefix list. prefix-list-owner-id - The ID of the owner of the prefix list. state
- The state of the prefix list reference (pending | available | modifying | deleting).
- `"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 get_transit_gateway_prefix_list_references(
TransitGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetTransitGatewayPrefixListReferences",
Dict{String,Any}("TransitGatewayRouteTableId" => TransitGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_prefix_list_references(
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetTransitGatewayPrefixListReferences",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_route_table_associations(transit_gateway_route_table_id)
get_transit_gateway_route_table_associations(transit_gateway_route_table_id, params::Dict{String,<:Any})
Gets information about the associations for the specified transit gateway route table.
# Arguments
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# 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.
- `"Filter"`: One or more filters. The possible values are: resource-id - The ID of the
resource. resource-type - The resource type. Valid values are vpc | vpn |
direct-connect-gateway | peering | connect. transit-gateway-attachment-id - The ID of
the attachment.
- `"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 get_transit_gateway_route_table_associations(
TransitGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetTransitGatewayRouteTableAssociations",
Dict{String,Any}("TransitGatewayRouteTableId" => TransitGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_route_table_associations(
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetTransitGatewayRouteTableAssociations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_transit_gateway_route_table_propagations(transit_gateway_route_table_id)
get_transit_gateway_route_table_propagations(transit_gateway_route_table_id, params::Dict{String,<:Any})
Gets information about the route table propagations for the specified transit gateway route
table.
# Arguments
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# 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.
- `"Filter"`: One or more filters. The possible values are: resource-id - The ID of the
resource. resource-type - The resource type. Valid values are vpc | vpn |
direct-connect-gateway | peering | connect. transit-gateway-attachment-id - The ID of
the attachment.
- `"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 get_transit_gateway_route_table_propagations(
TransitGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetTransitGatewayRouteTablePropagations",
Dict{String,Any}("TransitGatewayRouteTableId" => TransitGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_transit_gateway_route_table_propagations(
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetTransitGatewayRouteTablePropagations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_verified_access_endpoint_policy(verified_access_endpoint_id)
get_verified_access_endpoint_policy(verified_access_endpoint_id, params::Dict{String,<:Any})
Get the Verified Access policy associated with the endpoint.
# Arguments
- `verified_access_endpoint_id`: The ID of the Verified Access endpoint.
# 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.
"""
function get_verified_access_endpoint_policy(
VerifiedAccessEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetVerifiedAccessEndpointPolicy",
Dict{String,Any}("VerifiedAccessEndpointId" => VerifiedAccessEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_verified_access_endpoint_policy(
VerifiedAccessEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetVerifiedAccessEndpointPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VerifiedAccessEndpointId" => VerifiedAccessEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_verified_access_group_policy(verified_access_group_id)
get_verified_access_group_policy(verified_access_group_id, params::Dict{String,<:Any})
Shows the contents of the Verified Access policy associated with the group.
# Arguments
- `verified_access_group_id`: The ID of the Verified Access group.
# 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.
"""
function get_verified_access_group_policy(
VerifiedAccessGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetVerifiedAccessGroupPolicy",
Dict{String,Any}("VerifiedAccessGroupId" => VerifiedAccessGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_verified_access_group_policy(
VerifiedAccessGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetVerifiedAccessGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VerifiedAccessGroupId" => VerifiedAccessGroupId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vpn_connection_device_sample_configuration(vpn_connection_device_type_id, vpn_connection_id)
get_vpn_connection_device_sample_configuration(vpn_connection_device_type_id, vpn_connection_id, params::Dict{String,<:Any})
Download an Amazon Web Services-provided sample configuration file to be used with the
customer gateway device specified for your Site-to-Site VPN connection.
# Arguments
- `vpn_connection_device_type_id`: Device identifier provided by the
GetVpnConnectionDeviceTypes API.
- `vpn_connection_id`: The VpnConnectionId specifies the Site-to-Site VPN connection used
for the sample configuration.
# 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.
- `"InternetKeyExchangeVersion"`: The IKE version to be used in the sample configuration
file for your customer gateway device. You can specify one of the following versions: ikev1
or ikev2.
"""
function get_vpn_connection_device_sample_configuration(
VpnConnectionDeviceTypeId,
VpnConnectionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetVpnConnectionDeviceSampleConfiguration",
Dict{String,Any}(
"VpnConnectionDeviceTypeId" => VpnConnectionDeviceTypeId,
"VpnConnectionId" => VpnConnectionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vpn_connection_device_sample_configuration(
VpnConnectionDeviceTypeId,
VpnConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetVpnConnectionDeviceSampleConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VpnConnectionDeviceTypeId" => VpnConnectionDeviceTypeId,
"VpnConnectionId" => VpnConnectionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vpn_connection_device_types()
get_vpn_connection_device_types(params::Dict{String,<:Any})
Obtain a list of customer gateway devices for which sample configuration files can be
provided. The request has no additional parameters. You can also see the list of device
types with sample configuration files available under Your customer gateway device in the
Amazon Web Services Site-to-Site VPN User Guide.
# 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.
- `"MaxResults"`: The maximum number of results returned by GetVpnConnectionDeviceTypes in
paginated output. When this parameter is used, GetVpnConnectionDeviceTypes only returns
MaxResults results in a single page along with a NextToken response element. The remaining
results of the initial request can be seen by sending another GetVpnConnectionDeviceTypes
request with the returned NextToken value. This value can be between 200 and 1000. If this
parameter is not used, then GetVpnConnectionDeviceTypes returns all results.
- `"NextToken"`: The NextToken value returned from a previous paginated
GetVpnConnectionDeviceTypes request where MaxResults was used and the results exceeded the
value of that parameter. Pagination continues from the end of the previous results that
returned the NextToken value. This value is null when there are no more results to return.
"""
function get_vpn_connection_device_types(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetVpnConnectionDeviceTypes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vpn_connection_device_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"GetVpnConnectionDeviceTypes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vpn_tunnel_replacement_status(vpn_connection_id, vpn_tunnel_outside_ip_address)
get_vpn_tunnel_replacement_status(vpn_connection_id, vpn_tunnel_outside_ip_address, params::Dict{String,<:Any})
Get details of available tunnel endpoint maintenance.
# Arguments
- `vpn_connection_id`: The ID of the Site-to-Site VPN connection.
- `vpn_tunnel_outside_ip_address`: The external IP address of the VPN tunnel.
# 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.
"""
function get_vpn_tunnel_replacement_status(
VpnConnectionId,
VpnTunnelOutsideIpAddress;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetVpnTunnelReplacementStatus",
Dict{String,Any}(
"VpnConnectionId" => VpnConnectionId,
"VpnTunnelOutsideIpAddress" => VpnTunnelOutsideIpAddress,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vpn_tunnel_replacement_status(
VpnConnectionId,
VpnTunnelOutsideIpAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"GetVpnTunnelReplacementStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VpnConnectionId" => VpnConnectionId,
"VpnTunnelOutsideIpAddress" => VpnTunnelOutsideIpAddress,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_client_vpn_client_certificate_revocation_list(certificate_revocation_list, client_vpn_endpoint_id)
import_client_vpn_client_certificate_revocation_list(certificate_revocation_list, client_vpn_endpoint_id, params::Dict{String,<:Any})
Uploads a client certificate revocation list to the specified Client VPN endpoint.
Uploading a client certificate revocation list overwrites the existing client certificate
revocation list. Uploading a client certificate revocation list resets existing client
connections.
# Arguments
- `certificate_revocation_list`: The client certificate revocation list file. For more
information, see Generate a Client Certificate Revocation List in the Client VPN
Administrator Guide.
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint to which the client
certificate revocation list applies.
# 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.
"""
function import_client_vpn_client_certificate_revocation_list(
CertificateRevocationList,
ClientVpnEndpointId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ImportClientVpnClientCertificateRevocationList",
Dict{String,Any}(
"CertificateRevocationList" => CertificateRevocationList,
"ClientVpnEndpointId" => ClientVpnEndpointId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_client_vpn_client_certificate_revocation_list(
CertificateRevocationList,
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ImportClientVpnClientCertificateRevocationList",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CertificateRevocationList" => CertificateRevocationList,
"ClientVpnEndpointId" => ClientVpnEndpointId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_image()
import_image(params::Dict{String,<:Any})
To import your virtual machines (VMs) with a console-based experience, you can use the
Import virtual machine images to Amazon Web Services template in the Migration Hub
Orchestrator console. For more information, see the Migration Hub Orchestrator User Guide
. Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image
(AMI). Amazon Web Services VM Import/Export strongly recommends specifying a value for
either the --license-type or --usage-operation parameter when you create a new VM Import
task. This ensures your operating system is licensed appropriately and your billing is
optimized. For more information, see Importing a VM as an image using VM Import/Export in
the VM Import/Export User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Architecture"`: The architecture of the virtual machine. Valid values: i386 | x86_64
- `"BootMode"`: The boot mode of the virtual machine. The uefi-preferred boot mode isn't
supported for importing images. For more information, see Boot modes in the VM
Import/Export User Guide.
- `"ClientData"`: The client-specific data.
- `"ClientToken"`: The token to enable idempotency for VM import requests.
- `"Description"`: A description string for the import image task.
- `"DiskContainer"`: Information about the disk containers.
- `"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.
- `"Encrypted"`: Specifies whether the destination AMI of the imported image should be
encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key
using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic
Compute Cloud User Guide.
- `"Hypervisor"`: The target hypervisor platform. Valid values: xen
- `"KmsKeyId"`: An identifier for the symmetric KMS key to use when creating the encrypted
AMI. This parameter is only required if you want to use a non-default KMS key; if this
parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is
specified, the Encrypted flag must also be set. The KMS key identifier may be provided in
any of the following formats: Key ID Key alias ARN using key ID. The ID ARN contains
the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services
account ID of the key owner, the key namespace, and then the key ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. ARN using
key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the
key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the
key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. Amazon
Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to
complete even though you provided an invalid identifier. This action will eventually report
failure. The specified KMS key must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric KMS keys.
- `"LicenseSpecifications"`: The ARNs of the license configurations.
- `"LicenseType"`: The license type to be used for the Amazon Machine Image (AMI) after
importing. Specify AWS to replace the source-system license with an Amazon Web Services
license or BYOL to retain the source-system license. Leaving this parameter undefined is
the same as choosing AWS when importing a Windows Server operating system, and the same as
choosing BYOL when importing a Windows client operating system (such as Windows 10) or a
Linux operating system. To use BYOL, you must have existing licenses with rights to use
these licenses in a third party cloud, such as Amazon Web Services. For more information,
see Prerequisites in the VM Import/Export User Guide.
- `"Platform"`: The operating system of the virtual machine. If you import a VM that is
compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you
must specify a value for the platform. Valid values: Windows | Linux
- `"RoleName"`: The name of the role to use when not using the default role, 'vmimport'.
- `"TagSpecification"`: The tags to apply to the import image task during creation.
- `"UsageOperation"`: The usage operation value. For more information, see Licensing
options in the VM Import/Export User Guide.
"""
function import_image(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("ImportImage"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function import_image(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ImportImage", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
import_instance(platform)
import_instance(platform, params::Dict{String,<:Any})
We recommend that you use the ImportImage API. For more information, see Importing a VM
as an image using VM Import/Export in the VM Import/Export User Guide. Creates an import
instance task using metadata from the specified disk image. This API action is not
supported by the Command Line Interface (CLI). For information about using the Amazon EC2
CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference
PDF file. This API action supports only single-volume VMs. To import multi-volume VMs, use
ImportImage instead. For information about the import manifest referenced by this API
action, see VM Import Manifest.
# Arguments
- `platform`: The instance operating system.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description for the instance being imported.
- `"diskImage"`: The disk image.
- `"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.
- `"launchSpecification"`: The launch specification.
"""
function import_instance(platform; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ImportInstance",
Dict{String,Any}("platform" => platform);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_instance(
platform,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ImportInstance",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("platform" => platform), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_key_pair(key_name, public_key_material)
import_key_pair(key_name, public_key_material, params::Dict{String,<:Any})
Imports the public key from an RSA or ED25519 key pair that you created with a third-party
tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair
and gives the keys to you (Amazon Web Services keeps a copy of the public key). With
ImportKeyPair, you create the key pair and give Amazon Web Services just the public key.
The private key is never transferred between you and Amazon Web Services. For more
information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud
User Guide.
# Arguments
- `key_name`: A unique name for the key pair.
- `public_key_material`: The public key. For API calls, the text must be base64-encoded.
For command line tools, base64 encoding is performed for you.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagSpecification"`: The tags to apply to the imported key pair.
- `"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.
"""
function import_key_pair(
keyName, publicKeyMaterial; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ImportKeyPair",
Dict{String,Any}("keyName" => keyName, "publicKeyMaterial" => publicKeyMaterial);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_key_pair(
keyName,
publicKeyMaterial,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ImportKeyPair",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"keyName" => keyName, "publicKeyMaterial" => publicKeyMaterial
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_snapshot()
import_snapshot(params::Dict{String,<:Any})
Imports a disk into an EBS snapshot. For more information, see Importing a disk as a
snapshot using VM Import/Export in the VM Import/Export User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientData"`: The client-specific data.
- `"ClientToken"`: Token to enable idempotency for VM import requests.
- `"Description"`: The description string for the import snapshot task.
- `"DiskContainer"`: Information about the disk container.
- `"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.
- `"Encrypted"`: Specifies whether the destination snapshot of the imported image should be
encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key
using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic
Compute Cloud User Guide.
- `"KmsKeyId"`: An identifier for the symmetric KMS key to use when creating the encrypted
snapshot. This parameter is only required if you want to use a non-default KMS key; if this
parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is
specified, the Encrypted flag must also be set. The KMS key identifier may be provided in
any of the following formats: Key ID Key alias ARN using key ID. The ID ARN contains
the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services
account ID of the key owner, the key namespace, and then the key ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. ARN using
key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the
key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the
key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. Amazon
Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to
complete even though you provided an invalid identifier. This action will eventually report
failure. The specified KMS key must exist in the Region that the snapshot is being copied
to. Amazon EBS does not support asymmetric KMS keys.
- `"RoleName"`: The name of the role to use when not using the default role, 'vmimport'.
- `"TagSpecification"`: The tags to apply to the import snapshot task during creation.
"""
function import_snapshot(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("ImportSnapshot"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function import_snapshot(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ImportSnapshot", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
import_volume(availability_zone, image, volume)
import_volume(availability_zone, image, volume, params::Dict{String,<:Any})
Creates an import volume task using metadata from the specified disk image. This API action
supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To
import a disk to a snapshot, use ImportSnapshot instead. This API action is not supported
by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which
is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import
Manifest.
# Arguments
- `availability_zone`: The Availability Zone for the resulting EBS volume.
- `image`: The disk image.
- `volume`: The volume size.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the volume.
- `"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.
"""
function import_volume(
availabilityZone, image, volume; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ImportVolume",
Dict{String,Any}(
"availabilityZone" => availabilityZone, "image" => image, "volume" => volume
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_volume(
availabilityZone,
image,
volume,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ImportVolume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"availabilityZone" => availabilityZone,
"image" => image,
"volume" => volume,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_images_in_recycle_bin()
list_images_in_recycle_bin(params::Dict{String,<:Any})
Lists one or more AMIs that are currently in the Recycle Bin. For more information, see
Recycle Bin in the Amazon EC2 User Guide.
# 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.
- `"ImageId"`: The IDs of the AMIs to list. Omit this parameter to list all of the AMIs
that are in the Recycle Bin. You can specify up to 20 IDs in a single request.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
"""
function list_images_in_recycle_bin(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ListImagesInRecycleBin"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_images_in_recycle_bin(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ListImagesInRecycleBin",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_snapshots_in_recycle_bin()
list_snapshots_in_recycle_bin(params::Dict{String,<:Any})
Lists one or more snapshots that are currently in the Recycle Bin.
# 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.
- `"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. For more
information, see Pagination.
- `"NextToken"`: The token returned from a previous paginated request. Pagination continues
from the end of the items returned by the previous request.
- `"SnapshotId"`: The IDs of the snapshots to list. Omit this parameter to list all of the
snapshots that are in the Recycle Bin.
"""
function list_snapshots_in_recycle_bin(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ListSnapshotsInRecycleBin"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_snapshots_in_recycle_bin(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ListSnapshotsInRecycleBin",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
lock_snapshot(lock_mode, snapshot_id)
lock_snapshot(lock_mode, snapshot_id, params::Dict{String,<:Any})
Locks an Amazon EBS snapshot in either governance or compliance mode to protect it against
accidental or malicious deletions for a specific duration. A locked snapshot can't be
deleted. You can also use this action to modify the lock settings for a snapshot that is
already locked. The allowed modifications depend on the lock mode and lock state: If the
snapshot is locked in governance mode, you can modify the lock mode and the lock duration
or lock expiration date. If the snapshot is locked in compliance mode and it is in the
cooling-off period, you can modify the lock mode and the lock duration or lock expiration
date. If the snapshot is locked in compliance mode and the cooling-off period has lapsed,
you can only increase the lock duration or extend the lock expiration date.
# Arguments
- `lock_mode`: The mode in which to lock the snapshot. Specify one of the following:
governance - Locks the snapshot in governance mode. Snapshots locked in governance mode
can't be deleted until one of the following conditions are met: The lock duration
expires. The snapshot is unlocked by a user with the appropriate permissions. Users
with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock
duration, and change the lock mode to compliance at any time. If you lock a snapshot in
governance mode, omit CoolOffPeriod. compliance - Locks the snapshot in compliance
mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be
deleted only after the lock duration expires. Users can't decrease the lock duration or
change the lock mode to governance. However, users with appropriate IAM permissions can
increase the lock duration at any time. If you lock a snapshot in compliance mode, you can
optionally specify CoolOffPeriod.
- `snapshot_id`: The ID of the snapshot to lock.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CoolOffPeriod"`: The cooling-off period during which you can unlock the snapshot or
modify the lock settings after locking the snapshot in compliance mode, in hours. After the
cooling-off period expires, you can't unlock or delete the snapshot, decrease the lock
duration, or change the lock mode. You can increase the lock duration after the cooling-off
period expires. The cooling-off period is optional when locking a snapshot in compliance
mode. If you are locking the snapshot in governance mode, omit this parameter. To lock the
snapshot in compliance mode immediately without a cooling-off period, omit this parameter.
If you are extending the lock duration for a snapshot that is locked in compliance mode
after the cooling-off period has expired, omit this parameter. If you specify a
cooling-period in a such a request, the request fails. Allowed values: Min 1, max 72.
- `"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.
- `"ExpirationDate"`: The date and time at which the snapshot lock is to automatically
expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). You must specify either this
parameter or LockDuration, but not both.
- `"LockDuration"`: The period of time for which to lock the snapshot, in days. The
snapshot lock will automatically expire after this period lapses. You must specify either
this parameter or ExpirationDate, but not both. Allowed values: Min: 1, max 36500
"""
function lock_snapshot(
LockMode, SnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"LockSnapshot",
Dict{String,Any}("LockMode" => LockMode, "SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function lock_snapshot(
LockMode,
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"LockSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LockMode" => LockMode, "SnapshotId" => SnapshotId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_address_attribute(allocation_id)
modify_address_attribute(allocation_id, params::Dict{String,<:Any})
Modifies an attribute of the specified Elastic IP address. For requirements, see Using
reverse DNS for email applications.
# Arguments
- `allocation_id`: [EC2-VPC] The allocation ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DomainName"`: The domain name to modify for the IP address.
- `"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.
"""
function modify_address_attribute(
AllocationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyAddressAttribute",
Dict{String,Any}("AllocationId" => AllocationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_address_attribute(
AllocationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyAddressAttribute",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AllocationId" => AllocationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_availability_zone_group(group_name, opt_in_status)
modify_availability_zone_group(group_name, opt_in_status, params::Dict{String,<:Any})
Changes the opt-in status of the specified zone group for your account.
# Arguments
- `group_name`: The name of the Availability Zone group, Local Zone group, or Wavelength
Zone group.
- `opt_in_status`: Indicates whether to opt in to the zone group. The only valid value is
opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or
Wavelength Zone group.
# 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.
"""
function modify_availability_zone_group(
GroupName, OptInStatus; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyAvailabilityZoneGroup",
Dict{String,Any}("GroupName" => GroupName, "OptInStatus" => OptInStatus);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_availability_zone_group(
GroupName,
OptInStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyAvailabilityZoneGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "OptInStatus" => OptInStatus),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_capacity_reservation(capacity_reservation_id)
modify_capacity_reservation(capacity_reservation_id, params::Dict{String,<:Any})
Modifies a Capacity Reservation's capacity and the conditions under which it is to be
released. You cannot change a Capacity Reservation's instance type, EBS optimization,
instance store settings, platform, Availability Zone, or instance eligibility. If you need
to modify any of these attributes, we recommend that you cancel the Capacity Reservation,
and then create a new one with the required attributes.
# Arguments
- `capacity_reservation_id`: The ID of the Capacity Reservation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Accept"`: Reserved. Capacity Reservations you have created are accepted by default.
- `"AdditionalInfo"`: Reserved for future use.
- `"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.
- `"EndDate"`: The date and time at which the Capacity Reservation expires. When a Capacity
Reservation expires, the reserved capacity is released and you can no longer launch
instances into it. The Capacity Reservation's state changes to expired when it reaches its
end date and time. The Capacity Reservation is cancelled within an hour from the specified
time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is
guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019. You must provide an EndDate
value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
- `"EndDateType"`: Indicates the way in which the Capacity Reservation ends. A Capacity
Reservation can have one of the following end types: unlimited - The Capacity
Reservation remains active until you explicitly cancel it. Do not provide an EndDate value
if EndDateType is unlimited. limited - The Capacity Reservation expires automatically at
a specified date and time. You must provide an EndDate value if EndDateType is limited.
- `"InstanceCount"`: The number of instances for which to reserve capacity. The number of
instances can't be increased or decreased by more than 1000 in a single request.
"""
function modify_capacity_reservation(
CapacityReservationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyCapacityReservation",
Dict{String,Any}("CapacityReservationId" => CapacityReservationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_capacity_reservation(
CapacityReservationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyCapacityReservation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CapacityReservationId" => CapacityReservationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_capacity_reservation_fleet(capacity_reservation_fleet_id)
modify_capacity_reservation_fleet(capacity_reservation_fleet_id, params::Dict{String,<:Any})
Modifies a Capacity Reservation Fleet. When you modify the total target capacity of a
Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or
modifies or cancels existing Capacity Reservations in the Fleet to meet the new total
target capacity. When you modify the end date for the Fleet, the end dates for all of the
individual Capacity Reservations in the Fleet are updated accordingly.
# Arguments
- `capacity_reservation_fleet_id`: The ID of the Capacity Reservation Fleet to modify.
# 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.
- `"EndDate"`: The date and time at which the Capacity Reservation Fleet expires. When the
Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity
Reservations in the Fleet expire. The Capacity Reservation Fleet expires within an hour
after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity
Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019. You
can't specify EndDate and RemoveEndDate in the same request.
- `"RemoveEndDate"`: Indicates whether to remove the end date from the Capacity Reservation
Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it
remains active until you explicitly cancel it using the CancelCapacityReservationFleet
action. You can't specify RemoveEndDate and EndDate in the same request.
- `"TotalTargetCapacity"`: The total number of capacity units to be reserved by the
Capacity Reservation Fleet. This value, together with the instance type weights that you
assign to each instance type used by the Fleet determine the number of instances for which
the Fleet reserves capacity. Both values are based on units that make sense for your
workload. For more information, see Total target capacity in the Amazon EC2 User Guide.
"""
function modify_capacity_reservation_fleet(
CapacityReservationFleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyCapacityReservationFleet",
Dict{String,Any}("CapacityReservationFleetId" => CapacityReservationFleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_capacity_reservation_fleet(
CapacityReservationFleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyCapacityReservationFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CapacityReservationFleetId" => CapacityReservationFleetId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_client_vpn_endpoint(client_vpn_endpoint_id)
modify_client_vpn_endpoint(client_vpn_endpoint_id, params::Dict{String,<:Any})
Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client
connections.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientConnectOptions"`: The options for managing connection authorization for new
client connections.
- `"ClientLoginBannerOptions"`: Options for enabling a customizable text banner that will
be displayed on Amazon Web Services provided clients when a VPN session is established.
- `"ConnectionLogOptions"`: Information about the client connection logging options. If you
enable client connection logging, data about client connections is sent to a Cloudwatch
Logs log stream. The following information is logged: Client connection requests Client
connection results (successful and unsuccessful) Reasons for unsuccessful client
connection requests Client connection termination time
- `"Description"`: A brief description of the Client VPN endpoint.
- `"DnsServers"`: Information about the DNS servers to be used by Client VPN connections. A
Client VPN endpoint can have up to two DNS servers.
- `"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.
- `"SecurityGroupId"`: The IDs of one or more security groups to apply to the target
network.
- `"SelfServicePortal"`: Specify whether to enable the self-service portal for the Client
VPN endpoint.
- `"ServerCertificateArn"`: The ARN of the server certificate to be used. The server
certificate must be provisioned in Certificate Manager (ACM).
- `"SessionTimeoutHours"`: The maximum VPN session duration time in hours. Valid values: 8
| 10 | 12 | 24 Default value: 24
- `"SplitTunnel"`: Indicates whether the VPN is split-tunnel. For information about
split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN
Administrator Guide.
- `"VpcId"`: The ID of the VPC to associate with the Client VPN endpoint.
- `"VpnPort"`: The port number to assign to the Client VPN endpoint for TCP and UDP
traffic. Valid Values: 443 | 1194 Default Value: 443
"""
function modify_client_vpn_endpoint(
ClientVpnEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyClientVpnEndpoint",
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_client_vpn_endpoint(
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyClientVpnEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_default_credit_specification(cpu_credits, instance_family)
modify_default_credit_specification(cpu_credits, instance_family, params::Dict{String,<:Any})
Modifies the default credit option for CPU usage of burstable performance instances. The
default credit option is set at the account level per Amazon Web Services Region, and is
specified per instance family. All new burstable performance instances in the account
launch using the default credit option. ModifyDefaultCreditSpecification is an
asynchronous operation, which works at an Amazon Web Services Region level and modifies the
credit option for each Availability Zone. All zones in a Region are updated within five
minutes. But if instances are launched during this operation, they might not get the new
credit option until the zone is updated. To verify whether the update has occurred, you can
call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates. For
more information, see Burstable performance instances in the Amazon EC2 User Guide.
# Arguments
- `cpu_credits`: The credit option for CPU usage of the instance family. Valid Values:
standard | unlimited
- `instance_family`: The instance family.
# 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.
"""
function modify_default_credit_specification(
CpuCredits, InstanceFamily; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyDefaultCreditSpecification",
Dict{String,Any}("CpuCredits" => CpuCredits, "InstanceFamily" => InstanceFamily);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_default_credit_specification(
CpuCredits,
InstanceFamily,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyDefaultCreditSpecification",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CpuCredits" => CpuCredits, "InstanceFamily" => InstanceFamily
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_ebs_default_kms_key_id(kms_key_id)
modify_ebs_default_kms_key_id(kms_key_id, params::Dict{String,<:Any})
Changes the default KMS key for EBS encryption by default for your account in this Region.
Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for
use with encryption by default. If you change the default KMS key to a symmetric customer
managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset
the default KMS key to the Amazon Web Services managed KMS key for EBS, use
ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys. If you delete or
disable the customer managed KMS key that you specified for use with encryption by default,
your instances will fail to launch. For more information, see Amazon EBS encryption in the
Amazon EBS User Guide.
# Arguments
- `kms_key_id`: The identifier of the KMS key to use for Amazon EBS encryption. If this
parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified,
the encrypted state must be true. You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. For example,
alias/ExampleAlias. Key ARN. For example,
arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN.
For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. Amazon Web Services
authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN
that is not valid, the action can appear to complete, but eventually fails. Amazon EBS does
not support asymmetric KMS keys.
# 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.
"""
function modify_ebs_default_kms_key_id(
KmsKeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyEbsDefaultKmsKeyId",
Dict{String,Any}("KmsKeyId" => KmsKeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_ebs_default_kms_key_id(
KmsKeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyEbsDefaultKmsKeyId",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("KmsKeyId" => KmsKeyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_fleet(fleet_id)
modify_fleet(fleet_id, params::Dict{String,<:Any})
Modifies the specified EC2 Fleet. You can only modify an EC2 Fleet request of type
maintain. While the EC2 Fleet is being modified, it is in the modifying state. To scale up
your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot
Instances according to the allocation strategy for the EC2 Fleet request. If the allocation
strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool
with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes
the instances across the Spot Instance pools. If the allocation strategy is
capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal
capacity for the number of instances that are launching. To scale down your EC2 Fleet,
decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed
the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until
the size of the fleet no longer exceeds the new target capacity. If the allocation strategy
is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If
the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in
the Spot Instance pools that have the least available Spot Instance capacity. If the
allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot
Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its
current size, but not replace any Spot Instances that are interrupted or that you terminate
manually. If you are finished with your EC2 Fleet for now, but will use it again later, you
can set the target capacity to 0.
# Arguments
- `fleet_id`: The ID of the EC2 Fleet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Context"`: Reserved.
- `"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.
- `"ExcessCapacityTerminationPolicy"`: Indicates whether running instances should be
terminated if the total target capacity of the EC2 Fleet is decreased below the current
size of the EC2 Fleet. Supported only for fleets of type maintain.
- `"LaunchTemplateConfig"`: The launch template and overrides.
- `"TargetCapacitySpecification"`: The size of the EC2 Fleet.
"""
function modify_fleet(FleetId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ModifyFleet",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_fleet(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyFleet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_fpga_image_attribute(fpga_image_id)
modify_fpga_image_attribute(fpga_image_id, params::Dict{String,<:Any})
Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
# Arguments
- `fpga_image_id`: The ID of the AFI.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attribute"`: The name of the attribute.
- `"Description"`: A description for the AFI.
- `"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.
- `"LoadPermission"`: The load permission for the AFI.
- `"Name"`: A name for the AFI.
- `"OperationType"`: The operation type.
- `"ProductCode"`: The product codes. After you add a product code to an AFI, it can't be
removed. This parameter is valid only when modifying the productCodes attribute.
- `"UserGroup"`: The user groups. This parameter is valid only when modifying the
loadPermission attribute.
- `"UserId"`: The Amazon Web Services account IDs. This parameter is valid only when
modifying the loadPermission attribute.
"""
function modify_fpga_image_attribute(
FpgaImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyFpgaImageAttribute",
Dict{String,Any}("FpgaImageId" => FpgaImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_fpga_image_attribute(
FpgaImageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyFpgaImageAttribute",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FpgaImageId" => FpgaImageId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_hosts(host_id)
modify_hosts(host_id, params::Dict{String,<:Any})
Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any
instances that you launch with a tenancy of host but without a specific host ID are placed
onto any available Dedicated Host in your account that has auto-placement enabled. When
auto-placement is disabled, you need to provide a host ID to have the instance launch onto
a specific host. If no host ID is provided, the instance is launched onto a suitable host
with auto-placement enabled. You can also use this API action to modify a Dedicated Host to
support either multiple instance types in an instance family, or to support a specific
instance type only.
# Arguments
- `host_id`: The IDs of the Dedicated Hosts to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HostMaintenance"`: Indicates whether to enable or disable host maintenance for the
Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
- `"HostRecovery"`: Indicates whether to enable or disable host recovery for the Dedicated
Host. For more information, see Host recovery in the Amazon EC2 User Guide.
- `"InstanceFamily"`: Specifies the instance family to be supported by the Dedicated Host.
Specify this parameter to modify a Dedicated Host to support multiple instance types within
its current instance family. If you want to modify a Dedicated Host to support a specific
instance type only, omit this parameter and specify InstanceType instead. You cannot
specify InstanceFamily and InstanceType in the same request.
- `"InstanceType"`: Specifies the instance type to be supported by the Dedicated Host.
Specify this parameter to modify a Dedicated Host to support only a specific instance type.
If you want to modify a Dedicated Host to support multiple instance types in its current
instance family, omit this parameter and specify InstanceFamily instead. You cannot specify
InstanceType and InstanceFamily in the same request.
- `"autoPlacement"`: Specify whether to enable or disable auto-placement.
"""
function modify_hosts(hostId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ModifyHosts",
Dict{String,Any}("hostId" => hostId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_hosts(
hostId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyHosts",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("hostId" => hostId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_id_format(resource, use_long_ids)
modify_id_format(resource, use_long_ids, params::Dict{String,<:Any})
Modifies the ID format for the specified resource on a per-Region basis. You can specify
that resources should receive longer IDs (17-character IDs) when they are created. This
request can only be used to modify longer ID settings for resource types that are within
the opt-in period. Resources currently in their opt-in period include: bundle |
conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway |
network-acl | network-acl-association | network-interface | network-interface-attachment |
prefix-list | route-table | route-table-association | security-group | subnet |
subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway. This setting applies to the IAM user
who makes the request; it does not apply to the entire Amazon Web Services account. By
default, an IAM user defaults to the same settings as the root user. If you're using this
action as the root user, then these settings apply to the entire account, unless an IAM
user explicitly overrides these settings for themselves. For more information, see Resource
IDs in the Amazon Elastic Compute Cloud User Guide. Resources created with longer IDs are
visible to all IAM roles and users, regardless of these settings and provided that they
have permission to use the relevant Describe command for the resource type.
# Arguments
- `resource`: The type of resource: bundle | conversion-task | customer-gateway |
dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log |
image | import-task | internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list | route-table |
route-table-association | security-group | subnet | subnet-cidr-block-association | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection |
vpn-gateway. Alternatively, use the all-current option to include all resource types that
are currently within their opt-in period for longer IDs.
- `use_long_ids`: Indicate whether the resource should use longer IDs (17-character IDs).
"""
function modify_id_format(
Resource, UseLongIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyIdFormat",
Dict{String,Any}("Resource" => Resource, "UseLongIds" => UseLongIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_id_format(
Resource,
UseLongIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyIdFormat",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Resource" => Resource, "UseLongIds" => UseLongIds),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_identity_id_format(principal_arn, resource, use_long_ids)
modify_identity_id_format(principal_arn, resource, use_long_ids, params::Dict{String,<:Any})
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user
for an account; or all IAM users, IAM roles, and the root user for an account. You can
specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are
within the opt-in period. Resources currently in their opt-in period include: bundle |
conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway |
network-acl | network-acl-association | network-interface | network-interface-attachment |
prefix-list | route-table | route-table-association | security-group | subnet |
subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint |
vpc-peering-connection | vpn-connection | vpn-gateway. For more information, see Resource
IDs in the Amazon Elastic Compute Cloud User Guide. This setting applies to the principal
specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and users, regardless of
these settings and provided that they have permission to use the relevant Describe command
for the resource type.
# Arguments
- `principal_arn`: The ARN of the principal, which can be an IAM user, IAM role, or the
root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root
user of the account.
- `resource`: The type of resource: bundle | conversion-task | customer-gateway |
dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log |
image | import-task | internet-gateway | network-acl | network-acl-association |
network-interface | network-interface-attachment | prefix-list | route-table |
route-table-association | security-group | subnet | subnet-cidr-block-association | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection |
vpn-gateway. Alternatively, use the all-current option to include all resource types that
are currently within their opt-in period for longer IDs.
- `use_long_ids`: Indicates whether the resource should use longer IDs (17-character IDs)
"""
function modify_identity_id_format(
principalArn, resource, useLongIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyIdentityIdFormat",
Dict{String,Any}(
"principalArn" => principalArn,
"resource" => resource,
"useLongIds" => useLongIds,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_identity_id_format(
principalArn,
resource,
useLongIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyIdentityIdFormat",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"principalArn" => principalArn,
"resource" => resource,
"useLongIds" => useLongIds,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_image_attribute(image_id)
modify_image_attribute(image_id, params::Dict{String,<:Any})
Modifies the specified attribute of the specified AMI. You can specify only one attribute
at a time. To specify the attribute, you can use the Attribute parameter, or one of the
following parameters: Description, ImdsSupport, or LaunchPermission. Images with an Amazon
Web Services Marketplace product code cannot be made public. To enable the SriovNetSupport
enhanced networking attribute of an image, enable SriovNetSupport on an instance and create
an AMI from the instance.
# Arguments
- `image_id`: The ID of the AMI.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attribute"`: The name of the attribute to modify. Valid values: description |
imdsSupport | launchPermission
- `"Description"`: A new description for the AMI.
- `"ImdsSupport"`: Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances
launched from this AMI will have HttpTokens automatically set to required so that, by
default, the instance requires that IMDSv2 is used when requesting instance metadata. In
addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI
in the Amazon EC2 User Guide. Do not use this parameter unless your AMI software supports
IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset”
your AMI is to create a new AMI from the underlying snapshot.
- `"LaunchPermission"`: A new launch permission for the AMI.
- `"OperationType"`: The operation type. This parameter can be used only when the Attribute
parameter is launchPermission.
- `"OrganizationArn"`: The Amazon Resource Name (ARN) of an organization. This parameter
can be used only when the Attribute parameter is launchPermission.
- `"OrganizationalUnitArn"`: The Amazon Resource Name (ARN) of an organizational unit (OU).
This parameter can be used only when the Attribute parameter is launchPermission.
- `"ProductCode"`: Not supported.
- `"UserGroup"`: The user groups. This parameter can be used only when the Attribute
parameter is launchPermission.
- `"UserId"`: The Amazon Web Services account IDs. This parameter can be used only when the
Attribute parameter is launchPermission.
- `"Value"`: The value of the attribute being modified. This parameter can be used only
when the Attribute parameter is description or imdsSupport.
- `"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.
"""
function modify_image_attribute(ImageId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ModifyImageAttribute",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_image_attribute(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyImageAttribute",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_attribute(instance_id)
modify_instance_attribute(instance_id, params::Dict{String,<:Any})
Modifies the specified attribute of the specified instance. You can specify only one
attribute at a time. Note: Using this action to change the security groups associated with
an elastic network interface (ENI) attached to an instance can result in an error if the
instance has more than one ENI. To change the security groups associated with an ENI
attached to an instance that has multiple ENIs, we recommend that you use the
ModifyNetworkInterfaceAttribute action. To modify some attributes, the instance must be
stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The ID of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DisableApiStop"`: Indicates whether an instance is enabled for stop protection. For
more information, see Enable stop protection for your instance.
- `"GroupId"`: Replaces the security groups of the instance with the specified security
groups. You must specify the ID of at least one security group, even if it's just the
default security group for the VPC.
- `"SourceDestCheck"`: Enable or disable source/destination checks, which ensure that the
instance is either the source or the destination of any traffic that it receives. If the
value is true, source/destination checks are enabled; otherwise, they are disabled. The
default value is true. You must disable source/destination checks if the instance runs
services such as network address translation, routing, or firewalls.
- `"attribute"`: The name of the attribute to modify. You can modify the following
attributes only: disableApiTermination | instanceType | kernel | ramdisk |
instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | sourceDestCheck |
groupSet | ebsOptimized | sriovNetSupport | enaSupport | nvmeSupport | disableApiStop |
enclaveOptions
- `"blockDeviceMapping"`: Modifies the DeleteOnTermination attribute for volumes that are
currently attached. The volume must be owned by the caller. If no value is specified for
DeleteOnTermination, the default is true and the volume is deleted when the instance is
terminated. You can't modify the DeleteOnTermination attribute for volumes that are
attached to Fargate tasks. To add instance store volumes to an Amazon EBS-backed instance,
you must add them when you launch the instance. For more information, see Update the block
device mapping when launching an instance in the Amazon EC2 User Guide.
- `"disableApiTermination"`: If the value is true, you can't terminate the instance using
the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for
Spot Instances.
- `"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.
- `"ebsOptimized"`: Specifies whether the instance is optimized for Amazon EBS I/O. This
optimization provides dedicated throughput to Amazon EBS and an optimized configuration
stack to provide optimal EBS I/O performance. This optimization isn't available with all
instance types. Additional usage charges apply when using an EBS Optimized instance.
- `"enaSupport"`: Set to true to enable enhanced networking with ENA for the instance. This
option is supported only for HVM instances. Specifying this option with a PV instance can
make it unreachable.
- `"instanceInitiatedShutdownBehavior"`: Specifies whether an instance stops or terminates
when you initiate shutdown from the instance (using the operating system command for system
shutdown).
- `"instanceType"`: Changes the instance type to the specified value. For more information,
see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the
error returned is InvalidInstanceAttributeValue.
- `"kernel"`: Changes the instance's kernel to the specified value. We recommend that you
use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
- `"ramdisk"`: Changes the instance's RAM disk to the specified value. We recommend that
you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
- `"sriovNetSupport"`: Set to simple to enable enhanced networking with the Intel 82599
Virtual Function interface for the instance. There is no way to disable enhanced networking
with the Intel 82599 Virtual Function interface at this time. This option is supported only
for HVM instances. Specifying this option with a PV instance can make it unreachable.
- `"userData"`: Changes the instance's user data to the specified value. If you are using
an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and
you can load the text from a file. Otherwise, you must provide base64-encoded text.
- `"value"`: A new value for the attribute. Use only with the kernel, ramdisk, userData,
disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
"""
function modify_instance_attribute(
instanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyInstanceAttribute",
Dict{String,Any}("instanceId" => instanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_attribute(
instanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyInstanceAttribute",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceId" => instanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_capacity_reservation_attributes(capacity_reservation_specification, instance_id)
modify_instance_capacity_reservation_attributes(capacity_reservation_specification, instance_id, params::Dict{String,<:Any})
Modifies the Capacity Reservation settings for a stopped instance. Use this action to
configure an instance to target a specific Capacity Reservation, run in any open Capacity
Reservation with matching attributes, or run On-Demand Instance capacity.
# Arguments
- `capacity_reservation_specification`: Information about the Capacity Reservation
targeting option.
- `instance_id`: The ID of the instance to be modified.
# 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.
"""
function modify_instance_capacity_reservation_attributes(
CapacityReservationSpecification,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyInstanceCapacityReservationAttributes",
Dict{String,Any}(
"CapacityReservationSpecification" => CapacityReservationSpecification,
"InstanceId" => InstanceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_capacity_reservation_attributes(
CapacityReservationSpecification,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyInstanceCapacityReservationAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CapacityReservationSpecification" => CapacityReservationSpecification,
"InstanceId" => InstanceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_credit_specification(instance_credit_specification)
modify_instance_credit_specification(instance_credit_specification, params::Dict{String,<:Any})
Modifies the credit option for CPU usage on a running or stopped burstable performance
instance. The credit options are standard and unlimited. For more information, see
Burstable performance instances in the Amazon EC2 User Guide.
# Arguments
- `instance_credit_specification`: Information about the credit option for CPU usage.
# 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 idempotency of
your modification request. For more information, see Ensuring Idempotency.
- `"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.
"""
function modify_instance_credit_specification(
InstanceCreditSpecification; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyInstanceCreditSpecification",
Dict{String,Any}("InstanceCreditSpecification" => InstanceCreditSpecification);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_credit_specification(
InstanceCreditSpecification,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyInstanceCreditSpecification",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceCreditSpecification" => InstanceCreditSpecification
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_event_start_time(instance_event_id, instance_id, not_before)
modify_instance_event_start_time(instance_event_id, instance_id, not_before, params::Dict{String,<:Any})
Modifies the start time for a scheduled Amazon EC2 instance event.
# Arguments
- `instance_event_id`: The ID of the event whose date and time you are modifying.
- `instance_id`: The ID of the instance with the scheduled event.
- `not_before`: The new date and time when the event will take place.
# 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.
"""
function modify_instance_event_start_time(
InstanceEventId,
InstanceId,
NotBefore;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyInstanceEventStartTime",
Dict{String,Any}(
"InstanceEventId" => InstanceEventId,
"InstanceId" => InstanceId,
"NotBefore" => NotBefore,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_event_start_time(
InstanceEventId,
InstanceId,
NotBefore,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyInstanceEventStartTime",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceEventId" => InstanceEventId,
"InstanceId" => InstanceId,
"NotBefore" => NotBefore,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_event_window(instance_event_window_id)
modify_instance_event_window(instance_event_window_id, params::Dict{String,<:Any})
Modifies the specified event window. You can define either a set of time ranges or a cron
expression when modifying the event window, but not both. To modify the targets associated
with the event window, use the AssociateInstanceEventWindow and
DisassociateInstanceEventWindow API. If Amazon Web Services has already scheduled an event,
modifying an event window won't change the time of the scheduled event. For more
information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
# Arguments
- `instance_event_window_id`: The ID of the event window.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CronExpression"`: The cron expression of the event window, for example, * 0-4,20-23 * *
1,5. Constraints: Only hour and day of the week values are supported. For day of the
week values, you can specify either integers 0 through 6, or alternative single values SUN
through SAT. The minute, month, and year must be specified by *. The hour value must be
one or a multiple range, for example, 0-4 or 0-4,20-23. Each hour range must be >= 2
hours, for example, 0-2 or 20-23. The event window must be >= 4 hours. The combined
total time ranges in the event window must be >= 4 hours. For more information about
cron expressions, see cron on the Wikipedia website.
- `"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.
- `"Name"`: The name of the event window.
- `"TimeRange"`: The time ranges of the event window.
"""
function modify_instance_event_window(
InstanceEventWindowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyInstanceEventWindow",
Dict{String,Any}("InstanceEventWindowId" => InstanceEventWindowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_event_window(
InstanceEventWindowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyInstanceEventWindow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceEventWindowId" => InstanceEventWindowId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_maintenance_options(instance_id)
modify_instance_maintenance_options(instance_id, params::Dict{String,<:Any})
Modifies the recovery behavior of your instance to disable simplified automatic recovery or
set the recovery behavior to default. The default configuration will not enable simplified
automatic recovery for an unsupported instance type. For more information, see Simplified
automatic recovery.
# Arguments
- `instance_id`: The ID of the instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoRecovery"`: Disables the automatic recovery behavior of your instance or sets it to
default.
- `"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.
"""
function modify_instance_maintenance_options(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyInstanceMaintenanceOptions",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_maintenance_options(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyInstanceMaintenanceOptions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_metadata_defaults()
modify_instance_metadata_defaults(params::Dict{String,<:Any})
Modifies the default instance metadata service (IMDS) settings at the account level in the
specified Amazon Web Services
 Region. To remove a parameter's account-level
default setting, specify no-preference. If an account-level setting is cleared with
no-preference, then the instance launch considers the other instance metadata settings. For
more information, see Order of precedence for instance metadata options in the Amazon EC2
User Guide.
# 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.
- `"HttpEndpoint"`: Enables or disables the IMDS endpoint on an instance. When disabled,
the instance metadata can't be accessed.
- `"HttpPutResponseHopLimit"`: The maximum number of hops that the metadata token can
travel. To indicate no preference, specify -1. Possible values: Integers from 1 to 64, and
-1 to indicate no preference
- `"HttpTokens"`: Indicates whether IMDSv2 is required. optional – IMDSv2 is optional,
which means that you can use either IMDSv2 or IMDSv1. required – IMDSv2 is required,
which means that IMDSv1 is disabled, and you must use IMDSv2.
- `"InstanceMetadataTags"`: Enables or disables access to an instance's tags from the
instance metadata. For more information, see Work with instance tags using the instance
metadata in the Amazon EC2 User Guide.
"""
function modify_instance_metadata_defaults(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyInstanceMetadataDefaults";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_metadata_defaults(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyInstanceMetadataDefaults",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_metadata_options(instance_id)
modify_instance_metadata_options(instance_id, params::Dict{String,<:Any})
Modify the instance metadata parameters on a running or stopped instance. When you modify
the parameters on a stopped instance, they are applied when the instance is started. When
you modify the parameters on a running instance, the API responds with a state of
“pending”. After the parameter modifications are successfully applied to the instance,
the state of the modifications changes from “pending” to “applied” in subsequent
describe-instances API calls. For more information, see Instance metadata and user data in
the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The ID of the instance.
# 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.
- `"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. Applies only if you enabled the HTTP metadata endpoint.
- `"HttpPutResponseHopLimit"`: The desired HTTP PUT response hop limit for instance
metadata requests. The larger the number, the further instance metadata requests can
travel. If no parameter is specified, the existing state is maintained. Possible values:
Integers from 1 to 64
- `"HttpTokens"`: Indicates whether IMDSv2 is required. optional - IMDSv2 is optional.
You can choose whether to send a session token in your instance metadata retrieval
requests. If you retrieve IAM role credentials without a session token, you receive the
IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token,
you receive the IMDSv2 role credentials. required - IMDSv2 is required. You must send a
session token in your instance metadata retrieval requests. With this option, retrieving
the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not
available. Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for
your instance is v2.0 and the account level default is set to no-preference, the default is
required. If the value of ImdsSupport for the Amazon Machine Image (AMI) for your
instance is v2.0, but the account level default is set to V1 or V2, the default is
optional. The default value can also be affected by other combinations of parameters. For
more information, see Order of precedence for instance metadata options in the Amazon EC2
User Guide.
- `"InstanceMetadataTags"`: Set to enabled to allow access to instance tags from the
instance metadata. Set to disabled to turn off access to instance tags from the instance
metadata. For more information, see Work with instance tags using the instance metadata.
"""
function modify_instance_metadata_options(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyInstanceMetadataOptions",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_metadata_options(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyInstanceMetadataOptions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_placement(instance_id)
modify_instance_placement(instance_id, params::Dict{String,<:Any})
Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to host
and the instance is not associated with a specific Dedicated Host, the next time the
instance is started, it is automatically associated with the host on which it lands. If the
instance is restarted or rebooted, this relationship persists. Change the Dedicated Host
with which an instance is associated. Change the instance tenancy of an instance. Move
an instance to or from a placement group. At least one attribute for affinity, host ID,
tenancy, or placement group name must be specified in the request. Affinity and tenancy can
be modified in the same request. To modify the host ID, tenancy, placement group, or
partition for an instance, the instance must be in the stopped state.
# Arguments
- `instance_id`: The ID of the instance that you are modifying.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GroupId"`: The Group Id of a placement group. You must specify the Placement Group
Group Id to launch an instance in a shared placement group.
- `"GroupName"`: The name of the placement group in which to place the instance. For spread
placement groups, the instance must have a tenancy of default. For cluster and partition
placement groups, the instance must have a tenancy of default or dedicated. To remove an
instance from a placement group, specify an empty string (\"\").
- `"HostResourceGroupArn"`: The ARN of the host resource group in which to place the
instance. The instance must have a tenancy of host to specify this parameter.
- `"PartitionNumber"`: The number of the partition in which to place the instance. Valid
only if the placement group strategy is set to partition.
- `"affinity"`: The affinity setting for the instance. For more information, see Host
affinity in the Amazon EC2 User Guide.
- `"hostId"`: The ID of the Dedicated Host with which to associate the instance.
- `"tenancy"`: The tenancy for the instance. For T3 instances, you must launch the
instance on a Dedicated Host to use a tenancy of host. You can't change the tenancy from
host to dedicated or default. Attempting to make one of these unsupported tenancy changes
results in an InvalidRequest error code.
"""
function modify_instance_placement(
instanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyInstancePlacement",
Dict{String,Any}("instanceId" => instanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_placement(
instanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyInstancePlacement",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("instanceId" => instanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_ipam(ipam_id)
modify_ipam(ipam_id, params::Dict{String,<:Any})
Modify the configurations of an IPAM.
# Arguments
- `ipam_id`: The ID of the IPAM you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddOperatingRegion"`: Choose the operating Regions for the IPAM. Operating Regions are
Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only
discovers and monitors resources in the Amazon Web Services Regions you select as operating
Regions. For more information about operating Regions, see Create an IPAM in the Amazon VPC
IPAM User Guide.
- `"Description"`: The description of the IPAM you want to modify.
- `"DryRun"`: A check for 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.
- `"RemoveOperatingRegion"`: The operating Regions to remove.
- `"Tier"`: IPAM is offered in a Free Tier and an Advanced Tier. For more information about
the features available in each tier and the costs associated with the tiers, see Amazon VPC
pricing > IPAM tab.
"""
function modify_ipam(IpamId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ModifyIpam",
Dict{String,Any}("IpamId" => IpamId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_ipam(
IpamId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyIpam",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("IpamId" => IpamId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_ipam_pool(ipam_pool_id)
modify_ipam_pool(ipam_pool_id, params::Dict{String,<:Any})
Modify the configurations of an IPAM pool. For more information, see Modify a pool in the
Amazon VPC IPAM User Guide.
# Arguments
- `ipam_pool_id`: The ID of the IPAM pool you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddAllocationResourceTag"`: Add tag allocation rules to a pool. For more information
about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
- `"AllocationDefaultNetmaskLength"`: The default netmask length for allocations added to
this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16
here, new allocations will default to 10.0.0.0/16.
- `"AllocationMaxNetmaskLength"`: The maximum netmask length possible for CIDR allocations
in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32.
Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be
greater than the minimum netmask length.
- `"AllocationMinNetmaskLength"`: The minimum netmask length required for CIDR allocations
in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32.
Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be
less than the maximum netmask length.
- `"AutoImport"`: If true, IPAM will continuously look for resources within the CIDR range
of this pool and automatically import them as allocations into your IPAM. The CIDRs that
will be allocated for these resources must not already be allocated to other resources in
order for the import to succeed. IPAM will import a CIDR regardless of its compliance with
the pool's allocation rules, so a resource might be imported and subsequently marked as
noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest
CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import
one of them only. A locale must be set on the pool for this feature to work.
- `"ClearAllocationDefaultNetmaskLength"`: Clear the default netmask length allocation rule
for this pool.
- `"Description"`: The description of the IPAM pool you want to modify.
- `"DryRun"`: A check for 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.
- `"RemoveAllocationResourceTag"`: Remove tag allocation rules from a pool.
"""
function modify_ipam_pool(IpamPoolId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ModifyIpamPool",
Dict{String,Any}("IpamPoolId" => IpamPoolId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_ipam_pool(
IpamPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyIpamPool",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IpamPoolId" => IpamPoolId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_ipam_resource_cidr(current_ipam_scope_id, monitored, resource_cidr, resource_id, resource_region)
modify_ipam_resource_cidr(current_ipam_scope_id, monitored, resource_cidr, resource_id, resource_region, params::Dict{String,<:Any})
Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes
and ignore resource CIDRs that you do not want to manage. If set to false, the resource
will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be
removed from any pool it has an allocation in. For more information, see Move resource
CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC
IPAM User Guide.
# Arguments
- `current_ipam_scope_id`: The ID of the current scope that the resource CIDR is in.
- `monitored`: Determines if the resource is monitored by IPAM. If a resource is monitored,
the resource is discovered by IPAM and you can view details about the resource’s CIDR.
- `resource_cidr`: The CIDR of the resource you want to modify.
- `resource_id`: The ID of the resource you want to modify.
- `resource_region`: The Amazon Web Services Region of the resource you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationIpamScopeId"`: The ID of the scope you want to transfer the resource CIDR to.
- `"DryRun"`: A check for 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.
"""
function modify_ipam_resource_cidr(
CurrentIpamScopeId,
Monitored,
ResourceCidr,
ResourceId,
ResourceRegion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyIpamResourceCidr",
Dict{String,Any}(
"CurrentIpamScopeId" => CurrentIpamScopeId,
"Monitored" => Monitored,
"ResourceCidr" => ResourceCidr,
"ResourceId" => ResourceId,
"ResourceRegion" => ResourceRegion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_ipam_resource_cidr(
CurrentIpamScopeId,
Monitored,
ResourceCidr,
ResourceId,
ResourceRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyIpamResourceCidr",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CurrentIpamScopeId" => CurrentIpamScopeId,
"Monitored" => Monitored,
"ResourceCidr" => ResourceCidr,
"ResourceId" => ResourceId,
"ResourceRegion" => ResourceRegion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_ipam_resource_discovery(ipam_resource_discovery_id)
modify_ipam_resource_discovery(ipam_resource_discovery_id, params::Dict{String,<:Any})
Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM
to manage and monitor resources that belong to the owning account.
# Arguments
- `ipam_resource_discovery_id`: A resource discovery ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddOperatingRegion"`: Add operating Regions to the resource discovery. Operating
Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address
CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you
select as operating Regions.
- `"Description"`: A resource discovery description.
- `"DryRun"`: A check for 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.
- `"RemoveOperatingRegion"`: Remove operating Regions.
"""
function modify_ipam_resource_discovery(
IpamResourceDiscoveryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyIpamResourceDiscovery",
Dict{String,Any}("IpamResourceDiscoveryId" => IpamResourceDiscoveryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_ipam_resource_discovery(
IpamResourceDiscoveryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyIpamResourceDiscovery",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IpamResourceDiscoveryId" => IpamResourceDiscoveryId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_ipam_scope(ipam_scope_id)
modify_ipam_scope(ipam_scope_id, params::Dict{String,<:Any})
Modify an IPAM scope.
# Arguments
- `ipam_scope_id`: The ID of the scope you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description of the scope you want to modify.
- `"DryRun"`: A check for 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.
"""
function modify_ipam_scope(IpamScopeId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ModifyIpamScope",
Dict{String,Any}("IpamScopeId" => IpamScopeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_ipam_scope(
IpamScopeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyIpamScope",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("IpamScopeId" => IpamScopeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_launch_template()
modify_launch_template(params::Dict{String,<:Any})
Modifies a launch template. You can specify which version of the launch template to set as
the default version. When launching an instance, the default version applies when a launch
template version is not specified.
# 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. For more information, see Ensuring idempotency. Constraint: Maximum 128
ASCII characters.
- `"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.
- `"LaunchTemplateId"`: The ID of the launch template. You must specify either the launch
template ID or the launch template name, but not both.
- `"LaunchTemplateName"`: The name of the launch template. You must specify either the
launch template ID or the launch template name, but not both.
- `"SetDefaultVersion"`: The version number of the launch template to set as the default
version.
"""
function modify_launch_template(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ModifyLaunchTemplate"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function modify_launch_template(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyLaunchTemplate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_local_gateway_route(local_gateway_route_table_id)
modify_local_gateway_route(local_gateway_route_table_id, params::Dict{String,<:Any})
Modifies the specified local gateway route.
# Arguments
- `local_gateway_route_table_id`: The ID of the local gateway route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationCidrBlock"`: The CIDR block used for destination matches. The value that you
provide must match the CIDR of an existing route in the table.
- `"DestinationPrefixListId"`: The ID of the prefix list. Use a prefix list in place of
DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in
the same request.
- `"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.
- `"LocalGatewayVirtualInterfaceGroupId"`: The ID of the virtual interface group.
- `"NetworkInterfaceId"`: The ID of the network interface.
"""
function modify_local_gateway_route(
LocalGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyLocalGatewayRoute",
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_local_gateway_route(
LocalGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyLocalGatewayRoute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_managed_prefix_list(prefix_list_id)
modify_managed_prefix_list(prefix_list_id, params::Dict{String,<:Any})
Modifies the specified managed prefix list. Adding or removing entries in a prefix list
creates a new version of the prefix list. Changing the name of the prefix list does not
affect the version. If you specify a current version number that does not match the true
current version number, the request fails.
# Arguments
- `prefix_list_id`: The ID of the prefix list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddEntry"`: One or more entries to add to the prefix list.
- `"CurrentVersion"`: The current version of the prefix list.
- `"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.
- `"MaxEntries"`: The maximum number of entries for the prefix list. You cannot modify the
entries of a prefix list and modify the size of a prefix list at the same time. If any of
the resources that reference the prefix list cannot support the new maximum size, the
modify operation fails. Check the state message for the IDs of the first ten resources that
do not support the new maximum size.
- `"PrefixListName"`: A name for the prefix list.
- `"RemoveEntry"`: One or more entries to remove from the prefix list.
"""
function modify_managed_prefix_list(
PrefixListId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyManagedPrefixList",
Dict{String,Any}("PrefixListId" => PrefixListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_managed_prefix_list(
PrefixListId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyManagedPrefixList",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PrefixListId" => PrefixListId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_network_interface_attribute(network_interface_id)
modify_network_interface_attribute(network_interface_id, params::Dict{String,<:Any})
Modifies the specified network interface attribute. You can specify only one attribute at a
time. You can use this action to attach and detach security groups from an existing EC2
instance.
# Arguments
- `network_interface_id`: The ID of the network interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociatePublicIpAddress"`: Indicates whether to assign a public IPv4 address to a
network interface. This option can be enabled for any network interface but will only apply
to the primary network interface (eth0).
- `"ConnectionTrackingSpecification"`: A connection tracking specification.
- `"EnaSrdSpecification"`: Updates the ENA Express configuration for the network interface
that’s attached to the instance.
- `"EnablePrimaryIpv6"`: If you’re modifying a network interface in a dual-stack or
IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6
address is an IPv6 GUA address associated with an ENI that you have enabled to use a
primary IPv6 address. Use this option if the instance that this ENI will be attached to
relies on its IPv6 address not changing. Amazon Web Services will automatically assign an
IPv6 address associated with the ENI attached to your instance to be the primary IPv6
address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it.
When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made
the primary IPv6 address until the instance is terminated or the network interface is
detached. If you have multiple IPv6 addresses associated with an ENI attached to your
instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with
the ENI becomes the primary IPv6 address.
- `"SecurityGroupId"`: Changes the security groups for the network interface. The new set
of groups you specify replaces the current set. You must specify at least one group, even
if it's just the default security group in the VPC. You must specify the ID of the security
group, not the name.
- `"attachment"`: Information about the interface attachment. If modifying the delete on
termination attribute, you must specify the ID of the interface attachment.
- `"description"`: A description for the network interface.
- `"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.
- `"sourceDestCheck"`: Enable or disable source/destination checks, which ensure that the
instance is either the source or the destination of any traffic that it receives. If the
value is true, source/destination checks are enabled; otherwise, they are disabled. The
default value is true. You must disable source/destination checks if the instance runs
services such as network address translation, routing, or firewalls.
"""
function modify_network_interface_attribute(
networkInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyNetworkInterfaceAttribute",
Dict{String,Any}("networkInterfaceId" => networkInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_network_interface_attribute(
networkInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyNetworkInterfaceAttribute",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("networkInterfaceId" => networkInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_private_dns_name_options(instance_id)
modify_private_dns_name_options(instance_id, params::Dict{String,<:Any})
Modifies the options for instance hostnames for the specified instance.
# Arguments
- `instance_id`: The ID of the instance.
# 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.
- `"EnableResourceNameDnsAAAARecord"`: Indicates whether to respond to DNS queries for
instance hostnames with DNS AAAA records.
- `"EnableResourceNameDnsARecord"`: Indicates whether to respond to DNS queries for
instance hostnames with DNS A records.
- `"PrivateDnsHostnameType"`: The type of hostname for EC2 instances. For IPv4 only
subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only
subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you
can specify whether DNS names use the instance IPv4 address or the instance ID.
"""
function modify_private_dns_name_options(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyPrivateDnsNameOptions",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_private_dns_name_options(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyPrivateDnsNameOptions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_reserved_instances(reserved_instances_configuration_set_item_type, reserved_instances_id)
modify_reserved_instances(reserved_instances_configuration_set_item_type, reserved_instances_id, params::Dict{String,<:Any})
Modifies the configuration of your Reserved Instances, such as the Availability Zone,
instance count, or instance type. The Reserved Instances to be modified must be identical,
except for Availability Zone, network platform, and instance type. For more information,
see Modify Reserved Instances in the Amazon EC2 User Guide.
# Arguments
- `reserved_instances_configuration_set_item_type`: The configuration settings for the
Reserved Instances to modify.
- `reserved_instances_id`: The IDs of the Reserved Instances to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive token you provide to ensure idempotency of your
modification request. For more information, see Ensuring Idempotency.
"""
function modify_reserved_instances(
ReservedInstancesConfigurationSetItemType,
ReservedInstancesId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyReservedInstances",
Dict{String,Any}(
"ReservedInstancesConfigurationSetItemType" =>
ReservedInstancesConfigurationSetItemType,
"ReservedInstancesId" => ReservedInstancesId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_reserved_instances(
ReservedInstancesConfigurationSetItemType,
ReservedInstancesId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyReservedInstances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReservedInstancesConfigurationSetItemType" =>
ReservedInstancesConfigurationSetItemType,
"ReservedInstancesId" => ReservedInstancesId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_security_group_rules(group_id, security_group_rule)
modify_security_group_rules(group_id, security_group_rule, params::Dict{String,<:Any})
Modifies the rules of a security group.
# Arguments
- `group_id`: The ID of the security group.
- `security_group_rule`: Information about the security group properties to update.
# 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.
"""
function modify_security_group_rules(
GroupId, SecurityGroupRule; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifySecurityGroupRules",
Dict{String,Any}("GroupId" => GroupId, "SecurityGroupRule" => SecurityGroupRule);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_security_group_rules(
GroupId,
SecurityGroupRule,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifySecurityGroupRules",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupId" => GroupId, "SecurityGroupRule" => SecurityGroupRule
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_snapshot_attribute(snapshot_id)
modify_snapshot_attribute(snapshot_id, params::Dict{String,<:Any})
Adds or removes permission settings for the specified snapshot. You may add or remove
specified Amazon Web Services account IDs from a snapshot's list of create volume
permissions, but you cannot do both in a single operation. If you need to both add and
remove account IDs for a snapshot, you must use multiple operations. You can make up to 500
modifications to a snapshot in a single operation. Encrypted snapshots and snapshots with
Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted
with your default KMS key cannot be shared with other accounts. For more information about
modifying snapshot permissions, see Share a snapshot in the Amazon EBS User Guide.
# Arguments
- `snapshot_id`: The ID of the snapshot.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attribute"`: The snapshot attribute to modify. Only volume creation permissions can be
modified.
- `"CreateVolumePermission"`: A JSON representation of the snapshot attribute modification.
- `"OperationType"`: The type of operation to perform to the attribute.
- `"UserGroup"`: The group to modify for the snapshot.
- `"UserId"`: The account ID to modify for the snapshot.
- `"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.
"""
function modify_snapshot_attribute(
SnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifySnapshotAttribute",
Dict{String,Any}("SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_snapshot_attribute(
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifySnapshotAttribute",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotId" => SnapshotId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_snapshot_tier(snapshot_id)
modify_snapshot_tier(snapshot_id, params::Dict{String,<:Any})
Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full
snapshot that includes all of the blocks of data that were written to the volume at the
time the snapshot was created, and moved from the standard tier to the archive tier. For
more information, see Archive Amazon EBS snapshots in the Amazon EBS User Guide.
# Arguments
- `snapshot_id`: The ID of the snapshot.
# 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.
- `"StorageTier"`: The name of the storage tier. You must specify archive.
"""
function modify_snapshot_tier(SnapshotId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ModifySnapshotTier",
Dict{String,Any}("SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_snapshot_tier(
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifySnapshotTier",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotId" => SnapshotId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_spot_fleet_request(spot_fleet_request_id)
modify_spot_fleet_request(spot_fleet_request_id, params::Dict{String,<:Any})
Modifies the specified Spot Fleet request. You can only modify a Spot Fleet request of type
maintain. While the Spot Fleet request is being modified, it is in the modifying state. To
scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the
additional Spot Instances according to the allocation strategy for the Spot Fleet request.
If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot
Instance pool with the lowest price. If the allocation strategy is diversified, the Spot
Fleet distributes the instances across the Spot Instance pools. If the allocation strategy
is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal
capacity for the number of instances that are launching. To scale down your Spot Fleet,
decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed
the new target capacity. You can request that the Spot Fleet terminate Spot Instances until
the size of the fleet no longer exceeds the new target capacity. If the allocation strategy
is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If
the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in
the Spot Instance pools that have the least available Spot Instance capacity. If the
allocation strategy is diversified, the Spot Fleet terminates instances across the Spot
Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its
current size, but not replace any Spot Instances that are interrupted or that you terminate
manually. If you are finished with your Spot Fleet for now, but will use it again later,
you can set the target capacity to 0.
# Arguments
- `spot_fleet_request_id`: The ID of the Spot Fleet request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Context"`: Reserved.
- `"LaunchTemplateConfig"`: The launch template and overrides. You can only use this
parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet
request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this
parameter.
- `"OnDemandTargetCapacity"`: The number of On-Demand Instances in the fleet.
- `"excessCapacityTerminationPolicy"`: Indicates whether running instances should be
terminated if the target capacity of the Spot Fleet request is decreased below the current
size of the Spot Fleet. Supported only for fleets of type maintain.
- `"targetCapacity"`: The size of the fleet.
"""
function modify_spot_fleet_request(
spotFleetRequestId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifySpotFleetRequest",
Dict{String,Any}("spotFleetRequestId" => spotFleetRequestId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_spot_fleet_request(
spotFleetRequestId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifySpotFleetRequest",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("spotFleetRequestId" => spotFleetRequestId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_subnet_attribute(subnet_id)
modify_subnet_attribute(subnet_id, params::Dict{String,<:Any})
Modifies a subnet attribute. You can only modify one attribute at a time. Use this action
to modify subnets on Amazon Web Services Outposts. To modify a subnet on an Outpost rack,
set both MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool. These two parameters act as
a single attribute. To modify a subnet on an Outpost server, set either
EnableLniAtDeviceIndex or DisableLniAtDeviceIndex. For more information about Amazon Web
Services Outposts, see the following: Outpost servers Outpost racks
# Arguments
- `subnet_id`: The ID of the subnet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssignIpv6AddressOnCreation"`: Specify true to indicate that network interfaces created
in the specified subnet should be assigned an IPv6 address. This includes a network
interface that's created when launching an instance into the subnet (the instance therefore
receives an IPv6 address). If you enable the IPv6 addressing feature for your subnet, your
network interface or instance only receives an IPv6 address if it's created using version
2016-11-15 or later of the Amazon EC2 API.
- `"CustomerOwnedIpv4Pool"`: The customer-owned IPv4 address pool associated with the
subnet. You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
- `"DisableLniAtDeviceIndex"`: Specify true to indicate that local network interfaces at
the current position should be disabled.
- `"EnableDns64"`: Indicates whether DNS queries made to the Amazon-provided DNS Resolver
in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
- `"EnableLniAtDeviceIndex"`: Indicates the device position for local network interfaces
in this subnet. For example, 1 indicates local network interfaces in this subnet are the
secondary network interface (eth1). A local network interface cannot be the primary network
interface (eth0).
- `"EnableResourceNameDnsAAAARecordOnLaunch"`: Indicates whether to respond to DNS queries
for instance hostnames with DNS AAAA records.
- `"EnableResourceNameDnsARecordOnLaunch"`: Indicates whether to respond to DNS queries for
instance hostnames with DNS A records.
- `"MapCustomerOwnedIpOnLaunch"`: Specify true to indicate that network interfaces attached
to instances created in the specified subnet should be assigned a customer-owned IPv4
address. When this value is true, you must specify the customer-owned IP pool using
CustomerOwnedIpv4Pool.
- `"MapPublicIpOnLaunch"`: Specify true to indicate that network interfaces attached to
instances created in the specified subnet should be assigned a public IPv4 address. Amazon
Web Services charges for all public IPv4 addresses, including public IPv4 addresses
associated with running instances and Elastic IP addresses. For more information, see the
Public IPv4 Address tab on the Amazon VPC pricing page.
- `"PrivateDnsHostnameTypeOnLaunch"`: The type of hostname to assign to instances in the
subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS
name can be based on the instance IPv4 address (ip-name) or the instance ID
(resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance
ID (resource-name).
"""
function modify_subnet_attribute(
subnetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifySubnetAttribute",
Dict{String,Any}("subnetId" => subnetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_subnet_attribute(
subnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifySubnetAttribute",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("subnetId" => subnetId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_traffic_mirror_filter_network_services(traffic_mirror_filter_id)
modify_traffic_mirror_filter_network_services(traffic_mirror_filter_id, params::Dict{String,<:Any})
Allows or restricts mirroring network services. By default, Amazon DNS network services
are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a
Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all
traffic related to that network service will be mirrored. When you no longer want to mirror
network services, use RemoveNetworkServices to remove the network services from the Traffic
Mirror filter.
# Arguments
- `traffic_mirror_filter_id`: The ID of the Traffic Mirror filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddNetworkService"`: The network service, for example Amazon DNS, that you want to
mirror.
- `"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.
- `"RemoveNetworkService"`: The network service, for example Amazon DNS, that you no longer
want to mirror.
"""
function modify_traffic_mirror_filter_network_services(
TrafficMirrorFilterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyTrafficMirrorFilterNetworkServices",
Dict{String,Any}("TrafficMirrorFilterId" => TrafficMirrorFilterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_traffic_mirror_filter_network_services(
TrafficMirrorFilterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyTrafficMirrorFilterNetworkServices",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TrafficMirrorFilterId" => TrafficMirrorFilterId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_traffic_mirror_filter_rule(traffic_mirror_filter_rule_id)
modify_traffic_mirror_filter_rule(traffic_mirror_filter_rule_id, params::Dict{String,<:Any})
Modifies the specified Traffic Mirror rule. DestinationCidrBlock and SourceCidrBlock must
both be an IPv4 range or an IPv6 range.
# Arguments
- `traffic_mirror_filter_rule_id`: The ID of the Traffic Mirror rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description to assign to the Traffic Mirror rule.
- `"DestinationCidrBlock"`: The destination CIDR block to assign to the Traffic Mirror rule.
- `"DestinationPortRange"`: The destination ports that are associated with the Traffic
Mirror rule.
- `"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.
- `"Protocol"`: The protocol, for example TCP, to assign to the Traffic Mirror rule.
- `"RemoveField"`: The properties that you want to remove from the Traffic Mirror filter
rule. When you remove a property from a Traffic Mirror filter rule, the property is set to
the default.
- `"RuleAction"`: The action to assign to the rule.
- `"RuleNumber"`: The number of the Traffic Mirror rule. This number must be unique for
each Traffic Mirror rule in a given direction. The rules are processed in ascending order
by rule number.
- `"SourceCidrBlock"`: The source CIDR block to assign to the Traffic Mirror rule.
- `"SourcePortRange"`: The port range to assign to the Traffic Mirror rule.
- `"TrafficDirection"`: The type of traffic to assign to the rule.
"""
function modify_traffic_mirror_filter_rule(
TrafficMirrorFilterRuleId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyTrafficMirrorFilterRule",
Dict{String,Any}("TrafficMirrorFilterRuleId" => TrafficMirrorFilterRuleId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_traffic_mirror_filter_rule(
TrafficMirrorFilterRuleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyTrafficMirrorFilterRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TrafficMirrorFilterRuleId" => TrafficMirrorFilterRuleId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_traffic_mirror_session(traffic_mirror_session_id)
modify_traffic_mirror_session(traffic_mirror_session_id, params::Dict{String,<:Any})
Modifies a Traffic Mirror session.
# Arguments
- `traffic_mirror_session_id`: The ID of the Traffic Mirror session.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description to assign to the Traffic Mirror session.
- `"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.
- `"PacketLength"`: The number of bytes in each packet to mirror. These are bytes after the
VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example,
if you set this value to 100, then the first 100 bytes that meet the filter criteria are
copied to the target. Do not specify this parameter when you want to mirror the entire
packet. For sessions with Network Load Balancer (NLB) traffic mirror targets, the default
PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater
than 8500 will result in an error response.
- `"RemoveField"`: The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the
default.
- `"SessionNumber"`: The session number determines the order in which sessions are
evaluated when an interface is used by multiple sessions. The first session with a matching
filter is the one that mirrors the packets. Valid values are 1-32766.
- `"TrafficMirrorFilterId"`: The ID of the Traffic Mirror filter.
- `"TrafficMirrorTargetId"`: The Traffic Mirror target. The target must be in the same VPC
as the source, or have a VPC peering connection with the source.
- `"VirtualNetworkId"`: The virtual network ID of the Traffic Mirror session.
"""
function modify_traffic_mirror_session(
TrafficMirrorSessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyTrafficMirrorSession",
Dict{String,Any}("TrafficMirrorSessionId" => TrafficMirrorSessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_traffic_mirror_session(
TrafficMirrorSessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyTrafficMirrorSession",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TrafficMirrorSessionId" => TrafficMirrorSessionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_transit_gateway(transit_gateway_id)
modify_transit_gateway(transit_gateway_id, params::Dict{String,<:Any})
Modifies the specified transit gateway. When you modify a transit gateway, the modified
options are applied to new transit gateway attachments only. Your existing transit gateway
attachments are not modified.
# Arguments
- `transit_gateway_id`: The ID of the transit gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description for the transit gateway.
- `"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.
- `"Options"`: The options to modify.
"""
function modify_transit_gateway(
TransitGatewayId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyTransitGateway",
Dict{String,Any}("TransitGatewayId" => TransitGatewayId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_transit_gateway(
TransitGatewayId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyTransitGateway",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("TransitGatewayId" => TransitGatewayId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id)
modify_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Modifies a reference (route) to a prefix list in a specified transit gateway route table.
# Arguments
- `prefix_list_id`: The ID of the prefix list.
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Blackhole"`: Indicates whether to drop traffic that matches this route.
- `"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.
- `"TransitGatewayAttachmentId"`: The ID of the attachment to which traffic is routed.
"""
function modify_transit_gateway_prefix_list_reference(
PrefixListId,
TransitGatewayRouteTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyTransitGatewayPrefixListReference",
Dict{String,Any}(
"PrefixListId" => PrefixListId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_transit_gateway_prefix_list_reference(
PrefixListId,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyTransitGatewayPrefixListReference",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PrefixListId" => PrefixListId,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_transit_gateway_vpc_attachment(transit_gateway_attachment_id)
modify_transit_gateway_vpc_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Modifies the specified VPC attachment.
# Arguments
- `transit_gateway_attachment_id`: The ID of the attachment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddSubnetIds"`: The IDs of one or more subnets to add. You can specify at most one
subnet per Availability Zone.
- `"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.
- `"Options"`: The new VPC attachment options.
- `"RemoveSubnetIds"`: The IDs of one or more subnets to remove.
"""
function modify_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyTransitGatewayVpcAttachment",
Dict{String,Any}("TransitGatewayAttachmentId" => TransitGatewayAttachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyTransitGatewayVpcAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_verified_access_endpoint(verified_access_endpoint_id)
modify_verified_access_endpoint(verified_access_endpoint_id, params::Dict{String,<:Any})
Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.
# Arguments
- `verified_access_endpoint_id`: The ID of the Verified Access endpoint.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the Verified Access endpoint.
- `"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.
- `"LoadBalancerOptions"`: The load balancer details if creating the Verified Access
endpoint as load-balancertype.
- `"NetworkInterfaceOptions"`: The network interface options.
- `"VerifiedAccessGroupId"`: The ID of the Verified Access group.
"""
function modify_verified_access_endpoint(
VerifiedAccessEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVerifiedAccessEndpoint",
Dict{String,Any}(
"VerifiedAccessEndpointId" => VerifiedAccessEndpointId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_verified_access_endpoint(
VerifiedAccessEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVerifiedAccessEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessEndpointId" => VerifiedAccessEndpointId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_verified_access_endpoint_policy(verified_access_endpoint_id)
modify_verified_access_endpoint_policy(verified_access_endpoint_id, params::Dict{String,<:Any})
Modifies the specified Amazon Web Services Verified Access endpoint policy.
# Arguments
- `verified_access_endpoint_id`: The ID of the Verified Access endpoint.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"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.
- `"PolicyDocument"`: The Verified Access policy document.
- `"PolicyEnabled"`: The status of the Verified Access policy.
- `"SseSpecification"`: The options for server side encryption.
"""
function modify_verified_access_endpoint_policy(
VerifiedAccessEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVerifiedAccessEndpointPolicy",
Dict{String,Any}(
"VerifiedAccessEndpointId" => VerifiedAccessEndpointId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_verified_access_endpoint_policy(
VerifiedAccessEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVerifiedAccessEndpointPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessEndpointId" => VerifiedAccessEndpointId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_verified_access_group(verified_access_group_id)
modify_verified_access_group(verified_access_group_id, params::Dict{String,<:Any})
Modifies the specified Amazon Web Services Verified Access group configuration.
# Arguments
- `verified_access_group_id`: The ID of the Verified Access group.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the Verified Access group.
- `"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.
- `"VerifiedAccessInstanceId"`: The ID of the Verified Access instance.
"""
function modify_verified_access_group(
VerifiedAccessGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVerifiedAccessGroup",
Dict{String,Any}(
"VerifiedAccessGroupId" => VerifiedAccessGroupId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_verified_access_group(
VerifiedAccessGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVerifiedAccessGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessGroupId" => VerifiedAccessGroupId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_verified_access_group_policy(verified_access_group_id)
modify_verified_access_group_policy(verified_access_group_id, params::Dict{String,<:Any})
Modifies the specified Amazon Web Services Verified Access group policy.
# Arguments
- `verified_access_group_id`: The ID of the Verified Access group.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"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.
- `"PolicyDocument"`: The Verified Access policy document.
- `"PolicyEnabled"`: The status of the Verified Access policy.
- `"SseSpecification"`: The options for server side encryption.
"""
function modify_verified_access_group_policy(
VerifiedAccessGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVerifiedAccessGroupPolicy",
Dict{String,Any}(
"VerifiedAccessGroupId" => VerifiedAccessGroupId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_verified_access_group_policy(
VerifiedAccessGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVerifiedAccessGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessGroupId" => VerifiedAccessGroupId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_verified_access_instance(verified_access_instance_id)
modify_verified_access_instance(verified_access_instance_id, params::Dict{String,<:Any})
Modifies the configuration of the specified Amazon Web Services Verified Access instance.
# Arguments
- `verified_access_instance_id`: The ID of the Verified Access instance.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the Verified Access instance.
- `"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.
"""
function modify_verified_access_instance(
VerifiedAccessInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVerifiedAccessInstance",
Dict{String,Any}(
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_verified_access_instance(
VerifiedAccessInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVerifiedAccessInstance",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_verified_access_instance_logging_configuration(access_logs, verified_access_instance_id)
modify_verified_access_instance_logging_configuration(access_logs, verified_access_instance_id, params::Dict{String,<:Any})
Modifies the logging configuration for the specified Amazon Web Services Verified Access
instance.
# Arguments
- `access_logs`: The configuration options for Verified Access instances.
- `verified_access_instance_id`: The ID of the Verified Access instance.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"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.
"""
function modify_verified_access_instance_logging_configuration(
AccessLogs, VerifiedAccessInstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVerifiedAccessInstanceLoggingConfiguration",
Dict{String,Any}(
"AccessLogs" => AccessLogs,
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_verified_access_instance_logging_configuration(
AccessLogs,
VerifiedAccessInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVerifiedAccessInstanceLoggingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessLogs" => AccessLogs,
"VerifiedAccessInstanceId" => VerifiedAccessInstanceId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_verified_access_trust_provider(verified_access_trust_provider_id)
modify_verified_access_trust_provider(verified_access_trust_provider_id, params::Dict{String,<:Any})
Modifies the configuration of the specified Amazon Web Services Verified Access trust
provider.
# Arguments
- `verified_access_trust_provider_id`: The ID of the Verified Access trust provider.
# 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 idempotency of
your modification request. For more information, see Ensuring idempotency.
- `"Description"`: A description for the Verified Access trust provider.
- `"DeviceOptions"`: The options for a device-based trust provider. This parameter is
required when the provider type is device.
- `"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.
- `"OidcOptions"`: The options for an OpenID Connect-compatible user-identity trust
provider.
- `"SseSpecification"`: The options for server side encryption.
"""
function modify_verified_access_trust_provider(
VerifiedAccessTrustProviderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVerifiedAccessTrustProvider",
Dict{String,Any}(
"VerifiedAccessTrustProviderId" => VerifiedAccessTrustProviderId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_verified_access_trust_provider(
VerifiedAccessTrustProviderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVerifiedAccessTrustProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VerifiedAccessTrustProviderId" => VerifiedAccessTrustProviderId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_volume(volume_id)
modify_volume(volume_id, params::Dict{String,<:Any})
You can modify several parameters of an existing EBS volume, including volume size, volume
type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2
instance type, you might be able to apply these changes without stopping the instance or
detaching the volume from it. For more information about modifying EBS volumes, see Amazon
EBS Elastic Volumes in the Amazon EBS User Guide. When you complete a resize operation on
your volume, you need to extend the volume's file-system size to take advantage of the new
storage capacity. For more information, see Extend the file system. For more information,
see Monitor the progress of volume modifications in the Amazon EBS User Guide. With
previous-generation instance types, resizing an EBS volume might require detaching and
reattaching the volume or stopping and restarting the instance. After modifying a volume,
you must wait at least six hours and ensure that the volume is in the in-use or available
state before you can modify the same volume. This is sometimes referred to as a cooldown
period.
# Arguments
- `volume_id`: The ID of the volume.
# 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.
- `"Iops"`: The target IOPS rate of the volume. This parameter is valid only for gp3, io1,
and io2 volumes. The following are the supported values for each volume type: gp3: 3,000
- 16,000 IOPS io1: 100 - 64,000 IOPS io2: 100 - 256,000 IOPS For io2 volumes, you
can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances,
you can achieve performance up to 32,000 IOPS. Default: The existing value is retained if
you keep the same volume type. If you change the volume type to io1, io2, or gp3, the
default is 3,000.
- `"MultiAttachEnabled"`: Specifies whether to enable Amazon EBS Multi-Attach. If you
enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the
same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more
information, see Amazon EBS Multi-Attach in the Amazon EBS User Guide.
- `"Size"`: The target size of the volume, in GiB. The target volume size must be greater
than or equal to the existing size of the volume. The following are the supported volumes
sizes for each volume type: gp2 and gp3: 1 - 16,384 GiB io1: 4 - 16,384 GiB io2: 4
- 65,536 GiB st1 and sc1: 125 - 16,384 GiB standard: 1 - 1024 GiB Default: The
existing size is retained.
- `"Throughput"`: The target throughput of the volume, in MiB/s. This parameter is valid
only for gp3 volumes. The maximum value is 1,000. Default: The existing value is retained
if the source and target volume type is gp3. Otherwise, the default value is 125. Valid
Range: Minimum value of 125. Maximum value of 1000.
- `"VolumeType"`: The target EBS volume type of the volume. For more information, see
Amazon EBS volume types in the Amazon EBS User Guide. Default: The existing type is
retained.
"""
function modify_volume(VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ModifyVolume",
Dict{String,Any}("VolumeId" => VolumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_volume(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVolume",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeId" => VolumeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_volume_attribute(volume_id)
modify_volume_attribute(volume_id, params::Dict{String,<:Any})
Modifies a volume attribute. By default, all I/O operations for the volume are suspended
when the data on the volume is determined to be potentially inconsistent, to prevent
undetectable, latent data corruption. The I/O access to the volume can be resumed by first
enabling I/O access and then checking the data consistency on your volume. You can change
the default behavior to resume I/O operations. We recommend that you change this only for
boot volumes or for volumes that are stateless or disposable.
# Arguments
- `volume_id`: The ID of the volume.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoEnableIO"`: Indicates whether the volume should be auto-enabled for I/O operations.
- `"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.
"""
function modify_volume_attribute(
VolumeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVolumeAttribute",
Dict{String,Any}("VolumeId" => VolumeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_volume_attribute(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVolumeAttribute",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VolumeId" => VolumeId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpc_attribute(vpc_id)
modify_vpc_attribute(vpc_id, params::Dict{String,<:Any})
Modifies the specified attribute of the specified VPC.
# Arguments
- `vpc_id`: The ID of the VPC.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnableDnsHostnames"`: Indicates whether the instances launched in the VPC get DNS
hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. You
cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use
separate requests for each attribute. You can only enable DNS hostnames if you've enabled
DNS support.
- `"EnableDnsSupport"`: Indicates whether the DNS resolution is supported for the VPC. If
enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or
the reserved IP address at the base of the VPC network range \"plus two\" succeed. If
disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to
IP addresses is not enabled. You cannot modify the DNS resolution and DNS hostnames
attributes in the same request. Use separate requests for each attribute.
- `"EnableNetworkAddressUsageMetrics"`: Indicates whether Network Address Usage metrics are
enabled for your VPC.
"""
function modify_vpc_attribute(vpcId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ModifyVpcAttribute",
Dict{String,Any}("vpcId" => vpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpc_attribute(
vpcId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVpcAttribute",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("vpcId" => vpcId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpc_endpoint(vpc_endpoint_id)
modify_vpc_endpoint(vpc_endpoint_id, params::Dict{String,<:Any})
Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend
on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more
information, see the Amazon Web Services PrivateLink Guide.
# Arguments
- `vpc_endpoint_id`: The ID of the endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddRouteTableId"`: (Gateway endpoint) The IDs of the route tables to associate with the
endpoint.
- `"AddSecurityGroupId"`: (Interface endpoint) The IDs of the security groups to associate
with the endpoint network interfaces.
- `"AddSubnetId"`: (Interface and Gateway Load Balancer endpoints) The IDs of the subnets
in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only
one subnet.
- `"DnsOptions"`: The DNS options for the endpoint.
- `"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.
- `"IpAddressType"`: The IP address type for the endpoint.
- `"PolicyDocument"`: (Interface and gateway endpoints) A policy to attach to the endpoint
that controls access to the service. The policy must be in valid JSON format.
- `"PrivateDnsEnabled"`: (Interface endpoint) Indicates whether a private hosted zone is
associated with the VPC.
- `"RemoveRouteTableId"`: (Gateway endpoint) The IDs of the route tables to disassociate
from the endpoint.
- `"RemoveSecurityGroupId"`: (Interface endpoint) The IDs of the security groups to
disassociate from the endpoint network interfaces.
- `"RemoveSubnetId"`: (Interface endpoint) The IDs of the subnets from which to remove the
endpoint.
- `"ResetPolicy"`: (Gateway endpoint) Specify true to reset the policy document to the
default policy. The default policy allows full access to the service.
- `"SubnetConfiguration"`: The subnet configurations for the endpoint.
"""
function modify_vpc_endpoint(
VpcEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVpcEndpoint",
Dict{String,Any}("VpcEndpointId" => VpcEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpc_endpoint(
VpcEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpcEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("VpcEndpointId" => VpcEndpointId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpc_endpoint_connection_notification(connection_notification_id)
modify_vpc_endpoint_connection_notification(connection_notification_id, params::Dict{String,<:Any})
Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change
the SNS topic for the notification, or the events for which to be notified.
# Arguments
- `connection_notification_id`: The ID of the notification.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionEvents"`: The events for the endpoint. Valid values are Accept, Connect,
Delete, and Reject.
- `"ConnectionNotificationArn"`: The ARN for the SNS topic for the notification.
- `"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.
"""
function modify_vpc_endpoint_connection_notification(
ConnectionNotificationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVpcEndpointConnectionNotification",
Dict{String,Any}("ConnectionNotificationId" => ConnectionNotificationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpc_endpoint_connection_notification(
ConnectionNotificationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpcEndpointConnectionNotification",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConnectionNotificationId" => ConnectionNotificationId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpc_endpoint_service_configuration(service_id)
modify_vpc_endpoint_service_configuration(service_id, params::Dict{String,<:Any})
Modifies the attributes of your VPC endpoint service configuration. You can change the
Network Load Balancers or Gateway Load Balancers for your service, and you can specify
whether acceptance is required for requests to connect to your endpoint service through an
interface VPC endpoint. If you set or modify the private DNS name, you must prove that you
own the private DNS domain name.
# Arguments
- `service_id`: The ID of the service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptanceRequired"`: Indicates whether requests to create an endpoint to your service
must be accepted.
- `"AddGatewayLoadBalancerArn"`: The Amazon Resource Names (ARNs) of Gateway Load Balancers
to add to your service configuration.
- `"AddNetworkLoadBalancerArn"`: The Amazon Resource Names (ARNs) of Network Load Balancers
to add to your service configuration.
- `"AddSupportedIpAddressType"`: The IP address types to add to your service configuration.
- `"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.
- `"PrivateDnsName"`: (Interface endpoint configuration) The private DNS name to assign to
the endpoint service.
- `"RemoveGatewayLoadBalancerArn"`: The Amazon Resource Names (ARNs) of Gateway Load
Balancers to remove from your service configuration.
- `"RemoveNetworkLoadBalancerArn"`: The Amazon Resource Names (ARNs) of Network Load
Balancers to remove from your service configuration.
- `"RemovePrivateDnsName"`: (Interface endpoint configuration) Removes the private DNS name
of the endpoint service.
- `"RemoveSupportedIpAddressType"`: The IP address types to remove from your service
configuration.
"""
function modify_vpc_endpoint_service_configuration(
ServiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVpcEndpointServiceConfiguration",
Dict{String,Any}("ServiceId" => ServiceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpc_endpoint_service_configuration(
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpcEndpointServiceConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceId" => ServiceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpc_endpoint_service_payer_responsibility(payer_responsibility, service_id)
modify_vpc_endpoint_service_payer_responsibility(payer_responsibility, service_id, params::Dict{String,<:Any})
Modifies the payer responsibility for your VPC endpoint service.
# Arguments
- `payer_responsibility`: The entity that is responsible for the endpoint costs. The
default is the endpoint owner. If you set the payer responsibility to the service owner,
you cannot set it back to the endpoint owner.
- `service_id`: The ID of the service.
# 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.
"""
function modify_vpc_endpoint_service_payer_responsibility(
PayerResponsibility, ServiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVpcEndpointServicePayerResponsibility",
Dict{String,Any}(
"PayerResponsibility" => PayerResponsibility, "ServiceId" => ServiceId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpc_endpoint_service_payer_responsibility(
PayerResponsibility,
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpcEndpointServicePayerResponsibility",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PayerResponsibility" => PayerResponsibility, "ServiceId" => ServiceId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpc_endpoint_service_permissions(service_id)
modify_vpc_endpoint_service_permissions(service_id, params::Dict{String,<:Any})
Modifies the permissions for your VPC endpoint service. You can add or remove permissions
for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to
your endpoint service. If you grant permissions to all principals, the service is public.
Any users who know the name of a public service can send a request to attach an endpoint.
If the service does not require manual approval, attachments are automatically approved.
# Arguments
- `service_id`: The ID of the service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddAllowedPrincipals"`: The Amazon Resource Names (ARN) of the principals. Permissions
are granted to the principals in this list. To grant permissions to all principals, specify
an asterisk (*).
- `"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.
- `"RemoveAllowedPrincipals"`: The Amazon Resource Names (ARN) of the principals.
Permissions are revoked for principals in this list.
"""
function modify_vpc_endpoint_service_permissions(
ServiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVpcEndpointServicePermissions",
Dict{String,Any}("ServiceId" => ServiceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpc_endpoint_service_permissions(
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpcEndpointServicePermissions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceId" => ServiceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpc_peering_connection_options(vpc_peering_connection_id)
modify_vpc_peering_connection_options(vpc_peering_connection_id, params::Dict{String,<:Any})
Modifies the VPC peering connection options on one side of a VPC peering connection. If the
peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for
queries from the local VPC. This ensures that queries from the local VPC resolve to private
IP addresses in the peer VPC. This option is not available if the peered VPCs are in
different Amazon Web Services accounts or different Regions. For peered VPCs in different
Amazon Web Services accounts, each Amazon Web Services account owner must initiate a
separate request to modify the peering connection options. For inter-region peering
connections, you must use the Region for the requester VPC to modify the requester VPC
peering options and the Region for the accepter VPC to modify the accepter VPC peering
options. To verify which VPCs are the accepter and the requester for a VPC peering
connection, use the DescribeVpcPeeringConnections command.
# Arguments
- `vpc_peering_connection_id`: The ID of the VPC peering connection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccepterPeeringConnectionOptions"`: The VPC peering connection options for the accepter
VPC.
- `"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.
- `"RequesterPeeringConnectionOptions"`: The VPC peering connection options for the
requester VPC.
"""
function modify_vpc_peering_connection_options(
VpcPeeringConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVpcPeeringConnectionOptions",
Dict{String,Any}("VpcPeeringConnectionId" => VpcPeeringConnectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpc_peering_connection_options(
VpcPeeringConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpcPeeringConnectionOptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VpcPeeringConnectionId" => VpcPeeringConnectionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpc_tenancy(instance_tenancy, vpc_id)
modify_vpc_tenancy(instance_tenancy, vpc_id, params::Dict{String,<:Any})
Modifies the instance tenancy attribute of the specified VPC. You can change the instance
tenancy attribute of a VPC to default only. You cannot change the instance tenancy
attribute to dedicated. After you modify the tenancy of the VPC, any new instances that you
launch into the VPC have a tenancy of default, unless you specify otherwise during launch.
The tenancy of any existing instances in the VPC is not affected. For more information, see
Dedicated Instances in the Amazon EC2 User Guide.
# Arguments
- `instance_tenancy`: The instance tenancy attribute for the VPC.
- `vpc_id`: The ID of the VPC.
# 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.
"""
function modify_vpc_tenancy(
InstanceTenancy, VpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVpcTenancy",
Dict{String,Any}("InstanceTenancy" => InstanceTenancy, "VpcId" => VpcId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpc_tenancy(
InstanceTenancy,
VpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpcTenancy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceTenancy" => InstanceTenancy, "VpcId" => VpcId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpn_connection(vpn_connection_id)
modify_vpn_connection(vpn_connection_id, params::Dict{String,<:Any})
Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site
VPN connection. To modify the target gateway, the following migration options are
available: An existing virtual private gateway to a new virtual private gateway An
existing virtual private gateway to a transit gateway An existing transit gateway to a
new transit gateway An existing transit gateway to a virtual private gateway Before you
perform the migration to the new gateway, you must configure the new gateway. Use
CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a
transit gateway. This step is required when you migrate from a virtual private gateway with
static routes to a transit gateway. You must delete the static routes before you migrate
to the new gateway. Keep a copy of the static route before you delete it. You will need to
add back these routes to the transit gateway after the VPN connection migration is
complete. After you migrate to the new gateway, you might need to modify your VPC route
table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route
tables in the Amazon Web Services Site-to-Site VPN User Guide. When the new gateway is a
transit gateway, modify the transit gateway route table to allow traffic between the VPC
and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to
add the routes. If you deleted VPN static routes, you must add the static routes to the
transit gateway route table. After you perform this operation, the VPN endpoint's IP
addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon
Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period
while we provision the new endpoints.
# Arguments
- `vpn_connection_id`: The ID of the VPN connection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomerGatewayId"`: The ID of the customer gateway at your end of the VPN connection.
- `"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.
- `"TransitGatewayId"`: The ID of the transit gateway.
- `"VpnGatewayId"`: The ID of the virtual private gateway at the Amazon Web Services side
of the VPN connection.
"""
function modify_vpn_connection(
VpnConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVpnConnection",
Dict{String,Any}("VpnConnectionId" => VpnConnectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpn_connection(
VpnConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpnConnection",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("VpnConnectionId" => VpnConnectionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpn_connection_options(vpn_connection_id)
modify_vpn_connection_options(vpn_connection_id, params::Dict{String,<:Any})
Modifies the connection options for your Site-to-Site VPN connection. When you modify the
VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do
not change, and the tunnel options do not change. Your VPN connection will be temporarily
unavailable for a brief period while the VPN connection is updated.
# Arguments
- `vpn_connection_id`: The ID of the Site-to-Site VPN connection.
# 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.
- `"LocalIpv4NetworkCidr"`: The IPv4 CIDR on the customer gateway (on-premises) side of the
VPN connection. Default: 0.0.0.0/0
- `"LocalIpv6NetworkCidr"`: The IPv6 CIDR on the customer gateway (on-premises) side of the
VPN connection. Default: ::/0
- `"RemoteIpv4NetworkCidr"`: The IPv4 CIDR on the Amazon Web Services side of the VPN
connection. Default: 0.0.0.0/0
- `"RemoteIpv6NetworkCidr"`: The IPv6 CIDR on the Amazon Web Services side of the VPN
connection. Default: ::/0
"""
function modify_vpn_connection_options(
VpnConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ModifyVpnConnectionOptions",
Dict{String,Any}("VpnConnectionId" => VpnConnectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpn_connection_options(
VpnConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpnConnectionOptions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("VpnConnectionId" => VpnConnectionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpn_tunnel_certificate(vpn_connection_id, vpn_tunnel_outside_ip_address)
modify_vpn_tunnel_certificate(vpn_connection_id, vpn_tunnel_outside_ip_address, params::Dict{String,<:Any})
Modifies the VPN tunnel endpoint certificate.
# Arguments
- `vpn_connection_id`: The ID of the Amazon Web Services Site-to-Site VPN connection.
- `vpn_tunnel_outside_ip_address`: The external IP address of the VPN tunnel.
# 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.
"""
function modify_vpn_tunnel_certificate(
VpnConnectionId,
VpnTunnelOutsideIpAddress;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpnTunnelCertificate",
Dict{String,Any}(
"VpnConnectionId" => VpnConnectionId,
"VpnTunnelOutsideIpAddress" => VpnTunnelOutsideIpAddress,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpn_tunnel_certificate(
VpnConnectionId,
VpnTunnelOutsideIpAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpnTunnelCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VpnConnectionId" => VpnConnectionId,
"VpnTunnelOutsideIpAddress" => VpnTunnelOutsideIpAddress,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_vpn_tunnel_options(tunnel_options, vpn_connection_id, vpn_tunnel_outside_ip_address)
modify_vpn_tunnel_options(tunnel_options, vpn_connection_id, vpn_tunnel_outside_ip_address, params::Dict{String,<:Any})
Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN
connection. You can modify multiple options for a tunnel in a single request, but you can
only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options
for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
# Arguments
- `tunnel_options`: The tunnel options to modify.
- `vpn_connection_id`: The ID of the Amazon Web Services Site-to-Site VPN connection.
- `vpn_tunnel_outside_ip_address`: The external IP address of the VPN tunnel.
# 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.
- `"SkipTunnelReplacement"`: Choose whether or not to trigger immediate tunnel replacement.
This is only applicable when turning on or off EnableTunnelLifecycleControl. Valid values:
True | False
"""
function modify_vpn_tunnel_options(
TunnelOptions,
VpnConnectionId,
VpnTunnelOutsideIpAddress;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpnTunnelOptions",
Dict{String,Any}(
"TunnelOptions" => TunnelOptions,
"VpnConnectionId" => VpnConnectionId,
"VpnTunnelOutsideIpAddress" => VpnTunnelOutsideIpAddress,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_vpn_tunnel_options(
TunnelOptions,
VpnConnectionId,
VpnTunnelOutsideIpAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ModifyVpnTunnelOptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TunnelOptions" => TunnelOptions,
"VpnConnectionId" => VpnConnectionId,
"VpnTunnelOutsideIpAddress" => VpnTunnelOutsideIpAddress,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
monitor_instances(instance_id)
monitor_instances(instance_id, params::Dict{String,<:Any})
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled.
For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User
Guide. To disable detailed monitoring, see UnmonitorInstances.
# Arguments
- `instance_id`: The IDs of the instances.
# 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.
"""
function monitor_instances(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"MonitorInstances",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function monitor_instances(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"MonitorInstances",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
move_address_to_vpc(public_ip)
move_address_to_vpc(public_ip, params::Dict{String,<:Any})
This action is deprecated. Moves an Elastic IP address from the EC2-Classic platform to
the EC2-VPC platform. The Elastic IP address must be allocated to your account for more
than 24 hours, and it must not be associated with an instance. After the Elastic IP address
is moved, it is no longer available for use in the EC2-Classic platform, unless you move it
back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that
was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.
# Arguments
- `public_ip`: The Elastic IP address.
# 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.
"""
function move_address_to_vpc(publicIp; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"MoveAddressToVpc",
Dict{String,Any}("publicIp" => publicIp);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function move_address_to_vpc(
publicIp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"MoveAddressToVpc",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("publicIp" => publicIp), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
move_byoip_cidr_to_ipam(cidr, ipam_pool_id, ipam_pool_owner)
move_byoip_cidr_to_ipam(cidr, ipam_pool_id, ipam_pool_owner, params::Dict{String,<:Any})
Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool. If you already have a BYOIPv4 CIDR
with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot
move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for
the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.
# Arguments
- `cidr`: The BYOIP CIDR.
- `ipam_pool_id`: The IPAM pool ID.
- `ipam_pool_owner`: The Amazon Web Services account ID of the owner of the IPAM pool.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
"""
function move_byoip_cidr_to_ipam(
Cidr, IpamPoolId, IpamPoolOwner; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"MoveByoipCidrToIpam",
Dict{String,Any}(
"Cidr" => Cidr, "IpamPoolId" => IpamPoolId, "IpamPoolOwner" => IpamPoolOwner
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function move_byoip_cidr_to_ipam(
Cidr,
IpamPoolId,
IpamPoolOwner,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"MoveByoipCidrToIpam",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Cidr" => Cidr,
"IpamPoolId" => IpamPoolId,
"IpamPoolOwner" => IpamPoolOwner,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
provision_byoip_cidr(cidr)
provision_byoip_cidr(cidr, params::Dict{String,<:Any})
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources
through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After
the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise
it. You must ensure that the address range is registered to you and that you created an
RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more
information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.
Provisioning an address range is an asynchronous operation, so the call returns
immediately, but the address range is not ready to use until its status changes from
pending-provision to provisioned. To monitor the status of an address range, use
DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use
AllocateAddress with either the specific address from the address pool or the ID of the
address pool.
# Arguments
- `cidr`: The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4
prefix that you can specify is /24. The most specific IPv6 address range that you can bring
is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly
advertisable. The address range cannot overlap with another address range that you've
brought to this or another Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CidrAuthorizationContext"`: A signed document that proves that you are authorized to
bring the specified IP address range to Amazon using BYOIP.
- `"Description"`: A description for the address range and the address pool.
- `"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.
- `"MultiRegion"`: Reserved.
- `"NetworkBorderGroup"`: If you have Local Zones enabled, you can choose a network border
group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network
border group carefully as the EIP and the Amazon Web Services resource it is associated
with must reside in the same network border group. You can provision BYOIP address ranges
to and advertise them in the following Local Zone network border groups: us-east-1-dfw-2
us-west-2-lax-1 us-west-2-phx-2 You cannot provision or advertise BYOIPv6 address
ranges in Local Zones at this time.
- `"PoolTagSpecification"`: The tags to apply to the address pool.
- `"PubliclyAdvertisable"`: (IPv6 only) Indicate whether the address range will be publicly
advertised to the internet. Default: true
"""
function provision_byoip_cidr(Cidr; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ProvisionByoipCidr",
Dict{String,Any}("Cidr" => Cidr);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function provision_byoip_cidr(
Cidr, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ProvisionByoipCidr",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Cidr" => Cidr), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
provision_ipam_byoasn(asn, asn_authorization_context, ipam_id)
provision_ipam_byoasn(asn, asn_authorization_context, ipam_id, params::Dict{String,<:Any})
Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account.
This action requires authorization context for Amazon to bring the ASN to an Amazon Web
Services account. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon
VPC IPAM guide.
# Arguments
- `asn`: A public 2-byte or 4-byte ASN.
- `asn_authorization_context`: An ASN authorization context.
- `ipam_id`: An IPAM ID.
# 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.
"""
function provision_ipam_byoasn(
Asn, AsnAuthorizationContext, IpamId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ProvisionIpamByoasn",
Dict{String,Any}(
"Asn" => Asn,
"AsnAuthorizationContext" => AsnAuthorizationContext,
"IpamId" => IpamId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function provision_ipam_byoasn(
Asn,
AsnAuthorizationContext,
IpamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ProvisionIpamByoasn",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Asn" => Asn,
"AsnAuthorizationContext" => AsnAuthorizationContext,
"IpamId" => IpamId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
provision_ipam_pool_cidr(ipam_pool_id)
provision_ipam_pool_cidr(ipam_pool_id, params::Dict{String,<:Any})
Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a
top-level pool or to transfer a CIDR from a top-level pool to a pool within it. For more
information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.
# Arguments
- `ipam_pool_id`: The ID of the IPAM pool to which you want to assign a CIDR.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Cidr"`: The CIDR you want to assign to the IPAM pool. Either \"NetmaskLength\" or
\"Cidr\" is required. This value will be null if you specify \"NetmaskLength\" and will be
filled in during the provisioning process.
- `"CidrAuthorizationContext"`: A signed document that proves that you are authorized to
bring a specified IP address range to Amazon using BYOIP. This option applies to public
pools only.
- `"ClientToken"`: A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency.
- `"DryRun"`: A check for 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.
- `"NetmaskLength"`: The netmask length of the CIDR you'd like to provision to a pool. Can
be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning
CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level
pools. Either \"NetmaskLength\" or \"Cidr\" is required.
"""
function provision_ipam_pool_cidr(
IpamPoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ProvisionIpamPoolCidr",
Dict{String,Any}("IpamPoolId" => IpamPoolId, "ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function provision_ipam_pool_cidr(
IpamPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ProvisionIpamPoolCidr",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IpamPoolId" => IpamPoolId, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
provision_public_ipv4_pool_cidr(ipam_pool_id, netmask_length, pool_id)
provision_public_ipv4_pool_cidr(ipam_pool_id, netmask_length, pool_id, params::Dict{String,<:Any})
Provision a CIDR to a public IPv4 pool. For more information about IPAM, see What is IPAM?
in the Amazon VPC IPAM User Guide.
# Arguments
- `ipam_pool_id`: The ID of the IPAM pool you would like to use to allocate this CIDR.
- `netmask_length`: The netmask length of the CIDR you would like to allocate to the public
IPv4 pool.
- `pool_id`: The ID of the public IPv4 pool you would like to use for this CIDR.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
"""
function provision_public_ipv4_pool_cidr(
IpamPoolId, NetmaskLength, PoolId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ProvisionPublicIpv4PoolCidr",
Dict{String,Any}(
"IpamPoolId" => IpamPoolId, "NetmaskLength" => NetmaskLength, "PoolId" => PoolId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function provision_public_ipv4_pool_cidr(
IpamPoolId,
NetmaskLength,
PoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ProvisionPublicIpv4PoolCidr",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IpamPoolId" => IpamPoolId,
"NetmaskLength" => NetmaskLength,
"PoolId" => PoolId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_capacity_block(capacity_block_offering_id, instance_platform)
purchase_capacity_block(capacity_block_offering_id, instance_platform, params::Dict{String,<:Any})
Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU
capacity is available for machine learning (ML) workloads. You must specify the ID of the
Capacity Block offering you are purchasing.
# Arguments
- `capacity_block_offering_id`: The ID of the Capacity Block offering.
- `instance_platform`: The type of operating system for which to reserve capacity.
# 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.
- `"TagSpecification"`: The tags to apply to the Capacity Block during launch.
"""
function purchase_capacity_block(
CapacityBlockOfferingId,
InstancePlatform;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"PurchaseCapacityBlock",
Dict{String,Any}(
"CapacityBlockOfferingId" => CapacityBlockOfferingId,
"InstancePlatform" => InstancePlatform,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_capacity_block(
CapacityBlockOfferingId,
InstancePlatform,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"PurchaseCapacityBlock",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CapacityBlockOfferingId" => CapacityBlockOfferingId,
"InstancePlatform" => InstancePlatform,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_host_reservation(offering_id, item)
purchase_host_reservation(offering_id, item, params::Dict{String,<:Any})
Purchase a reservation with configurations that match those of your Dedicated Host. You
must have active Dedicated Hosts in your account before you purchase a reservation. This
action results in the specified reservation being purchased and charged to your account.
# Arguments
- `offering_id`: The ID of the offering.
- `item`: The IDs of the Dedicated Hosts with which the reservation will be associated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring Idempotency.
- `"CurrencyCode"`: The currency in which the totalUpfrontPrice, LimitPrice, and
totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.
- `"HostIdSet"`: The IDs of the Dedicated Hosts with which the reservation will be
associated.
- `"LimitPrice"`: The specified limit is checked against the total upfront cost of the
reservation (calculated as the offering's upfront cost multiplied by the host count). If
the total upfront cost is greater than the specified price limit, the request fails. This
is used to ensure that the purchase does not exceed the expected upfront cost of the
purchase. At this time, the only supported currency is USD. For example, to indicate a
limit price of USD 100, specify 100.00.
- `"TagSpecification"`: The tags to apply to the Dedicated Host Reservation during purchase.
"""
function purchase_host_reservation(
OfferingId, item; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"PurchaseHostReservation",
Dict{String,Any}("OfferingId" => OfferingId, "item" => item);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_host_reservation(
OfferingId,
item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"PurchaseHostReservation",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("OfferingId" => OfferingId, "item" => item), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_reserved_instances_offering(instance_count, reserved_instances_offering_id)
purchase_reserved_instances_offering(instance_count, reserved_instances_offering_id, params::Dict{String,<:Any})
Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a
lower hourly rate compared to On-Demand instance pricing. Use
DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match
your specifications. After you've purchased a Reserved Instance, you can check for your new
Reserved Instance with DescribeReservedInstances. To queue a purchase for a future date and
time, specify a purchase time. If you do not specify a purchase time, the default is the
current time. For more information, see Reserved Instances and Sell in the Reserved
Instance Marketplace in the Amazon EC2 User Guide.
# Arguments
- `instance_count`: The number of Reserved Instances to purchase.
- `reserved_instances_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:
- `"PurchaseTime"`: The time at which to purchase the Reserved Instance, in UTC format (for
example, YYYY-MM-DDTHH:MM:SSZ).
- `"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.
- `"limitPrice"`: Specified for Reserved Instance Marketplace offerings to limit the total
order and ensure that the Reserved Instances are not purchased at unexpected prices.
"""
function purchase_reserved_instances_offering(
InstanceCount,
ReservedInstancesOfferingId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"PurchaseReservedInstancesOffering",
Dict{String,Any}(
"InstanceCount" => InstanceCount,
"ReservedInstancesOfferingId" => ReservedInstancesOfferingId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_reserved_instances_offering(
InstanceCount,
ReservedInstancesOfferingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"PurchaseReservedInstancesOffering",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceCount" => InstanceCount,
"ReservedInstancesOfferingId" => ReservedInstancesOfferingId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_scheduled_instances(purchase_request)
purchase_scheduled_instances(purchase_request, params::Dict{String,<:Any})
You can no longer purchase Scheduled Instances. Purchases the Scheduled Instances with
the specified schedule. Scheduled Instances enable you to purchase Amazon EC2 compute
capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you
must call DescribeScheduledInstanceAvailability to check for available schedules and obtain
a purchase token. After you purchase a Scheduled Instance, you must call
RunScheduledInstances during each scheduled time period. After you purchase a Scheduled
Instance, you can't cancel, modify, or resell your purchase.
# Arguments
- `purchase_request`: The purchase requests.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that ensures the idempotency of the
request. For more information, see Ensuring Idempotency.
- `"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.
"""
function purchase_scheduled_instances(
PurchaseRequest; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"PurchaseScheduledInstances",
Dict{String,Any}(
"PurchaseRequest" => PurchaseRequest, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_scheduled_instances(
PurchaseRequest,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"PurchaseScheduledInstances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PurchaseRequest" => PurchaseRequest, "ClientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_instances(instance_id)
reboot_instances(instance_id, params::Dict{String,<:Any})
Requests a reboot of the specified instances. This operation is asynchronous; it only
queues a request to reboot the specified instances. The operation succeeds if the instances
are valid and belong to you. Requests to reboot terminated instances are ignored. If an
instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard
reboot. For more information about troubleshooting, see Troubleshoot an unreachable
instance in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The instance IDs.
# 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.
"""
function reboot_instances(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"RebootInstances",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_instances(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RebootInstances",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_image(name)
register_image(name, params::Dict{String,<:Any})
Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI is
the final step in the creation process. For more information about creating AMIs, see
Create your own AMI in the Amazon Elastic Compute Cloud User Guide. For Amazon EBS-backed
instances, CreateImage creates and registers the AMI in a single request, so you don't have
to register the AMI yourself. We recommend that you always use CreateImage unless you have
a specific reason to use RegisterImage. If needed, you can deregister an AMI at any time.
Any modifications you make to an AMI backed by an instance store volume invalidates its
registration. If you make changes to an image, deregister the previous image and register
the new image. Register a snapshot of a root device volume You can use RegisterImage to
create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify
the snapshot using a block device mapping. You can't set the encryption state of the volume
using the block device mapping. If the snapshot is encrypted, or encryption by default is
enabled, the root volume of an instance launched from the AMI is encrypted. For more
information, see Create a Linux AMI from a snapshot and Use encryption with Amazon
EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide. Amazon Web Services
Marketplace product codes If any snapshots have Amazon Web Services Marketplace product
codes, they are copied to the new AMI. Windows and some Linux distributions, such as Red
Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2
billing product code associated with an AMI to verify the subscription status for package
updates. To create a new AMI for operating systems that require a billing product code,
instead of registering the AMI, do the following to preserve the billing product code
association: Launch an instance from an existing AMI with that billing product code.
Customize the instance. Create an AMI from the instance using CreateImage. If you
purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an
AMI with a billing product code, make sure that the Reserved Instance has the matching
billing product code. If you purchase a Reserved Instance without the matching billing
product code, the Reserved Instance will not be applied to the On-Demand Instance. For
information about how to obtain the platform details and billing information of an AMI, see
Understand AMI billing information in the Amazon EC2 User Guide.
# Arguments
- `name`: A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses
(()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes
('), at-signs (@), or underscores(_)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BillingProduct"`: The billing product codes. Your account must be authorized to specify
billing product codes. If your account is not authorized to specify billing product codes,
you can publish AMIs that include billable software and list them on the Amazon Web
Services Marketplace. You must first register as a seller on the Amazon Web Services
Marketplace. For more information, see Getting started as a seller and AMI-based products
in the Amazon Web Services Marketplace Seller Guide.
- `"BlockDeviceMapping"`: The block device mapping entries. If you specify an Amazon EBS
volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of
the volume. If you create an AMI on an Outpost, then all backing snapshots must be on the
same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local
snapshots can be used to launch instances on the same Outpost only. For more information,
Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
- `"BootMode"`: The boot mode of the AMI. A value of uefi-preferred indicates that the AMI
supports both UEFI and Legacy BIOS. The operating system contained in the AMI must be
configured to support the specified boot mode. For more information, see Boot modes in the
Amazon EC2 User Guide.
- `"ImageLocation"`: The full path to your AMI manifest in Amazon S3 storage. The specified
bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can
be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service
Developer Guide.
- `"ImdsSupport"`: Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances
launched from this AMI will have HttpTokens automatically set to required so that, by
default, the instance requires that IMDSv2 is used when requesting instance metadata. In
addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI
in the Amazon EC2 User Guide. If you set the value to v2.0, make sure that your AMI
software can support IMDSv2.
- `"TagSpecification"`: The tags to apply to the AMI. To tag the AMI, the value for
ResourceType must be image. If you specify another value for ResourceType, the request
fails. To tag an AMI after it has been registered, see CreateTags.
- `"TpmSupport"`: Set to v2.0 to enable Trusted Platform Module (TPM) support. For more
information, see NitroTPM in the Amazon EC2 User Guide.
- `"UefiData"`: Base64 representation of the non-volatile UEFI variable store. To retrieve
the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI
data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure
Boot in the Amazon EC2 User Guide.
- `"architecture"`: The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386.
For instance store-backed AMIs, the architecture specified in the manifest file.
- `"description"`: A description for your AMI.
- `"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.
- `"enaSupport"`: Set to true to enable enhanced networking with ENA for the AMI and any
instances that you launch from the AMI. This option is supported only for HVM AMIs.
Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
- `"kernelId"`: The ID of the kernel.
- `"ramdiskId"`: The ID of the RAM disk.
- `"rootDeviceName"`: The device name of the root device volume (for example, /dev/sda1).
- `"sriovNetSupport"`: Set to simple to enable enhanced networking with the Intel 82599
Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time. This option is supported only for
HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI
unreachable.
- `"virtualizationType"`: The type of virtualization (hvm | paravirtual). Default:
paravirtual
"""
function register_image(name; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"RegisterImage",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_image(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RegisterImage",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_instance_event_notification_attributes(instance_tag_attribute)
register_instance_event_notification_attributes(instance_tag_attribute, params::Dict{String,<:Any})
Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
# Arguments
- `instance_tag_attribute`: Information about the tag keys to register.
# 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.
"""
function register_instance_event_notification_attributes(
InstanceTagAttribute; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RegisterInstanceEventNotificationAttributes",
Dict{String,Any}("InstanceTagAttribute" => InstanceTagAttribute);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_instance_event_notification_attributes(
InstanceTagAttribute,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RegisterInstanceEventNotificationAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceTagAttribute" => InstanceTagAttribute),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_transit_gateway_multicast_group_members(transit_gateway_multicast_domain_id, item)
register_transit_gateway_multicast_group_members(transit_gateway_multicast_domain_id, item, params::Dict{String,<:Any})
Registers members (network interfaces) with the transit gateway multicast group. A member
is a network interface associated with a supported EC2 instance that receives multicast
traffic. For more information, see Multicast on transit gateways in the Amazon Web Services
Transit Gateways Guide. After you add the members, use SearchTransitGatewayMulticastGroups
to verify that the members were added to the transit gateway multicast group.
# Arguments
- `transit_gateway_multicast_domain_id`: The ID of the transit gateway multicast domain.
- `item`: The group members' network interface IDs to register with the transit gateway
multicast group.
# 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.
- `"GroupIpAddress"`: The IP address assigned to the transit gateway multicast group.
- `"NetworkInterfaceIds"`: The group members' network interface IDs to register with the
transit gateway multicast group.
"""
function register_transit_gateway_multicast_group_members(
TransitGatewayMulticastDomainId, item; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RegisterTransitGatewayMulticastGroupMembers",
Dict{String,Any}(
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId,
"item" => item,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_transit_gateway_multicast_group_members(
TransitGatewayMulticastDomainId,
item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RegisterTransitGatewayMulticastGroupMembers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId,
"item" => item,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_transit_gateway_multicast_group_sources(transit_gateway_multicast_domain_id, item)
register_transit_gateway_multicast_group_sources(transit_gateway_multicast_domain_id, item, params::Dict{String,<:Any})
Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends
multicast traffic. For more information about supported instances, see Multicast on transit
gateways in the Amazon Web Services Transit Gateways Guide. After you add the source, use
SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast
group.
# Arguments
- `transit_gateway_multicast_domain_id`: The ID of the transit gateway multicast domain.
- `item`: The group sources' network interface IDs to register with the transit gateway
multicast group.
# 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.
- `"GroupIpAddress"`: The IP address assigned to the transit gateway multicast group.
- `"NetworkInterfaceIds"`: The group sources' network interface IDs to register with the
transit gateway multicast group.
"""
function register_transit_gateway_multicast_group_sources(
TransitGatewayMulticastDomainId, item; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RegisterTransitGatewayMulticastGroupSources",
Dict{String,Any}(
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId,
"item" => item,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_transit_gateway_multicast_group_sources(
TransitGatewayMulticastDomainId,
item,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RegisterTransitGatewayMulticastGroupSources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId,
"item" => item,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_transit_gateway_multicast_domain_associations()
reject_transit_gateway_multicast_domain_associations(params::Dict{String,<:Any})
Rejects a request to associate cross-account subnets with a transit gateway multicast
domain.
# 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.
- `"SubnetIds"`: The IDs of the subnets to associate with the transit gateway multicast
domain.
- `"TransitGatewayAttachmentId"`: The ID of the transit gateway attachment.
- `"TransitGatewayMulticastDomainId"`: The ID of the transit gateway multicast domain.
"""
function reject_transit_gateway_multicast_domain_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RejectTransitGatewayMulticastDomainAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_transit_gateway_multicast_domain_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RejectTransitGatewayMulticastDomainAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_transit_gateway_peering_attachment(transit_gateway_attachment_id)
reject_transit_gateway_peering_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Rejects a transit gateway peering attachment request.
# Arguments
- `transit_gateway_attachment_id`: The ID of the transit gateway peering attachment.
# 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.
"""
function reject_transit_gateway_peering_attachment(
TransitGatewayAttachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RejectTransitGatewayPeeringAttachment",
Dict{String,Any}("TransitGatewayAttachmentId" => TransitGatewayAttachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_transit_gateway_peering_attachment(
TransitGatewayAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RejectTransitGatewayPeeringAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_transit_gateway_vpc_attachment(transit_gateway_attachment_id)
reject_transit_gateway_vpc_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Rejects a request to attach a VPC to a transit gateway. The VPC attachment must be in the
pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC
attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment
request.
# Arguments
- `transit_gateway_attachment_id`: The ID of the attachment.
# 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.
"""
function reject_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RejectTransitGatewayVpcAttachment",
Dict{String,Any}("TransitGatewayAttachmentId" => TransitGatewayAttachmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_transit_gateway_vpc_attachment(
TransitGatewayAttachmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RejectTransitGatewayVpcAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayAttachmentId" => TransitGatewayAttachmentId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_vpc_endpoint_connections(service_id, vpc_endpoint_id)
reject_vpc_endpoint_connections(service_id, vpc_endpoint_id, params::Dict{String,<:Any})
Rejects VPC endpoint connection requests to your VPC endpoint service.
# Arguments
- `service_id`: The ID of the service.
- `vpc_endpoint_id`: The IDs of the VPC endpoints.
# 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.
"""
function reject_vpc_endpoint_connections(
ServiceId, VpcEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RejectVpcEndpointConnections",
Dict{String,Any}("ServiceId" => ServiceId, "VpcEndpointId" => VpcEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_vpc_endpoint_connections(
ServiceId,
VpcEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RejectVpcEndpointConnections",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServiceId" => ServiceId, "VpcEndpointId" => VpcEndpointId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_vpc_peering_connection(vpc_peering_connection_id)
reject_vpc_peering_connection(vpc_peering_connection_id, params::Dict{String,<:Any})
Rejects a VPC peering connection request. The VPC peering connection must be in the
pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your
outstanding VPC peering connection requests. To delete an active VPC peering connection, or
to delete a VPC peering connection request that you initiated, use
DeleteVpcPeeringConnection.
# Arguments
- `vpc_peering_connection_id`: The ID of the VPC peering connection.
# 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.
"""
function reject_vpc_peering_connection(
vpcPeeringConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RejectVpcPeeringConnection",
Dict{String,Any}("vpcPeeringConnectionId" => vpcPeeringConnectionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_vpc_peering_connection(
vpcPeeringConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RejectVpcPeeringConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("vpcPeeringConnectionId" => vpcPeeringConnectionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
release_address()
release_address(params::Dict{String,<:Any})
Releases the specified Elastic IP address. [Default VPC] Releasing an Elastic IP address
automatically disassociates it from any instance that it's associated with. To disassociate
an Elastic IP address without releasing it, use DisassociateAddress. [Nondefault VPC] You
must use DisassociateAddress to disassociate the Elastic IP address before you can release
it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse). After releasing an
Elastic IP address, it is released to the IP address pool. Be sure to update your DNS
records and any servers or devices that communicate with the address. If you attempt to
release an Elastic IP address that you already released, you'll get an AuthFailure error if
the address is already allocated to another Amazon Web Services account. After you release
an Elastic IP address, you might be able to recover it. For more information, see
AllocateAddress.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocationId"`: The allocation ID. This parameter is required.
- `"NetworkBorderGroup"`: The set of Availability Zones, Local Zones, or Wavelength Zones
from which Amazon Web Services advertises IP addresses. If you provide an incorrect network
border group, you receive an InvalidAddress.NotFound error.
- `"PublicIp"`: Deprecated.
- `"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.
"""
function release_address(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2("ReleaseAddress"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function release_address(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ReleaseAddress", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
release_hosts(host_id)
release_hosts(host_id, params::Dict{String,<:Any})
When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand
billing is stopped and the host goes into released state. The host ID of Dedicated Hosts
that have been released can no longer be specified in another request, for example, to
modify the host. You must stop or terminate all instances on a host before it can be
released. When Dedicated Hosts are released, it may take some time for them to stop
counting toward your limit and you may receive capacity errors when trying to allocate new
Dedicated Hosts. Wait a few minutes and then try again. Released hosts still appear in a
DescribeHosts response.
# Arguments
- `host_id`: The IDs of the Dedicated Hosts to release.
"""
function release_hosts(hostId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ReleaseHosts",
Dict{String,Any}("hostId" => hostId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function release_hosts(
hostId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ReleaseHosts",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("hostId" => hostId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
release_ipam_pool_allocation(cidr, ipam_pool_allocation_id, ipam_pool_id)
release_ipam_pool_allocation(cidr, ipam_pool_allocation_id, ipam_pool_id, params::Dict{String,<:Any})
Release an allocation within an IPAM pool. The Region you use should be the IPAM pool
locale. The locale is the Amazon Web Services Region where this IPAM pool is available for
allocations. You can only use this action to release manual allocations. To remove an
allocation for a resource without deleting the resource, set its monitored state to false
using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon
VPC IPAM User Guide. All EC2 API actions follow an eventual consistency model.
# Arguments
- `cidr`: The CIDR of the allocation you want to release.
- `ipam_pool_allocation_id`: The ID of the allocation.
- `ipam_pool_id`: The ID of the IPAM pool which contains the allocation you want to release.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DryRun"`: A check for 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.
"""
function release_ipam_pool_allocation(
Cidr,
IpamPoolAllocationId,
IpamPoolId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReleaseIpamPoolAllocation",
Dict{String,Any}(
"Cidr" => Cidr,
"IpamPoolAllocationId" => IpamPoolAllocationId,
"IpamPoolId" => IpamPoolId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function release_ipam_pool_allocation(
Cidr,
IpamPoolAllocationId,
IpamPoolId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReleaseIpamPoolAllocation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Cidr" => Cidr,
"IpamPoolAllocationId" => IpamPoolAllocationId,
"IpamPoolId" => IpamPoolId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replace_iam_instance_profile_association(association_id, iam_instance_profile)
replace_iam_instance_profile_association(association_id, iam_instance_profile, params::Dict{String,<:Any})
Replaces an IAM instance profile for the specified running instance. You can use this
action to change the IAM instance profile that's associated with an instance without having
to disassociate the existing IAM instance profile first. Use
DescribeIamInstanceProfileAssociations to get the association ID.
# Arguments
- `association_id`: The ID of the existing IAM instance profile association.
- `iam_instance_profile`: The IAM instance profile.
"""
function replace_iam_instance_profile_association(
AssociationId, IamInstanceProfile; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ReplaceIamInstanceProfileAssociation",
Dict{String,Any}(
"AssociationId" => AssociationId, "IamInstanceProfile" => IamInstanceProfile
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replace_iam_instance_profile_association(
AssociationId,
IamInstanceProfile,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReplaceIamInstanceProfileAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationId" => AssociationId,
"IamInstanceProfile" => IamInstanceProfile,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replace_network_acl_association(association_id, network_acl_id)
replace_network_acl_association(association_id, network_acl_id, params::Dict{String,<:Any})
Changes which network ACL a subnet is associated with. By default when you create a subnet,
it's automatically associated with the default network ACL. For more information, see
Network ACLs in the Amazon VPC User Guide. This is an idempotent operation.
# Arguments
- `association_id`: The ID of the current association between the original network ACL and
the subnet.
- `network_acl_id`: The ID of the new network ACL to associate with the subnet.
# 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.
"""
function replace_network_acl_association(
associationId, networkAclId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ReplaceNetworkAclAssociation",
Dict{String,Any}("associationId" => associationId, "networkAclId" => networkAclId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replace_network_acl_association(
associationId,
networkAclId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReplaceNetworkAclAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"associationId" => associationId, "networkAclId" => networkAclId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replace_network_acl_entry(egress, network_acl_id, protocol, rule_action, rule_number)
replace_network_acl_entry(egress, network_acl_id, protocol, rule_action, rule_number, params::Dict{String,<:Any})
Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the
Amazon VPC User Guide.
# Arguments
- `egress`: Indicates whether to replace the egress rule. Default: If no value is
specified, we replace the ingress rule.
- `network_acl_id`: The ID of the ACL.
- `protocol`: The protocol number. A value of \"-1\" means all protocols. If you specify
\"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic
on all ports is allowed, regardless of any ports or ICMP types or codes that you specify.
If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all
ICMP types and codes allowed, regardless of any that you specify. If you specify protocol
\"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.
- `rule_action`: Indicates whether to allow or deny the traffic that matches the rule.
- `rule_number`: The rule number of the entry to replace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Icmp"`: ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying
protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
- `"cidrBlock"`: The IPv4 network range to allow or deny, in CIDR notation (for example
172.16.0.0/24).
- `"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.
- `"ipv6CidrBlock"`: The IPv6 network range to allow or deny, in CIDR notation (for example
2001:bd8:1234:1a00::/64).
- `"portRange"`: TCP or UDP protocols: The range of ports the rule applies to. Required if
specifying protocol 6 (TCP) or 17 (UDP).
"""
function replace_network_acl_entry(
egress,
networkAclId,
protocol,
ruleAction,
ruleNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReplaceNetworkAclEntry",
Dict{String,Any}(
"egress" => egress,
"networkAclId" => networkAclId,
"protocol" => protocol,
"ruleAction" => ruleAction,
"ruleNumber" => ruleNumber,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replace_network_acl_entry(
egress,
networkAclId,
protocol,
ruleAction,
ruleNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReplaceNetworkAclEntry",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"egress" => egress,
"networkAclId" => networkAclId,
"protocol" => protocol,
"ruleAction" => ruleAction,
"ruleNumber" => ruleNumber,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replace_route(route_table_id)
replace_route(route_table_id, params::Dict{String,<:Any})
Replaces an existing route within a route table in a VPC. You must specify either a
destination CIDR block or a prefix list ID. You must also specify exactly one of the
resources from the parameter list, or reset the local route to its default target. For more
information, see Route tables in the Amazon VPC User Guide.
# Arguments
- `route_table_id`: The ID of the route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CarrierGatewayId"`: [IPv4 traffic only] The ID of a carrier gateway.
- `"CoreNetworkArn"`: The Amazon Resource Name (ARN) of the core network.
- `"DestinationPrefixListId"`: The ID of the prefix list for the route.
- `"LocalGatewayId"`: The ID of the local gateway.
- `"LocalTarget"`: Specifies whether to reset the local route to its default target (local).
- `"TransitGatewayId"`: The ID of a transit gateway.
- `"VpcEndpointId"`: The ID of a VPC endpoint. Supported for Gateway Load Balancer
endpoints only.
- `"destinationCidrBlock"`: The IPv4 CIDR address block used for the destination match. The
value that you provide must match the CIDR of an existing route in the table.
- `"destinationIpv6CidrBlock"`: The IPv6 CIDR address block used for the destination match.
The value that you provide must match the CIDR of an existing route in the table.
- `"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.
- `"egressOnlyInternetGatewayId"`: [IPv6 traffic only] The ID of an egress-only internet
gateway.
- `"gatewayId"`: The ID of an internet gateway or virtual private gateway.
- `"instanceId"`: The ID of a NAT instance in your VPC.
- `"natGatewayId"`: [IPv4 traffic only] The ID of a NAT gateway.
- `"networkInterfaceId"`: The ID of a network interface.
- `"vpcPeeringConnectionId"`: The ID of a VPC peering connection.
"""
function replace_route(routeTableId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ReplaceRoute",
Dict{String,Any}("routeTableId" => routeTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replace_route(
routeTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReplaceRoute",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("routeTableId" => routeTableId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replace_route_table_association(association_id, route_table_id)
replace_route_table_association(association_id, route_table_id, params::Dict{String,<:Any})
Changes the route table associated with a given subnet, internet gateway, or virtual
private gateway in a VPC. After the operation completes, the subnet or gateway uses the
routes in the new route table. For more information about route tables, see Route tables in
the Amazon VPC User Guide. You can also use this operation to change which table is the
main route table in the VPC. Specify the main route table's association ID and the route
table ID of the new main route table.
# Arguments
- `association_id`: The association ID.
- `route_table_id`: The ID of the new route table to associate with the subnet.
# 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.
"""
function replace_route_table_association(
associationId, routeTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ReplaceRouteTableAssociation",
Dict{String,Any}("associationId" => associationId, "routeTableId" => routeTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replace_route_table_association(
associationId,
routeTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReplaceRouteTableAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"associationId" => associationId, "routeTableId" => routeTableId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replace_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id)
replace_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id, params::Dict{String,<:Any})
Replaces the specified route in the specified transit gateway route table.
# Arguments
- `destination_cidr_block`: The CIDR range used for the destination match. Routing
decisions are based on the most specific match.
- `transit_gateway_route_table_id`: The ID of the route table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Blackhole"`: Indicates whether traffic matching this route is to be dropped.
- `"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.
- `"TransitGatewayAttachmentId"`: The ID of the attachment.
"""
function replace_transit_gateway_route(
DestinationCidrBlock,
TransitGatewayRouteTableId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReplaceTransitGatewayRoute",
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replace_transit_gateway_route(
DestinationCidrBlock,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReplaceTransitGatewayRoute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationCidrBlock" => DestinationCidrBlock,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replace_vpn_tunnel(vpn_connection_id, vpn_tunnel_outside_ip_address)
replace_vpn_tunnel(vpn_connection_id, vpn_tunnel_outside_ip_address, params::Dict{String,<:Any})
Trigger replacement of specified VPN tunnel.
# Arguments
- `vpn_connection_id`: The ID of the Site-to-Site VPN connection.
- `vpn_tunnel_outside_ip_address`: The external IP address of the VPN tunnel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplyPendingMaintenance"`: Trigger pending tunnel endpoint maintenance.
- `"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.
"""
function replace_vpn_tunnel(
VpnConnectionId,
VpnTunnelOutsideIpAddress;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReplaceVpnTunnel",
Dict{String,Any}(
"VpnConnectionId" => VpnConnectionId,
"VpnTunnelOutsideIpAddress" => VpnTunnelOutsideIpAddress,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replace_vpn_tunnel(
VpnConnectionId,
VpnTunnelOutsideIpAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReplaceVpnTunnel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VpnConnectionId" => VpnConnectionId,
"VpnTunnelOutsideIpAddress" => VpnTunnelOutsideIpAddress,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
report_instance_status(instance_id, reason_code, status)
report_instance_status(instance_id, reason_code, status, params::Dict{String,<:Any})
Submits feedback about the status of an instance. The instance must be in the running
state. If your experience with the instance differs from the instance status returned by
DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the
instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
# Arguments
- `instance_id`: The instances.
- `reason_code`: The reason codes that describe the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state. unresponsive: My instance is
unresponsive. not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems that I believe are
network related. performance-instance-store: My instance is experiencing performance
problems that I believe are related to the instance stores. performance-ebs-volume: My
instance is experiencing performance problems that I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems. other: [explain
using the description parameter]
- `status`: The status of all instances listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: Descriptive text about the health state of your instance.
- `"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.
- `"endTime"`: The time at which the reported instance health state ended.
- `"startTime"`: The time at which the reported instance health state began.
"""
function report_instance_status(
instanceId, reasonCode, status; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ReportInstanceStatus",
Dict{String,Any}(
"instanceId" => instanceId, "reasonCode" => reasonCode, "status" => status
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function report_instance_status(
instanceId,
reasonCode,
status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ReportInstanceStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"instanceId" => instanceId,
"reasonCode" => reasonCode,
"status" => status,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
request_spot_fleet(spot_fleet_request_config)
request_spot_fleet(spot_fleet_request_config, params::Dict{String,<:Any})
Creates a Spot Fleet request. The Spot Fleet request specifies the total target capacity
and the On-Demand target capacity. Amazon EC2 calculates the difference between the total
capacity and On-Demand capacity, and launches the difference as Spot capacity. You can
submit a single request that includes multiple launch specifications that vary by instance
type, AMI, Availability Zone, or subnet. By default, the Spot Fleet requests Spot Instances
in the Spot Instance pool where the price per unit is the lowest. Each launch specification
can include its own instance weighting that reflects the value of the instance type to your
application workload. Alternatively, you can specify that the Spot Fleet distribute the
target capacity across the Spot pools included in its launch specifications. By ensuring
that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the
availability of your fleet. You can specify tags for the Spot Fleet request and instances
launched by the fleet. You cannot tag other resource types in a Spot Fleet request because
only the spot-fleet-request and instance resource types are supported. For more
information, see Spot Fleet requests in the Amazon EC2 User Guide. We strongly discourage
using the RequestSpotFleet API because it is a legacy API with no planned investment. For
options for requesting Spot Instances, see Which is the best Spot request method to use? in
the Amazon EC2 User Guide.
# Arguments
- `spot_fleet_request_config`: The configuration for the Spot Fleet request.
# 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.
"""
function request_spot_fleet(
spotFleetRequestConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RequestSpotFleet",
Dict{String,Any}("spotFleetRequestConfig" => spotFleetRequestConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function request_spot_fleet(
spotFleetRequestConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RequestSpotFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("spotFleetRequestConfig" => spotFleetRequestConfig),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
request_spot_instances()
request_spot_instances(params::Dict{String,<:Any})
Creates a Spot Instance request. For more information, see Work with Spot Instance in the
Amazon EC2 User Guide. We strongly discourage using the RequestSpotInstances API because
it is a legacy API with no planned investment. For options for requesting Spot Instances,
see Which is the best Spot request method to use? in the Amazon EC2 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceInterruptionBehavior"`: The behavior when a Spot Instance is interrupted. The
default is terminate.
- `"LaunchSpecification"`: The launch specification.
- `"TagSpecification"`: The key-value pair for tagging the Spot Instance request on
creation. The value for ResourceType must be spot-instances-request, otherwise the Spot
Instance request fails. To tag the Spot Instance request after it has been created, see
CreateTags.
- `"availabilityZoneGroup"`: The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances
in the request are launched in the same Availability Zone. Instance proximity is maintained
with this parameter, but the choice of Availability Zone is not. The group applies only to
requests for Spot Instances of the same instance type. Any additional Spot Instance
requests that are specified with the same Availability Zone group name are launched in that
same Availability Zone, as long as at least one instance from the group is still active. If
there is no active instance running in the Availability Zone group that you specify for a
new Spot Instance request (all instances are terminated, the request is expired, or the
maximum price you specified falls below current Spot price), then Amazon EC2 launches the
instance in any Availability Zone where the constraint can be met. Consequently, the
subsequent set of Spot Instances could be placed in a different zone from the original
request, even if you specified the same Availability Zone group. Default: Instances are
launched in any available Availability Zone.
- `"blockDurationMinutes"`: Deprecated.
- `"clientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see Ensuring idempotency in Amazon EC2
API requests in the Amazon EC2 User Guide.
- `"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.
- `"instanceCount"`: The maximum number of Spot Instances to launch. Default: 1
- `"launchGroup"`: The instance launch group. Launch groups are Spot Instances that launch
together and terminate together. Default: Instances are launched and terminated individually
- `"spotPrice"`: The maximum price per unit hour that you are willing to pay for a Spot
Instance. We do not recommend using this parameter because it can lead to increased
interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if
you do not specify this parameter.
- `"type"`: The Spot Instance request type. Default: one-time
- `"validFrom"`: The start date of the request. If this is a one-time request, the request
becomes active at this date and time and remains active until all instances launch, the
request expires, or the request is canceled. If the request is persistent, the request
becomes active at this date and time and remains active until it expires or is canceled.
The specified start date and time cannot be equal to the current date and time. You must
specify a start date and time that occurs after the current date and time.
- `"validUntil"`: The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). For
a persistent request, the request remains active until the ValidUntil date and time is
reached. Otherwise, the request remains active until you cancel it. For a one-time
request, the request remains active until all instances launch, the request is canceled, or
the ValidUntil date and time is reached. By default, the request is valid for 7 days from
the date the request was created.
"""
function request_spot_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"RequestSpotInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function request_spot_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RequestSpotInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_address_attribute(allocation_id, attribute)
reset_address_attribute(allocation_id, attribute, params::Dict{String,<:Any})
Resets the attribute of the specified IP address. For requirements, see Using reverse DNS
for email applications.
# Arguments
- `allocation_id`: [EC2-VPC] The allocation ID.
- `attribute`: The attribute of the IP address.
# 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.
"""
function reset_address_attribute(
AllocationId, Attribute; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ResetAddressAttribute",
Dict{String,Any}("AllocationId" => AllocationId, "Attribute" => Attribute);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_address_attribute(
AllocationId,
Attribute,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ResetAddressAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AllocationId" => AllocationId, "Attribute" => Attribute),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_ebs_default_kms_key_id()
reset_ebs_default_kms_key_id(params::Dict{String,<:Any})
Resets the default KMS key for EBS encryption for your account in this Region to the Amazon
Web Services managed KMS key for EBS. After resetting the default KMS key to the Amazon Web
Services managed KMS key, you can continue to encrypt by a customer managed KMS key by
specifying it when you create the volume. For more information, see Amazon EBS encryption
in the Amazon EBS User Guide.
# 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.
"""
function reset_ebs_default_kms_key_id(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"ResetEbsDefaultKmsKeyId"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function reset_ebs_default_kms_key_id(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ResetEbsDefaultKmsKeyId",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_fpga_image_attribute(fpga_image_id)
reset_fpga_image_attribute(fpga_image_id, params::Dict{String,<:Any})
Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default
value. You can only reset the load permission attribute.
# Arguments
- `fpga_image_id`: The ID of the AFI.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Attribute"`: The attribute.
- `"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.
"""
function reset_fpga_image_attribute(
FpgaImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ResetFpgaImageAttribute",
Dict{String,Any}("FpgaImageId" => FpgaImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_fpga_image_attribute(
FpgaImageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ResetFpgaImageAttribute",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("FpgaImageId" => FpgaImageId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_image_attribute(attribute, image_id)
reset_image_attribute(attribute, image_id, params::Dict{String,<:Any})
Resets an attribute of an AMI to its default value.
# Arguments
- `attribute`: The attribute to reset (currently you can only reset the launch permission
attribute).
- `image_id`: The ID of the AMI.
# 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.
"""
function reset_image_attribute(
Attribute, ImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ResetImageAttribute",
Dict{String,Any}("Attribute" => Attribute, "ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_image_attribute(
Attribute,
ImageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ResetImageAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Attribute" => Attribute, "ImageId" => ImageId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_instance_attribute(attribute, instance_id)
reset_instance_attribute(attribute, instance_id, params::Dict{String,<:Any})
Resets an attribute of an instance to its default value. To reset the kernel or ramdisk,
the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be
either running or stopped. The sourceDestCheck attribute controls whether
source/destination checking is enabled. The default value is true, which means checking is
enabled. This value must be false for a NAT instance to perform NAT. For more information,
see NAT instances in the Amazon VPC User Guide.
# Arguments
- `attribute`: The attribute to reset. You can only reset the following attributes: kernel
| ramdisk | sourceDestCheck.
- `instance_id`: The ID of the instance.
# 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.
"""
function reset_instance_attribute(
attribute, instanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ResetInstanceAttribute",
Dict{String,Any}("attribute" => attribute, "instanceId" => instanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_instance_attribute(
attribute,
instanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ResetInstanceAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("attribute" => attribute, "instanceId" => instanceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_network_interface_attribute(network_interface_id)
reset_network_interface_attribute(network_interface_id, params::Dict{String,<:Any})
Resets a network interface attribute. You can specify only one attribute at a time.
# Arguments
- `network_interface_id`: The ID of the network interface.
# 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.
- `"sourceDestCheck"`: The source/destination checking attribute. Resets the value to true.
"""
function reset_network_interface_attribute(
networkInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ResetNetworkInterfaceAttribute",
Dict{String,Any}("networkInterfaceId" => networkInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_network_interface_attribute(
networkInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ResetNetworkInterfaceAttribute",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("networkInterfaceId" => networkInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_snapshot_attribute(attribute, snapshot_id)
reset_snapshot_attribute(attribute, snapshot_id, params::Dict{String,<:Any})
Resets permission settings for the specified snapshot. For more information about modifying
snapshot permissions, see Share a snapshot in the Amazon EBS User Guide.
# Arguments
- `attribute`: The attribute to reset. Currently, only the attribute for permission to
create volumes can be reset.
- `snapshot_id`: The ID of the snapshot.
# 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.
"""
function reset_snapshot_attribute(
Attribute, SnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"ResetSnapshotAttribute",
Dict{String,Any}("Attribute" => Attribute, "SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_snapshot_attribute(
Attribute,
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"ResetSnapshotAttribute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Attribute" => Attribute, "SnapshotId" => SnapshotId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_address_to_classic(public_ip)
restore_address_to_classic(public_ip, params::Dict{String,<:Any})
This action is deprecated. Restores an Elastic IP address that was previously moved to
the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP
address that was originally allocated for use in EC2-VPC. The Elastic IP address must not
be associated with an instance or network interface.
# Arguments
- `public_ip`: The Elastic IP address.
# 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.
"""
function restore_address_to_classic(
publicIp; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RestoreAddressToClassic",
Dict{String,Any}("publicIp" => publicIp);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_address_to_classic(
publicIp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RestoreAddressToClassic",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("publicIp" => publicIp), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_image_from_recycle_bin(image_id)
restore_image_from_recycle_bin(image_id, params::Dict{String,<:Any})
Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon
EC2 User Guide.
# Arguments
- `image_id`: The ID of the AMI to restore.
# 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.
"""
function restore_image_from_recycle_bin(
ImageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RestoreImageFromRecycleBin",
Dict{String,Any}("ImageId" => ImageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_image_from_recycle_bin(
ImageId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RestoreImageFromRecycleBin",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ImageId" => ImageId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_managed_prefix_list_version(current_version, prefix_list_id, previous_version)
restore_managed_prefix_list_version(current_version, prefix_list_id, previous_version, params::Dict{String,<:Any})
Restores the entries from a previous version of a managed prefix list to a new version of
the prefix list.
# Arguments
- `current_version`: The current version number for the prefix list.
- `prefix_list_id`: The ID of the prefix list.
- `previous_version`: The version to restore.
# 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.
"""
function restore_managed_prefix_list_version(
CurrentVersion,
PrefixListId,
PreviousVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RestoreManagedPrefixListVersion",
Dict{String,Any}(
"CurrentVersion" => CurrentVersion,
"PrefixListId" => PrefixListId,
"PreviousVersion" => PreviousVersion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_managed_prefix_list_version(
CurrentVersion,
PrefixListId,
PreviousVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RestoreManagedPrefixListVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CurrentVersion" => CurrentVersion,
"PrefixListId" => PrefixListId,
"PreviousVersion" => PreviousVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_snapshot_from_recycle_bin(snapshot_id)
restore_snapshot_from_recycle_bin(snapshot_id, params::Dict{String,<:Any})
Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from
the Recycle Bin in the Amazon EBS User Guide.
# Arguments
- `snapshot_id`: The ID of the snapshot to restore.
# 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.
"""
function restore_snapshot_from_recycle_bin(
SnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RestoreSnapshotFromRecycleBin",
Dict{String,Any}("SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_snapshot_from_recycle_bin(
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RestoreSnapshotFromRecycleBin",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotId" => SnapshotId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_snapshot_tier(snapshot_id)
restore_snapshot_tier(snapshot_id, params::Dict{String,<:Any})
Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies
the restore period or restore type for a snapshot that was previously temporarily restored.
For more information see Restore an archived snapshot and modify the restore period or
restore type for a temporarily restored snapshot in the Amazon EBS User Guide.
# Arguments
- `snapshot_id`: The ID of the snapshot to restore.
# 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.
- `"PermanentRestore"`: Indicates whether to permanently restore an archived snapshot. To
permanently restore an archived snapshot, specify true and omit the
RestoreSnapshotTierRequestTemporaryRestoreDays parameter.
- `"TemporaryRestoreDays"`: Specifies the number of days for which to temporarily restore
an archived snapshot. Required for temporary restores only. The snapshot will be
automatically re-archived after this period. To temporarily restore an archived snapshot,
specify the number of days and omit the PermanentRestore parameter or set it to false.
"""
function restore_snapshot_tier(
SnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RestoreSnapshotTier",
Dict{String,Any}("SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_snapshot_tier(
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RestoreSnapshotTier",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotId" => SnapshotId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_client_vpn_ingress(client_vpn_endpoint_id, target_network_cidr)
revoke_client_vpn_ingress(client_vpn_endpoint_id, target_network_cidr, params::Dict{String,<:Any})
Removes an ingress authorization rule from a Client VPN endpoint.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint with which the authorization
rule is associated.
- `target_network_cidr`: The IPv4 address range, in CIDR notation, of the network for which
access is being removed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessGroupId"`: The ID of the Active Directory group for which to revoke access.
- `"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.
- `"RevokeAllGroups"`: Indicates whether access should be revoked for all clients.
"""
function revoke_client_vpn_ingress(
ClientVpnEndpointId,
TargetNetworkCidr;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RevokeClientVpnIngress",
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"TargetNetworkCidr" => TargetNetworkCidr,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_client_vpn_ingress(
ClientVpnEndpointId,
TargetNetworkCidr,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RevokeClientVpnIngress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientVpnEndpointId" => ClientVpnEndpointId,
"TargetNetworkCidr" => TargetNetworkCidr,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_security_group_egress(group_id)
revoke_security_group_egress(group_id, params::Dict{String,<:Any})
Removes the specified outbound (egress) rules from the specified security group. You can
specify rules using either rule IDs or security group rule properties. If you use rule
properties, the values that you specify (for example, ports) must match the existing rule's
values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range,
security group, or prefix list). For the TCP and UDP protocols, you must also specify the
destination port or range of ports. For the ICMP protocol, you must also specify the ICMP
type and code. If the security group rule has a description, you do not need to specify the
description to revoke the rule. For a default VPC, if the values you specify do not match
the existing rule's values, no error is returned, and the output describes the security
group rules that were not revoked. Amazon Web Services recommends that you describe the
security group to verify that the rules were removed. Rule changes are propagated to
instances within the security group as quickly as possible. However, a small delay might
occur.
# Arguments
- `group_id`: The ID of the security group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SecurityGroupRuleId"`: The IDs of the security group rules.
- `"cidrIp"`: Not supported. Use a set of IP permissions to specify the CIDR.
- `"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.
- `"fromPort"`: Not supported. Use a set of IP permissions to specify the port.
- `"ipPermissions"`: The sets of IP permissions. You can't specify a destination security
group and a CIDR IP address range in the same set of permissions.
- `"ipProtocol"`: Not supported. Use a set of IP permissions to specify the protocol name
or number.
- `"sourceSecurityGroupName"`: Not supported. Use a set of IP permissions to specify a
destination security group.
- `"sourceSecurityGroupOwnerId"`: Not supported. Use a set of IP permissions to specify a
destination security group.
- `"toPort"`: Not supported. Use a set of IP permissions to specify the port.
"""
function revoke_security_group_egress(
groupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RevokeSecurityGroupEgress",
Dict{String,Any}("groupId" => groupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_security_group_egress(
groupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RevokeSecurityGroupEgress",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("groupId" => groupId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_security_group_ingress()
revoke_security_group_ingress(params::Dict{String,<:Any})
Removes the specified inbound (ingress) rules from a security group. You can specify rules
using either rule IDs or security group rule properties. If you use rule properties, the
values that you specify (for example, ports) must match the existing rule's values exactly.
Each rule has a protocol, from and to ports, and source (CIDR range, security group, or
prefix list). For the TCP and UDP protocols, you must also specify the destination port or
range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the
security group rule has a description, you do not need to specify the description to revoke
the rule. For a default VPC, if the values you specify do not match the existing rule's
values, no error is returned, and the output describes the security group rules that were
not revoked. For a non-default VPC, if the values you specify do not match the existing
rule's values, an InvalidPermission.NotFound client error is returned, and no rules are
revoked. Amazon Web Services recommends that you describe the security group to verify that
the rules were removed. Rule changes are propagated to instances within the security group
as quickly as possible. However, a small delay might occur.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CidrIp"`: The CIDR IP address range. You can't specify this parameter when specifying a
source security group.
- `"FromPort"`: If the protocol is TCP or UDP, this is the start of the port range. If the
protocol is ICMP, this is the ICMP type or -1 (all ICMP types).
- `"GroupId"`: The ID of the security group.
- `"GroupName"`: [Default VPC] The name of the security group. You must specify either the
security group ID or the security group name in the request. For security groups in a
nondefault VPC, you must specify the security group ID.
- `"IpPermissions"`: The sets of IP permissions. You can't specify a source security group
and a CIDR IP address range in the same set of permissions.
- `"IpProtocol"`: The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
Use -1 to specify all.
- `"SecurityGroupRuleId"`: The IDs of the security group rules.
- `"SourceSecurityGroupName"`: [Default VPC] The name of the source security group. You
can't specify this parameter in combination with the following parameters: the CIDR IP
address range, the start of the port range, the IP protocol, and the end of the port range.
The source security group must be in the same VPC. To revoke a specific rule for an IP
protocol and port range, use a set of IP permissions instead.
- `"SourceSecurityGroupOwnerId"`: Not supported.
- `"ToPort"`: If the protocol is TCP or UDP, this is the end of the port range. If the
protocol is ICMP, this is the ICMP code or -1 (all ICMP codes).
- `"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.
"""
function revoke_security_group_ingress(; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"RevokeSecurityGroupIngress"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function revoke_security_group_ingress(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RevokeSecurityGroupIngress",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
run_instances(max_count, min_count)
run_instances(max_count, min_count, params::Dict{String,<:Any})
Launches the specified number of instances using an AMI for which you have permissions. You
can specify a number of options, or leave the default options. The following rules apply:
If you don't specify a subnet ID, we choose a default subnet from your default VPC for you.
If you don't have a default VPC, you must specify a subnet ID in the request. All
instances have a network interface with a primary private IPv4 address. If you don't
specify this address, we choose one from the IPv4 range of your subnet. Not all instance
types support IPv6 addresses. For more information, see Instance types. If you don't
specify a security group ID, we use the default security group for the VPC. For more
information, see Security groups. If any of the AMIs have a product code attached for
which the user has not subscribed, the request fails. You can create a launch template,
which is a resource that contains the parameters to launch an instance. When you launch an
instance using RunInstances, you can specify the launch template instead of specifying the
launch parameters. To ensure faster instance launches, break up large requests into smaller
batches. For example, create five separate launch requests for 100 instances each instead
of one launch request for 500 instances. RunInstances is subject to both request rate
limiting and resource rate limiting. For more information, see Request throttling. An
instance is ready for you to use when it's in the running state. You can check the state of
your instance using DescribeInstances. You can tag instances and EBS volumes during launch,
after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2
resources. Linux instances have access to the public key of the key pair at boot. You can
use this key to provide secure access to the instance. Amazon EC2 public images use this
feature to provide secure access without passwords. For more information, see Key pairs.
For troubleshooting, see What to do if an instance immediately terminates, and
Troubleshooting connecting to your instance.
# Arguments
- `max_count`: The maximum number of instances to launch. If you specify a value that is
more capacity than Amazon EC2 can launch in the target Availability Zone, Amazon EC2
launches the largest possible number of instances above the specified minimum count.
Constraints: Between 1 and the quota for the specified instance type for your account for
this Region. For more information, see Amazon EC2 instance type quotas.
- `min_count`: The minimum number of instances to launch. If you specify a value that is
more capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does
not launch any instances. Constraints: Between 1 and the quota for the specified instance
type for your account for this Region. For more information, see Amazon EC2 instance type
quotas.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BlockDeviceMapping"`: The block device mapping, which defines the EBS volumes and
instance store volumes to attach to the instance at launch. For more information, see Block
device mappings in the Amazon EC2 User Guide.
- `"CapacityReservationSpecification"`: Information about the Capacity Reservation
targeting option. If you do not specify this parameter, the instance's Capacity Reservation
preference defaults to open, which enables it to run in any open Capacity Reservation that
has matching attributes (instance type, platform, Availability Zone).
- `"CpuOptions"`: The CPU options for the instance. For more information, see Optimize CPU
options in the Amazon EC2 User Guide.
- `"CreditSpecification"`: The credit option for CPU usage of the burstable performance
instance. Valid values are standard and unlimited. To change this attribute after launch,
use ModifyInstanceCreditSpecification. For more information, see Burstable performance
instances in the Amazon EC2 User Guide. Default: standard (T2 instances) or unlimited
(T3/T3a/T4g instances) For T3 instances with host tenancy, only standard is supported.
- `"DisableApiStop"`: Indicates whether an instance is enabled for stop protection. For
more information, see Stop protection.
- `"ElasticGpuSpecification"`: An elastic GPU to associate with the instance. Amazon
Elastic Graphics reached end of life on January 8, 2024.
- `"ElasticInferenceAccelerator"`: An elastic inference accelerator to associate with the
instance. Amazon Elastic Inference (EI) is no longer available to new customers. For more
information, see Amazon Elastic Inference FAQs.
- `"EnablePrimaryIpv6"`: If you’re launching an instance into a dual-stack or IPv6-only
subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6
GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use
this option if an instance relies on its IPv6 address not changing. When you launch the
instance, Amazon Web Services will automatically assign an IPv6 address associated with the
ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA
address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to
be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the
instance is terminated or the network interface is detached. If you have multiple IPv6
addresses associated with an ENI attached to your instance and you enable a primary IPv6
address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6
address.
- `"EnclaveOptions"`: Indicates whether the instance is enabled for Amazon Web Services
Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in
the Amazon Web Services Nitro Enclaves User Guide. You can't enable Amazon Web Services
Nitro Enclaves and hibernation on the same instance.
- `"HibernationOptions"`: Indicates whether an instance is enabled for hibernation. This
parameter is valid only if the instance meets the hibernation prerequisites. For more
information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide. You can't
enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
- `"ImageId"`: The ID of the AMI. An AMI ID is required to launch an instance and must be
specified here or in a launch template.
- `"InstanceMarketOptions"`: The market (purchasing) option for the instances. For
RunInstances, persistent Spot Instance requests are only supported when
InstanceInterruptionBehavior is set to either hibernate or stop.
- `"InstanceType"`: The instance type. For more information, see Amazon EC2 instance types
in the Amazon EC2 User Guide.
- `"Ipv6Address"`: The IPv6 addresses from the range of the subnet to associate with the
primary network interface. You cannot specify this option and the option to assign a number
of IPv6 addresses in the same request. You cannot specify this option if you've specified a
minimum number of instances to launch. You cannot specify this option and the network
interfaces option in the same request.
- `"Ipv6AddressCount"`: The number of IPv6 addresses to associate with the primary network
interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot
specify this option and the option to assign specific IPv6 addresses in the same request.
You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
- `"KernelId"`: The ID of the kernel. We recommend that you use PV-GRUB instead of kernels
and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
- `"KeyName"`: The name of the key pair. You can create a key pair using CreateKeyPair or
ImportKeyPair. If you do not specify a key pair, you can't connect to the instance unless
you choose an AMI that is configured to allow users another way to log in.
- `"LaunchTemplate"`: The launch template. Any additional parameters that you specify for
the new instance overwrite the corresponding parameters included in the launch template.
- `"LicenseSpecification"`: The license configurations.
- `"MaintenanceOptions"`: The maintenance and recovery options for the instance.
- `"MetadataOptions"`: The metadata options for the instance. For more information, see
Instance metadata and user data.
- `"Monitoring"`: Specifies whether detailed monitoring is enabled for the instance.
- `"Placement"`: The placement for the instance.
- `"PrivateDnsNameOptions"`: The options for the instance hostname. The default values are
inherited from the subnet. Applies only if creating a network interface, not attaching an
existing one.
- `"RamdiskId"`: The ID of the RAM disk to select. Some kernels require additional drivers
at launch. Check the kernel requirements for information about whether you need to specify
a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and
search for the kernel ID. We recommend that you use PV-GRUB instead of kernels and RAM
disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
- `"SecurityGroup"`: [Default VPC] The names of the security groups. If you specify a
network interface, you must specify any security groups as part of the network interface
instead of using this parameter. Default: Amazon EC2 uses the default security group.
- `"SecurityGroupId"`: The IDs of the security groups. You can create a security group
using CreateSecurityGroup. If you specify a network interface, you must specify any
security groups as part of the network interface instead of using this parameter.
- `"SubnetId"`: The ID of the subnet to launch the instance into. If you specify a network
interface, you must specify any subnets as part of the network interface instead of using
this parameter.
- `"TagSpecification"`: The tags to apply to the resources that are created during instance
launch. You can specify tags for the following resources only: Instances Volumes Spot
Instance requests Network interfaces To tag a resource after it has been created, see
CreateTags.
- `"UserData"`: The user data script to make available to the instance. For more
information, see Run commands on your Amazon EC2 instance at launch in the Amazon EC2 User
Guide. If you are using a command line tool, base64-encoding is performed for you, and you
can load the text from a file. Otherwise, you must provide base64-encoded text. User data
is limited to 16 KB.
- `"additionalInfo"`: Reserved.
- `"clientToken"`: Unique, case-sensitive identifier you provide to ensure the idempotency
of the request. If you do not specify a client token, a randomly generated token is used
for the request to ensure idempotency. For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
- `"disableApiTermination"`: If you set this parameter to true, you can't terminate the
instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this
attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set
InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running
the shutdown command from the instance. Default: false
- `"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.
- `"ebsOptimized"`: Indicates whether the instance is optimized for Amazon EBS I/O. This
optimization provides dedicated throughput to Amazon EBS and an optimized configuration
stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with
all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
- `"iamInstanceProfile"`: The name or Amazon Resource Name (ARN) of an IAM instance profile.
- `"instanceInitiatedShutdownBehavior"`: Indicates whether an instance stops or terminates
when you initiate shutdown from the instance (using the operating system command for system
shutdown). Default: stop
- `"networkInterface"`: The network interfaces to associate with the instance.
- `"privateIpAddress"`: The primary IPv4 address. You must specify a value from the IPv4
address range of the subnet. Only one private IP address can be designated as primary. You
can't specify this option if you've specified the option to designate a private IP address
as the primary IP address in a network interface specification. You cannot specify this
option if you're launching more than one instance in the request. You cannot specify this
option and the network interfaces option in the same request.
"""
function run_instances(
MaxCount, MinCount; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"RunInstances",
Dict{String,Any}(
"MaxCount" => MaxCount, "MinCount" => MinCount, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function run_instances(
MaxCount,
MinCount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RunInstances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MaxCount" => MaxCount,
"MinCount" => MinCount,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
run_scheduled_instances(launch_specification, scheduled_instance_id)
run_scheduled_instances(launch_specification, scheduled_instance_id, params::Dict{String,<:Any})
Launches the specified Scheduled Instances. Before you can launch a Scheduled Instance, you
must purchase it and obtain an identifier using PurchaseScheduledInstances. You must launch
a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled
Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before
the current scheduled time period ends, you can launch it again after a few minutes.
# Arguments
- `launch_specification`: The launch specification. You must match the instance type,
Availability Zone, network, and platform of the schedule that you purchased.
- `scheduled_instance_id`: The Scheduled Instance ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Unique, case-sensitive identifier that ensures the idempotency of the
request. For more information, see Ensuring Idempotency.
- `"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.
- `"InstanceCount"`: The number of instances. Default: 1
"""
function run_scheduled_instances(
LaunchSpecification,
ScheduledInstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RunScheduledInstances",
Dict{String,Any}(
"LaunchSpecification" => LaunchSpecification,
"ScheduledInstanceId" => ScheduledInstanceId,
"ClientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function run_scheduled_instances(
LaunchSpecification,
ScheduledInstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"RunScheduledInstances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LaunchSpecification" => LaunchSpecification,
"ScheduledInstanceId" => ScheduledInstanceId,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_local_gateway_routes(local_gateway_route_table_id)
search_local_gateway_routes(local_gateway_route_table_id, params::Dict{String,<:Any})
Searches for routes in the specified local gateway route table.
# Arguments
- `local_gateway_route_table_id`: The ID of the local gateway route table.
# 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.
- `"Filter"`: One or more filters. prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR
filter. route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR
filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and
you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29. state
- The state of the route. type - The route type.
- `"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 search_local_gateway_routes(
LocalGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"SearchLocalGatewayRoutes",
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_local_gateway_routes(
LocalGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"SearchLocalGatewayRoutes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LocalGatewayRouteTableId" => LocalGatewayRouteTableId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_transit_gateway_multicast_groups(transit_gateway_multicast_domain_id)
search_transit_gateway_multicast_groups(transit_gateway_multicast_domain_id, params::Dict{String,<:Any})
Searches one or more transit gateway multicast groups and returns the group membership
information.
# Arguments
- `transit_gateway_multicast_domain_id`: The ID of the transit gateway multicast domain.
# 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.
- `"Filter"`: One or more filters. The possible values are: group-ip-address - The IP
address of the transit gateway multicast group. is-group-member - The resource is a
group member. Valid values are true | false. is-group-source - The resource is a group
source. Valid values are true | false. member-type - The member type. Valid values are
igmp | static. resource-id - The ID of the resource. resource-type - The type of
resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering. source-type
- The source type. Valid values are igmp | static. subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
- `"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 search_transit_gateway_multicast_groups(
TransitGatewayMulticastDomainId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"SearchTransitGatewayMulticastGroups",
Dict{String,Any}(
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_transit_gateway_multicast_groups(
TransitGatewayMulticastDomainId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"SearchTransitGatewayMulticastGroups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"TransitGatewayMulticastDomainId" => TransitGatewayMulticastDomainId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_transit_gateway_routes(filter, transit_gateway_route_table_id)
search_transit_gateway_routes(filter, transit_gateway_route_table_id, params::Dict{String,<:Any})
Searches for routes in the specified transit gateway route table.
# Arguments
- `filter`: One or more filters. The possible values are:
attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
attachment.resource-type - The attachment resource type. Valid values are vpc | vpn |
direct-connect-gateway | peering | connect. prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR
filter. route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR
filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and
you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29. state
- The state of the route (active | blackhole). type - The type of route (propagated |
static).
- `transit_gateway_route_table_id`: The ID of the transit gateway route table.
# 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.
- `"MaxResults"`: The maximum number of routes to return. If a value is not provided, the
default is 1000.
"""
function search_transit_gateway_routes(
Filter, TransitGatewayRouteTableId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"SearchTransitGatewayRoutes",
Dict{String,Any}(
"Filter" => Filter, "TransitGatewayRouteTableId" => TransitGatewayRouteTableId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_transit_gateway_routes(
Filter,
TransitGatewayRouteTableId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"SearchTransitGatewayRoutes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Filter" => Filter,
"TransitGatewayRouteTableId" => TransitGatewayRouteTableId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_diagnostic_interrupt(instance_id)
send_diagnostic_interrupt(instance_id, params::Dict{String,<:Any})
Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic
(on Linux instances), or a blue screen/stop error (on Windows instances). For instances
based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt
(NMI). In general, the operating system crashes and reboots when a kernel panic or stop
error is triggered. The operating system can also be configured to perform diagnostic
tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a
call trace. Before sending a diagnostic interrupt to your instance, ensure that its
operating system is configured to perform the required diagnostic tasks. For more
information about configuring your operating system to generate a crash dump when a kernel
panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) in the
Amazon EC2 User Guide.
# Arguments
- `instance_id`: The ID of the instance.
# 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.
"""
function send_diagnostic_interrupt(
InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"SendDiagnosticInterrupt",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_diagnostic_interrupt(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"SendDiagnosticInterrupt",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_instances(instance_id)
start_instances(instance_id, params::Dict{String,<:Any})
Starts an Amazon EBS-backed instance that you've previously stopped. Instances that use
Amazon EBS volumes as their root devices can be quickly stopped and started. When an
instance is stopped, the compute resources are released and you are not billed for instance
usage. However, your root partition Amazon EBS volume remains and continues to persist your
data, and you are charged for Amazon EBS volume usage. You can restart your instance at any
time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for
instance usage, and thereafter charges per second for instance usage. Before stopping an
instance, make sure it is in a state from which it can be restarted. Stopping an instance
does not preserve data stored in RAM. Performing this operation on an instance that uses an
instance store as its root device returns an error. If you attempt to start a T3 instance
with host tenancy and the unlimited CPU credit option, the request fails. The unlimited CPU
credit option is not supported on Dedicated Hosts. Before you start the instance, either
change its CPU credit option to standard, or change its tenancy to default or dedicated.
For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The IDs of the instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalInfo"`: Reserved.
- `"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.
"""
function start_instances(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"StartInstances",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_instances(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"StartInstances",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_network_insights_access_scope_analysis(client_token, network_insights_access_scope_id)
start_network_insights_access_scope_analysis(client_token, network_insights_access_scope_id, params::Dict{String,<:Any})
Starts analyzing the specified Network Access Scope.
# Arguments
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `network_insights_access_scope_id`: The ID of the Network Access Scope.
# 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.
- `"TagSpecification"`: The tags to apply.
"""
function start_network_insights_access_scope_analysis(
ClientToken,
NetworkInsightsAccessScopeId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"StartNetworkInsightsAccessScopeAnalysis",
Dict{String,Any}(
"ClientToken" => ClientToken,
"NetworkInsightsAccessScopeId" => NetworkInsightsAccessScopeId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_network_insights_access_scope_analysis(
ClientToken,
NetworkInsightsAccessScopeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"StartNetworkInsightsAccessScopeAnalysis",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"NetworkInsightsAccessScopeId" => NetworkInsightsAccessScopeId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_network_insights_analysis(client_token, network_insights_path_id)
start_network_insights_analysis(client_token, network_insights_path_id, params::Dict{String,<:Any})
Starts analyzing the specified path. If the path is reachable, the operation returns the
shortest feasible path.
# Arguments
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see How to ensure idempotency.
- `network_insights_path_id`: The ID of the path.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalAccount"`: The member accounts that contain resources that the path can
traverse.
- `"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.
- `"FilterInArn"`: The Amazon Resource Names (ARN) of the resources that the path must
traverse.
- `"TagSpecification"`: The tags to apply.
"""
function start_network_insights_analysis(
ClientToken, NetworkInsightsPathId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"StartNetworkInsightsAnalysis",
Dict{String,Any}(
"ClientToken" => ClientToken, "NetworkInsightsPathId" => NetworkInsightsPathId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_network_insights_analysis(
ClientToken,
NetworkInsightsPathId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"StartNetworkInsightsAnalysis",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"NetworkInsightsPathId" => NetworkInsightsPathId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_vpc_endpoint_service_private_dns_verification(service_id)
start_vpc_endpoint_service_private_dns_verification(service_id, params::Dict{String,<:Any})
Initiates the verification process to prove that the service provider owns the private DNS
name domain for the endpoint service. The service provider must successfully perform the
verification before the consumer can use the name to access the service. Before the service
provider runs this command, they must add a record to the DNS server.
# Arguments
- `service_id`: The ID of the endpoint service.
# 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.
"""
function start_vpc_endpoint_service_private_dns_verification(
ServiceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"StartVpcEndpointServicePrivateDnsVerification",
Dict{String,Any}("ServiceId" => ServiceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_vpc_endpoint_service_private_dns_verification(
ServiceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"StartVpcEndpointServicePrivateDnsVerification",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ServiceId" => ServiceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_instances(instance_id)
stop_instances(instance_id, params::Dict{String,<:Any})
Stops an Amazon EBS-backed instance. For more information, see Stop and start Amazon EC2
instances in the Amazon EC2 User Guide. You can use the Stop action to hibernate an
instance if the instance is enabled for hibernation and it meets the hibernation
prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon
EC2 User Guide. We don't charge usage for a stopped instance, or data transfer fees;
however, your root partition Amazon EBS volume remains and continues to persist your data,
and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon
EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for
instance usage. You can't stop or hibernate instance store-backed instances. You can't use
the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should
hibernate Spot Instances when they are interrupted. For more information, see Hibernating
interrupted Spot Instances in the Amazon EC2 User Guide. When you stop or hibernate an
instance, we shut it down. You can restart your instance at any time. Before stopping or
hibernating an instance, make sure it is in a state from which it can be restarted.
Stopping an instance does not preserve data stored in RAM, but hibernating an instance does
preserve data stored in RAM. If an instance cannot hibernate successfully, a normal
shutdown occurs. Stopping and hibernating an instance is different to rebooting or
terminating it. For example, when you stop or hibernate an instance, the root device and
any other devices attached to the instance persist. When you terminate an instance, the
root device and any other devices attached during the instance launch are automatically
deleted. For more information about the differences between rebooting, stopping,
hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User
Guide. When you stop an instance, we attempt to shut it down forcibly after a short while.
If your instance appears stuck in the stopping state after a period of time, there may be
an issue with the underlying host computer. For more information, see Troubleshoot stopping
your instance in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The IDs of the instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Hibernate"`: Hibernates the instance if the instance was enabled for hibernation at
launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more
information, see Hibernate your instance in the Amazon EC2 User Guide. Default: false
- `"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.
- `"force"`: Forces the instances to stop. The instances do not have an opportunity to
flush file system caches or file system metadata. If you use this option, you must perform
file system check and repair procedures. This option is not recommended for Windows
instances. Default: false
"""
function stop_instances(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"StopInstances",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_instances(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"StopInstances",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
terminate_client_vpn_connections(client_vpn_endpoint_id)
terminate_client_vpn_connections(client_vpn_endpoint_id, params::Dict{String,<:Any})
Terminates active Client VPN endpoint connections. This action can be used to terminate a
specific client connection, or up to five connections established by a specific user.
# Arguments
- `client_vpn_endpoint_id`: The ID of the Client VPN endpoint to which the client is
connected.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionId"`: The ID of the client connection to be terminated.
- `"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.
- `"Username"`: The name of the user who initiated the connection. Use this option to
terminate all active connections for the specified user. This option can only be used if
the user has established up to five connections.
"""
function terminate_client_vpn_connections(
ClientVpnEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"TerminateClientVpnConnections",
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function terminate_client_vpn_connections(
ClientVpnEndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"TerminateClientVpnConnections",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClientVpnEndpointId" => ClientVpnEndpointId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
terminate_instances(instance_id)
terminate_instances(instance_id, params::Dict{String,<:Any})
Shuts down the specified instances. This operation is idempotent; if you terminate an
instance more than once, each call succeeds. If you specify multiple instances and the
request fails (for example, because of a single incorrect instance ID), none of the
instances are terminated. If you terminate multiple instances across multiple Availability
Zones, and one or more of the specified instances are enabled for termination protection,
the request fails with the following results: The specified instances that are in the
same Availability Zone as the protected instance are not terminated. The specified
instances that are in different Availability Zones, where no other specified instances are
protected, are successfully terminated. For example, say you have the following
instances: Instance A: us-east-1a; Not protected Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected Instance D: us-east-1b; not protected If you attempt
to terminate all of these instances in the same request, the request reports failure with
the following results: Instance A and Instance B are successfully terminated because none
of the specified instances in us-east-1a are enabled for termination protection. Instance
C and Instance D fail to terminate because at least one of the specified instances in
us-east-1b (Instance C) is enabled for termination protection. Terminated instances
remain visible after termination (for approximately one hour). By default, Amazon EC2
deletes all EBS volumes that were attached when the instance launched. Volumes attached
after instance launch continue running. You can stop, start, and terminate EBS-backed
instances. You can only terminate instance store-backed instances. What happens to an
instance differs if you stop it or terminate it. For example, when you stop an instance,
the root device and any other devices attached to the instance persist. When you terminate
an instance, any attached EBS volumes with the DeleteOnTermination block device mapping
parameter set to true are automatically deleted. For more information about the differences
between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User
Guide. For more information about troubleshooting, see Troubleshooting terminating your
instance in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The IDs of the instances. Constraints: Up to 1000 instance IDs. We
recommend breaking up this request into smaller batches.
# 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.
"""
function terminate_instances(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"TerminateInstances",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function terminate_instances(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"TerminateInstances",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unassign_ipv6_addresses(network_interface_id)
unassign_ipv6_addresses(network_interface_id, params::Dict{String,<:Any})
Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network
interface.
# Arguments
- `network_interface_id`: The ID of the network interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Ipv6Prefix"`: The IPv6 prefixes to unassign from the network interface.
- `"ipv6Addresses"`: The IPv6 addresses to unassign from the network interface.
"""
function unassign_ipv6_addresses(
networkInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"UnassignIpv6Addresses",
Dict{String,Any}("networkInterfaceId" => networkInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unassign_ipv6_addresses(
networkInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"UnassignIpv6Addresses",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("networkInterfaceId" => networkInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unassign_private_ip_addresses(network_interface_id)
unassign_private_ip_addresses(network_interface_id, params::Dict{String,<:Any})
Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes
from a network interface.
# Arguments
- `network_interface_id`: The ID of the network interface.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Ipv4Prefix"`: The IPv4 prefixes to unassign from the network interface.
- `"privateIpAddress"`: The secondary private IP addresses to unassign from the network
interface. You can specify this option multiple times to unassign more than one IP address.
"""
function unassign_private_ip_addresses(
networkInterfaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"UnassignPrivateIpAddresses",
Dict{String,Any}("networkInterfaceId" => networkInterfaceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unassign_private_ip_addresses(
networkInterfaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"UnassignPrivateIpAddresses",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("networkInterfaceId" => networkInterfaceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unassign_private_nat_gateway_address(nat_gateway_id, private_ip_address)
unassign_private_nat_gateway_address(nat_gateway_id, private_ip_address, params::Dict{String,<:Any})
Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign
your primary private IP. For more information, see Edit secondary IP address associations
in the Amazon VPC User Guide. While unassigning is in progress, you cannot assign/unassign
additional IP addresses while the connections are being drained. You are, however, allowed
to delete the NAT gateway. A private IP address will only be released at the end of
MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing
connections, but do not support any new connections (new connections are distributed across
the remaining assigned private IP address). After the existing connections drain out, the
private IP addresses are released.
# Arguments
- `nat_gateway_id`: The ID of the NAT gateway.
- `private_ip_address`: The private IPv4 addresses you want to unassign.
# 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.
- `"MaxDrainDurationSeconds"`: The maximum amount of time to wait (in seconds) before
forcibly releasing the IP addresses if connections are still in progress. Default value is
350 seconds.
"""
function unassign_private_nat_gateway_address(
NatGatewayId, PrivateIpAddress; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"UnassignPrivateNatGatewayAddress",
Dict{String,Any}(
"NatGatewayId" => NatGatewayId, "PrivateIpAddress" => PrivateIpAddress
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unassign_private_nat_gateway_address(
NatGatewayId,
PrivateIpAddress,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"UnassignPrivateNatGatewayAddress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NatGatewayId" => NatGatewayId, "PrivateIpAddress" => PrivateIpAddress
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unlock_snapshot(snapshot_id)
unlock_snapshot(snapshot_id, params::Dict{String,<:Any})
Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode
but still in the cooling-off period. You can't unlock a snapshot that is locked in
compliance mode after the cooling-off period has expired.
# Arguments
- `snapshot_id`: The ID of the snapshot to unlock.
# 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.
"""
function unlock_snapshot(SnapshotId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"UnlockSnapshot",
Dict{String,Any}("SnapshotId" => SnapshotId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unlock_snapshot(
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"UnlockSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotId" => SnapshotId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unmonitor_instances(instance_id)
unmonitor_instances(instance_id, params::Dict{String,<:Any})
Disables detailed monitoring for a running instance. For more information, see Monitoring
your instances and volumes in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The IDs of the instances.
# 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.
"""
function unmonitor_instances(InstanceId; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"UnmonitorInstances",
Dict{String,Any}("InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unmonitor_instances(
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2(
"UnmonitorInstances",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InstanceId" => InstanceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_security_group_rule_descriptions_egress()
update_security_group_rule_descriptions_egress(params::Dict{String,<:Any})
Updates the description of an egress (outbound) security group rule. You can replace an
existing description, or add a description to a rule that did not have one previously. You
can remove a description for a security group rule by omitting the description parameter in
the request.
# 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.
- `"GroupId"`: The ID of the security group. You must specify either the security group ID
or the security group name in the request. For security groups in a nondefault VPC, you
must specify the security group ID.
- `"GroupName"`: [Default VPC] The name of the security group. You must specify either the
security group ID or the security group name.
- `"IpPermissions"`: The IP permissions for the security group rule. You must specify
either the IP permissions or the description.
- `"SecurityGroupRuleDescription"`: The description for the egress security group rules.
You must specify either the description or the IP permissions.
"""
function update_security_group_rule_descriptions_egress(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"UpdateSecurityGroupRuleDescriptionsEgress";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_security_group_rule_descriptions_egress(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"UpdateSecurityGroupRuleDescriptionsEgress",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_security_group_rule_descriptions_ingress()
update_security_group_rule_descriptions_ingress(params::Dict{String,<:Any})
Updates the description of an ingress (inbound) security group rule. You can replace an
existing description, or add a description to a rule that did not have one previously. You
can remove a description for a security group rule by omitting the description parameter in
the request.
# 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.
- `"GroupId"`: The ID of the security group. You must specify either the security group ID
or the security group name in the request. For security groups in a nondefault VPC, you
must specify the security group ID.
- `"GroupName"`: [Default VPC] The name of the security group. You must specify either the
security group ID or the security group name. For security groups in a nondefault VPC, you
must specify the security group ID.
- `"IpPermissions"`: The IP permissions for the security group rule. You must specify
either IP permissions or a description.
- `"SecurityGroupRuleDescription"`: The description for the ingress security group rules.
You must specify either a description or IP permissions.
"""
function update_security_group_rule_descriptions_ingress(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"UpdateSecurityGroupRuleDescriptionsIngress";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_security_group_rule_descriptions_ingress(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"UpdateSecurityGroupRuleDescriptionsIngress",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
withdraw_byoip_cidr(cidr)
withdraw_byoip_cidr(cidr, params::Dict{String,<:Any})
Stops advertising an address range that is provisioned as an address pool. You can perform
this operation at most once every 10 seconds, even if you specify different address ranges
each time. It can take a few minutes before traffic to the specified addresses stops
routing to Amazon Web Services because of BGP propagation delays.
# Arguments
- `cidr`: The address range, in CIDR notation.
# 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.
"""
function withdraw_byoip_cidr(Cidr; aws_config::AbstractAWSConfig=global_aws_config())
return ec2(
"WithdrawByoipCidr",
Dict{String,Any}("Cidr" => Cidr);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function withdraw_byoip_cidr(
Cidr, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2(
"WithdrawByoipCidr",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Cidr" => Cidr), 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 | 3983 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ec2_instance_connect
using AWS.Compat
using AWS.UUIDs
"""
send_serial_console_sshpublic_key(instance_id, sshpublic_key)
send_serial_console_sshpublic_key(instance_id, sshpublic_key, params::Dict{String,<:Any})
Pushes an SSH public key to the specified EC2 instance. The key remains for 60 seconds,
which gives you 60 seconds to establish a serial console connection to the instance using
SSH. For more information, see EC2 Serial Console in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The ID of the EC2 instance.
- `sshpublic_key`: The public key material. To use the public key, you must have the
matching private key. For information about the supported key formats and lengths, see
Requirements for key pairs in the Amazon EC2 User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SerialPort"`: The serial port of the EC2 instance. Currently only port 0 is supported.
Default: 0
"""
function send_serial_console_sshpublic_key(
InstanceId, SSHPublicKey; aws_config::AbstractAWSConfig=global_aws_config()
)
return ec2_instance_connect(
"SendSerialConsoleSSHPublicKey",
Dict{String,Any}("InstanceId" => InstanceId, "SSHPublicKey" => SSHPublicKey);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_serial_console_sshpublic_key(
InstanceId,
SSHPublicKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2_instance_connect(
"SendSerialConsoleSSHPublicKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceId" => InstanceId, "SSHPublicKey" => SSHPublicKey
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_sshpublic_key(instance_id, instance_osuser, sshpublic_key)
send_sshpublic_key(instance_id, instance_osuser, sshpublic_key, params::Dict{String,<:Any})
Pushes an SSH public key to the specified EC2 instance for use by the specified user. The
key remains for 60 seconds. For more information, see Connect to your Linux instance using
EC2 Instance Connect in the Amazon EC2 User Guide.
# Arguments
- `instance_id`: The ID of the EC2 instance.
- `instance_osuser`: The OS user on the EC2 instance for whom the key can be used to
authenticate.
- `sshpublic_key`: The public key material. To use the public key, you must have the
matching private key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZone"`: The Availability Zone in which the EC2 instance was launched.
"""
function send_sshpublic_key(
InstanceId,
InstanceOSUser,
SSHPublicKey;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2_instance_connect(
"SendSSHPublicKey",
Dict{String,Any}(
"InstanceId" => InstanceId,
"InstanceOSUser" => InstanceOSUser,
"SSHPublicKey" => SSHPublicKey,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_sshpublic_key(
InstanceId,
InstanceOSUser,
SSHPublicKey,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ec2_instance_connect(
"SendSSHPublicKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceId" => InstanceId,
"InstanceOSUser" => InstanceOSUser,
"SSHPublicKey" => SSHPublicKey,
),
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 | 75499 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ecr
using AWS.Compat
using AWS.UUIDs
"""
batch_check_layer_availability(layer_digests, repository_name)
batch_check_layer_availability(layer_digests, repository_name, params::Dict{String,<:Any})
Checks the availability of one or more image layers in a repository. When an image is
pushed to a repository, each image layer is checked to verify if it has been uploaded
before. If it has been uploaded, then the image layer is skipped. This operation is used
by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
# Arguments
- `layer_digests`: The digests of the image layers to check.
- `repository_name`: The name of the repository that is associated with the image layers to
check.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the image layers to check. If you do not specify a registry, the default registry
is assumed.
"""
function batch_check_layer_availability(
layerDigests, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"BatchCheckLayerAvailability",
Dict{String,Any}(
"layerDigests" => layerDigests, "repositoryName" => repositoryName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_check_layer_availability(
layerDigests,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"BatchCheckLayerAvailability",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"layerDigests" => layerDigests, "repositoryName" => repositoryName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_image(image_ids, repository_name)
batch_delete_image(image_ids, repository_name, params::Dict{String,<:Any})
Deletes a list of specified images within a repository. Images are specified with either an
imageTag or imageDigest. You can remove a tag from an image by specifying the image's tag
in your request. When you remove the last tag from an image, the image is deleted from your
repository. You can completely delete an image (and all of its tags) by specifying the
image's digest in your request.
# Arguments
- `image_ids`: A list of image ID references that correspond to images to delete. The
format of the imageIds reference is imageTag=tag or imageDigest=digest.
- `repository_name`: The repository that contains the image to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the image to delete. If you do not specify a registry, the default registry is
assumed.
"""
function batch_delete_image(
imageIds, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"BatchDeleteImage",
Dict{String,Any}("imageIds" => imageIds, "repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_image(
imageIds,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"BatchDeleteImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"imageIds" => imageIds, "repositoryName" => repositoryName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_image(image_ids, repository_name)
batch_get_image(image_ids, repository_name, params::Dict{String,<:Any})
Gets detailed information for an image. Images are specified with either an imageTag or
imageDigest. When an image is pulled, the BatchGetImage API is called once to retrieve the
image manifest.
# Arguments
- `image_ids`: A list of image ID references that correspond to images to describe. The
format of the imageIds reference is imageTag=tag or imageDigest=digest.
- `repository_name`: The repository that contains the images to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"acceptedMediaTypes"`: The accepted media types for the request. Valid values:
application/vnd.docker.distribution.manifest.v1+json |
application/vnd.docker.distribution.manifest.v2+json |
application/vnd.oci.image.manifest.v1+json
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the images to describe. If you do not specify a registry, the default registry is
assumed.
"""
function batch_get_image(
imageIds, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"BatchGetImage",
Dict{String,Any}("imageIds" => imageIds, "repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_image(
imageIds,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"BatchGetImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"imageIds" => imageIds, "repositoryName" => repositoryName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_repository_scanning_configuration(repository_names)
batch_get_repository_scanning_configuration(repository_names, params::Dict{String,<:Any})
Gets the scanning configuration for one or more repositories.
# Arguments
- `repository_names`: One or more repository names to get the scanning configuration for.
"""
function batch_get_repository_scanning_configuration(
repositoryNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"BatchGetRepositoryScanningConfiguration",
Dict{String,Any}("repositoryNames" => repositoryNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_repository_scanning_configuration(
repositoryNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"BatchGetRepositoryScanningConfiguration",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("repositoryNames" => repositoryNames), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
complete_layer_upload(layer_digests, repository_name, upload_id)
complete_layer_upload(layer_digests, repository_name, upload_id, params::Dict{String,<:Any})
Informs Amazon ECR that the image layer upload has completed for a specified registry,
repository name, and upload ID. You can optionally provide a sha256 digest of the image
layer for data validation purposes. When an image is pushed, the CompleteLayerUpload API is
called once per each new image layer to verify that the upload has completed. This
operation is used by the Amazon ECR proxy and is not generally used by customers for
pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and
push images.
# Arguments
- `layer_digests`: The sha256 digest of the image layer.
- `repository_name`: The name of the repository to associate with the image layer.
- `upload_id`: The upload ID from a previous InitiateLayerUpload operation to associate
with the image layer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry to which
to upload layers. If you do not specify a registry, the default registry is assumed.
"""
function complete_layer_upload(
layerDigests,
repositoryName,
uploadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"CompleteLayerUpload",
Dict{String,Any}(
"layerDigests" => layerDigests,
"repositoryName" => repositoryName,
"uploadId" => uploadId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function complete_layer_upload(
layerDigests,
repositoryName,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"CompleteLayerUpload",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"layerDigests" => layerDigests,
"repositoryName" => repositoryName,
"uploadId" => uploadId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_pull_through_cache_rule(ecr_repository_prefix, upstream_registry_url)
create_pull_through_cache_rule(ecr_repository_prefix, upstream_registry_url, params::Dict{String,<:Any})
Creates a pull through cache rule. A pull through cache rule provides a way to cache images
from an upstream registry source in your Amazon ECR private registry. For more information,
see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.
# Arguments
- `ecr_repository_prefix`: The repository name prefix to use when caching images from the
source registry.
- `upstream_registry_url`: The registry URL of the upstream public registry to use as the
source for the pull through cache rule. The following is the syntax to use for each
supported upstream registry. Amazon ECR Public (ecr-public) - public.ecr.aws Docker
Hub (docker-hub) - registry-1.docker.io Quay (quay) - quay.io Kubernetes (k8s) -
registry.k8s.io GitHub Container Registry (github-container-registry) - ghcr.io
Microsoft Azure Container Registry (azure-container-registry) - <custom>.azurecr.io
GitLab Container Registry (gitlab-container-registry) - registry.gitlab.com
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"credentialArn"`: The Amazon Resource Name (ARN) of the Amazon Web Services Secrets
Manager secret that identifies the credentials to authenticate to the upstream registry.
- `"registryId"`: The Amazon Web Services account ID associated with the registry to create
the pull through cache rule for. If you do not specify a registry, the default registry is
assumed.
- `"upstreamRegistry"`: The name of the upstream registry.
"""
function create_pull_through_cache_rule(
ecrRepositoryPrefix,
upstreamRegistryUrl;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"CreatePullThroughCacheRule",
Dict{String,Any}(
"ecrRepositoryPrefix" => ecrRepositoryPrefix,
"upstreamRegistryUrl" => upstreamRegistryUrl,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_pull_through_cache_rule(
ecrRepositoryPrefix,
upstreamRegistryUrl,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"CreatePullThroughCacheRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ecrRepositoryPrefix" => ecrRepositoryPrefix,
"upstreamRegistryUrl" => upstreamRegistryUrl,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_repository(repository_name)
create_repository(repository_name, params::Dict{String,<:Any})
Creates a repository. For more information, see Amazon ECR repositories in the Amazon
Elastic Container Registry User Guide.
# Arguments
- `repository_name`: The name to use for the repository. The repository name may be
specified on its own (such as nginx-web-app) or it can be prepended with a namespace to
group the repository into a category (such as project-a/nginx-web-app). The repository name
must start with a letter and can only contain lowercase letters, numbers, hyphens,
underscores, and forward slashes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"encryptionConfiguration"`: The encryption configuration for the repository. This
determines how the contents of your repository are encrypted at rest.
- `"imageScanningConfiguration"`: The image scanning configuration for the repository. This
determines whether images are scanned for known vulnerabilities after being pushed to the
repository.
- `"imageTagMutability"`: The tag mutability setting for the repository. If this parameter
is omitted, the default setting of MUTABLE will be used which will allow image tags to be
overwritten. If IMMUTABLE is specified, all image tags within the repository will be
immutable which will prevent them from being overwritten.
- `"registryId"`: The Amazon Web Services account ID associated with the registry to create
the repository. If you do not specify a registry, the default registry is assumed.
- `"tags"`: The metadata that you apply to the repository to help you categorize and
organize them. Each tag consists of a key and an optional value, both of which you define.
Tag keys can have a maximum character length of 128 characters, and tag values can have a
maximum length of 256 characters.
"""
function create_repository(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"CreateRepository",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_repository(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"CreateRepository",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lifecycle_policy(repository_name)
delete_lifecycle_policy(repository_name, params::Dict{String,<:Any})
Deletes the lifecycle policy associated with the specified repository.
# Arguments
- `repository_name`: The name of the repository.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository. If you do not specify a registry, the default registry is assumed.
"""
function delete_lifecycle_policy(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DeleteLifecyclePolicy",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lifecycle_policy(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"DeleteLifecyclePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_pull_through_cache_rule(ecr_repository_prefix)
delete_pull_through_cache_rule(ecr_repository_prefix, params::Dict{String,<:Any})
Deletes a pull through cache rule.
# Arguments
- `ecr_repository_prefix`: The Amazon ECR repository prefix associated with the pull
through cache rule to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the pull through cache rule. If you do not specify a registry, the default
registry is assumed.
"""
function delete_pull_through_cache_rule(
ecrRepositoryPrefix; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DeletePullThroughCacheRule",
Dict{String,Any}("ecrRepositoryPrefix" => ecrRepositoryPrefix);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_pull_through_cache_rule(
ecrRepositoryPrefix,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"DeletePullThroughCacheRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ecrRepositoryPrefix" => ecrRepositoryPrefix),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_registry_policy()
delete_registry_policy(params::Dict{String,<:Any})
Deletes the registry permissions policy.
"""
function delete_registry_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return ecr(
"DeleteRegistryPolicy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_registry_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DeleteRegistryPolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_repository(repository_name)
delete_repository(repository_name, params::Dict{String,<:Any})
Deletes a repository. If the repository isn't empty, you must either delete the contents of
the repository or use the force option to delete the repository and have Amazon ECR delete
all of its contents on your behalf.
# Arguments
- `repository_name`: The name of the repository to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: If true, deleting the repository force deletes the contents of the repository.
If false, the repository must be empty before attempting to delete it.
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository to delete. If you do not specify a registry, the default registry
is assumed.
"""
function delete_repository(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DeleteRepository",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_repository(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"DeleteRepository",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_repository_policy(repository_name)
delete_repository_policy(repository_name, params::Dict{String,<:Any})
Deletes the repository policy associated with the specified repository.
# Arguments
- `repository_name`: The name of the repository that is associated with the repository
policy to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository policy to delete. If you do not specify a registry, the default
registry is assumed.
"""
function delete_repository_policy(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DeleteRepositoryPolicy",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_repository_policy(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"DeleteRepositoryPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_image_replication_status(image_id, repository_name)
describe_image_replication_status(image_id, repository_name, params::Dict{String,<:Any})
Returns the replication status for a specified image.
# Arguments
- `image_id`:
- `repository_name`: The name of the repository that the image is in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry. If you
do not specify a registry, the default registry is assumed.
"""
function describe_image_replication_status(
imageId, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DescribeImageReplicationStatus",
Dict{String,Any}("imageId" => imageId, "repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_image_replication_status(
imageId,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"DescribeImageReplicationStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("imageId" => imageId, "repositoryName" => repositoryName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_image_scan_findings(image_id, repository_name)
describe_image_scan_findings(image_id, repository_name, params::Dict{String,<:Any})
Returns the scan findings for the specified image.
# Arguments
- `image_id`:
- `repository_name`: The repository for the image for which to describe the scan findings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of image scan results returned by
DescribeImageScanFindings in paginated output. When this parameter is used,
DescribeImageScanFindings only returns maxResults results in a single page along with a
nextToken response element. The remaining results of the initial request can be seen by
sending another DescribeImageScanFindings request with the returned nextToken value. This
value can be between 1 and 1000. If this parameter is not used, then
DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.
- `"nextToken"`: The nextToken value returned from a previous paginated
DescribeImageScanFindings request where maxResults was used and the results exceeded the
value of that parameter. Pagination continues from the end of the previous results that
returned the nextToken value. This value is null when there are no more results to return.
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository in which to describe the image scan findings for. If you do not
specify a registry, the default registry is assumed.
"""
function describe_image_scan_findings(
imageId, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DescribeImageScanFindings",
Dict{String,Any}("imageId" => imageId, "repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_image_scan_findings(
imageId,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"DescribeImageScanFindings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("imageId" => imageId, "repositoryName" => repositoryName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_images(repository_name)
describe_images(repository_name, params::Dict{String,<:Any})
Returns metadata about the images in a repository. Beginning with Docker version 1.9, the
Docker client compresses image layers before pushing them to a V2 Docker registry. The
output of the docker images command shows the uncompressed image size, so it may return a
larger image size than the image sizes returned by DescribeImages.
# Arguments
- `repository_name`: The repository that contains the images to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: The filter key and value with which to filter your DescribeImages results.
- `"imageIds"`: The list of image IDs for the requested repository.
- `"maxResults"`: The maximum number of repository results returned by DescribeImages in
paginated output. When this parameter is used, DescribeImages only returns maxResults
results in a single page along with a nextToken response element. The remaining results of
the initial request can be seen by sending another DescribeImages request with the returned
nextToken value. This value can be between 1 and 1000. If this parameter is not used, then
DescribeImages returns up to 100 results and a nextToken value, if applicable. This option
cannot be used when you specify images with imageIds.
- `"nextToken"`: The nextToken value returned from a previous paginated DescribeImages
request where maxResults was used and the results exceeded the value of that parameter.
Pagination continues from the end of the previous results that returned the nextToken
value. This value is null when there are no more results to return. This option cannot be
used when you specify images with imageIds.
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository in which to describe images. If you do not specify a registry, the
default registry is assumed.
"""
function describe_images(repositoryName; aws_config::AbstractAWSConfig=global_aws_config())
return ecr(
"DescribeImages",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_images(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"DescribeImages",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pull_through_cache_rules()
describe_pull_through_cache_rules(params::Dict{String,<:Any})
Returns the pull through cache rules for a registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ecrRepositoryPrefixes"`: The Amazon ECR repository prefixes associated with the pull
through cache rules to return. If no repository prefix value is specified, all pull through
cache rules are returned.
- `"maxResults"`: The maximum number of pull through cache rules returned by
DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used,
DescribePullThroughCacheRulesRequest only returns maxResults results in a single page along
with a nextToken response element. The remaining results of the initial request can be seen
by sending another DescribePullThroughCacheRulesRequest request with the returned nextToken
value. This value can be between 1 and 1000. If this parameter is not used, then
DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value, if
applicable.
- `"nextToken"`: The nextToken value returned from a previous paginated
DescribePullThroughCacheRulesRequest request where maxResults was used and the results
exceeded the value of that parameter. Pagination continues from the end of the previous
results that returned the nextToken value. This value is null when there are no more
results to return.
- `"registryId"`: The Amazon Web Services account ID associated with the registry to return
the pull through cache rules for. If you do not specify a registry, the default registry is
assumed.
"""
function describe_pull_through_cache_rules(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DescribePullThroughCacheRules";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_pull_through_cache_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DescribePullThroughCacheRules",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_registry()
describe_registry(params::Dict{String,<:Any})
Describes the settings for a registry. The replication configuration for a repository can
be created or updated with the PutReplicationConfiguration API action.
"""
function describe_registry(; aws_config::AbstractAWSConfig=global_aws_config())
return ecr("DescribeRegistry"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_registry(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DescribeRegistry", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_repositories()
describe_repositories(params::Dict{String,<:Any})
Describes image repositories in a registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of repository results returned by DescribeRepositories
in paginated output. When this parameter is used, DescribeRepositories only returns
maxResults results in a single page along with a nextToken response element. The remaining
results of the initial request can be seen by sending another DescribeRepositories request
with the returned nextToken value. This value can be between 1 and 1000. If this parameter
is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if
applicable. This option cannot be used when you specify repositories with repositoryNames.
- `"nextToken"`: The nextToken value returned from a previous paginated
DescribeRepositories request where maxResults was used and the results exceeded the value
of that parameter. Pagination continues from the end of the previous results that returned
the nextToken value. This value is null when there are no more results to return. This
option cannot be used when you specify repositories with repositoryNames. This token
should be treated as an opaque identifier that is only used to retrieve the next items in a
list and not for other programmatic purposes.
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repositories to be described. If you do not specify a registry, the default
registry is assumed.
- `"repositoryNames"`: A list of repositories to describe. If this parameter is omitted,
then all repositories in a registry are described.
"""
function describe_repositories(; aws_config::AbstractAWSConfig=global_aws_config())
return ecr(
"DescribeRepositories"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_repositories(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"DescribeRepositories",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_authorization_token()
get_authorization_token(params::Dict{String,<:Any})
Retrieves an authorization token. An authorization token represents your IAM authentication
credentials and can be used to access any Amazon ECR registry that your IAM principal has
access to. The authorization token is valid for 12 hours. The authorizationToken returned
is a base64 encoded string that can be decoded and used in a docker login command to
authenticate to a registry. The CLI offers an get-login-password command that simplifies
the login process. For more information, see Registry authentication in the Amazon Elastic
Container Registry User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryIds"`: A list of Amazon Web Services account IDs that are associated with the
registries for which to get AuthorizationData objects. If you do not specify a registry,
the default registry is assumed.
"""
function get_authorization_token(; aws_config::AbstractAWSConfig=global_aws_config())
return ecr(
"GetAuthorizationToken"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_authorization_token(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"GetAuthorizationToken",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_download_url_for_layer(layer_digest, repository_name)
get_download_url_for_layer(layer_digest, repository_name, params::Dict{String,<:Any})
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can
only get URLs for image layers that are referenced in an image. When an image is pulled,
the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
This operation is used by the Amazon ECR proxy and is not generally used by customers for
pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and
push images.
# Arguments
- `layer_digest`: The digest of the image layer to download.
- `repository_name`: The name of the repository that is associated with the image layer to
download.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the image layer to download. If you do not specify a registry, the default
registry is assumed.
"""
function get_download_url_for_layer(
layerDigest, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"GetDownloadUrlForLayer",
Dict{String,Any}("layerDigest" => layerDigest, "repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_download_url_for_layer(
layerDigest,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"GetDownloadUrlForLayer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"layerDigest" => layerDigest, "repositoryName" => repositoryName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lifecycle_policy(repository_name)
get_lifecycle_policy(repository_name, params::Dict{String,<:Any})
Retrieves the lifecycle policy for the specified repository.
# Arguments
- `repository_name`: The name of the repository.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository. If you do not specify a registry, the default registry is assumed.
"""
function get_lifecycle_policy(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"GetLifecyclePolicy",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lifecycle_policy(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"GetLifecyclePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lifecycle_policy_preview(repository_name)
get_lifecycle_policy_preview(repository_name, params::Dict{String,<:Any})
Retrieves the results of the lifecycle policy preview request for the specified repository.
# Arguments
- `repository_name`: The name of the repository.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: An optional parameter that filters results based on image tag status and all
tags, if tagged.
- `"imageIds"`: The list of imageIDs to be included.
- `"maxResults"`: The maximum number of repository results returned by
GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is used,
GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a single page
along with a nextToken
 response element. The remaining results of the initial
request can be seen by sending
 another GetLifecyclePolicyPreviewRequest request
with the returned nextToken
 value. This value can be between 1 and 1000. If
this
 parameter is not used, then GetLifecyclePolicyPreviewRequest returns up
to
 100 results and a nextToken value, if
 applicable. This option cannot be
used when you specify images with imageIds.
- `"nextToken"`: The nextToken value returned from a previous paginated

GetLifecyclePolicyPreviewRequest request where maxResults was used and the
 results
exceeded the value of that parameter. Pagination continues from the end of the

previous results that returned the nextToken value. This value is
 null when there
are no more results to return. This option cannot be used when you specify images with
imageIds.
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository. If you do not specify a registry, the default registry is assumed.
"""
function get_lifecycle_policy_preview(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"GetLifecyclePolicyPreview",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lifecycle_policy_preview(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"GetLifecyclePolicyPreview",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_registry_policy()
get_registry_policy(params::Dict{String,<:Any})
Retrieves the permissions policy for a registry.
"""
function get_registry_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return ecr("GetRegistryPolicy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_registry_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"GetRegistryPolicy", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_registry_scanning_configuration()
get_registry_scanning_configuration(params::Dict{String,<:Any})
Retrieves the scanning configuration for a registry.
"""
function get_registry_scanning_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"GetRegistryScanningConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_registry_scanning_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"GetRegistryScanningConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_repository_policy(repository_name)
get_repository_policy(repository_name, params::Dict{String,<:Any})
Retrieves the repository policy for the specified repository.
# Arguments
- `repository_name`: The name of the repository with the policy to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository. If you do not specify a registry, the default registry is assumed.
"""
function get_repository_policy(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"GetRepositoryPolicy",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_repository_policy(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"GetRepositoryPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
initiate_layer_upload(repository_name)
initiate_layer_upload(repository_name, params::Dict{String,<:Any})
Notifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the
InitiateLayerUpload API is called once per image layer that has not already been uploaded.
Whether or not an image layer has been uploaded is determined by the
BatchCheckLayerAvailability API action. This operation is used by the Amazon ECR proxy and
is not generally used by customers for pulling and pushing images. In most cases, you
should use the docker CLI to pull, tag, and push images.
# Arguments
- `repository_name`: The name of the repository to which you intend to upload layers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry to which
you intend to upload layers. If you do not specify a registry, the default registry is
assumed.
"""
function initiate_layer_upload(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"InitiateLayerUpload",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function initiate_layer_upload(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"InitiateLayerUpload",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_images(repository_name)
list_images(repository_name, params::Dict{String,<:Any})
Lists all the image IDs for the specified repository. You can filter images based on
whether or not they are tagged by using the tagStatus filter and specifying either TAGGED,
UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images
and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can
filter your results to return only TAGGED images to list all of the tags in your repository.
# Arguments
- `repository_name`: The repository with image IDs to be listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: The filter key and value with which to filter your ListImages results.
- `"maxResults"`: The maximum number of image results returned by ListImages in paginated
output. When this parameter is used, ListImages only returns maxResults results in a single
page along with a nextToken response element. The remaining results of the initial request
can be seen by sending another ListImages request with the returned nextToken value. This
value can be between 1 and 1000. If this parameter is not used, then ListImages returns up
to 100 results and a nextToken value, if applicable.
- `"nextToken"`: The nextToken value returned from a previous paginated ListImages request
where maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is only used to retrieve the next items in a list and not for other
programmatic purposes.
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository in which to list images. If you do not specify a registry, the
default registry is assumed.
"""
function list_images(repositoryName; aws_config::AbstractAWSConfig=global_aws_config())
return ecr(
"ListImages",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_images(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"ListImages",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), 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 for an Amazon ECR resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags. Currently, the only supported resource is an Amazon ECR repository.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"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 ecr(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_image(image_manifest, repository_name)
put_image(image_manifest, repository_name, params::Dict{String,<:Any})
Creates or updates the image manifest and tags associated with an image. When an image is
pushed and all new image layers have been uploaded, the PutImage API is called once to
create or update the image manifest and the tags associated with the image. This operation
is used by the Amazon ECR proxy and is not generally used by customers for pulling and
pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
# Arguments
- `image_manifest`: The image manifest corresponding to the image to be uploaded.
- `repository_name`: The name of the repository in which to put the image.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"imageDigest"`: The image digest of the image manifest corresponding to the image.
- `"imageManifestMediaType"`: The media type of the image manifest. If you push an image
manifest that does not contain the mediaType field, you must specify the
imageManifestMediaType in the request.
- `"imageTag"`: The tag to associate with the image. This parameter is required for images
that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository in which to put the image. If you do not specify a registry, the
default registry is assumed.
"""
function put_image(
imageManifest, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"PutImage",
Dict{String,Any}(
"imageManifest" => imageManifest, "repositoryName" => repositoryName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_image(
imageManifest,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"PutImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"imageManifest" => imageManifest, "repositoryName" => repositoryName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_image_scanning_configuration(image_scanning_configuration, repository_name)
put_image_scanning_configuration(image_scanning_configuration, repository_name, params::Dict{String,<:Any})
The PutImageScanningConfiguration API is being deprecated, in favor of specifying the
image scanning configuration at the registry level. For more information, see
PutRegistryScanningConfiguration. Updates the image scanning configuration for the
specified repository.
# Arguments
- `image_scanning_configuration`: The image scanning configuration for the repository. This
setting determines whether images are scanned for known vulnerabilities after being pushed
to the repository.
- `repository_name`: The name of the repository in which to update the image scanning
configuration setting.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository in which to update the image scanning configuration setting. If you
do not specify a registry, the default registry is assumed.
"""
function put_image_scanning_configuration(
imageScanningConfiguration,
repositoryName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"PutImageScanningConfiguration",
Dict{String,Any}(
"imageScanningConfiguration" => imageScanningConfiguration,
"repositoryName" => repositoryName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_image_scanning_configuration(
imageScanningConfiguration,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"PutImageScanningConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"imageScanningConfiguration" => imageScanningConfiguration,
"repositoryName" => repositoryName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_image_tag_mutability(image_tag_mutability, repository_name)
put_image_tag_mutability(image_tag_mutability, repository_name, params::Dict{String,<:Any})
Updates the image tag mutability settings for the specified repository. For more
information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.
# Arguments
- `image_tag_mutability`: The tag mutability setting for the repository. If MUTABLE is
specified, image tags can be overwritten. If IMMUTABLE is specified, all image tags within
the repository will be immutable which will prevent them from being overwritten.
- `repository_name`: The name of the repository in which to update the image tag mutability
settings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository in which to update the image tag mutability settings. If you do not
specify a registry, the default registry is assumed.
"""
function put_image_tag_mutability(
imageTagMutability, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"PutImageTagMutability",
Dict{String,Any}(
"imageTagMutability" => imageTagMutability, "repositoryName" => repositoryName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_image_tag_mutability(
imageTagMutability,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"PutImageTagMutability",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"imageTagMutability" => imageTagMutability,
"repositoryName" => repositoryName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_lifecycle_policy(lifecycle_policy_text, repository_name)
put_lifecycle_policy(lifecycle_policy_text, repository_name, params::Dict{String,<:Any})
Creates or updates the lifecycle policy for the specified repository. For more information,
see Lifecycle policy template.
# Arguments
- `lifecycle_policy_text`: The JSON repository policy text to apply to the repository.
- `repository_name`: The name of the repository to receive the policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository. If you do
 not specify a registry, the default registry is
assumed.
"""
function put_lifecycle_policy(
lifecyclePolicyText, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"PutLifecyclePolicy",
Dict{String,Any}(
"lifecyclePolicyText" => lifecyclePolicyText, "repositoryName" => repositoryName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_lifecycle_policy(
lifecyclePolicyText,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"PutLifecyclePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"lifecyclePolicyText" => lifecyclePolicyText,
"repositoryName" => repositoryName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_registry_policy(policy_text)
put_registry_policy(policy_text, params::Dict{String,<:Any})
Creates or updates the permissions policy for your registry. A registry policy is used to
specify permissions for another Amazon Web Services account and is used when configuring
cross-account replication. For more information, see Registry permissions in the Amazon
Elastic Container Registry User Guide.
# Arguments
- `policy_text`: The JSON policy text to apply to your registry. The policy text follows
the same format as IAM policy text. For more information, see Registry permissions in the
Amazon Elastic Container Registry User Guide.
"""
function put_registry_policy(policyText; aws_config::AbstractAWSConfig=global_aws_config())
return ecr(
"PutRegistryPolicy",
Dict{String,Any}("policyText" => policyText);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_registry_policy(
policyText,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"PutRegistryPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyText" => policyText), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_registry_scanning_configuration()
put_registry_scanning_configuration(params::Dict{String,<:Any})
Creates or updates the scanning configuration for your private registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"rules"`: The scanning rules to use for the registry. A scanning rule is used to
determine which repository filters are used and at what frequency scanning will occur.
- `"scanType"`: The scanning type to set for the registry. When a registry scanning
configuration is not defined, by default the BASIC scan type is used. When basic scanning
is used, you may specify filters to determine which individual repositories, or all
repositories, are scanned when new images are pushed to those repositories. Alternatively,
you can do manual scans of images with basic scanning. When the ENHANCED scan type is set,
Amazon Inspector provides automated vulnerability scanning. You may choose between
continuous scanning or scan on push and you may specify filters to determine which
individual repositories, or all repositories, are scanned.
"""
function put_registry_scanning_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"PutRegistryScanningConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_registry_scanning_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"PutRegistryScanningConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_replication_configuration(replication_configuration)
put_replication_configuration(replication_configuration, params::Dict{String,<:Any})
Creates or updates the replication configuration for a registry. The existing replication
configuration for a repository can be retrieved with the DescribeRegistry API action. The
first time the PutReplicationConfiguration API is called, a service-linked IAM role is
created in your account for the replication process. For more information, see Using
service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide.
When configuring cross-account replication, the destination account must grant the source
account permission to replicate. This permission is controlled using a registry permissions
policy. For more information, see PutRegistryPolicy.
# Arguments
- `replication_configuration`: An object representing the replication configuration for a
registry.
"""
function put_replication_configuration(
replicationConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"PutReplicationConfiguration",
Dict{String,Any}("replicationConfiguration" => replicationConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_replication_configuration(
replicationConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"PutReplicationConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("replicationConfiguration" => replicationConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_repository_policy(policy_text, repository_name)
set_repository_policy(policy_text, repository_name, params::Dict{String,<:Any})
Applies a repository policy to the specified repository to control access permissions. For
more information, see Amazon ECR Repository policies in the Amazon Elastic Container
Registry User Guide.
# Arguments
- `policy_text`: The JSON repository policy text to apply to the repository. For more
information, see Amazon ECR repository policies in the Amazon Elastic Container Registry
User Guide.
- `repository_name`: The name of the repository to receive the policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: If the policy you are attempting to set on a repository policy would prevent
you from setting another policy in the future, you must force the SetRepositoryPolicy
operation. This is intended to prevent accidental repository lock outs.
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository. If you do not specify a registry, the default registry is assumed.
"""
function set_repository_policy(
policyText, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"SetRepositoryPolicy",
Dict{String,Any}("policyText" => policyText, "repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_repository_policy(
policyText,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"SetRepositoryPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"policyText" => policyText, "repositoryName" => repositoryName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_image_scan(image_id, repository_name)
start_image_scan(image_id, repository_name, params::Dict{String,<:Any})
Starts an image vulnerability scan. An image scan can only be started once per 24 hours on
an individual image. This limit includes if an image was scanned on initial push. For more
information, see Image scanning in the Amazon Elastic Container Registry User Guide.
# Arguments
- `image_id`:
- `repository_name`: The name of the repository that contains the images to scan.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository in which to start an image scan request. If you do not specify a
registry, the default registry is assumed.
"""
function start_image_scan(
imageId, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"StartImageScan",
Dict{String,Any}("imageId" => imageId, "repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_image_scan(
imageId,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"StartImageScan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("imageId" => imageId, "repositoryName" => repositoryName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_lifecycle_policy_preview(repository_name)
start_lifecycle_policy_preview(repository_name, params::Dict{String,<:Any})
Starts a preview of a lifecycle policy for the specified repository. This allows you to see
the results before associating the lifecycle policy with the repository.
# Arguments
- `repository_name`: The name of the repository to be evaluated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"lifecyclePolicyText"`: The policy to be evaluated against. If you do not specify a
policy, the current policy for the repository is used.
- `"registryId"`: The Amazon Web Services account ID associated with the registry that
contains the repository. If you do not specify a registry, the default registry is assumed.
"""
function start_lifecycle_policy_preview(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"StartLifecyclePolicyPreview",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_lifecycle_policy_preview(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"StartLifecyclePolicyPreview",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), 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 specified tags to a resource with the specified ARN. Existing tags on a resource are
not changed if they are not specified in the request parameters.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the the resource to which to add tags.
Currently, the only supported resource is an Amazon ECR repository.
- `tags`: The tags to add to the resource. A tag is an array of key-value pairs. 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 ecr(
"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 ecr(
"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 specified tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource from which to remove tags.
Currently, the only supported resource is an Amazon ECR repository.
- `tag_keys`: The keys of the tags to be removed.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"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 ecr(
"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_pull_through_cache_rule(credential_arn, ecr_repository_prefix)
update_pull_through_cache_rule(credential_arn, ecr_repository_prefix, params::Dict{String,<:Any})
Updates an existing pull through cache rule.
# Arguments
- `credential_arn`: The Amazon Resource Name (ARN) of the Amazon Web Services Secrets
Manager secret that identifies the credentials to authenticate to the upstream registry.
- `ecr_repository_prefix`: The repository name prefix to use when caching images from the
source registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry
associated with the pull through cache rule. If you do not specify a registry, the default
registry is assumed.
"""
function update_pull_through_cache_rule(
credentialArn, ecrRepositoryPrefix; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"UpdatePullThroughCacheRule",
Dict{String,Any}(
"credentialArn" => credentialArn, "ecrRepositoryPrefix" => ecrRepositoryPrefix
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pull_through_cache_rule(
credentialArn,
ecrRepositoryPrefix,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"UpdatePullThroughCacheRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"credentialArn" => credentialArn,
"ecrRepositoryPrefix" => ecrRepositoryPrefix,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_layer_part(layer_part_blob, part_first_byte, part_last_byte, repository_name, upload_id)
upload_layer_part(layer_part_blob, part_first_byte, part_last_byte, repository_name, upload_id, params::Dict{String,<:Any})
Uploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is
uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or
about 20MB). The UploadLayerPart API is called once per each new image layer part. This
operation is used by the Amazon ECR proxy and is not generally used by customers for
pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and
push images.
# Arguments
- `layer_part_blob`: The base64-encoded layer part payload.
- `part_first_byte`: The position of the first byte of the layer part witin the overall
image layer.
- `part_last_byte`: The position of the last byte of the layer part within the overall
image layer.
- `repository_name`: The name of the repository to which you are uploading layer parts.
- `upload_id`: The upload ID from a previous InitiateLayerUpload operation to associate
with the layer part upload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID associated with the registry to which
you are uploading layer parts. If you do not specify a registry, the default registry is
assumed.
"""
function upload_layer_part(
layerPartBlob,
partFirstByte,
partLastByte,
repositoryName,
uploadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"UploadLayerPart",
Dict{String,Any}(
"layerPartBlob" => layerPartBlob,
"partFirstByte" => partFirstByte,
"partLastByte" => partLastByte,
"repositoryName" => repositoryName,
"uploadId" => uploadId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upload_layer_part(
layerPartBlob,
partFirstByte,
partLastByte,
repositoryName,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"UploadLayerPart",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"layerPartBlob" => layerPartBlob,
"partFirstByte" => partFirstByte,
"partLastByte" => partLastByte,
"repositoryName" => repositoryName,
"uploadId" => uploadId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
validate_pull_through_cache_rule(ecr_repository_prefix)
validate_pull_through_cache_rule(ecr_repository_prefix, params::Dict{String,<:Any})
Validates an existing pull through cache rule for an upstream registry that requires
authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager
secret, verify the syntax, and then validate that authentication to the upstream registry
is successful.
# Arguments
- `ecr_repository_prefix`: The repository name prefix associated with the pull through
cache rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The registry ID associated with the pull through cache rule. If you do
not specify a registry, the default registry is assumed.
"""
function validate_pull_through_cache_rule(
ecrRepositoryPrefix; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr(
"ValidatePullThroughCacheRule",
Dict{String,Any}("ecrRepositoryPrefix" => ecrRepositoryPrefix);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function validate_pull_through_cache_rule(
ecrRepositoryPrefix,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr(
"ValidatePullThroughCacheRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ecrRepositoryPrefix" => ecrRepositoryPrefix),
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 | 40475 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ecr_public
using AWS.Compat
using AWS.UUIDs
"""
batch_check_layer_availability(layer_digests, repository_name)
batch_check_layer_availability(layer_digests, repository_name, params::Dict{String,<:Any})
Checks the availability of one or more image layers that are within a repository in a
public registry. When an image is pushed to a repository, each image layer is checked to
verify if it has been uploaded before. If it has been uploaded, then the image layer is
skipped. This operation is used by the Amazon ECR proxy and is not generally used by
customers for pulling and pushing images. In most cases, you should use the docker CLI to
pull, tag, and push images.
# Arguments
- `layer_digests`: The digests of the image layers to check.
- `repository_name`: The name of the repository that's associated with the image layers to
check.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID, or registry alias, associated with
the public registry that contains the image layers to check. If you do not specify a
registry, the default public registry is assumed.
"""
function batch_check_layer_availability(
layerDigests, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"BatchCheckLayerAvailability",
Dict{String,Any}(
"layerDigests" => layerDigests, "repositoryName" => repositoryName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_check_layer_availability(
layerDigests,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"BatchCheckLayerAvailability",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"layerDigests" => layerDigests, "repositoryName" => repositoryName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_image(image_ids, repository_name)
batch_delete_image(image_ids, repository_name, params::Dict{String,<:Any})
Deletes a list of specified images that are within a repository in a public registry.
Images are specified with either an imageTag or imageDigest. You can remove a tag from an
image by specifying the image's tag in your request. When you remove the last tag from an
image, the image is deleted from your repository. You can completely delete an image (and
all of its tags) by specifying the digest of the image in your request.
# Arguments
- `image_ids`: A list of image ID references that correspond to images to delete. The
format of the imageIds reference is imageTag=tag or imageDigest=digest.
- `repository_name`: The repository in a public registry that contains the image to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID, or registry alias, that's associated
with the registry that contains the image to delete. If you do not specify a registry, the
default public registry is assumed.
"""
function batch_delete_image(
imageIds, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"BatchDeleteImage",
Dict{String,Any}("imageIds" => imageIds, "repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_image(
imageIds,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"BatchDeleteImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"imageIds" => imageIds, "repositoryName" => repositoryName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
complete_layer_upload(layer_digests, repository_name, upload_id)
complete_layer_upload(layer_digests, repository_name, upload_id, params::Dict{String,<:Any})
Informs Amazon ECR that the image layer upload is complete for a specified public registry,
repository name, and upload ID. You can optionally provide a sha256 digest of the image
layer for data validation purposes. When an image is pushed, the CompleteLayerUpload API is
called once for each new image layer to verify that the upload is complete. This operation
is used by the Amazon ECR proxy and is not generally used by customers for pulling and
pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
# Arguments
- `layer_digests`: The sha256 digest of the image layer.
- `repository_name`: The name of the repository in a public registry to associate with the
image layer.
- `upload_id`: The upload ID from a previous InitiateLayerUpload operation to associate
with the image layer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID, or registry alias, associated with
the registry where layers are uploaded. If you do not specify a registry, the default
public registry is assumed.
"""
function complete_layer_upload(
layerDigests,
repositoryName,
uploadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"CompleteLayerUpload",
Dict{String,Any}(
"layerDigests" => layerDigests,
"repositoryName" => repositoryName,
"uploadId" => uploadId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function complete_layer_upload(
layerDigests,
repositoryName,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"CompleteLayerUpload",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"layerDigests" => layerDigests,
"repositoryName" => repositoryName,
"uploadId" => uploadId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_repository(repository_name)
create_repository(repository_name, params::Dict{String,<:Any})
Creates a repository in a public registry. For more information, see Amazon ECR
repositories in the Amazon Elastic Container Registry User Guide.
# Arguments
- `repository_name`: The name to use for the repository. This appears publicly in the
Amazon ECR Public Gallery. The repository name can be specified on its own (for example
nginx-web-app) or prepended with a namespace to group the repository into a category (for
example project-a/nginx-web-app).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"catalogData"`: The details about the repository that are publicly visible in the Amazon
ECR Public Gallery.
- `"tags"`: The metadata that you apply to each repository to help categorize and organize
your repositories. Each tag consists of a key and an optional value. You define both of
them. Tag keys can have a maximum character length of 128 characters, and tag values can
have a maximum length of 256 characters.
"""
function create_repository(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"CreateRepository",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_repository(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"CreateRepository",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_repository(repository_name)
delete_repository(repository_name, params::Dict{String,<:Any})
Deletes a repository in a public registry. If the repository contains images, you must
either manually delete all images in the repository or use the force option. This option
deletes all images on your behalf before deleting the repository.
# Arguments
- `repository_name`: The name of the repository to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: The force option can be used to delete a repository that contains images. If
the force option is not used, the repository must be empty prior to deletion.
- `"registryId"`: The Amazon Web Services account ID that's associated with the public
registry that contains the repository to delete. If you do not specify a registry, the
default public registry is assumed.
"""
function delete_repository(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"DeleteRepository",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_repository(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"DeleteRepository",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_repository_policy(repository_name)
delete_repository_policy(repository_name, params::Dict{String,<:Any})
Deletes the repository policy that's associated with the specified repository.
# Arguments
- `repository_name`: The name of the repository that's associated with the repository
policy to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID that's associated with the public
registry that contains the repository policy to delete. If you do not specify a registry,
the default public registry is assumed.
"""
function delete_repository_policy(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"DeleteRepositoryPolicy",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_repository_policy(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"DeleteRepositoryPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_image_tags(repository_name)
describe_image_tags(repository_name, params::Dict{String,<:Any})
Returns the image tag details for a repository in a public registry.
# Arguments
- `repository_name`: The name of the repository that contains the image tag details to
describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of repository results that's returned by
DescribeImageTags in paginated output. When this parameter is used, DescribeImageTags only
returns maxResults results in a single page along with a nextToken response element. You
can see the remaining results of the initial request by sending another DescribeImageTags
request with the returned nextToken value. This value can be between 1 and 1000. If this
parameter isn't used, then DescribeImageTags returns up to 100 results and a nextToken
value, if applicable. If you specify images with imageIds, you can't use this option.
- `"nextToken"`: The nextToken value that's returned from a previous paginated
DescribeImageTags request where maxResults was used and the results exceeded the value of
that parameter. Pagination continues from the end of the previous results that returned the
nextToken value. If there are no more results to return, this value is null. If you specify
images with imageIds, you can't use this option.
- `"registryId"`: The Amazon Web Services account ID that's associated with the public
registry that contains the repository where images are described. If you do not specify a
registry, the default public registry is assumed.
"""
function describe_image_tags(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"DescribeImageTags",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_image_tags(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"DescribeImageTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_images(repository_name)
describe_images(repository_name, params::Dict{String,<:Any})
Returns metadata that's related to the images in a repository in a public registry.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing
them to a V2 Docker registry. The output of the docker images command shows the
uncompressed image size. Therefore, it might return a larger image size than the image
sizes that are returned by DescribeImages.
# Arguments
- `repository_name`: The repository that contains the images to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"imageIds"`: The list of image IDs for the requested repository.
- `"maxResults"`: The maximum number of repository results that's returned by
DescribeImages in paginated output. When this parameter is used, DescribeImages only
returns maxResults results in a single page along with a nextToken response element. You
can see the remaining results of the initial request by sending another DescribeImages
request with the returned nextToken value. This value can be between 1 and 1000. If this
parameter isn't used, then DescribeImages returns up to 100 results and a nextToken value,
if applicable. If you specify images with imageIds, you can't use this option.
- `"nextToken"`: The nextToken value that's returned from a previous paginated
DescribeImages request where maxResults was used and the results exceeded the value of that
parameter. Pagination continues from the end of the previous results that returned the
nextToken value. If there are no more results to return, this value is null. If you specify
images with imageIds, you can't use this option.
- `"registryId"`: The Amazon Web Services account ID that's associated with the public
registry that contains the repository where images are described. If you do not specify a
registry, the default public registry is assumed.
"""
function describe_images(repositoryName; aws_config::AbstractAWSConfig=global_aws_config())
return ecr_public(
"DescribeImages",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_images(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"DescribeImages",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_registries()
describe_registries(params::Dict{String,<:Any})
Returns details for a public registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of repository results that's returned by
DescribeRegistries in paginated output. When this parameter is used, DescribeRegistries
only returns maxResults results in a single page along with a nextToken response element.
The remaining results of the initial request can be seen by sending another
DescribeRegistries request with the returned nextToken value. This value can be between 1
and 1000. If this parameter isn't used, then DescribeRegistries returns up to 100 results
and a nextToken value, if applicable.
- `"nextToken"`: The nextToken value that's returned from a previous paginated
DescribeRegistries request where maxResults was used and the results exceeded the value of
that parameter. Pagination continues from the end of the previous results that returned the
nextToken value. If there are no more results to return, this value is null. This token
should be treated as an opaque identifier that is only used to retrieve the next items in a
list and not for other programmatic purposes.
"""
function describe_registries(; aws_config::AbstractAWSConfig=global_aws_config())
return ecr_public(
"DescribeRegistries"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_registries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"DescribeRegistries", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_repositories()
describe_repositories(params::Dict{String,<:Any})
Describes repositories that are in a public registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of repository results that's returned by
DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories
only returns maxResults results in a single page along with a nextToken response element.
You can see the remaining results of the initial request by sending another
DescribeRepositories request with the returned nextToken value. This value can be between 1
and 1000. If this parameter isn't used, then DescribeRepositories returns up to 100 results
and a nextToken value, if applicable. If you specify repositories with repositoryNames, you
can't use this option.
- `"nextToken"`: The nextToken value that's returned from a previous paginated
DescribeRepositories request where maxResults was used and the results exceeded the value
of that parameter. Pagination continues from the end of the previous results that returned
the nextToken value. If there are no more results to return, this value is null. If you
specify repositories with repositoryNames, you can't use this option. This token should be
treated as an opaque identifier that is only used to retrieve the next items in a list and
not for other programmatic purposes.
- `"registryId"`: The Amazon Web Services account ID that's associated with the registry
that contains the repositories to be described. If you do not specify a registry, the
default public registry is assumed.
- `"repositoryNames"`: A list of repositories to describe. If this parameter is omitted,
then all repositories in a registry are described.
"""
function describe_repositories(; aws_config::AbstractAWSConfig=global_aws_config())
return ecr_public(
"DescribeRepositories"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_repositories(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"DescribeRepositories",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_authorization_token()
get_authorization_token(params::Dict{String,<:Any})
Retrieves an authorization token. An authorization token represents your IAM authentication
credentials. You can use it to access any Amazon ECR registry that your IAM principal has
access to. The authorization token is valid for 12 hours. This API requires the
ecr-public:GetAuthorizationToken and sts:GetServiceBearerToken permissions.
"""
function get_authorization_token(; aws_config::AbstractAWSConfig=global_aws_config())
return ecr_public(
"GetAuthorizationToken"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_authorization_token(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"GetAuthorizationToken",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_registry_catalog_data()
get_registry_catalog_data(params::Dict{String,<:Any})
Retrieves catalog metadata for a public registry.
"""
function get_registry_catalog_data(; aws_config::AbstractAWSConfig=global_aws_config())
return ecr_public(
"GetRegistryCatalogData"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_registry_catalog_data(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"GetRegistryCatalogData",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_repository_catalog_data(repository_name)
get_repository_catalog_data(repository_name, params::Dict{String,<:Any})
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed
publicly in the Amazon ECR Public Gallery.
# Arguments
- `repository_name`: The name of the repository to retrieve the catalog metadata for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID that's associated with the registry
that contains the repositories to be described. If you do not specify a registry, the
default public registry is assumed.
"""
function get_repository_catalog_data(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"GetRepositoryCatalogData",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_repository_catalog_data(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"GetRepositoryCatalogData",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_repository_policy(repository_name)
get_repository_policy(repository_name, params::Dict{String,<:Any})
Retrieves the repository policy for the specified repository.
# Arguments
- `repository_name`: The name of the repository with the policy to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID that's associated with the public
registry that contains the repository. If you do not specify a registry, the default public
registry is assumed.
"""
function get_repository_policy(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"GetRepositoryPolicy",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_repository_policy(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"GetRepositoryPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
initiate_layer_upload(repository_name)
initiate_layer_upload(repository_name, params::Dict{String,<:Any})
Notifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the
InitiateLayerUpload API is called once for each image layer that hasn't already been
uploaded. Whether an image layer uploads is determined by the BatchCheckLayerAvailability
API action. This operation is used by the Amazon ECR proxy and is not generally used by
customers for pulling and pushing images. In most cases, you should use the docker CLI to
pull, tag, and push images.
# Arguments
- `repository_name`: The name of the repository that you want to upload layers to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID, or registry alias, that's associated
with the registry to which you intend to upload layers. If you do not specify a registry,
the default public registry is assumed.
"""
function initiate_layer_upload(
repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"InitiateLayerUpload",
Dict{String,Any}("repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function initiate_layer_upload(
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"InitiateLayerUpload",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("repositoryName" => repositoryName), 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 for an Amazon ECR Public resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource to list the
tags for. Currently, the supported resource is an Amazon ECR Public repository.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"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 ecr_public(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_image(image_manifest, repository_name)
put_image(image_manifest, repository_name, params::Dict{String,<:Any})
Creates or updates the image manifest and tags that are associated with an image. When an
image is pushed and all new image layers have been uploaded, the PutImage API is called
once to create or update the image manifest and the tags that are associated with the
image. This operation is used by the Amazon ECR proxy and is not generally used by
customers for pulling and pushing images. In most cases, you should use the docker CLI to
pull, tag, and push images.
# Arguments
- `image_manifest`: The image manifest that corresponds to the image to be uploaded.
- `repository_name`: The name of the repository where the image is put.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"imageDigest"`: The image digest of the image manifest that corresponds to the image.
- `"imageManifestMediaType"`: The media type of the image manifest. If you push an image
manifest that doesn't contain the mediaType field, you must specify the
imageManifestMediaType in the request.
- `"imageTag"`: The tag to associate with the image. This parameter is required for images
that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.
- `"registryId"`: The Amazon Web Services account ID, or registry alias, that's associated
with the public registry that contains the repository where the image is put. If you do not
specify a registry, the default public registry is assumed.
"""
function put_image(
imageManifest, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"PutImage",
Dict{String,Any}(
"imageManifest" => imageManifest, "repositoryName" => repositoryName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_image(
imageManifest,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"PutImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"imageManifest" => imageManifest, "repositoryName" => repositoryName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_registry_catalog_data()
put_registry_catalog_data(params::Dict{String,<:Any})
Create or update the catalog data for a public registry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"displayName"`: The display name for a public registry. The display name is shown as the
repository author in the Amazon ECR Public Gallery. The registry display name is only
publicly visible in the Amazon ECR Public Gallery for verified accounts.
"""
function put_registry_catalog_data(; aws_config::AbstractAWSConfig=global_aws_config())
return ecr_public(
"PutRegistryCatalogData"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function put_registry_catalog_data(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"PutRegistryCatalogData",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_repository_catalog_data(catalog_data, repository_name)
put_repository_catalog_data(catalog_data, repository_name, params::Dict{String,<:Any})
Creates or updates the catalog data for a repository in a public registry.
# Arguments
- `catalog_data`: An object containing the catalog data for a repository. This data is
publicly visible in the Amazon ECR Public Gallery.
- `repository_name`: The name of the repository to create or update the catalog data for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID that's associated with the public
registry the repository is in. If you do not specify a registry, the default public
registry is assumed.
"""
function put_repository_catalog_data(
catalogData, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"PutRepositoryCatalogData",
Dict{String,Any}("catalogData" => catalogData, "repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_repository_catalog_data(
catalogData,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"PutRepositoryCatalogData",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"catalogData" => catalogData, "repositoryName" => repositoryName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_repository_policy(policy_text, repository_name)
set_repository_policy(policy_text, repository_name, params::Dict{String,<:Any})
Applies a repository policy to the specified public repository to control access
permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic
Container Registry User Guide.
# Arguments
- `policy_text`: The JSON repository policy text to apply to the repository. For more
information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry
User Guide.
- `repository_name`: The name of the repository to receive the policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: If the policy that you want to set on a repository policy would prevent you
from setting another policy in the future, you must force the SetRepositoryPolicy
operation. This prevents accidental repository lockouts.
- `"registryId"`: The Amazon Web Services account ID that's associated with the registry
that contains the repository. If you do not specify a registry, the default public registry
is assumed.
"""
function set_repository_policy(
policyText, repositoryName; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"SetRepositoryPolicy",
Dict{String,Any}("policyText" => policyText, "repositoryName" => repositoryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_repository_policy(
policyText,
repositoryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"SetRepositoryPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"policyText" => policyText, "repositoryName" => repositoryName
),
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 aren't specified in the request parameters, they aren't changed. When a
resource is deleted, the tags associated with that resource are also deleted.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to add tags to. Currently,
the supported resource is an Amazon ECR Public repository.
- `tags`: The tags to add to the resource. A tag is an array of key-value pairs. 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 ecr_public(
"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 ecr_public(
"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 specified tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to delete tags from.
Currently, the supported resource is an Amazon ECR Public repository.
- `tag_keys`: The keys of the tags to be removed.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecr_public(
"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 ecr_public(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_layer_part(layer_part_blob, part_first_byte, part_last_byte, repository_name, upload_id)
upload_layer_part(layer_part_blob, part_first_byte, part_last_byte, repository_name, upload_id, params::Dict{String,<:Any})
Uploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is
uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (about
20MB). The UploadLayerPart API is called once for each new image layer part. This
operation is used by the Amazon ECR proxy and is not generally used by customers for
pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and
push images.
# Arguments
- `layer_part_blob`: The base64-encoded layer part payload.
- `part_first_byte`: The position of the first byte of the layer part witin the overall
image layer.
- `part_last_byte`: The position of the last byte of the layer part within the overall
image layer.
- `repository_name`: The name of the repository that you're uploading layer parts to.
- `upload_id`: The upload ID from a previous InitiateLayerUpload operation to associate
with the layer part upload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"registryId"`: The Amazon Web Services account ID, or registry alias, that's associated
with the registry that you're uploading layer parts to. If you do not specify a registry,
the default public registry is assumed.
"""
function upload_layer_part(
layerPartBlob,
partFirstByte,
partLastByte,
repositoryName,
uploadId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"UploadLayerPart",
Dict{String,Any}(
"layerPartBlob" => layerPartBlob,
"partFirstByte" => partFirstByte,
"partLastByte" => partLastByte,
"repositoryName" => repositoryName,
"uploadId" => uploadId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upload_layer_part(
layerPartBlob,
partFirstByte,
partLastByte,
repositoryName,
uploadId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecr_public(
"UploadLayerPart",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"layerPartBlob" => layerPartBlob,
"partFirstByte" => partFirstByte,
"partLastByte" => partLastByte,
"repositoryName" => repositoryName,
"uploadId" => uploadId,
),
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 | 195831 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: ecs
using AWS.Compat
using AWS.UUIDs
"""
create_capacity_provider(auto_scaling_group_provider, name)
create_capacity_provider(auto_scaling_group_provider, name, params::Dict{String,<:Any})
Creates a new capacity provider. Capacity providers are associated with an Amazon ECS
cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on
Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available
to all accounts in the Amazon Web Services Regions that Fargate supports.
# Arguments
- `auto_scaling_group_provider`: The details of the Auto Scaling group for the capacity
provider.
- `name`: The name of the capacity provider. Up to 255 characters are allowed. They include
letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The
name can't be prefixed with \"aws\", \"ecs\", or \"fargate\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The metadata that you apply to the capacity provider to categorize and organize
them more conveniently. Each tag consists of a key and an optional value. You define both
of them. The following basic restrictions apply to tags: Maximum number of tags per
resource - 50 For each resource, each tag key must be unique, and each tag key can have
only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value
length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple
services and resources, remember that other services may have restrictions on allowed
characters. Generally allowed characters are: letters, numbers, and spaces representable in
UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are
case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a
prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot
edit or delete tag keys or values with this prefix. Tags with this prefix do not count
against your tags per resource limit.
"""
function create_capacity_provider(
autoScalingGroupProvider, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"CreateCapacityProvider",
Dict{String,Any}(
"autoScalingGroupProvider" => autoScalingGroupProvider, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_capacity_provider(
autoScalingGroupProvider,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"CreateCapacityProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"autoScalingGroupProvider" => autoScalingGroupProvider, "name" => name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster()
create_cluster(params::Dict{String,<:Any})
Creates a new Amazon ECS cluster. By default, your account receives a default cluster when
you launch your first container instance. However, you can create your own cluster with a
unique name with the CreateCluster action. When you call the CreateCluster API operation,
Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is
so that it can manage required resources in other Amazon Web Services services on your
behalf. However, if the user that makes the call doesn't have permissions to create the
service-linked role, it isn't created. For more information, see Using service-linked roles
for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capacityProviders"`: The short name of one or more capacity providers to associate with
the cluster. A capacity provider must be associated with a cluster before it can be
included as part of the default capacity provider strategy of the cluster or used in a
capacity provider strategy when calling the CreateService or RunTask actions. If specifying
a capacity provider that uses an Auto Scaling group, the capacity provider must be created
but not associated with another cluster. New Auto Scaling group capacity providers can be
created with the CreateCapacityProvider API operation. To use a Fargate capacity provider,
specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity
providers are available to all accounts and only need to be associated with a cluster to be
used. The PutCapacityProvider API operation is used to update the list of available
capacity providers for a cluster after the cluster is created.
- `"clusterName"`: The name of your cluster. If you don't specify a name for your cluster,
you create a cluster that's named default. Up to 255 letters (uppercase and lowercase),
numbers, underscores, and hyphens are allowed.
- `"configuration"`: The execute command configuration for the cluster.
- `"defaultCapacityProviderStrategy"`: The capacity provider strategy to set as the default
for the cluster. After a default capacity provider strategy is set for a cluster, when you
call the CreateService or RunTask APIs with no capacity provider strategy or launch type
specified, the default capacity provider strategy for the cluster is used. If a default
capacity provider strategy isn't defined for a cluster when it was created, it can be
defined later with the PutClusterCapacityProviders API operation.
- `"serviceConnectDefaults"`: Use this parameter to set a default Service Connect
namespace. After you set a default Service Connect namespace, any new services with Service
Connect turned on that are created in the cluster are added as client services in the
namespace. This setting only applies to new services that set the enabled parameter to true
in the ServiceConnectConfiguration. You can set the namespace of each service individually
in the ServiceConnectConfiguration to override this default parameter. Tasks that run in a
namespace can use short names to connect to services in the namespace. Tasks can connect to
services across all of the clusters in the namespace. Tasks connect through a managed proxy
container that collects logs and metrics for increased visibility. Only the tasks that
Amazon ECS services create are supported with Service Connect. For more information, see
Service Connect in the Amazon Elastic Container Service Developer Guide.
- `"settings"`: The setting to use when creating a cluster. This parameter is used to turn
on CloudWatch Container Insights for a cluster. If this value is specified, it overrides
the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
- `"tags"`: The metadata that you apply to the cluster to help you categorize and organize
them. Each tag consists of a key and an optional value. You define both. The following
basic restrictions apply to tags: Maximum number of tags per resource - 50 For each
resource, each tag key must be unique, and each tag key can have only one value. Maximum
key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode
characters in UTF-8 If your tagging schema is used across multiple services and
resources, remember that other services may have restrictions on allowed characters.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and
the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do
not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either
keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per
resource limit.
"""
function create_cluster(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs("CreateCluster"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_cluster(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"CreateCluster", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_service(service_name)
create_service(service_name, params::Dict{String,<:Any})
Runs and maintains your desired number of tasks from a specified task definition. If the
number of tasks running in a service drops below the desiredCount, Amazon ECS runs another
copy of the task in the specified cluster. To update an existing service, see the
UpdateService action. On March 21, 2024, a change was made to resolve the task definition
revision before authorization. When a task definition revision is not specified,
authorization will occur using the latest revision of a task definition. In addition to
maintaining the desired count of tasks in your service, you can optionally run your service
behind one or more load balancers. The load balancers distribute traffic across the tasks
that are associated with the service. For more information, see Service load balancing in
the Amazon Elastic Container Service Developer Guide. You can attach Amazon EBS volumes to
Amazon ECS tasks by configuring the volume when creating or updating a service.
volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more
infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the
RUNNING state. Tasks for services that use a load balancer are considered healthy if
they're in the RUNNING state and are reported as healthy by the load balancer. There are
two service scheduler strategies available: REPLICA - The replica scheduling strategy
places and maintains your desired number of tasks across your cluster. By default, the
service scheduler spreads tasks across Availability Zones. You can use task placement
strategies and constraints to customize task placement decisions. For more information, see
Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container
instance that meets all of the task placement constraints that you specify in your cluster.
The service scheduler also evaluates the task placement constraints for running tasks. It
also stops tasks that don't meet the placement constraints. When using this strategy, you
don't need to specify a desired number of tasks, a task placement strategy, or use Service
Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon
Elastic Container Service Developer Guide. You can optionally specify a deployment
configuration for your service. The deployment is initiated by changing properties. For
example, the deployment might be initiated by the task definition or by your desired count
of a service. This is done with an UpdateService operation. The default value for a replica
service for minimumHealthyPercent is 100%. The default value for a daemon service for
minimumHealthyPercent is 0%. If a service uses the ECS deployment controller, the minimum
healthy percent represents a lower limit on the number of tasks in a service that must
remain in the RUNNING state during a deployment. Specifically, it represents it as a
percentage of your desired number of tasks (rounded up to the nearest integer). This
happens when any of your container instances are in the DRAINING state if the service
contains tasks using the EC2 launch type. Using this parameter, you can deploy without
using additional cluster capacity. For example, if you set your service to have desired
number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two
existing tasks to free up cluster capacity before starting two new tasks. If they're in the
RUNNING state, tasks for services that don't use a load balancer are considered healthy .
If they're in the RUNNING state and reported as healthy by the load balancer, tasks for
services that do use a load balancer are considered healthy . The default value for minimum
healthy percent is 100%. If a service uses the ECS deployment controller, the maximum
percent parameter represents an upper limit on the number of tasks in a service that are
allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it
as a percentage of the desired number of tasks (rounded down to the nearest integer). This
happens when any of your container instances are in the DRAINING state if the service
contains tasks using the EC2 launch type. Using this parameter, you can define the
deployment batch size. For example, if your service has a desired number of four tasks and
a maximum percent value of 200%, the scheduler may start four new tasks before stopping the
four older tasks (provided that the cluster resources required to do this are available).
The default value for maximum percent is 200%. If a service uses either the CODE_DEPLOY or
EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum
healthy percent and maximum percent values are used only to define the lower and upper
limit on the number of the tasks in the service that remain in the RUNNING state. This is
while the container instances are in the DRAINING state. If the tasks in the service use
the Fargate launch type, the minimum healthy percent and maximum percent values aren't
used. This is the case even if they're currently visible when describing your service. When
creating a service that uses the EXTERNAL deployment controller, you can specify only
parameters that aren't controlled at the task set level. The only required parameter is the
service name. You control your services using the CreateTaskSet operation. For more
information, see Amazon ECS deployment types in the Amazon Elastic Container Service
Developer Guide. When the service scheduler launches new tasks, it determines task
placement. For information about task placement and task placement strategies, see Amazon
ECS task placement in the Amazon Elastic Container Service Developer Guide Starting April
15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference
(EI), and will help current customers migrate their workloads to options that offer better
price and performance. After April 15, 2023, new customers will not be able to launch
instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
However, customers who have used Amazon EI at least once during the past 30-day period are
considered current customers and will be able to continue using the service.
# Arguments
- `service_name`: The name of your service. Up to 255 letters (uppercase and lowercase),
numbers, underscores, and hyphens are allowed. Service names must be unique within a
cluster, but you can have similarly named services in multiple clusters within a Region or
across multiple Regions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capacityProviderStrategy"`: The capacity provider strategy to use for the service. If a
capacityProviderStrategy is specified, the launchType parameter must be omitted. If no
capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy
for the cluster is used. A capacity provider strategy may contain a maximum of 6 capacity
providers.
- `"clientToken"`: An identifier that you provide to ensure the idempotency of the request.
It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126
(inclusive) are allowed.
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that you
run your service on. If you do not specify a cluster, the default cluster is assumed.
- `"deploymentConfiguration"`: Optional deployment parameters that control how many tasks
run during the deployment and the ordering of stopping and starting tasks.
- `"deploymentController"`: The deployment controller to use for the service. If no
deployment controller is specified, the default value of ECS is used.
- `"desiredCount"`: The number of instantiations of the specified task definition to place
and keep running in your service. This is required if schedulingStrategy is REPLICA or
isn't specified. If schedulingStrategy is DAEMON then this isn't required.
- `"enableECSManagedTags"`: Specifies whether to turn on Amazon ECS managed tags for the
tasks within the service. For more information, see Tagging your Amazon ECS resources in
the Amazon Elastic Container Service Developer Guide. When you use Amazon ECS managed tags,
you need to set the propagateTags request parameter.
- `"enableExecuteCommand"`: Determines whether the execute command functionality is turned
on for the service. If true, this enables execute command functionality on all containers
in the service tasks.
- `"healthCheckGracePeriodSeconds"`: The period of time, in seconds, that the Amazon ECS
service scheduler ignores unhealthy Elastic Load Balancing target health checks after a
task has first started. This is only used when your service is configured to use a load
balancer. If your service has a load balancer defined and you don't specify a health check
grace period value, the default value of 0 is used. If you do not use an Elastic Load
Balancing, we recommend that you use the startPeriod in the task definition health check
parameters. For more information, see Health check. If your service's tasks take a while to
start and respond to Elastic Load Balancing health checks, you can specify a health check
grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon
ECS service scheduler ignores health check status. This grace period can prevent the
service scheduler from marking tasks as unhealthy and stopping them before they have time
to come up.
- `"launchType"`: The infrastructure that you run your service on. For more information,
see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide. The
FARGATE launch type runs your tasks on Fargate On-Demand infrastructure. Fargate Spot
infrastructure is available for use but a capacity provider strategy must be used. For more
information, see Fargate capacity providers in the Amazon ECS Developer Guide. The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster. The
EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM)
capacity registered to your cluster. A service can use either a launch type or a capacity
provider strategy. If a launchType is specified, the capacityProviderStrategy parameter
must be omitted.
- `"loadBalancers"`: A load balancer object representing the load balancers to use with
your service. For more information, see Service load balancing in the Amazon Elastic
Container Service Developer Guide. If the service uses the rolling update (ECS) deployment
controller and using either an Application Load Balancer or Network Load Balancer, you must
specify one or more target group ARNs to attach to the service. The service-linked role is
required for services that use multiple target groups. For more information, see Using
service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer
Guide. If the service uses the CODE_DEPLOY deployment controller, the service is required
to use either an Application Load Balancer or Network Load Balancer. When creating an
CodeDeploy deployment group, you specify two target groups (referred to as a
targetGroupPair). During a deployment, CodeDeploy determines which task set in your service
has the status PRIMARY, and it associates one target group with it. Then, it also
associates the other target group with the replacement task set. The load balancer can also
have up to two listeners: a required listener for production traffic and an optional
listener that you can use to perform validation tests with Lambda functions before routing
production traffic to it. If you use the CODE_DEPLOY deployment controller, these values
can be changed when updating the service. For Application Load Balancers and Network Load
Balancers, this object must contain the load balancer target group ARN, the container name,
and the container port to access from the load balancer. The container name must be as it
appears in a container definition. The load balancer name parameter must be omitted. When a
task from this service is placed on a container instance, the container instance and port
combination is registered as a target in the target group that's specified here. For
Classic Load Balancers, this object must contain the load balancer name, the container name
, and the container port to access from the load balancer. The container name must be as it
appears in a container definition. The target group ARN parameter must be omitted. When a
task from this service is placed on a container instance, the container instance is
registered with the load balancer that's specified here. Services with tasks that use the
awsvpc network mode (for example, those with the Fargate launch type) only support
Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't
supported. Also, when you create any target groups for these services, you must choose ip
as the target type, not instance. This is because tasks that use the awsvpc network mode
are associated with an elastic network interface, not an Amazon EC2 instance.
- `"networkConfiguration"`: The network configuration for the service. This parameter is
required for task definitions that use the awsvpc network mode to receive their own elastic
network interface, and it isn't supported for other network modes. For more information,
see Task networking in the Amazon Elastic Container Service Developer Guide.
- `"placementConstraints"`: An array of placement constraint objects to use for tasks in
your service. You can specify a maximum of 10 constraints for each task. This limit
includes constraints in the task definition and those specified at runtime.
- `"placementStrategy"`: The placement strategy objects to use for tasks in your service.
You can specify a maximum of 5 strategy rules for each service.
- `"platformVersion"`: The platform version that your tasks in the service are running on.
A platform version is specified only for tasks using the Fargate launch type. If one isn't
specified, the LATEST platform version is used. For more information, see Fargate platform
versions in the Amazon Elastic Container Service Developer Guide.
- `"propagateTags"`: Specifies whether to propagate the tags from the task definition to
the task. If no value is specified, the tags aren't propagated. Tags can only be propagated
to the task during task creation. To add tags to a task after task creation, use the
TagResource API action. You must set this to a value other than NONE when you use Cost
Explorer. For more information, see Amazon ECS usage reports in the Amazon Elastic
Container Service Developer Guide. The default is NONE.
- `"role"`: The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon
ECS to make calls to your load balancer on your behalf. This parameter is only permitted if
you are using a load balancer with your service and your task definition doesn't use the
awsvpc network mode. If you specify the role parameter, you must also specify a load
balancer object with the loadBalancers parameter. If your account has already created the
Amazon ECS service-linked role, that role is used for your service unless you specify a
role here. The service-linked role is required if your task definition uses the awsvpc
network mode or if the service is configured to use service discovery, an external
deployment controller, multiple target groups, or Elastic Inference accelerators in which
case you don't specify a role here. For more information, see Using service-linked roles
for Amazon ECS in the Amazon Elastic Container Service Developer Guide. If your specified
role has a path other than /, then you must either specify the full role ARN (this is
recommended) or prefix the role name with the path. For example, if a role with the name
bar has a path of /foo/ then you would specify /foo/bar as the role name. For more
information, see Friendly names and paths in the IAM User Guide.
- `"schedulingStrategy"`: The scheduling strategy to use for the service. For more
information, see Services. There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks
across your cluster. By default, the service scheduler spreads tasks across Availability
Zones. You can use task placement strategies and constraints to customize task placement
decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or
EXTERNAL deployment controller types. DAEMON-The daemon scheduling strategy deploys
exactly one task on each active container instance that meets all of the task placement
constraints that you specify in your cluster. The service scheduler also evaluates the task
placement constraints for running tasks and will stop tasks that don't meet the placement
constraints. When you're using this strategy, you don't need to specify a desired number of
tasks, a task placement strategy, or use Service Auto Scaling policies. Tasks using the
Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't
support the DAEMON scheduling strategy.
- `"serviceConnectConfiguration"`: The configuration for this service to discover and
connect to services, and be discovered by, and connected from, other services within a
namespace. Tasks that run in a namespace can use short names to connect to services in the
namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks
connect through a managed proxy container that collects logs and metrics for increased
visibility. Only the tasks that Amazon ECS services create are supported with Service
Connect. For more information, see Service Connect in the Amazon Elastic Container Service
Developer Guide.
- `"serviceRegistries"`: The details of the service discovery registry to associate with
this service. For more information, see Service discovery. Each service may be associated
with one service registry. Multiple service registries for each service isn't supported.
- `"tags"`: The metadata that you apply to the service to help you categorize and organize
them. Each tag consists of a key and an optional value, both of which you define. When a
service is deleted, the tags are deleted as well. The following basic restrictions apply to
tags: Maximum number of tags per resource - 50 For each resource, each tag key must be
unique, and each tag key can have only one value. Maximum key length - 128 Unicode
characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your
tagging schema is used across multiple services and resources, remember that other services
may have restrictions on allowed characters. Generally allowed characters are: letters,
numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase
combination of such as a prefix for either keys or values as it is reserved for Amazon Web
Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this
prefix do not count against your tags per resource limit.
- `"taskDefinition"`: The family and revision (family:revision) or full ARN of the task
definition to run in your service. If a revision isn't specified, the latest ACTIVE
revision is used. A task definition must be specified if the service uses either the ECS or
CODE_DEPLOY deployment controllers. For more information about deployment types, see Amazon
ECS deployment types.
- `"volumeConfigurations"`: The configuration for a volume specified in the task definition
as a volume that is configured at launch time. Currently, the only supported volume type is
an Amazon EBS volume.
"""
function create_service(serviceName; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"CreateService",
Dict{String,Any}("serviceName" => serviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service(
serviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"CreateService",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("serviceName" => serviceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_task_set(cluster, service, task_definition)
create_task_set(cluster, service, task_definition, params::Dict{String,<:Any})
Create a task set in the specified cluster and service. This is used when a service uses
the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment
types in the Amazon Elastic Container Service Developer Guide. On March 21, 2024, a change
was made to resolve the task definition revision before authorization. When a task
definition revision is not specified, authorization will occur using the latest revision of
a task definition. For information about the maximum number of task sets and otther
quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer
Guide.
# Arguments
- `cluster`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the service to create the task set in.
- `service`: The short name or full Amazon Resource Name (ARN) of the service to create the
task set in.
- `task_definition`: The task definition for the tasks in the task set to use. If a
revision isn't specified, the latest ACTIVE revision is used.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capacityProviderStrategy"`: The capacity provider strategy to use for the task set. A
capacity provider strategy consists of one or more capacity providers along with the base
and weight to assign to them. A capacity provider must be associated with the cluster to be
used in a capacity provider strategy. The PutClusterCapacityProviders API is used to
associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or
UPDATING status can be used. If a capacityProviderStrategy is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the
defaultCapacityProviderStrategy for the cluster is used. If specifying a capacity provider
that uses an Auto Scaling group, the capacity provider must already be created. New
capacity providers can be created with the CreateCapacityProvider API operation. To use a
Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers.
The Fargate capacity providers are available to all accounts and only need to be associated
with a cluster to be used. The PutClusterCapacityProviders API operation is used to update
the list of available capacity providers for a cluster after the cluster is created.
- `"clientToken"`: An identifier that you provide to ensure the idempotency of the request.
It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126
(inclusive) are allowed.
- `"externalId"`: An optional non-unique tag that identifies this task set in external
systems. If the task set is associated with a service discovery registry, the tasks in this
task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided
value.
- `"launchType"`: The launch type that new tasks in the task set uses. For more
information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer
Guide. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
- `"loadBalancers"`: A load balancer object representing the load balancer to use with the
task set. The supported load balancer types are either an Application Load Balancer or a
Network Load Balancer.
- `"networkConfiguration"`: An object representing the network configuration for a task set.
- `"platformVersion"`: The platform version that the tasks in the task set uses. A platform
version is specified only for tasks using the Fargate launch type. If one isn't specified,
the LATEST platform version is used.
- `"scale"`: A floating-point percentage of the desired number of tasks to place and keep
running in the task set.
- `"serviceRegistries"`: The details of the service discovery registries to assign to this
task set. For more information, see Service discovery.
- `"tags"`: The metadata that you apply to the task set to help you categorize and organize
them. Each tag consists of a key and an optional value. You define both. When a service is
deleted, the tags are deleted. The following basic restrictions apply to tags: Maximum
number of tags per resource - 50 For each resource, each tag key must be unique, and each
tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used
across multiple services and resources, remember that other services may have restrictions
on allowed characters. Generally allowed characters are: letters, numbers, and spaces
representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and
values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination
of such as a prefix for either keys or values as it is reserved for Amazon Web Services
use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix
do not count against your tags per resource limit.
"""
function create_task_set(
cluster, service, taskDefinition; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"CreateTaskSet",
Dict{String,Any}(
"cluster" => cluster, "service" => service, "taskDefinition" => taskDefinition
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_task_set(
cluster,
service,
taskDefinition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"CreateTaskSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"cluster" => cluster,
"service" => service,
"taskDefinition" => taskDefinition,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_account_setting(name)
delete_account_setting(name, params::Dict{String,<:Any})
Disables an account setting for a specified user, role, or the root user for an account.
# Arguments
- `name`: The resource name to disable the account setting for. If serviceLongArnFormat is
specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is
specified, the ARN and resource ID for your Amazon ECS tasks is affected. If
containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS
container instances is affected. If awsvpcTrunking is specified, the ENI limit for your
Amazon ECS container instances is affected.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"principalArn"`: The Amazon Resource Name (ARN) of the principal. It can be an user,
role, or the root user. If you specify the root user, it disables the account setting for
all users, roles, and the root user of the account unless a user or role explicitly
overrides these settings. If this field is omitted, the setting is changed only for the
authenticated user.
"""
function delete_account_setting(name; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"DeleteAccountSetting",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_account_setting(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DeleteAccountSetting",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_attributes(attributes)
delete_attributes(attributes, params::Dict{String,<:Any})
Deletes one or more custom attributes from an Amazon ECS resource.
# Arguments
- `attributes`: The attributes to delete from your resource. You can specify up to 10
attributes for each request. For custom attributes, specify the attribute name and target
ID, but don't specify the value. If you specify the target ID using the short form, you
must also specify the target type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that
contains the resource to delete attributes. If you do not specify a cluster, the default
cluster is assumed.
"""
function delete_attributes(attributes; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"DeleteAttributes",
Dict{String,Any}("attributes" => attributes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_attributes(
attributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"DeleteAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("attributes" => attributes), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_capacity_provider(capacity_provider)
delete_capacity_provider(capacity_provider, params::Dict{String,<:Any})
Deletes the specified capacity provider. The FARGATE and FARGATE_SPOT capacity providers
are reserved and can't be deleted. You can disassociate them from a cluster using either
the PutClusterCapacityProviders API or by deleting the cluster. Prior to a capacity
provider being deleted, the capacity provider must be removed from the capacity provider
strategy from all services. The UpdateService API can be used to remove a capacity provider
from a service's capacity provider strategy. When updating a service, the
forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2
instance capacity provided by the capacity provider are transitioned to use the capacity
from the remaining capacity providers. Only capacity providers that aren't associated with
a cluster can be deleted. To remove a capacity provider from a cluster, you can either use
PutClusterCapacityProviders or delete the cluster.
# Arguments
- `capacity_provider`: The short name or full Amazon Resource Name (ARN) of the capacity
provider to delete.
"""
function delete_capacity_provider(
capacityProvider; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DeleteCapacityProvider",
Dict{String,Any}("capacityProvider" => capacityProvider);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_capacity_provider(
capacityProvider,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"DeleteCapacityProvider",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("capacityProvider" => capacityProvider), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster(cluster)
delete_cluster(cluster, params::Dict{String,<:Any})
Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with
an INACTIVE status might remain discoverable in your account for a period of time. However,
this behavior is subject to change in the future. We don't recommend that you rely on
INACTIVE clusters persisting. You must deregister all container instances from this cluster
before you may delete it. You can list the container instances in a cluster with
ListContainerInstances and deregister them with DeregisterContainerInstance.
# Arguments
- `cluster`: The short name or full Amazon Resource Name (ARN) of the cluster to delete.
"""
function delete_cluster(cluster; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"DeleteCluster",
Dict{String,Any}("cluster" => cluster);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster(
cluster, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DeleteCluster",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("cluster" => cluster), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service(service)
delete_service(service, params::Dict{String,<:Any})
Deletes a specified service within a cluster. You can delete a service if you have no
running tasks in it and the desired task count is zero. If the service is actively
maintaining tasks, you can't delete it, and you must update the service to a desired task
count of zero. For more information, see UpdateService. When you delete a service, if
there are still running tasks that require cleanup, the service status moves from ACTIVE to
DRAINING, and the service is no longer visible in the console or in the ListServices API
operation. After all tasks have transitioned to either STOPPING or STOPPED status, the
service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status
can still be viewed with the DescribeServices API operation. However, in the future,
INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and
DescribeServices calls on those services return a ServiceNotFoundException error. If you
attempt to create a new service with the same name as an existing service in either ACTIVE
or DRAINING status, you receive an error.
# Arguments
- `service`: The name of the service to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the service to delete. If you do not specify a cluster, the default cluster is assumed.
- `"force"`: If true, allows you to delete a service even if it wasn't scaled down to zero
tasks. It's only necessary to use this if the service uses the REPLICA scheduling strategy.
"""
function delete_service(service; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"DeleteService",
Dict{String,Any}("service" => service);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service(
service, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DeleteService",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("service" => service), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_task_definitions(task_definitions)
delete_task_definitions(task_definitions, params::Dict{String,<:Any})
Deletes one or more task definitions. You must deregister a task definition revision before
you delete it. For more information, see DeregisterTaskDefinition. When you delete a task
definition revision, it is immediately transitions from the INACTIVE to DELETE_IN_PROGRESS.
Existing tasks and services that reference a DELETE_IN_PROGRESS task definition revision
continue to run without disruption. Existing services that reference a DELETE_IN_PROGRESS
task definition revision can still scale up or down by modifying the service's desired
count. You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or
create new services. You also can't update an existing service to reference a
DELETE_IN_PROGRESS task definition revision. A task definition revision will stay in
DELETE_IN_PROGRESS status until all the associated tasks and services have been terminated.
When you delete all INACTIVE task definition revisions, the task definition name is not
displayed in the console and not returned in the API. If a task definition revisions are in
the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and
returned in the API. The task definition name is retained by Amazon ECS and the revision is
incremented the next time you create a task definition with that name.
# Arguments
- `task_definitions`: The family and revision (family:revision) or full Amazon Resource
Name (ARN) of the task definition to delete. You must specify a revision. You can specify
up to 10 task definitions as a comma separated list.
"""
function delete_task_definitions(
taskDefinitions; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DeleteTaskDefinitions",
Dict{String,Any}("taskDefinitions" => taskDefinitions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_task_definitions(
taskDefinitions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"DeleteTaskDefinitions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("taskDefinitions" => taskDefinitions), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_task_set(cluster, service, task_set)
delete_task_set(cluster, service, task_set, params::Dict{String,<:Any})
Deletes a specified task set within a service. This is used when a service uses the
EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types
in the Amazon Elastic Container Service Developer Guide.
# Arguments
- `cluster`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the service that the task set found in to delete.
- `service`: The short name or full Amazon Resource Name (ARN) of the service that hosts
the task set to delete.
- `task_set`: The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: If true, you can delete a task set even if it hasn't been scaled down to zero.
"""
function delete_task_set(
cluster, service, taskSet; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DeleteTaskSet",
Dict{String,Any}("cluster" => cluster, "service" => service, "taskSet" => taskSet);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_task_set(
cluster,
service,
taskSet,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"DeleteTaskSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"cluster" => cluster, "service" => service, "taskSet" => taskSet
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_container_instance(container_instance)
deregister_container_instance(container_instance, params::Dict{String,<:Any})
Deregisters an Amazon ECS container instance from the specified cluster. This instance is
no longer available to run tasks. If you intend to use the container instance for some
other purpose after deregistration, we recommend that you stop all of the tasks running on
the container instance before deregistration. That prevents any orphaned tasks from
consuming resources. Deregistering a container instance removes the instance from a
cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance,
be sure to terminate it in the Amazon EC2 console to stop billing. If you terminate a
running container instance, Amazon ECS automatically deregisters the instance from your
cluster (stopped container instances or instances with disconnected agents aren't
automatically deregistered when terminated).
# Arguments
- `container_instance`: The container instance ID or full ARN of the container instance to
deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in
the Amazon ECS Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the container instance to deregister. If you do not specify a cluster, the default cluster
is assumed.
- `"force"`: Forces the container instance to be deregistered. If you have tasks running on
the container instance when you deregister it with the force option, these tasks remain
running until you terminate the instance or the tasks stop through some other means, but
they're orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task
on your container instance is part of an Amazon ECS service, then the service scheduler
starts another copy of that task, on a different container instance if possible. Any
containers in orphaned service tasks that are registered with a Classic Load Balancer or an
Application Load Balancer target group are deregistered. They begin connection draining
according to the settings on the load balancer or target group.
"""
function deregister_container_instance(
containerInstance; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DeregisterContainerInstance",
Dict{String,Any}("containerInstance" => containerInstance);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_container_instance(
containerInstance,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"DeregisterContainerInstance",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("containerInstance" => containerInstance), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_task_definition(task_definition)
deregister_task_definition(task_definition, params::Dict{String,<:Any})
Deregisters the specified task definition by family and revision. Upon deregistration, the
task definition is marked as INACTIVE. Existing tasks and services that reference an
INACTIVE task definition continue to run without disruption. Existing services that
reference an INACTIVE task definition can still scale up or down by modifying the service's
desired count. If you want to delete a task definition revision, you must first deregister
the task definition revision. You can't use an INACTIVE task definition to run new tasks or
create new services, and you can't update an existing service to reference an INACTIVE task
definition. However, there may be up to a 10-minute window following deregistration where
these restrictions have not yet taken effect. At this time, INACTIVE task definitions
remain discoverable in your account indefinitely. However, this behavior is subject to
change in the future. We don't recommend that you rely on INACTIVE task definitions
persisting beyond the lifecycle of any associated tasks and services. You must deregister
a task definition revision before you delete it. For more information, see
DeleteTaskDefinitions.
# Arguments
- `task_definition`: The family and revision (family:revision) or full Amazon Resource Name
(ARN) of the task definition to deregister. You must specify a revision.
"""
function deregister_task_definition(
taskDefinition; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DeregisterTaskDefinition",
Dict{String,Any}("taskDefinition" => taskDefinition);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_task_definition(
taskDefinition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"DeregisterTaskDefinition",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("taskDefinition" => taskDefinition), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_capacity_providers()
describe_capacity_providers(params::Dict{String,<:Any})
Describes one or more of your capacity providers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capacityProviders"`: The short name or full Amazon Resource Name (ARN) of one or more
capacity providers. Up to 100 capacity providers can be described in an action.
- `"include"`: Specifies whether or not you want to see the resource tags for the capacity
provider. If TAGS is specified, the tags are included in the response. If this field is
omitted, tags aren't included in the response.
- `"maxResults"`: The maximum number of account setting results returned by
DescribeCapacityProviders in paginated output. When this parameter is used,
DescribeCapacityProviders only returns maxResults results in a single page along with a
nextToken response element. The remaining results of the initial request can be seen by
sending another DescribeCapacityProviders request with the returned nextToken value. This
value can be between 1 and 10. If this parameter is not used, then
DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.
- `"nextToken"`: The nextToken value returned from a previous paginated
DescribeCapacityProviders request where maxResults was used and the results exceeded the
value of that parameter. Pagination continues from the end of the previous results that
returned the nextToken value. This token should be treated as an opaque identifier that is
only used to retrieve the next items in a list and not for other programmatic purposes.
"""
function describe_capacity_providers(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"DescribeCapacityProviders"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_capacity_providers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DescribeCapacityProviders",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_clusters()
describe_clusters(params::Dict{String,<:Any})
Describes one or more of your clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clusters"`: A list of up to 100 cluster names or full cluster Amazon Resource Name
(ARN) entries. If you do not specify a cluster, the default cluster is assumed.
- `"include"`: Determines whether to include additional information about the clusters in
the response. If this field is omitted, this information isn't included. If ATTACHMENTS is
specified, the attachments for the container instances or tasks within the cluster are
included, for example the capacity providers. If SETTINGS is specified, the settings for
the cluster are included. If CONFIGURATIONS is specified, the configuration for the cluster
is included. If STATISTICS is specified, the task and service count is included, separated
by launch type. If TAGS is specified, the metadata tags associated with the cluster are
included.
"""
function describe_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs("DescribeClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DescribeClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_container_instances(container_instances)
describe_container_instances(container_instances, params::Dict{String,<:Any})
Describes one or more container instances. Returns metadata about each container instance
requested.
# Arguments
- `container_instances`: A list of up to 100 container instance IDs or full Amazon Resource
Name (ARN) entries.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the container instances to describe. If you do not specify a cluster, the default cluster
is assumed. This parameter is required if the container instance or container instances you
are describing were launched in any cluster other than the default cluster.
- `"include"`: Specifies whether you want to see the resource tags for the container
instance. If TAGS is specified, the tags are included in the response. If
CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the
response. If this field is omitted, tags and container instance health status aren't
included in the response.
"""
function describe_container_instances(
containerInstances; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DescribeContainerInstances",
Dict{String,Any}("containerInstances" => containerInstances);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_container_instances(
containerInstances,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"DescribeContainerInstances",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("containerInstances" => containerInstances), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_services(services)
describe_services(services, params::Dict{String,<:Any})
Describes the specified services running in your cluster.
# Arguments
- `services`: A list of services to describe. You may specify up to 10 services to describe
in a single operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN)the cluster that hosts the
service to describe. If you do not specify a cluster, the default cluster is assumed. This
parameter is required if the service or services you are describing were launched in any
cluster other than the default cluster.
- `"include"`: Determines whether you want to see the resource tags for the service. If
TAGS is specified, the tags are included in the response. If this field is omitted, tags
aren't included in the response.
"""
function describe_services(services; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"DescribeServices",
Dict{String,Any}("services" => services);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_services(
services,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"DescribeServices",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("services" => services), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_task_definition(task_definition)
describe_task_definition(task_definition, params::Dict{String,<:Any})
Describes a task definition. You can specify a family and revision to find information
about a specific task definition, or you can simply specify the family to find the latest
ACTIVE revision in that family. You can only describe INACTIVE task definitions while an
active task or service references them.
# Arguments
- `task_definition`: The family for the latest ACTIVE revision, family and revision
(family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN)
of the task definition to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"include"`: Determines whether to see the resource tags for the task definition. If TAGS
is specified, the tags are included in the response. If this field is omitted, tags aren't
included in the response.
"""
function describe_task_definition(
taskDefinition; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DescribeTaskDefinition",
Dict{String,Any}("taskDefinition" => taskDefinition);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_task_definition(
taskDefinition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"DescribeTaskDefinition",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("taskDefinition" => taskDefinition), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_task_sets(cluster, service)
describe_task_sets(cluster, service, params::Dict{String,<:Any})
Describes the task sets in the specified cluster and service. This is used when a service
uses the EXTERNAL deployment controller type. For more information, see Amazon ECS
Deployment Types in the Amazon Elastic Container Service Developer Guide.
# Arguments
- `cluster`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the service that the task sets exist in.
- `service`: The short name or full Amazon Resource Name (ARN) of the service that the task
sets exist in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"include"`: Specifies whether to see the resource tags for the task set. If TAGS is
specified, the tags are included in the response. If this field is omitted, tags aren't
included in the response.
- `"taskSets"`: The ID or full Amazon Resource Name (ARN) of task sets to describe.
"""
function describe_task_sets(
cluster, service; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DescribeTaskSets",
Dict{String,Any}("cluster" => cluster, "service" => service);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_task_sets(
cluster,
service,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"DescribeTaskSets",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("cluster" => cluster, "service" => service), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tasks(tasks)
describe_tasks(tasks, params::Dict{String,<:Any})
Describes a specified task or tasks. Currently, stopped tasks appear in the returned
results for at least one hour. If you have tasks with tags, and then delete the cluster,
the tagged tasks are returned in the response. If you create a new cluster with the same
name as the deleted cluster, the tagged tasks are not included in the response.
# Arguments
- `tasks`: A list of up to 100 task IDs or full ARN entries.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the task or tasks to describe. If you do not specify a cluster, the default cluster is
assumed. This parameter is required if the task or tasks you are describing were launched
in any cluster other than the default cluster.
- `"include"`: Specifies whether you want to see the resource tags for the task. If TAGS is
specified, the tags are included in the response. If this field is omitted, tags aren't
included in the response.
"""
function describe_tasks(tasks; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"DescribeTasks",
Dict{String,Any}("tasks" => tasks);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tasks(
tasks, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DescribeTasks",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tasks" => tasks), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
discover_poll_endpoint()
discover_poll_endpoint(params::Dict{String,<:Any})
This action is only used by the Amazon ECS agent, and it is not intended for use outside
of the agent. Returns an endpoint for the Amazon ECS agent to poll for updates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that the
container instance belongs to.
- `"containerInstance"`: The container instance ID or full ARN of the container instance.
For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS
Developer Guide.
"""
function discover_poll_endpoint(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"DiscoverPollEndpoint"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function discover_poll_endpoint(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"DiscoverPollEndpoint",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
execute_command(command, interactive, task)
execute_command(command, interactive, task, params::Dict{String,<:Any})
Runs a command remotely on a container within a task. If you use a condition key in your
IAM policy to refine the conditions for the policy statement, for example limit the actions
to a specific cluster, you receive an AccessDeniedException when there is a mismatch
between the condition key value and the corresponding parameter value. For information
about required permissions and considerations, see Using Amazon ECS Exec for debugging in
the Amazon ECS Developer Guide.
# Arguments
- `command`: The command to run on the container.
- `interactive`: Use this flag to run your command in interactive mode.
- `task`: The Amazon Resource Name (ARN) or ID of the task the container is part of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The Amazon Resource Name (ARN) or short name of the cluster the task is
running in. If you do not specify a cluster, the default cluster is assumed.
- `"container"`: The name of the container to execute the command on. A container name only
needs to be specified for tasks containing multiple containers.
"""
function execute_command(
command, interactive, task; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"ExecuteCommand",
Dict{String,Any}(
"command" => command, "interactive" => interactive, "task" => task
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function execute_command(
command,
interactive,
task,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"ExecuteCommand",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"command" => command, "interactive" => interactive, "task" => task
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_task_protection(cluster)
get_task_protection(cluster, params::Dict{String,<:Any})
Retrieves the protection status of tasks in an Amazon ECS service.
# Arguments
- `cluster`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the service that the task sets exist in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tasks"`: A list of up to 100 task IDs or full ARN entries.
"""
function get_task_protection(cluster; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"GetTaskProtection",
Dict{String,Any}("cluster" => cluster);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_task_protection(
cluster, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"GetTaskProtection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("cluster" => cluster), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_account_settings()
list_account_settings(params::Dict{String,<:Any})
Lists the account settings for a specified principal.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"effectiveSettings"`: Determines whether to return the effective settings. If true, the
account settings for the root user or the default setting for the principalArn are
returned. If false, the account settings for the principalArn are returned if they're set.
Otherwise, no account settings are returned.
- `"maxResults"`: The maximum number of account setting results returned by
ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings
only returns maxResults results in a single page along with a nextToken response element.
The remaining results of the initial request can be seen by sending another
ListAccountSettings request with the returned nextToken value. This value can be between 1
and 10. If this parameter isn't used, then ListAccountSettings returns up to 10 results and
a nextToken value if applicable.
- `"name"`: The name of the account setting you want to list the settings for.
- `"nextToken"`: The nextToken value returned from a ListAccountSettings request indicating
that more results are available to fulfill the request and further calls will be needed. If
maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next
items in a list and not for other programmatic purposes.
- `"principalArn"`: The ARN of the principal, which can be a user, role, or the root user.
If this field is omitted, the account settings are listed only for the authenticated user.
Federated users assume the account setting of the root user and can't have explicit account
settings set for them.
- `"value"`: The value of the account settings to filter results with. You must also
specify an account setting name to use this parameter.
"""
function list_account_settings(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"ListAccountSettings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_account_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"ListAccountSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_attributes(target_type)
list_attributes(target_type, params::Dict{String,<:Any})
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
When you specify a target type and cluster, ListAttributes returns a list of attribute
objects, one for each attribute on each resource. You can filter the list of results to a
single attribute name to only return results that have that name. You can also filter the
results by attribute name and value. You can do this, for example, to see which container
instances in a cluster are running a Linux AMI (ecs.os-type=linux).
# Arguments
- `target_type`: The type of the target to list attributes with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributeName"`: The name of the attribute to filter the results with.
- `"attributeValue"`: The value of the attribute to filter results with. You must also
specify an attribute name to use this parameter.
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster to list
attributes. If you do not specify a cluster, the default cluster is assumed.
- `"maxResults"`: The maximum number of cluster results that ListAttributes returned in
paginated output. When this parameter is used, ListAttributes only returns maxResults
results in a single page along with a nextToken response element. The remaining results of
the initial request can be seen by sending another ListAttributes request with the returned
nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
ListAttributes returns up to 100 results and a nextToken value if applicable.
- `"nextToken"`: The nextToken value returned from a ListAttributes request indicating that
more results are available to fulfill the request and further calls are needed. If
maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next
items in a list and not for other programmatic purposes.
"""
function list_attributes(targetType; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"ListAttributes",
Dict{String,Any}("targetType" => targetType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_attributes(
targetType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"ListAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("targetType" => targetType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_clusters()
list_clusters(params::Dict{String,<:Any})
Returns a list of existing clusters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of cluster results that ListClusters returned in
paginated output. When this parameter is used, ListClusters only returns maxResults results
in a single page along with a nextToken response element. The remaining results of the
initial request can be seen by sending another ListClusters request with the returned
nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
ListClusters returns up to 100 results and a nextToken value if applicable.
- `"nextToken"`: The nextToken value returned from a ListClusters request indicating that
more results are available to fulfill the request and further calls are needed. If
maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next
items in a list and not for other programmatic purposes.
"""
function list_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs("ListClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"ListClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_container_instances()
list_container_instances(params::Dict{String,<:Any})
Returns a list of container instances in a specified cluster. You can filter the results of
a ListContainerInstances operation with cluster query language statements inside the filter
parameter. For more information, see Cluster Query Language in the Amazon Elastic Container
Service Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the container instances to list. If you do not specify a cluster, the default cluster is
assumed.
- `"filter"`: You can filter the results of a ListContainerInstances operation with cluster
query language statements. For more information, see Cluster Query Language in the Amazon
Elastic Container Service Developer Guide.
- `"maxResults"`: The maximum number of container instance results that
ListContainerInstances returned in paginated output. When this parameter is used,
ListContainerInstances only returns maxResults results in a single page along with a
nextToken response element. The remaining results of the initial request can be seen by
sending another ListContainerInstances request with the returned nextToken value. This
value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances
returns up to 100 results and a nextToken value if applicable.
- `"nextToken"`: The nextToken value returned from a ListContainerInstances request
indicating that more results are available to fulfill the request and further calls are
needed. If maxResults was provided, it's possible the number of results to be fewer than
maxResults. This token should be treated as an opaque identifier that is only used to
retrieve the next items in a list and not for other programmatic purposes.
- `"status"`: Filters the container instances by status. For example, if you specify the
DRAINING status, the results include only container instances that have been set to
DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the
default is to include container instances set to all states other than INACTIVE.
"""
function list_container_instances(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"ListContainerInstances"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_container_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"ListContainerInstances",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_services()
list_services(params::Dict{String,<:Any})
Returns a list of services. You can filter the results by cluster, launch type, and
scheduling strategy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster to use when
filtering the ListServices results. If you do not specify a cluster, the default cluster is
assumed.
- `"launchType"`: The launch type to use when filtering the ListServices results.
- `"maxResults"`: The maximum number of service results that ListServices returned in
paginated output. When this parameter is used, ListServices only returns maxResults results
in a single page along with a nextToken response element. The remaining results of the
initial request can be seen by sending another ListServices request with the returned
nextToken value. This value can be between 1 and 100. If this parameter isn't used, then
ListServices returns up to 10 results and a nextToken value if applicable.
- `"nextToken"`: The nextToken value returned from a ListServices request indicating that
more results are available to fulfill the request and further calls will be needed. If
maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next
items in a list and not for other programmatic purposes.
- `"schedulingStrategy"`: The scheduling strategy to use when filtering the ListServices
results.
"""
function list_services(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs("ListServices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_services(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"ListServices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_services_by_namespace(namespace)
list_services_by_namespace(namespace, params::Dict{String,<:Any})
This operation lists all of the services that are associated with a Cloud Map namespace.
This list might include services in different clusters. In contrast, ListServices can only
list services in one cluster at a time. If you need to filter the list of services in a
single cluster by various parameters, use ListServices. For more information, see Service
Connect in the Amazon Elastic Container Service Developer Guide.
# Arguments
- `namespace`: The namespace name or full Amazon Resource Name (ARN) of the Cloud Map
namespace to list the services in. Tasks that run in a namespace can use short names to
connect to services in the namespace. Tasks can connect to services across all of the
clusters in the namespace. Tasks connect through a managed proxy container that collects
logs and metrics for increased visibility. Only the tasks that Amazon ECS services create
are supported with Service Connect. For more information, see Service Connect in the Amazon
Elastic Container Service Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of service results that ListServicesByNamespace
returns in paginated output. When this parameter is used, ListServicesByNamespace only
returns maxResults results in a single page along with a nextToken response element. The
remaining results of the initial request can be seen by sending another
ListServicesByNamespace request with the returned nextToken value. This value can be
between 1 and 100. If this parameter isn't used, then ListServicesByNamespace returns up to
10 results and a nextToken value if applicable.
- `"nextToken"`: The nextToken value that's returned from a ListServicesByNamespace
request. It indicates that more results are available to fulfill the request and further
calls are needed. If maxResults is returned, it is possible the number of results is less
than maxResults.
"""
function list_services_by_namespace(
namespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"ListServicesByNamespace",
Dict{String,Any}("namespace" => namespace);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_services_by_namespace(
namespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"ListServicesByNamespace",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("namespace" => namespace), 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 for an Amazon ECS resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource to list the
tags for. Currently, the supported resources are Amazon ECS tasks, services, task
definitions, clusters, and container instances.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"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 ecs(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_task_definition_families()
list_task_definition_families(params::Dict{String,<:Any})
Returns a list of task definition families that are registered to your account. This list
includes task definition families that no longer have any ACTIVE task definition revisions.
You can filter out task definition families that don't contain any ACTIVE task definition
revisions by setting the status parameter to ACTIVE. You can also filter the results with
the familyPrefix parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"familyPrefix"`: The familyPrefix is a string that's used to filter the results of
ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family
names that begin with the familyPrefix string are returned.
- `"maxResults"`: The maximum number of task definition family results that
ListTaskDefinitionFamilies returned in paginated output. When this parameter is used,
ListTaskDefinitions only returns maxResults results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending
another ListTaskDefinitionFamilies request with the returned nextToken value. This value
can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitionFamilies
returns up to 100 results and a nextToken value if applicable.
- `"nextToken"`: The nextToken value returned from a ListTaskDefinitionFamilies request
indicating that more results are available to fulfill the request and further calls will be
needed. If maxResults was provided, it is possible the number of results to be fewer than
maxResults. This token should be treated as an opaque identifier that is only used to
retrieve the next items in a list and not for other programmatic purposes.
- `"status"`: The task definition family status to filter the ListTaskDefinitionFamilies
results with. By default, both ACTIVE and INACTIVE task definition families are listed. If
this parameter is set to ACTIVE, only task definition families that have an ACTIVE task
definition revision are returned. If this parameter is set to INACTIVE, only task
definition families that do not have any ACTIVE task definition revisions are returned. If
you paginate the resulting output, be sure to keep the status value constant in each
subsequent request.
"""
function list_task_definition_families(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"ListTaskDefinitionFamilies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_task_definition_families(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"ListTaskDefinitionFamilies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_task_definitions()
list_task_definitions(params::Dict{String,<:Any})
Returns a list of task definitions that are registered to your account. You can filter the
results by family name with the familyPrefix parameter or by status with the status
parameter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"familyPrefix"`: The full family name to filter the ListTaskDefinitions results with.
Specifying a familyPrefix limits the listed task definitions to task definition revisions
that belong to that family.
- `"maxResults"`: The maximum number of task definition results that ListTaskDefinitions
returned in paginated output. When this parameter is used, ListTaskDefinitions only returns
maxResults results in a single page along with a nextToken response element. The remaining
results of the initial request can be seen by sending another ListTaskDefinitions request
with the returned nextToken value. This value can be between 1 and 100. If this parameter
isn't used, then ListTaskDefinitions returns up to 100 results and a nextToken value if
applicable.
- `"nextToken"`: The nextToken value returned from a ListTaskDefinitions request indicating
that more results are available to fulfill the request and further calls will be needed. If
maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next
items in a list and not for other programmatic purposes.
- `"sort"`: The order to sort the results in. Valid values are ASC and DESC. By default,
(ASC) task definitions are listed lexicographically by family name and in ascending
numerical order by revision so that the newest task definitions in a family are listed
last. Setting this parameter to DESC reverses the sort order on family name and revision.
This is so that the newest task definitions in a family are listed first.
- `"status"`: The task definition status to filter the ListTaskDefinitions results with. By
default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE,
you can view task definitions that are INACTIVE as long as an active task or service still
references them. If you paginate the resulting output, be sure to keep the status value
constant in each subsequent request.
"""
function list_task_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"ListTaskDefinitions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_task_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"ListTaskDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tasks()
list_tasks(params::Dict{String,<:Any})
Returns a list of tasks. You can filter the results by cluster, task definition family,
container instance, launch type, what IAM principal started the task, or by the desired
status of the task. Recently stopped tasks might appear in the returned results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster to use when
filtering the ListTasks results. If you do not specify a cluster, the default cluster is
assumed.
- `"containerInstance"`: The container instance ID or full ARN of the container instance to
use when filtering the ListTasks results. Specifying a containerInstance limits the results
to tasks that belong to that container instance.
- `"desiredStatus"`: The task desired status to use when filtering the ListTasks results.
Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set
the desired status to STOPPED. This can be useful for debugging tasks that aren't starting
properly or have died or finished. The default status filter is RUNNING, which shows tasks
that Amazon ECS has set the desired status to RUNNING. Although you can filter results
based on a desired status of PENDING, this doesn't return any results. Amazon ECS never
sets the desired status of a task to that value (only a task's lastStatus may have a value
of PENDING).
- `"family"`: The name of the task definition family to use when filtering the ListTasks
results. Specifying a family limits the results to tasks that belong to that family.
- `"launchType"`: The launch type to use when filtering the ListTasks results.
- `"maxResults"`: The maximum number of task results that ListTasks returned in paginated
output. When this parameter is used, ListTasks only returns maxResults results in a single
page along with a nextToken response element. The remaining results of the initial request
can be seen by sending another ListTasks request with the returned nextToken value. This
value can be between 1 and 100. If this parameter isn't used, then ListTasks returns up to
100 results and a nextToken value if applicable.
- `"nextToken"`: The nextToken value returned from a ListTasks request indicating that more
results are available to fulfill the request and further calls will be needed. If
maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next
items in a list and not for other programmatic purposes.
- `"serviceName"`: The name of the service to use when filtering the ListTasks results.
Specifying a serviceName limits the results to tasks that belong to that service.
- `"startedBy"`: The startedBy value to filter the task results with. Specifying a
startedBy value limits the results to tasks that were started with that value. When you
specify startedBy as the filter, it must be the only filter that you use.
"""
function list_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs("ListTasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs("ListTasks", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
put_account_setting(name, value)
put_account_setting(name, value, params::Dict{String,<:Any})
Modifies an account setting. Account settings are set on a per-Region basis. If you change
the root user account setting, the default settings are reset for users and roles that do
not have specified individual account settings. For more information, see Account Settings
in the Amazon Elastic Container Service Developer Guide.
# Arguments
- `name`: The Amazon ECS account setting name to modify. The following are the valid values
for the account setting name. serviceLongArnFormat - When modified, the Amazon Resource
Name (ARN) and resource ID format of the resource type for a specified user, role, or the
root user for an account is affected. The opt-in and opt-out account setting must be set
for each Amazon ECS resource separately. The ARN and resource ID format of a resource is
defined by the opt-in status of the user or role that created the resource. You must turn
on this setting to use Amazon ECS features such as resource tagging. taskLongArnFormat -
When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type
for a specified user, role, or the root user for an account is affected. The opt-in and
opt-out account setting must be set for each Amazon ECS resource separately. The ARN and
resource ID format of a resource is defined by the opt-in status of the user or role that
created the resource. You must turn on this setting to use Amazon ECS features such as
resource tagging. containerInstanceLongArnFormat - When modified, the Amazon Resource
Name (ARN) and resource ID format of the resource type for a specified user, role, or the
root user for an account is affected. The opt-in and opt-out account setting must be set
for each Amazon ECS resource separately. The ARN and resource ID format of a resource is
defined by the opt-in status of the user or role that created the resource. You must turn
on this setting to use Amazon ECS features such as resource tagging. awsvpcTrunking -
When modified, the elastic network interface (ENI) limit for any new container instances
that support the feature is changed. If awsvpcTrunking is turned on, any new container
instances that support the feature are launched have the increased ENI limits available to
them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic
Container Service Developer Guide. containerInsights - When modified, the default
setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on
for your clusters is changed. If containerInsights is turned on, any new clusters that are
created will have Container Insights turned on unless you disable it during cluster
creation. For more information, see CloudWatch Container Insights in the Amazon Elastic
Container Service Developer Guide. dualStackIPv6 - When turned on, when using a VPC in
dual stack mode, your tasks using the awsvpc network mode can have an IPv6 address
assigned. For more information on using IPv6 with tasks launched on Amazon EC2 instances,
see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks launched
on Fargate, see Using a VPC in dual-stack mode. fargateFIPSMode - If you specify
fargateFIPSMode, Fargate FIPS 140 compliance is affected.
fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a security or
infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to
be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to
configure the wait time to retire a Fargate task. For information about the Fargate tasks
maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer
Guide. tagResourceAuthorization - Amazon ECS is introducing tagging authorization for
resource creation. Users must have permissions for actions that create the resource, such
as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services
performs additional authorization to verify if users or roles have permissions to create
tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For
more information, see Grant permission to tag resources on creation in the Amazon ECS
Developer Guide. guardDutyActivate - The guardDutyActivate parameter is read-only in
Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by
your security administrator in your Amazon ECS account. Amazon GuardDuty controls this
account setting on your behalf. For more information, see Protecting Amazon ECS workloads
with Amazon ECS Runtime Monitoring.
- `value`: The account setting value for the specified principal ARN. Accepted values are
enabled, disabled, on, and off. When you specify fargateTaskRetirementWaitPeriod for the
name, the following are the valid values: 0 - Amazon Web Services sends the
notification, and immediately retires the affected tasks. 7 - Amazon Web Services sends
the notification, and waits 7 calendar days to retire the tasks. 14 - Amazon Web
Services sends the notification, and waits 14 calendar days to retire the tasks.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"principalArn"`: The ARN of the principal, which can be a user, role, or the root user.
If you specify the root user, it modifies the account setting for all users, roles, and the
root user of the account unless a user or role explicitly overrides these settings. If this
field is omitted, the setting is changed only for the authenticated user. You must use the
root user when you set the Fargate wait time (fargateTaskRetirementWaitPeriod). Federated
users assume the account setting of the root user and can't have explicit account settings
set for them.
"""
function put_account_setting(name, value; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"PutAccountSetting",
Dict{String,Any}("name" => name, "value" => value);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_setting(
name,
value,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"PutAccountSetting",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("name" => name, "value" => value), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_account_setting_default(name, value)
put_account_setting_default(name, value, params::Dict{String,<:Any})
Modifies an account setting for all users on an account for whom no individual account
setting has been specified. Account settings are set on a per-Region basis.
# Arguments
- `name`: The resource name for which to modify the account setting. The following are the
valid values for the account setting name. serviceLongArnFormat - When modified, the
Amazon Resource Name (ARN) and resource ID format of the resource type for a specified
user, role, or the root user for an account is affected. The opt-in and opt-out account
setting must be set for each Amazon ECS resource separately. The ARN and resource ID format
of a resource is defined by the opt-in status of the user or role that created the
resource. You must turn on this setting to use Amazon ECS features such as resource
tagging. taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource
ID format of the resource type for a specified user, role, or the root user for an account
is affected. The opt-in and opt-out account setting must be set for each Amazon ECS
resource separately. The ARN and resource ID format of a resource is defined by the opt-in
status of the user or role that created the resource. You must turn on this setting to use
Amazon ECS features such as resource tagging. containerInstanceLongArnFormat - When
modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a
specified user, role, or the root user for an account is affected. The opt-in and opt-out
account setting must be set for each Amazon ECS resource separately. The ARN and resource
ID format of a resource is defined by the opt-in status of the user or role that created
the resource. You must turn on this setting to use Amazon ECS features such as resource
tagging. awsvpcTrunking - When modified, the elastic network interface (ENI) limit for
any new container instances that support the feature is changed. If awsvpcTrunking is
turned on, any new container instances that support the feature are launched have the
increased ENI limits available to them. For more information, see Elastic Network Interface
Trunking in the Amazon Elastic Container Service Developer Guide. containerInsights -
When modified, the default setting indicating whether Amazon Web Services CloudWatch
Container Insights is turned on for your clusters is changed. If containerInsights is
turned on, any new clusters that are created will have Container Insights turned on unless
you disable it during cluster creation. For more information, see CloudWatch Container
Insights in the Amazon Elastic Container Service Developer Guide. dualStackIPv6 - When
turned on, when using a VPC in dual stack mode, your tasks using the awsvpc network mode
can have an IPv6 address assigned. For more information on using IPv6 with tasks launched
on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using
IPv6 with tasks launched on Fargate, see Using a VPC in dual-stack mode. fargateFIPSMode
- If you specify fargateFIPSMode, Fargate FIPS 140 compliance is affected.
fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a security or
infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to
be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to
configure the wait time to retire a Fargate task. For information about the Fargate tasks
maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer
Guide. tagResourceAuthorization - Amazon ECS is introducing tagging authorization for
resource creation. Users must have permissions for actions that create the resource, such
as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services
performs additional authorization to verify if users or roles have permissions to create
tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For
more information, see Grant permission to tag resources on creation in the Amazon ECS
Developer Guide. guardDutyActivate - The guardDutyActivate parameter is read-only in
Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by
your security administrator in your Amazon ECS account. Amazon GuardDuty controls this
account setting on your behalf. For more information, see Protecting Amazon ECS workloads
with Amazon ECS Runtime Monitoring.
- `value`: The account setting value for the specified principal ARN. Accepted values are
enabled, disabled, on, and off. When you specify fargateTaskRetirementWaitPeriod for the
name, the following are the valid values: 0 - Amazon Web Services sends the
notification, and immediately retires the affected tasks. 7 - Amazon Web Services sends
the notification, and waits 7 calendar days to retire the tasks. 14 - Amazon Web
Services sends the notification, and waits 14 calendar days to retire the tasks.
"""
function put_account_setting_default(
name, value; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"PutAccountSettingDefault",
Dict{String,Any}("name" => name, "value" => value);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_setting_default(
name,
value,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"PutAccountSettingDefault",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("name" => name, "value" => value), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_attributes(attributes)
put_attributes(attributes, params::Dict{String,<:Any})
Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,
it's created. If the attribute exists, its value is replaced with the specified value. To
delete an attribute, use DeleteAttributes. For more information, see Attributes in the
Amazon Elastic Container Service Developer Guide.
# Arguments
- `attributes`: The attributes to apply to your resource. You can specify up to 10 custom
attributes for each resource. You can specify up to 10 attributes in a single call.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that
contains the resource to apply attributes. If you do not specify a cluster, the default
cluster is assumed.
"""
function put_attributes(attributes; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"PutAttributes",
Dict{String,Any}("attributes" => attributes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_attributes(
attributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"PutAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("attributes" => attributes), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_cluster_capacity_providers(capacity_providers, cluster, default_capacity_provider_strategy)
put_cluster_capacity_providers(capacity_providers, cluster, default_capacity_provider_strategy, params::Dict{String,<:Any})
Modifies the available capacity providers and the default capacity provider strategy for a
cluster. You must specify both the available capacity providers and a default capacity
provider strategy for the cluster. If the specified cluster has existing capacity providers
associated with it, you must specify all existing capacity providers in addition to any new
ones you want to add. Any existing capacity providers that are associated with a cluster
that are omitted from a PutClusterCapacityProviders API call will be disassociated with the
cluster. You can only disassociate an existing capacity provider from a cluster if it's not
being used by any existing tasks. When creating a service or running a task on a cluster,
if no capacity provider or launch type is specified, then the cluster's default capacity
provider strategy is used. We recommend that you define a default capacity provider
strategy for your cluster. However, you must specify an empty array ([]) to bypass defining
a default strategy.
# Arguments
- `capacity_providers`: The name of one or more capacity providers to associate with the
cluster. If specifying a capacity provider that uses an Auto Scaling group, the capacity
provider must already be created. New capacity providers can be created with the
CreateCapacityProvider API operation. To use a Fargate capacity provider, specify either
the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are
available to all accounts and only need to be associated with a cluster to be used.
- `cluster`: The short name or full Amazon Resource Name (ARN) of the cluster to modify the
capacity provider settings for. If you don't specify a cluster, the default cluster is
assumed.
- `default_capacity_provider_strategy`: The capacity provider strategy to use by default
for the cluster. When creating a service or running a task on a cluster, if no capacity
provider or launch type is specified then the default capacity provider strategy for the
cluster is used. A capacity provider strategy consists of one or more capacity providers
along with the base and weight to assign to them. A capacity provider must be associated
with the cluster to be used in a capacity provider strategy. The
PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.
Only capacity providers with an ACTIVE or UPDATING status can be used. If specifying a
capacity provider that uses an Auto Scaling group, the capacity provider must already be
created. New capacity providers can be created with the CreateCapacityProvider API
operation. To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only
need to be associated with a cluster to be used.
"""
function put_cluster_capacity_providers(
capacityProviders,
cluster,
defaultCapacityProviderStrategy;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"PutClusterCapacityProviders",
Dict{String,Any}(
"capacityProviders" => capacityProviders,
"cluster" => cluster,
"defaultCapacityProviderStrategy" => defaultCapacityProviderStrategy,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_cluster_capacity_providers(
capacityProviders,
cluster,
defaultCapacityProviderStrategy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"PutClusterCapacityProviders",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"capacityProviders" => capacityProviders,
"cluster" => cluster,
"defaultCapacityProviderStrategy" => defaultCapacityProviderStrategy,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_container_instance()
register_container_instance(params::Dict{String,<:Any})
This action is only used by the Amazon ECS agent, and it is not intended for use outside
of the agent. Registers an EC2 instance into the specified cluster. This instance becomes
available to place containers on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: The container instance attributes that this container instance supports.
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster to register
your container instance with. If you do not specify a cluster, the default cluster is
assumed.
- `"containerInstanceArn"`: The ARN of the container instance (if it was previously
registered).
- `"instanceIdentityDocument"`: The instance identity document for the EC2 instance to
register. This document can be found by running the following command from the instance:
curl http://169.254.169.254/latest/dynamic/instance-identity/document/
- `"instanceIdentityDocumentSignature"`: The instance identity document signature for the
EC2 instance to register. This signature can be found by running the following command from
the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
- `"platformDevices"`: The devices that are available on the container instance. The only
supported device type is a GPU.
- `"tags"`: The metadata that you apply to the container instance to help you categorize
and organize them. Each tag consists of a key and an optional value. You define both. The
following basic restrictions apply to tags: Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode
characters in UTF-8 If your tagging schema is used across multiple services and
resources, remember that other services may have restrictions on allowed characters.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and
the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do
not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either
keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per
resource limit.
- `"totalResources"`: The resources available on the instance.
- `"versionInfo"`: The version information for the Amazon ECS container agent and Docker
daemon that runs on the container instance.
"""
function register_container_instance(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"RegisterContainerInstance"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function register_container_instance(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"RegisterContainerInstance",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_task_definition(container_definitions, family)
register_task_definition(container_definitions, family, params::Dict{String,<:Any})
Registers a new task definition from the supplied family and containerDefinitions.
Optionally, you can add data volumes to your containers with the volumes parameter. For
more information about task definition parameters and defaults, see Amazon ECS Task
Definitions in the Amazon Elastic Container Service Developer Guide. You can specify a role
for your task with the taskRoleArn parameter. When you specify a role for a task, its
containers can then use the latest versions of the CLI or SDKs to make API requests to the
Amazon Web Services services that are specified in the policy that's associated with the
role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service
Developer Guide. You can specify a Docker networking mode for the containers in your task
definition with the networkMode parameter. The available network modes correspond to those
described in Network settings in the Docker run reference. If you specify the awsvpc
network mode, the task is allocated an elastic network interface, and you must specify a
NetworkConfiguration when you create a service or run a task with the task definition. For
more information, see Task Networking in the Amazon Elastic Container Service Developer
Guide.
# Arguments
- `container_definitions`: A list of container definitions in JSON format that describe the
different containers that make up your task.
- `family`: You must specify a family for a task definition. You can use it track multiple
versions of the same task definition. The family is used as a name for your task
definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens
are allowed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cpu"`: The number of CPU units used by the task. It can be expressed as an integer
using CPU units (for example, 1024) or as a string using vCPUs (for example, 1 vCPU or 1
vcpu) in a task definition. String values are converted to an integer indicating the CPU
units when the task definition is registered. Task-level CPU and memory parameters are
ignored for Windows containers. We recommend specifying container-level resources for
Windows containers. If you're using the EC2 launch type, this field is optional. Supported
values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you do
not specify a value, the parameter is ignored. If you're using the Fargate launch type,
this field is required and you must use one of the following values, which determines your
range of supported values for the memory parameter: The CPU units cannot be less than 1
vCPU when you use Windows containers on Fargate. 256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) 512 (.5 vCPU) - Available memory values:
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) 1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192
(8 GB) 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in
increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720
(30 GB) in increments of 1024 (1 GB) 8192 (8 vCPU) - Available memory values: 16 GB and
60 GB in 4 GB increments This option requires Linux platform 1.4.0 or later. 16384
(16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments This option requires
Linux platform 1.4.0 or later.
- `"ephemeralStorage"`: The amount of ephemeral storage to allocate for the task. This
parameter is used to expand the total amount of ephemeral storage available, beyond the
default amount, for tasks hosted on Fargate. For more information, see Using data volumes
in tasks in the Amazon ECS Developer Guide. For tasks using the Fargate launch type, the
task requires the following platforms: Linux platform version 1.4.0 or later. Windows
platform version 1.0.0 or later.
- `"executionRoleArn"`: The Amazon Resource Name (ARN) of the task execution role that
grants the Amazon ECS container agent permission to make Amazon Web Services API calls on
your behalf. The task execution IAM role is required depending on the requirements of your
task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic
Container Service Developer Guide.
- `"inferenceAccelerators"`: The Elastic Inference accelerators to use for the containers
in the task.
- `"ipcMode"`: The IPC resource namespace to use for the containers in the task. The valid
values are host, task, or none. If host is specified, then all containers within the tasks
that specified the host IPC mode on the same container instance share the same IPC
resources with the host Amazon EC2 instance. If task is specified, all containers within
the specified task share the same IPC resources. If none is specified, then IPC resources
within the containers of a task are private and not shared with other containers in a task
or on the container instance. If no value is specified, then the IPC resource namespace
sharing depends on the Docker daemon setting on the container instance. For more
information, see IPC settings in the Docker run reference. If the host IPC mode is used, be
aware that there is a heightened risk of undesired IPC namespace expose. For more
information, see Docker security. If you are setting namespaced kernel parameters using
systemControls for the containers in the task, the following will apply to your IPC
resource namespace. For more information, see System Controls in the Amazon Elastic
Container Service Developer Guide. For tasks that use the host IPC mode, IPC namespace
related systemControls are not supported. For tasks that use the task IPC mode, IPC
namespace related systemControls will apply to all containers within a task. This
parameter is not supported for Windows containers or tasks run on Fargate.
- `"memory"`: The amount of memory (in MiB) used by the task. It can be expressed as an
integer using MiB (for example ,1024) or as a string using GB (for example, 1GB or 1 GB) in
a task definition. String values are converted to an integer indicating the MiB when the
task definition is registered. Task-level CPU and memory parameters are ignored for
Windows containers. We recommend specifying container-level resources for Windows
containers. If using the EC2 launch type, this field is optional. If using the Fargate
launch type, this field is required and you must use one of the following values. This
determines your range of supported values for the cpu parameter. The CPU units cannot be
less than 1 vCPU when you use Windows containers on Fargate. 512 (0.5 GB), 1024 (1 GB),
2048 (2 GB) - Available cpu values: 256 (.25 vCPU) 1024 (1 GB), 2048 (2 GB), 3072 (3 GB),
4096 (4 GB) - Available cpu values: 512 (.5 vCPU) 2048 (2 GB), 3072 (3 GB), 4096 (4 GB),
5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values:
2048 (2 vCPU) Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
Available cpu values: 4096 (4 vCPU) Between 16 GB and 60 GB in 4 GB increments -
Available cpu values: 8192 (8 vCPU) This option requires Linux platform 1.4.0 or later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU) This
option requires Linux platform 1.4.0 or later.
- `"networkMode"`: The Docker networking mode to use for the containers in the task. The
valid values are none, bridge, awsvpc, and host. If no network mode is specified, the
default is bridge. For Amazon ECS tasks on Fargate, the awsvpc network mode is required.
For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For
Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If
the network mode is set to none, you cannot specify port mappings in your container
definitions, and the tasks containers do not have external connectivity. The host and
awsvpc network modes offer the highest networking performance for containers because they
use the EC2 network stack instead of the virtualized network stack provided by the bridge
mode. With the host and awsvpc network modes, exposed container ports are mapped directly
to the corresponding host port (for the host network mode) or the attached elastic network
interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host
port mappings. When using the host network mode, you should not run containers using the
root user (UID 0). It is considered best practice to use a non-root user. If the network
mode is awsvpc, the task is allocated an elastic network interface, and you must specify a
NetworkConfiguration value when you create a service or run a task with the task
definition. For more information, see Task Networking in the Amazon Elastic Container
Service Developer Guide. If the network mode is host, you cannot run multiple
instantiations of the same task on a single container instance when port mappings are used.
For more information, see Network settings in the Docker run reference.
- `"pidMode"`: The process namespace to use for the containers in the task. The valid
values are host or task. On Fargate for Linux containers, the only valid value is task. For
example, monitoring sidecars might need pidMode to access information about other
containers running in the same task. If host is specified, all containers within the tasks
that specified the host PID mode on the same container instance share the same process
namespace with the host Amazon EC2 instance. If task is specified, all containers within
the specified task share the same process namespace. If no value is specified, the default
is a private namespace for each container. For more information, see PID settings in the
Docker run reference. If the host PID mode is used, there's a heightened risk of undesired
process namespace exposure. For more information, see Docker security. This parameter is
not supported for Windows containers. This parameter is only supported for tasks that are
hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This
isn't supported for Windows containers on Fargate.
- `"placementConstraints"`: An array of placement constraint objects to use for the task.
You can specify a maximum of 10 constraints for each task. This limit includes constraints
in the task definition and those specified at runtime.
- `"proxyConfiguration"`: The configuration details for the App Mesh proxy. For tasks
hosted on Amazon EC2 instances, the container instances require at least version 1.26.0 of
the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy
configuration. If your container instances are launched from the Amazon ECS-optimized AMI
version 20190301 or later, then they contain the required versions of the container agent
and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon
Elastic Container Service Developer Guide.
- `"requiresCompatibilities"`: The task launch type that Amazon ECS validates the task
definition against. A client exception is returned if the task definition doesn't validate
against the compatibilities specified. If no value is specified, the parameter is omitted
from the response.
- `"runtimePlatform"`: The operating system that your tasks definitions run on. A platform
family is specified only for tasks using the Fargate launch type.
- `"tags"`: The metadata that you apply to the task definition to help you categorize and
organize them. Each tag consists of a key and an optional value. You define both of them.
The following basic restrictions apply to tags: Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode
characters in UTF-8 If your tagging schema is used across multiple services and
resources, remember that other services may have restrictions on allowed characters.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and
the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do
not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either
keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per
resource limit.
- `"taskRoleArn"`: The short name or full Amazon Resource Name (ARN) of the IAM role that
containers in this task can assume. All containers in this task are granted the permissions
that are specified in this role. For more information, see IAM Roles for Tasks in the
Amazon Elastic Container Service Developer Guide.
- `"volumes"`: A list of volume definitions in JSON format that containers in your task
might use.
"""
function register_task_definition(
containerDefinitions, family; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"RegisterTaskDefinition",
Dict{String,Any}(
"containerDefinitions" => containerDefinitions, "family" => family
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_task_definition(
containerDefinitions,
family,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"RegisterTaskDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"containerDefinitions" => containerDefinitions, "family" => family
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
run_task(task_definition)
run_task(task_definition, params::Dict{String,<:Any})
Starts a new task using the specified task definition. On March 21, 2024, a change was
made to resolve the task definition revision before authorization. When a task definition
revision is not specified, authorization will occur using the latest revision of a task
definition. You can allow Amazon ECS to place tasks for you, or you can customize how
Amazon ECS places tasks using placement constraints and placement strategies. For more
information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on
specific container instances. Starting April 15, 2023, Amazon Web Services will not onboard
new customers to Amazon Elastic Inference (EI), and will help current customers migrate
their workloads to options that offer better price and performance. After April 15, 2023,
new customers will not be able to launch instances with Amazon EI accelerators in Amazon
SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least
once during the past 30-day period are considered current customers and will be able to
continue using the service. You can attach Amazon EBS volumes to Amazon ECS tasks by
configuring the volume when creating or updating a service. For more infomation, see Amazon
EBS volumes in the Amazon Elastic Container Service Developer Guide. The Amazon ECS API
follows an eventual consistency model. This is because of the distributed nature of the
system supporting the API. This means that the result of an API command you run that
affects your Amazon ECS resources might not be immediately visible to all subsequent
commands you run. Keep this in mind when you carry out an API command that immediately
follows a previous API command. To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the
DescribeTasks command using an exponential backoff algorithm to ensure that you allow
enough time for the previous command to propagate through the system. To do this, run the
DescribeTasks command repeatedly, starting with a couple of seconds of wait time and
increasing gradually up to five minutes of wait time. Add wait time between subsequent
commands, even if the DescribeTasks command returns an accurate response. Apply an
exponential backoff algorithm starting with a couple of seconds of wait time, and increase
gradually up to about five minutes of wait time.
# Arguments
- `task_definition`: The family and revision (family:revision) or full ARN of the task
definition to run. If a revision isn't specified, the latest ACTIVE revision is used. The
full ARN value must match the value that you specified as the Resource of the principal's
permissions policy. When you specify a task definition, you must either specify a specific
revision, or all revisions in the ARN. To specify a specific revision, include the revision
number in the ARN. For example, to specify revision 2, use
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2. To specify all
revisions, use the wildcard (*) in the ARN. For example, to specify all revisions, use
arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*. For more information,
see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capacityProviderStrategy"`: The capacity provider strategy to use for the task. If a
capacityProviderStrategy is specified, the launchType parameter must be omitted. If no
capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy
for the cluster is used. When you use cluster auto scaling, you must specify
capacityProviderStrategy and not launchType. A capacity provider strategy may contain a
maximum of 6 capacity providers.
- `"clientToken"`: An identifier that you provide to ensure the idempotency of the request.
It must be unique and is case sensitive. Up to 64 characters are allowed. The valid
characters are characters in the range of 33-126, inclusive. For more information, see
Ensuring idempotency.
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster to run your
task on. If you do not specify a cluster, the default cluster is assumed.
- `"count"`: The number of instantiations of the specified task to place on your cluster.
You can specify up to 10 tasks for each call.
- `"enableECSManagedTags"`: Specifies whether to use Amazon ECS managed tags for the task.
For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container
Service Developer Guide.
- `"enableExecuteCommand"`: Determines whether to use the execute command functionality for
the containers in this task. If true, this enables execute command functionality on all
containers in the task. If true, then the task definition must have a task role, or you
must provide one as an override.
- `"group"`: The name of the task group to associate with the task. The default value is
the family name of the task definition (for example, family:my-family-name).
- `"launchType"`: The infrastructure to run your standalone task on. For more information,
see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide. The
FARGATE launch type runs your tasks on Fargate On-Demand infrastructure. Fargate Spot
infrastructure is available for use but a capacity provider strategy must be used. For more
information, see Fargate capacity providers in the Amazon ECS Developer Guide. The EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster. The
EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM)
capacity registered to your cluster. A task can use either a launch type or a capacity
provider strategy. If a launchType is specified, the capacityProviderStrategy parameter
must be omitted. When you use cluster auto scaling, you must specify
capacityProviderStrategy and not launchType.
- `"networkConfiguration"`: The network configuration for the task. This parameter is
required for task definitions that use the awsvpc network mode to receive their own elastic
network interface, and it isn't supported for other network modes. For more information,
see Task networking in the Amazon Elastic Container Service Developer Guide.
- `"overrides"`: A list of container overrides in JSON format that specify the name of a
container in the specified task definition and the overrides it should receive. You can
override the default command for a container (that's specified in the task definition or
Docker image) with a command override. You can also override existing environment variables
(that are specified in the task definition or Docker image) on a container or add new
environment variables to it with an environment override. A total of 8192 characters are
allowed for overrides. This limit includes the JSON formatting characters of the override
structure.
- `"placementConstraints"`: An array of placement constraint objects to use for the task.
You can specify up to 10 constraints for each task (including constraints in the task
definition and those specified at runtime).
- `"placementStrategy"`: The placement strategy objects to use for the task. You can
specify a maximum of 5 strategy rules for each task.
- `"platformVersion"`: The platform version the task uses. A platform version is only
specified for tasks hosted on Fargate. If one isn't specified, the LATEST platform version
is used. For more information, see Fargate platform versions in the Amazon Elastic
Container Service Developer Guide.
- `"propagateTags"`: Specifies whether to propagate the tags from the task definition to
the task. If no value is specified, the tags aren't propagated. Tags can only be propagated
to the task during task creation. To add tags to a task after task creation, use the
TagResource API action. An error will be received if you specify the SERVICE option when
running a task.
- `"referenceId"`: The reference ID to use for the task. The reference ID can have a
maximum length of 1024 characters.
- `"startedBy"`: An optional tag specified when a task is started. For example, if you
automatically trigger a task to run a batch process job, you could apply a unique
identifier for that job to your task with the startedBy parameter. You can then identify
which tasks belong to that job by filtering the results of a ListTasks call with the
startedBy value. Up to 128 letters (uppercase and lowercase), numbers, hyphens (-), and
underscores (_) are allowed. If a task is started by an Amazon ECS service, then the
startedBy parameter contains the deployment ID of the service that starts it.
- `"tags"`: The metadata that you apply to the task to help you categorize and organize
them. Each tag consists of a key and an optional value, both of which you define. The
following basic restrictions apply to tags: Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode
characters in UTF-8 If your tagging schema is used across multiple services and
resources, remember that other services may have restrictions on allowed characters.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and
the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do
not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either
keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per
resource limit.
- `"volumeConfigurations"`: The details of the volume that was configuredAtLaunch. You can
configure the size, volumeType, IOPS, throughput, snapshot and encryption in in
TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task
definition.
"""
function run_task(taskDefinition; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"RunTask",
Dict{String,Any}(
"taskDefinition" => taskDefinition, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function run_task(
taskDefinition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"RunTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"taskDefinition" => taskDefinition, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_task(container_instances, task_definition)
start_task(container_instances, task_definition, params::Dict{String,<:Any})
Starts a new task from the specified task definition on the specified container instance or
instances. On March 21, 2024, a change was made to resolve the task definition revision
before authorization. When a task definition revision is not specified, authorization will
occur using the latest revision of a task definition. Starting April 15, 2023, Amazon Web
Services will not onboard new customers to Amazon Elastic Inference (EI), and will help
current customers migrate their workloads to options that offer better price and
performance. After April 15, 2023, new customers will not be able to launch instances with
Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers
who have used Amazon EI at least once during the past 30-day period are considered current
customers and will be able to continue using the service. Alternatively, you can use
RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon
Elastic Container Service Developer Guide. You can attach Amazon EBS volumes to Amazon ECS
tasks by configuring the volume when creating or updating a service. For more infomation,
see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
# Arguments
- `container_instances`: The container instance IDs or full ARN entries for the container
instances where you would like to place your task. You can specify up to 10 container
instances.
- `task_definition`: The family and revision (family:revision) or full ARN of the task
definition to start. If a revision isn't specified, the latest ACTIVE revision is used.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster where to
start your task. If you do not specify a cluster, the default cluster is assumed.
- `"enableECSManagedTags"`: Specifies whether to use Amazon ECS managed tags for the task.
For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container
Service Developer Guide.
- `"enableExecuteCommand"`: Whether or not the execute command functionality is turned on
for the task. If true, this turns on the execute command functionality on all containers in
the task.
- `"group"`: The name of the task group to associate with the task. The default value is
the family name of the task definition (for example, family:my-family-name).
- `"networkConfiguration"`: The VPC subnet and security group configuration for tasks that
receive their own elastic network interface by using the awsvpc networking mode.
- `"overrides"`: A list of container overrides in JSON format that specify the name of a
container in the specified task definition and the overrides it receives. You can override
the default command for a container (that's specified in the task definition or Docker
image) with a command override. You can also override existing environment variables (that
are specified in the task definition or Docker image) on a container or add new environment
variables to it with an environment override. A total of 8192 characters are allowed for
overrides. This limit includes the JSON formatting characters of the override structure.
- `"propagateTags"`: Specifies whether to propagate the tags from the task definition or
the service to the task. If no value is specified, the tags aren't propagated.
- `"referenceId"`: The reference ID to use for the task.
- `"startedBy"`: An optional tag specified when a task is started. For example, if you
automatically trigger a task to run a batch process job, you could apply a unique
identifier for that job to your task with the startedBy parameter. You can then identify
which tasks belong to that job by filtering the results of a ListTasks call with the
startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens (-), and
underscores (_) are allowed. If a task is started by an Amazon ECS service, the startedBy
parameter contains the deployment ID of the service that starts it.
- `"tags"`: The metadata that you apply to the task to help you categorize and organize
them. Each tag consists of a key and an optional value, both of which you define. The
following basic restrictions apply to tags: Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode
characters in UTF-8 If your tagging schema is used across multiple services and
resources, remember that other services may have restrictions on allowed characters.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and
the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do
not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either
keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per
resource limit.
- `"volumeConfigurations"`: The details of the volume that was configuredAtLaunch. You can
configure the size, volumeType, IOPS, throughput, snapshot and encryption in
TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task
definition.
"""
function start_task(
containerInstances, taskDefinition; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"StartTask",
Dict{String,Any}(
"containerInstances" => containerInstances, "taskDefinition" => taskDefinition
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_task(
containerInstances,
taskDefinition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"StartTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"containerInstances" => containerInstances,
"taskDefinition" => taskDefinition,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_task(task)
stop_task(task, params::Dict{String,<:Any})
Stops a running task. Any tags associated with the task will be deleted. When StopTask is
called on a task, the equivalent of docker stop is issued to the containers running in the
task. This results in a SIGTERM value and a default 30-second timeout, after which the
SIGKILL value is sent and the containers are forcibly stopped. If the container handles the
SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is
sent. For Windows containers, POSIX signals do not work and runtime stops the container by
sending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful
shutdown of (Windows) container #25982 on GitHub. The default 30-second timeout can be
configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable.
For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic
Container Service Developer Guide.
# Arguments
- `task`: The task ID of the task to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the task to stop. If you do not specify a cluster, the default cluster is assumed.
- `"reason"`: An optional message specified when a task is stopped. For example, if you're
using a custom scheduler, you can use this parameter to specify the reason for stopping the
task here, and the message appears in subsequent DescribeTasks API operations on this task.
"""
function stop_task(task; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"StopTask",
Dict{String,Any}("task" => task);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_task(
task, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"StopTask",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("task" => task), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
submit_attachment_state_changes(attachments)
submit_attachment_state_changes(attachments, params::Dict{String,<:Any})
This action is only used by the Amazon ECS agent, and it is not intended for use outside
of the agent. Sent to acknowledge that an attachment changed states.
# Arguments
- `attachments`: Any attachments associated with the state change request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full ARN of the cluster that hosts the container instance
the attachment belongs to.
"""
function submit_attachment_state_changes(
attachments; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"SubmitAttachmentStateChanges",
Dict{String,Any}("attachments" => attachments);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function submit_attachment_state_changes(
attachments,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"SubmitAttachmentStateChanges",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("attachments" => attachments), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
submit_container_state_change()
submit_container_state_change(params::Dict{String,<:Any})
This action is only used by the Amazon ECS agent, and it is not intended for use outside
of the agent. Sent to acknowledge that a container changed states.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full ARN of the cluster that hosts the container.
- `"containerName"`: The name of the container.
- `"exitCode"`: The exit code that's returned for the state change request.
- `"networkBindings"`: The network bindings of the container.
- `"reason"`: The reason for the state change request.
- `"runtimeId"`: The ID of the Docker container.
- `"status"`: The status of the state change request.
- `"task"`: The task ID or full Amazon Resource Name (ARN) of the task that hosts the
container.
"""
function submit_container_state_change(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"SubmitContainerStateChange"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function submit_container_state_change(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"SubmitContainerStateChange",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
submit_task_state_change()
submit_task_state_change(params::Dict{String,<:Any})
This action is only used by the Amazon ECS agent, and it is not intended for use outside
of the agent. Sent to acknowledge that a task changed states.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attachments"`: Any attachments associated with the state change request.
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the task.
- `"containers"`: Any containers that's associated with the state change request.
- `"executionStoppedAt"`: The Unix timestamp for the time when the task execution stopped.
- `"managedAgents"`: The details for the managed agent that's associated with the task.
- `"pullStartedAt"`: The Unix timestamp for the time when the container image pull started.
- `"pullStoppedAt"`: The Unix timestamp for the time when the container image pull
completed.
- `"reason"`: The reason for the state change request.
- `"status"`: The status of the state change request.
- `"task"`: The task ID or full ARN of the task in the state change request.
"""
function submit_task_state_change(; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"SubmitTaskStateChange"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function submit_task_state_change(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"SubmitTaskStateChange",
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 aren't specified in the request parameters, they aren't changed. When a
resource is deleted, the tags that are associated with that resource are deleted as well.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to add tags to. Currently,
the supported resources are Amazon ECS capacity providers, tasks, services, task
definitions, clusters, and container instances.
- `tags`: The tags to add to the resource. A tag is an array of key-value pairs. The
following basic restrictions apply to tags: Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode
characters in UTF-8 If your tagging schema is used across multiple services and
resources, remember that other services may have restrictions on allowed characters.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and
the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do
not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either
keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag
keys or values with this prefix. Tags with this prefix do not count against your tags per
resource limit.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"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 ecs(
"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 specified tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to delete tags from.
Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task
definitions, clusters, and container instances.
- `tag_keys`: The keys of the tags to be removed.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"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 ecs(
"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_capacity_provider(auto_scaling_group_provider, name)
update_capacity_provider(auto_scaling_group_provider, name, params::Dict{String,<:Any})
Modifies the parameters for a capacity provider.
# Arguments
- `auto_scaling_group_provider`: An object that represent the parameters to update for the
Auto Scaling group capacity provider.
- `name`: The name of the capacity provider to update.
"""
function update_capacity_provider(
autoScalingGroupProvider, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"UpdateCapacityProvider",
Dict{String,Any}(
"autoScalingGroupProvider" => autoScalingGroupProvider, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_capacity_provider(
autoScalingGroupProvider,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"UpdateCapacityProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"autoScalingGroupProvider" => autoScalingGroupProvider, "name" => name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cluster(cluster)
update_cluster(cluster, params::Dict{String,<:Any})
Updates the cluster.
# Arguments
- `cluster`: The name of the cluster to modify the settings for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"configuration"`: The execute command configuration for the cluster.
- `"serviceConnectDefaults"`: Use this parameter to set a default Service Connect
namespace. After you set a default Service Connect namespace, any new services with Service
Connect turned on that are created in the cluster are added as client services in the
namespace. This setting only applies to new services that set the enabled parameter to true
in the ServiceConnectConfiguration. You can set the namespace of each service individually
in the ServiceConnectConfiguration to override this default parameter. Tasks that run in a
namespace can use short names to connect to services in the namespace. Tasks can connect to
services across all of the clusters in the namespace. Tasks connect through a managed proxy
container that collects logs and metrics for increased visibility. Only the tasks that
Amazon ECS services create are supported with Service Connect. For more information, see
Service Connect in the Amazon Elastic Container Service Developer Guide.
- `"settings"`: The cluster settings for your cluster.
"""
function update_cluster(cluster; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"UpdateCluster",
Dict{String,Any}("cluster" => cluster);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster(
cluster, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"UpdateCluster",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("cluster" => cluster), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cluster_settings(cluster, settings)
update_cluster_settings(cluster, settings, params::Dict{String,<:Any})
Modifies the settings to use for a cluster.
# Arguments
- `cluster`: The name of the cluster to modify the settings for.
- `settings`: The setting to use by default for a cluster. This parameter is used to turn
on CloudWatch Container Insights for a cluster. If this value is specified, it overrides
the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
Currently, if you delete an existing cluster that does not have Container Insights turned
on, and then create a new cluster with the same name with Container Insights tuned on,
Container Insights will not actually be turned on. If you want to preserve the same name
for your existing cluster and turn on Container Insights, you must wait 7 days before you
can re-create it.
"""
function update_cluster_settings(
cluster, settings; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"UpdateClusterSettings",
Dict{String,Any}("cluster" => cluster, "settings" => settings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster_settings(
cluster,
settings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"UpdateClusterSettings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("cluster" => cluster, "settings" => settings),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_container_agent(container_instance)
update_container_agent(container_instance, params::Dict{String,<:Any})
Updates the Amazon ECS container agent on a specified container instance. Updating the
Amazon ECS container agent doesn't interrupt running tasks or services on the container
instance. The process for updating the agent differs depending on whether your container
instance was launched with the Amazon ECS-optimized AMI or another operating system. The
UpdateContainerAgent API isn't supported for container instances using the Amazon
ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the
ecs-init package. This updates the agent. For more information, see Updating the Amazon ECS
container agent in the Amazon Elastic Container Service Developer Guide. Agent updates
with the UpdateContainerAgent API operation do not apply to Windows container instances. We
recommend that you launch new container instances to update the agent version in your
Windows clusters. The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or
Amazon Linux AMI with the ecs-init service installed and running. For help updating the
Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS
container agent in the Amazon Elastic Container Service Developer Guide.
# Arguments
- `container_instance`: The container instance ID or full ARN entries for the container
instance where you would like to update the Amazon ECS container agent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that your
container instance is running on. If you do not specify a cluster, the default cluster is
assumed.
"""
function update_container_agent(
containerInstance; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"UpdateContainerAgent",
Dict{String,Any}("containerInstance" => containerInstance);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_container_agent(
containerInstance,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"UpdateContainerAgent",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("containerInstance" => containerInstance), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_container_instances_state(container_instances, status)
update_container_instances_state(container_instances, status, params::Dict{String,<:Any})
Modifies the status of an Amazon ECS container instance. Once a container instance has
reached an ACTIVE state, you can change the status of a container instance to DRAINING to
manually remove an instance from a cluster, for example to perform system updates, update
the Docker daemon, or scale down the cluster size. A container instance can't be changed
to DRAINING until it has reached an ACTIVE status. If the instance is in any other status,
an error will be received. When you set a container instance to DRAINING, Amazon ECS
prevents new tasks from being scheduled for placement on the container instance and
replacement service tasks are started on other container instances in the cluster if the
resources are available. Service tasks on the container instance that are in the PENDING
state are stopped immediately. Service tasks on the container instance that are in the
RUNNING state are stopped and replaced according to the service's deployment configuration
parameters, minimumHealthyPercent and maximumPercent. You can change the deployment
configuration of your service using UpdateService. If minimumHealthyPercent is below
100%, the scheduler can ignore desiredCount temporarily during task replacement. For
example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two
existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler
can't remove existing tasks until the replacement tasks are considered healthy. Tasks for
services that do not use a load balancer are considered healthy if they're in the RUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in the
RUNNING state and are reported as healthy by the load balancer. The maximumPercent
parameter represents an upper limit on the number of running tasks during task replacement.
You can use this to define the replacement batch size. For example, if desiredCount is four
tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be
drained, provided that the cluster resources required to do this are available. If the
maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service aren't affected. You must
wait for them to finish or stop them manually. A container instance has completed draining
when it has no more RUNNING tasks. You can verify this using ListTasks. When a container
instance has been drained, you can set a container instance to ACTIVE status and once it
has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance
again.
# Arguments
- `container_instances`: A list of up to 10 container instance IDs or full ARN entries.
- `status`: The container instance state to update the container instance with. The only
valid values for this action are ACTIVE and DRAINING. A container instance can only be
updated to DRAINING status once it has reached an ACTIVE state. If a container instance is
in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container
instance but can't update the container instance state.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the container instance to update. If you do not specify a cluster, the default cluster is
assumed.
"""
function update_container_instances_state(
containerInstances, status; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"UpdateContainerInstancesState",
Dict{String,Any}("containerInstances" => containerInstances, "status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_container_instances_state(
containerInstances,
status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"UpdateContainerInstancesState",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"containerInstances" => containerInstances, "status" => status
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service(service)
update_service(service, params::Dict{String,<:Any})
Modifies the parameters of a service. On March 21, 2024, a change was made to resolve the
task definition revision before authorization. When a task definition revision is not
specified, authorization will occur using the latest revision of a task definition. For
services using the rolling update (ECS) you can update the desired count, deployment
configuration, network configuration, load balancers, service registries, enable ECS
managed tags option, propagate tags option, task placement constraints and strategies, and
task definition. When you update any of these parameters, Amazon ECS starts new tasks with
the new configuration. You can attach Amazon EBS volumes to Amazon ECS tasks by
configuring the volume when starting or running a task, or when creating or updating a
service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container
Service Developer Guide. You can update your volume configurations and trigger a new
deployment. volumeConfigurations is only supported for REPLICA service and not DAEMON
service. If you leave volumeConfigurations null, it doesn't trigger a new deployment. For
more infomation on volumes, see Amazon EBS volumes in the Amazon Elastic Container Service
Developer Guide. For services using the blue/green (CODE_DEPLOY) deployment controller,
only the desired count, deployment configuration, health check grace period, task placement
constraints and strategies, enable ECS managed tags option, and propagate tags can be
updated using this API. If the network configuration, platform version, task definition, or
load balancer need to be updated, create a new CodeDeploy deployment. For more information,
see CreateDeployment in the CodeDeploy API Reference. For services using an external
deployment controller, you can update only the desired count, task placement constraints
and strategies, health check grace period, enable ECS managed tags option, and propagate
tags option, using this API. If the launch type, load balancer, network configuration,
platform version, or task definition need to be updated, create a new task set For more
information, see CreateTaskSet. You can add to or subtract from the number of
instantiations of a task definition in a service by specifying the cluster that the service
is running in and a new desiredCount parameter. You can attach Amazon EBS volumes to Amazon
ECS tasks by configuring the volume when starting or running a task, or when creating or
updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic
Container Service Developer Guide. If you have updated the container image of your
application, you can create a new task definition with that image and deploy it to your
service. The service scheduler uses the minimum healthy percent and maximum percent
parameters (in the service's deployment configuration) to determine the deployment
strategy. If your updated Docker image uses the same tag as what is in the existing task
definition for your service (for example, my_image:latest), you don't need to create a new
revision of your task definition. You can update the service using the forceNewDeployment
option. The new tasks launched by the deployment pull the current image/tag combination
from your repository when they start. You can also update the deployment configuration of
a service. When a deployment is triggered by updating the task definition of a service, the
service scheduler uses the deployment configuration parameters, minimumHealthyPercent and
maximumPercent, to determine the deployment strategy. If minimumHealthyPercent is below
100%, the scheduler can ignore desiredCount temporarily during a deployment. For example,
if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing
tasks before starting two new tasks. Tasks for services that don't use a load balancer are
considered healthy if they're in the RUNNING state. Tasks for services that use a load
balancer are considered healthy if they're in the RUNNING state and are reported as healthy
by the load balancer. The maximumPercent parameter represents an upper limit on the
number of running tasks during a deployment. You can use it to define the deployment batch
size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks
before stopping the four older tasks (provided that the cluster resources required to do
this are available). When UpdateService stops a task during a deployment, the equivalent
of docker stop is issued to the containers running in the task. This results in a SIGTERM
and a 30-second timeout. After this, SIGKILL is sent and the containers are forcibly
stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from
receiving it, no SIGKILL is sent. When the service scheduler launches new tasks, it
determines task placement in your cluster with the following logic. Determine which of
the container instances in your cluster can support your service's task definition. For
example, they have the required CPU, memory, ports, and container instance attributes. By
default, the service scheduler attempts to balance tasks across Availability Zones in this
manner even though you can choose a different placement strategy. Sort the valid
container instances by the fewest number of running tasks for this service in the same
Availability Zone as the instance. For example, if zone A has one running service task and
zones B and C each have zero, valid container instances in either zone B or C are
considered optimal for placement. Place the new service task on a valid container
instance in an optimal Availability Zone (based on the previous steps), favoring container
instances with the fewest number of running tasks for this service. When the service
scheduler stops running tasks, it attempts to maintain balance across the Availability
Zones in your cluster using the following logic: Sort the container instances by the
largest number of running tasks for this service in the same Availability Zone as the
instance. For example, if zone A has one running service task and zones B and C each have
two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the
previous steps), favoring container instances with the largest number of running tasks for
this service. You must have a service-linked role when you update any of the following
service properties: loadBalancers, serviceRegistries For more information about
the role see the CreateService request parameter role .
# Arguments
- `service`: The name of the service to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"capacityProviderStrategy"`: The capacity provider strategy to update the service to
use. if the service uses the default capacity provider strategy for the cluster, the
service can be updated to use one or more capacity providers as opposed to the default
capacity provider strategy. However, when a service is using a capacity provider strategy
that's not the default capacity provider strategy, the service can't be updated to use the
cluster's default capacity provider strategy. A capacity provider strategy consists of one
or more capacity providers along with the base and weight to assign to them. A capacity
provider must be associated with the cluster to be used in a capacity provider strategy.
The PutClusterCapacityProviders API is used to associate a capacity provider with a
cluster. Only capacity providers with an ACTIVE or UPDATING status can be used. If
specifying a capacity provider that uses an Auto Scaling group, the capacity provider must
already be created. New capacity providers can be created with the CreateCapacityProvider
API operation. To use a Fargate capacity provider, specify either the FARGATE or
FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all
accounts and only need to be associated with a cluster to be used. The
PutClusterCapacityProviders API operation is used to update the list of available capacity
providers for a cluster after the cluster is created.
- `"cluster"`: The short name or full Amazon Resource Name (ARN) of the cluster that your
service runs on. If you do not specify a cluster, the default cluster is assumed.
- `"deploymentConfiguration"`: Optional deployment parameters that control how many tasks
run during the deployment and the ordering of stopping and starting tasks.
- `"desiredCount"`: The number of instantiations of the task to place and keep running in
your service.
- `"enableECSManagedTags"`: Determines whether to turn on Amazon ECS managed tags for the
tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the
Amazon Elastic Container Service Developer Guide. Only tasks launched after the update will
reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so
that Amazon ECS starts new tasks with the updated tags.
- `"enableExecuteCommand"`: If true, this enables execute command functionality on all task
containers. If you do not want to override the value that was set when the service was
created, you can set this to null when performing this action.
- `"forceNewDeployment"`: Determines whether to force a new deployment of the service. By
default, deployments aren't forced. You can use this option to start a new deployment with
no service definition changes. For example, you can update a service's tasks to use a newer
Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks
onto a newer platform version.
- `"healthCheckGracePeriodSeconds"`: The period of time, in seconds, that the Amazon ECS
service scheduler ignores unhealthy Elastic Load Balancing target health checks after a
task has first started. This is only valid if your service is configured to use a load
balancer. If your service's tasks take a while to start and respond to Elastic Load
Balancing health checks, you can specify a health check grace period of up to 2,147,483,647
seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load
Balancing health check status. This grace period can prevent the ECS service scheduler from
marking tasks as unhealthy and stopping them before they have time to come up.
- `"loadBalancers"`: A list of Elastic Load Balancing load balancer objects. It contains
the load balancer name, the container name, and the container port to access from the load
balancer. The container name is as it appears in a container definition. When you add,
update, or remove a load balancer configuration, Amazon ECS starts new tasks with the
updated Elastic Load Balancing configuration, and then stops the old tasks when the new
tasks are running. For services that use rolling updates, you can add, update, or remove
Elastic Load Balancing target groups. You can update from a single target group to multiple
target groups and from multiple target groups to a single target group. For services that
use blue/green deployments, you can update Elastic Load Balancing target groups by using
CreateDeployment through CodeDeploy. Note that multiple target groups are not supported
for blue/green deployments. For more information see Register multiple target groups with a
service in the Amazon Elastic Container Service Developer Guide. For services that use the
external deployment controller, you can add, update, or remove load balancers by using
CreateTaskSet. Note that multiple target groups are not supported for external deployments.
For more information see Register multiple target groups with a service in the Amazon
Elastic Container Service Developer Guide. You can remove existing loadBalancers by
passing an empty list.
- `"networkConfiguration"`: An object representing the network configuration for the
service.
- `"placementConstraints"`: An array of task placement constraint objects to update the
service to use. If no value is specified, the existing placement constraints for the
service will remain unchanged. If this value is specified, it will override any existing
placement constraints defined for the service. To remove all existing placement
constraints, specify an empty array. You can specify a maximum of 10 constraints for each
task. This limit includes constraints in the task definition and those specified at runtime.
- `"placementStrategy"`: The task placement strategy objects to update the service to use.
If no value is specified, the existing placement strategy for the service will remain
unchanged. If this value is specified, it will override the existing placement strategy
defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules for each service.
- `"platformVersion"`: The platform version that your tasks in the service run on. A
platform version is only specified for tasks using the Fargate launch type. If a platform
version is not specified, the LATEST platform version is used. For more information, see
Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
- `"propagateTags"`: Determines whether to propagate the tags from the task definition or
the service to the task. If no value is specified, the tags aren't propagated. Only tasks
launched after the update will reflect the update. To update the tags on all tasks, set
forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.
- `"serviceConnectConfiguration"`: The configuration for this service to discover and
connect to services, and be discovered by, and connected from, other services within a
namespace. Tasks that run in a namespace can use short names to connect to services in the
namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks
connect through a managed proxy container that collects logs and metrics for increased
visibility. Only the tasks that Amazon ECS services create are supported with Service
Connect. For more information, see Service Connect in the Amazon Elastic Container Service
Developer Guide.
- `"serviceRegistries"`: The details for the service discovery registries to assign to this
service. For more information, see Service Discovery. When you add, update, or remove the
service registries configuration, Amazon ECS starts new tasks with the updated service
registries configuration, and then stops the old tasks when the new tasks are running. You
can remove existing serviceRegistries by passing an empty list.
- `"taskDefinition"`: The family and revision (family:revision) or full ARN of the task
definition to run in your service. If a revision is not specified, the latest ACTIVE
revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a
task with the new version of the task definition and then stops an old task after the new
version is running.
- `"volumeConfigurations"`: The details of the volume that was configuredAtLaunch. You can
configure the size, volumeType, IOPS, throughput, snapshot and encryption in
ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the
task definition. If set to null, no new deployment is triggered. Otherwise, if this
configuration differs from the existing one, it triggers a new deployment.
"""
function update_service(service; aws_config::AbstractAWSConfig=global_aws_config())
return ecs(
"UpdateService",
Dict{String,Any}("service" => service);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service(
service, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"UpdateService",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("service" => service), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_primary_task_set(cluster, primary_task_set, service)
update_service_primary_task_set(cluster, primary_task_set, service, params::Dict{String,<:Any})
Modifies which task set in a service is the primary task set. Any parameters that are
updated on the primary task set in a service will transition to the service. This is used
when a service uses the EXTERNAL deployment controller type. For more information, see
Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
# Arguments
- `cluster`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the service that the task set exists in.
- `primary_task_set`: The short name or full Amazon Resource Name (ARN) of the task set to
set as the primary task set in the deployment.
- `service`: The short name or full Amazon Resource Name (ARN) of the service that the task
set exists in.
"""
function update_service_primary_task_set(
cluster, primaryTaskSet, service; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"UpdateServicePrimaryTaskSet",
Dict{String,Any}(
"cluster" => cluster, "primaryTaskSet" => primaryTaskSet, "service" => service
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_primary_task_set(
cluster,
primaryTaskSet,
service,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"UpdateServicePrimaryTaskSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"cluster" => cluster,
"primaryTaskSet" => primaryTaskSet,
"service" => service,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_task_protection(cluster, protection_enabled, tasks)
update_task_protection(cluster, protection_enabled, tasks, params::Dict{String,<:Any})
Updates the protection status of a task. You can set protectionEnabled to true to protect
your task from termination during scale-in events from Service Autoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the
protectionEnabled property making the task eligible for termination by a subsequent
scale-in event. You can specify a custom expiration period for task protection from 1
minute to up to 2,880 minutes (48 hours). To specify the custom expiration period, set the
expiresInMinutes property. The expiresInMinutes property is always reset when you invoke
this operation for a task that already has protectionEnabled set to true. You can keep
extending the protection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon
Elastic Container Service Developer Guide . This operation is only supported for tasks
belonging to an Amazon ECS service. Invoking this operation for a standalone task will
result in an TASK_NOT_VALID failure. For more information, see API failure reasons. If
you prefer to set task protection from within the container, we recommend using the Task
scale-in protection endpoint.
# Arguments
- `cluster`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the service that the task sets exist in.
- `protection_enabled`: Specify true to mark a task for protection and false to unset
protection, making it eligible for termination.
- `tasks`: A list of up to 10 task IDs or full ARN entries.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expiresInMinutes"`: If you set protectionEnabled to true, you can specify the duration
for task protection in minutes. You can specify a value from 1 minute to up to 2,880
minutes (48 hours). During this time, your task will not be terminated by scale-in events
from Service Auto Scaling or deployments. After this time period lapses, protectionEnabled
will be reset to false. If you don’t specify the time, then the task is automatically
protected for 120 minutes (2 hours).
"""
function update_task_protection(
cluster, protectionEnabled, tasks; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"UpdateTaskProtection",
Dict{String,Any}(
"cluster" => cluster, "protectionEnabled" => protectionEnabled, "tasks" => tasks
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_task_protection(
cluster,
protectionEnabled,
tasks,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"UpdateTaskProtection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"cluster" => cluster,
"protectionEnabled" => protectionEnabled,
"tasks" => tasks,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_task_set(cluster, scale, service, task_set)
update_task_set(cluster, scale, service, task_set, params::Dict{String,<:Any})
Modifies a task set. This is used when a service uses the EXTERNAL deployment controller
type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container
Service Developer Guide.
# Arguments
- `cluster`: The short name or full Amazon Resource Name (ARN) of the cluster that hosts
the service that the task set is found in.
- `scale`: A floating-point percentage of the desired number of tasks to place and keep
running in the task set.
- `service`: The short name or full Amazon Resource Name (ARN) of the service that the task
set is found in.
- `task_set`: The short name or full Amazon Resource Name (ARN) of the task set to update.
"""
function update_task_set(
cluster, scale, service, taskSet; aws_config::AbstractAWSConfig=global_aws_config()
)
return ecs(
"UpdateTaskSet",
Dict{String,Any}(
"cluster" => cluster,
"scale" => scale,
"service" => service,
"taskSet" => taskSet,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_task_set(
cluster,
scale,
service,
taskSet,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return ecs(
"UpdateTaskSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"cluster" => cluster,
"scale" => scale,
"service" => service,
"taskSet" => taskSet,
),
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 | 70634 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: efs
using AWS.Compat
using AWS.UUIDs
"""
create_access_point(client_token, file_system_id)
create_access_point(client_token, file_system_id, params::Dict{String,<:Any})
Creates an EFS access point. An access point is an application-specific view into an EFS
file system that applies an operating system user and group, and a file system path, to any
file system request made through the access point. The operating system user and group
override any identity information provided by the NFS client. The file system path is
exposed as the access point's root directory. Applications using the access point can only
access data in the application's own directory and any subdirectories. To learn more, see
Mounting a file system using EFS access points. If multiple requests to create access
points on the same file system are sent in quick succession, and the file system is near
the limit of 1,000 access points, you may experience a throttling response for these
requests. This is to ensure that the file system does not exceed the stated access point
limit. This operation requires permissions for the elasticfilesystem:CreateAccessPoint
action. Access points can be tagged on creation. If tags are specified in the creation
action, IAM performs additional authorization on the elasticfilesystem:TagResource action
to verify if users have permissions to create tags. Therefore, you must grant explicit
permissions to use the elasticfilesystem:TagResource action. For more information, see
Granting permissions to tag resources during creation.
# Arguments
- `client_token`: A string of up to 64 ASCII characters that Amazon EFS uses to ensure
idempotent creation.
- `file_system_id`: The ID of the EFS file system that the access point provides access to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PosixUser"`: The operating system user and group applied to all file system requests
made using the access point.
- `"RootDirectory"`: Specifies the directory on the EFS file system that the access point
exposes as the root directory of your file system to NFS clients using the access point.
The clients using the access point can only access the root directory and below. If the
RootDirectory > Path specified does not exist, Amazon EFS creates it and applies the
CreationInfo settings when a client connects to an access point. When specifying a
RootDirectory, you must provide the Path, and the CreationInfo. Amazon EFS creates a root
directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for
the directory. If you do not provide this information, Amazon EFS does not create the root
directory. If the root directory does not exist, attempts to mount using the access point
will fail.
- `"Tags"`: Creates tags associated with the access point. Each tag is a key-value pair,
each key must be unique. For more information, see Tagging Amazon Web Services resources in
the Amazon Web Services General Reference Guide.
"""
function create_access_point(
ClientToken, FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"POST",
"/2015-02-01/access-points",
Dict{String,Any}("ClientToken" => ClientToken, "FileSystemId" => FileSystemId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_point(
ClientToken,
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"POST",
"/2015-02-01/access-points",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken, "FileSystemId" => FileSystemId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_file_system(creation_token)
create_file_system(creation_token, params::Dict{String,<:Any})
Creates a new, empty file system. The operation requires a creation token in the request
that Amazon EFS uses to ensure idempotent creation (calling the operation with same
creation token has no effect). If a file system does not currently exist that is owned by
the caller's Amazon Web Services account with the specified creation token, this operation
does the following: Creates a new, empty file system. The file system will have an Amazon
EFS assigned ID, and an initial lifecycle state creating. Returns with the description of
the created file system. Otherwise, this operation returns a FileSystemAlreadyExists
error with the ID of the existing file system. For basic use cases, you can use a randomly
generated UUID for the creation token. The idempotent operation allows you to retry a
CreateFileSystem call without risk of creating an extra file system. This can happen when
an initial call fails in a way that leaves it uncertain whether or not a file system was
actually created. An example might be that a transport level timeout occurred or your
connection was reset. As long as you use the same creation token, if the initial call had
succeeded in creating a file system, the client can learn of its existence from the
FileSystemAlreadyExists error. For more information, see Creating a file system in the
Amazon EFS User Guide. The CreateFileSystem call returns while the file system's lifecycle
state is still creating. You can check the file system creation status by calling the
DescribeFileSystems operation, which among other things returns the file system state.
This operation accepts an optional PerformanceMode parameter that you choose for your file
system. We recommend generalPurpose performance mode for all file systems. File systems
using the maxIO mode is a previous generation performance type that is designed for highly
parallelized workloads that can tolerate higher latencies than the General Purpose mode.
Max I/O mode is not supported for One Zone file systems or file systems that use Elastic
throughput. Due to the higher per-operation latencies with Max I/O, we recommend using
General Purpose performance mode for all file systems. The performance mode can't be
changed after the file system has been created. For more information, see Amazon EFS
performance modes. You can set the throughput mode for the file system using the
ThroughputMode parameter. After the file system is fully created, Amazon EFS sets its
lifecycle state to available, at which point you can create one or more mount targets for
the file system in your VPC. For more information, see CreateMountTarget. You mount your
Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more
information, see Amazon EFS: How it Works. This operation requires permissions for the
elasticfilesystem:CreateFileSystem action. File systems can be tagged on creation. If tags
are specified in the creation action, IAM performs additional authorization on the
elasticfilesystem:TagResource action to verify if users have permissions to create tags.
Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource
action. For more information, see Granting permissions to tag resources during creation.
# Arguments
- `creation_token`: A string of up to 64 ASCII characters. Amazon EFS uses this to ensure
idempotent creation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZoneName"`: Used to create a One Zone file system. It specifies the Amazon
Web Services Availability Zone in which to create the file system. Use the format
us-east-1a to specify the Availability Zone. For more information about One Zone file
systems, see Using EFS storage classes in the Amazon EFS User Guide. One Zone file systems
are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS
is available.
- `"Backup"`: Specifies whether automatic backups are enabled on the file system that you
are creating. Set the value to true to enable automatic backups. If you are creating a One
Zone file system, automatic backups are enabled by default. For more information, see
Automatic backups in the Amazon EFS User Guide. Default is false. However, if you specify
an AvailabilityZoneName, the default is true. Backup is not available in all Amazon Web
Services Regions where Amazon EFS is available.
- `"Encrypted"`: A Boolean value that, if true, creates an encrypted file system. When
creating an encrypted file system, you have the option of specifying an existing Key
Management Service key (KMS key). If you don't specify a KMS key, then the default KMS key
for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
- `"KmsKeyId"`: The ID of the KMS key that you want to use to protect the encrypted file
system. This parameter is required only if you want to use a non-default KMS key. If this
parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a
KMS key ID using the following formats: Key ID - A unique identifier of the key, for
example 1234abcd-12ab-34cd-56ef-1234567890ab. ARN - An Amazon Resource Name (ARN) for the
key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. Key alias -
A previously created display name for a key, for example alias/projectKey1. Key alias ARN
- An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
If you use KmsKeyId, you must set the CreateFileSystemRequestEncrypted parameter to true.
EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS
file systems.
- `"PerformanceMode"`: The Performance mode of the file system. We recommend generalPurpose
performance mode for all file systems. File systems using the maxIO performance mode can
scale to higher levels of aggregate throughput and operations per second with a tradeoff of
slightly higher latencies for most file operations. The performance mode can't be changed
after the file system has been created. The maxIO mode is not supported on One Zone file
systems. Due to the higher per-operation latencies with Max I/O, we recommend using
General Purpose performance mode for all file systems. Default is generalPurpose.
- `"ProvisionedThroughputInMibps"`: The throughput, measured in mebibytes per second
(MiBps), that you want to provision for a file system that you're creating. Required if
ThroughputMode is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit
depending on Region. To increase this limit, contact Amazon Web Services Support. For more
information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
- `"Tags"`: Use to create one or more tags associated with the file system. Each tag is a
user-defined key-value pair. Name your file system on creation by including a
\"Key\":\"Name\",\"Value\":\"{value}\" key-value pair. Each key must be unique. For more
information, see Tagging Amazon Web Services resources in the Amazon Web Services General
Reference Guide.
- `"ThroughputMode"`: Specifies the throughput mode for the file system. The mode can be
bursting, provisioned, or elastic. If you set ThroughputMode to provisioned, you must also
set a value for ProvisionedThroughputInMibps. After you create the file system, you can
decrease your file system's Provisioned throughput or change between the throughput modes,
with certain time restrictions. For more information, see Specifying throughput with
provisioned mode in the Amazon EFS User Guide. Default is bursting.
"""
function create_file_system(
CreationToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"POST",
"/2015-02-01/file-systems",
Dict{String,Any}("CreationToken" => CreationToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_file_system(
CreationToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"POST",
"/2015-02-01/file-systems",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CreationToken" => CreationToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_mount_target(file_system_id, subnet_id)
create_mount_target(file_system_id, subnet_id, params::Dict{String,<:Any})
Creates a mount target for a file system. You can then mount the file system on EC2
instances by using the mount target. You can create one mount target in each Availability
Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a
single mount target for a given file system. If you have multiple subnets in an
Availability Zone, you create a mount target in one of the subnets. EC2 instances do not
need to be in the same subnet as the mount target in order to access their file system. You
can create only one mount target for a One Zone file system. You must create that mount
target in the same Availability Zone in which the file system is located. Use the
AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response
object to get this information. Use the subnetId associated with the file system's
Availability Zone when creating the mount target. For more information, see Amazon EFS: How
it Works. To create a mount target for a file system, the file system's lifecycle state
must be available. For more information, see DescribeFileSystems. In the request, provide
the following: The file system ID for which you are creating the mount target. A subnet
ID, which determines the following: The VPC in which Amazon EFS creates the mount target
The Availability Zone in which Amazon EFS creates the mount target The IP address range
from which Amazon EFS selects the IP address of the mount target (if you don't specify an
IP address in the request) After creating the mount target, Amazon EFS returns a
response that includes, a MountTargetId and an IpAddress. You use this IP address when
mounting the file system in an EC2 instance. You can also use the mount target's DNS name
when mounting the file system. The EC2 instance on which you mount the file system by using
the mount target can resolve the mount target's DNS name to its IP address. For more
information, see How it Works: Implementation Overview. Note that you can create mount
targets for a file system in only one VPC, and there can be only one mount target per
Availability Zone. That is, if the file system already has one or more mount targets
created for it, the subnet specified in the request to add another mount target must meet
the following requirements: Must belong to the same VPC as the subnets of the existing
mount targets Must not be in the same Availability Zone as any of the subnets of the
existing mount targets If the request satisfies the requirements, Amazon EFS does the
following: Creates a new mount target in the specified subnet. Also creates a new
network interface in the subnet as follows: If the request provides an IpAddress, Amazon
EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free
address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does
when a request does not specify a primary private IP address). If the request provides
SecurityGroups, this network interface is associated with those security groups. Otherwise,
it belongs to the default security group for the subnet's VPC. Assigns the description
Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and
fs-id is the FileSystemId. Sets the requesterManaged property of the network interface
to true, and the requesterId value to EFS. Each Amazon EFS mount target has one
corresponding requester-managed EC2 network interface. After the network interface is
created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to
the network interface ID, and the IpAddress field to its address. If network interface
creation fails, the entire CreateMountTarget operation fails. The CreateMountTarget call
returns only after creating the network interface, but while the mount target state is
still creating, you can check the mount target creation status by calling the
DescribeMountTargets operation, which among other things returns the mount target state.
We recommend that you create a mount target in each of the Availability Zones. There are
cost considerations for using a file system in an Availability Zone through a mount target
created in another Availability Zone. For more information, see Amazon EFS. In addition, by
always using a mount target local to the instance's Availability Zone, you eliminate a
partial failure scenario. If the Availability Zone in which your mount target is created
goes down, then you can't access your file system through that mount target. This
operation requires permissions for the following action on the file system:
elasticfilesystem:CreateMountTarget This operation also requires permissions for the
following Amazon EC2 actions: ec2:DescribeSubnets ec2:DescribeNetworkInterfaces
ec2:CreateNetworkInterface
# Arguments
- `file_system_id`: The ID of the file system for which to create the mount target.
- `subnet_id`: The ID of the subnet to add the mount target in. For One Zone file systems,
use the subnet that is associated with the file system's Availability Zone.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IpAddress"`: Valid IPv4 address within the address range of the specified subnet.
- `"SecurityGroups"`: Up to five VPC security group IDs, of the form sg-xxxxxxxx. These
must be for the same VPC as subnet specified.
"""
function create_mount_target(
FileSystemId, SubnetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"POST",
"/2015-02-01/mount-targets",
Dict{String,Any}("FileSystemId" => FileSystemId, "SubnetId" => SubnetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_mount_target(
FileSystemId,
SubnetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"POST",
"/2015-02-01/mount-targets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FileSystemId" => FileSystemId, "SubnetId" => SubnetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_replication_configuration(destinations, source_file_system_id)
create_replication_configuration(destinations, source_file_system_id, params::Dict{String,<:Any})
Creates a replication configuration that replicates an existing EFS file system to a new,
read-only file system. For more information, see Amazon EFS replication in the Amazon EFS
User Guide. The replication configuration specifies the following: Source file system
– The EFS file system that you want replicated. The source file system cannot be a
destination file system in an existing replication configuration. Amazon Web Services
Region – The Amazon Web Services Region in which the destination file system is created.
Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is
available. The Region must be enabled. For more information, see Managing Amazon Web
Services Regions in the Amazon Web Services General Reference Reference Guide.
Destination file system configuration – The configuration of the destination file system
to which the source file system will be replicated. There can only be one destination file
system in a replication configuration. Parameters for the replication configuration
include: File system ID – The ID of the destination file system for the replication.
If no ID is provided, then EFS creates a new file system with the default settings. For
existing file systems, the file system's replication overwrite protection must be disabled.
For more information, see Replicating to an existing file system. Availability Zone –
If you want the destination file system to use One Zone storage, you must specify the
Availability Zone to create the file system in. For more information, see EFS file system
types in the Amazon EFS User Guide. Encryption – All destination file systems are
created with encryption at rest enabled. You can specify the Key Management Service (KMS)
key that is used to encrypt the destination file system. If you don't specify a KMS key,
your service-managed KMS key for Amazon EFS is used. After the file system is created,
you cannot change the KMS key. After the file system is created, you cannot change
the KMS key. For new destination file systems, the following properties are set by
default: Performance mode - The destination file system's performance mode matches that
of the source file system, unless the destination file system uses EFS One Zone storage. In
that case, the General Purpose performance mode is used. The performance mode cannot be
changed. Throughput mode - The destination file system's throughput mode matches that of
the source file system. After the file system is created, you can modify the throughput
mode. Lifecycle management – Lifecycle management is not enabled on the destination
file system. After the destination file system is created, you can enable lifecycle
management. Automatic backups – Automatic daily backups are enabled on the destination
file system. After the file system is created, you can change this setting. For more
information, see Amazon EFS replication in the Amazon EFS User Guide.
# Arguments
- `destinations`: An array of destination configuration objects. Only one destination
configuration object is supported.
- `source_file_system_id`: Specifies the Amazon EFS file system that you want to replicate.
This file system cannot already be a source or destination file system in another
replication configuration.
"""
function create_replication_configuration(
Destinations, SourceFileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"POST",
"/2015-02-01/file-systems/$(SourceFileSystemId)/replication-configuration",
Dict{String,Any}("Destinations" => Destinations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replication_configuration(
Destinations,
SourceFileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"POST",
"/2015-02-01/file-systems/$(SourceFileSystemId)/replication-configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Destinations" => Destinations), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_tags(file_system_id, tags)
create_tags(file_system_id, tags, params::Dict{String,<:Any})
DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS
resources, use the API action. Creates or overwrites tags associated with a file system.
Each tag is a key-value pair. If a tag key specified in the request already exists on the
file system, this operation overwrites its value with the value provided in the request. If
you add the Name tag to your file system, Amazon EFS returns it in the response to the
DescribeFileSystems operation. This operation requires permission for the
elasticfilesystem:CreateTags action.
# Arguments
- `file_system_id`: The ID of the file system whose tags you want to modify (String). This
operation modifies the tags only, not the file system.
- `tags`: An array of Tag objects to add. Each Tag object is a key-value pair.
"""
function create_tags(FileSystemId, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return efs(
"POST",
"/2015-02-01/create-tags/$(FileSystemId)",
Dict{String,Any}("Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_tags(
FileSystemId,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"POST",
"/2015-02-01/create-tags/$(FileSystemId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Tags" => Tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_point(access_point_id)
delete_access_point(access_point_id, params::Dict{String,<:Any})
Deletes the specified access point. After deletion is complete, new clients can no longer
connect to the access points. Clients connected to the access point at the time of deletion
will continue to function until they terminate their connection. This operation requires
permissions for the elasticfilesystem:DeleteAccessPoint action.
# Arguments
- `access_point_id`: The ID of the access point that you want to delete.
"""
function delete_access_point(
AccessPointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"DELETE",
"/2015-02-01/access-points/$(AccessPointId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_point(
AccessPointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"DELETE",
"/2015-02-01/access-points/$(AccessPointId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_file_system(file_system_id)
delete_file_system(file_system_id, params::Dict{String,<:Any})
Deletes a file system, permanently severing access to its contents. Upon return, the file
system no longer exists and you can't access any contents of the deleted file system. You
need to manually delete mount targets attached to a file system before you can delete an
EFS file system. This step is performed for you when you use the Amazon Web Services
console to delete a file system. You cannot delete a file system that is part of an EFS
Replication configuration. You need to delete the replication configuration first. You
can't delete a file system that is in use. That is, if the file system has any mount
targets, you must first delete them. For more information, see DescribeMountTargets and
DeleteMountTarget. The DeleteFileSystem call returns while the file system state is still
deleting. You can check the file system deletion status by calling the DescribeFileSystems
operation, which returns a list of file systems in your account. If you pass file system ID
or creation token for the deleted file system, the DescribeFileSystems returns a 404
FileSystemNotFound error. This operation requires permissions for the
elasticfilesystem:DeleteFileSystem action.
# Arguments
- `file_system_id`: The ID of the file system you want to delete.
"""
function delete_file_system(FileSystemId; aws_config::AbstractAWSConfig=global_aws_config())
return efs(
"DELETE",
"/2015-02-01/file-systems/$(FileSystemId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_file_system(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"DELETE",
"/2015-02-01/file-systems/$(FileSystemId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_file_system_policy(file_system_id)
delete_file_system_policy(file_system_id, params::Dict{String,<:Any})
Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy
goes into effect once the existing policy is deleted. For more information about the
default file system policy, see Using Resource-based Policies with EFS. This operation
requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action.
# Arguments
- `file_system_id`: Specifies the EFS file system for which to delete the FileSystemPolicy.
"""
function delete_file_system_policy(
FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"DELETE",
"/2015-02-01/file-systems/$(FileSystemId)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_file_system_policy(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"DELETE",
"/2015-02-01/file-systems/$(FileSystemId)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_mount_target(mount_target_id)
delete_mount_target(mount_target_id, params::Dict{String,<:Any})
Deletes the specified mount target. This operation forcibly breaks any mounts of the file
system by using the mount target that is being deleted, which might disrupt instances or
applications using those mounts. To avoid applications getting cut off abruptly, you might
consider unmounting any mounts of the mount target, if feasible. The operation also deletes
the associated network interface. Uncommitted writes might be lost, but breaking a mount
target using this operation does not corrupt the file system itself. The file system you
created remains. You can mount an EC2 instance in your VPC by using another mount target.
This operation requires permissions for the following action on the file system:
elasticfilesystem:DeleteMountTarget The DeleteMountTarget call returns while the mount
target state is still deleting. You can check the mount target deletion by calling the
DescribeMountTargets operation, which returns a list of mount target descriptions for the
given file system. The operation also requires permissions for the following Amazon EC2
action on the mount target's network interface: ec2:DeleteNetworkInterface
# Arguments
- `mount_target_id`: The ID of the mount target to delete (String).
"""
function delete_mount_target(
MountTargetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"DELETE",
"/2015-02-01/mount-targets/$(MountTargetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_mount_target(
MountTargetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"DELETE",
"/2015-02-01/mount-targets/$(MountTargetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replication_configuration(source_file_system_id)
delete_replication_configuration(source_file_system_id, params::Dict{String,<:Any})
Deletes a replication configuration. Deleting a replication configuration ends the
replication process. After a replication configuration is deleted, the destination file
system becomes Writeable and its replication overwrite protection is re-enabled. For more
information, see Delete a replication configuration. This operation requires permissions
for the elasticfilesystem:DeleteReplicationConfiguration action.
# Arguments
- `source_file_system_id`: The ID of the source file system in the replication
configuration.
"""
function delete_replication_configuration(
SourceFileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"DELETE",
"/2015-02-01/file-systems/$(SourceFileSystemId)/replication-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replication_configuration(
SourceFileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"DELETE",
"/2015-02-01/file-systems/$(SourceFileSystemId)/replication-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tags(file_system_id, tag_keys)
delete_tags(file_system_id, tag_keys, params::Dict{String,<:Any})
DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS
resources, use the API action. Deletes the specified tags from a file system. If the
DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't
cause an error. For more information about tags and related restrictions, see Tag
restrictions in the Billing and Cost Management User Guide. This operation requires
permissions for the elasticfilesystem:DeleteTags action.
# Arguments
- `file_system_id`: The ID of the file system whose tags you want to delete (String).
- `tag_keys`: A list of tag keys to delete.
"""
function delete_tags(
FileSystemId, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"POST",
"/2015-02-01/delete-tags/$(FileSystemId)",
Dict{String,Any}("TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tags(
FileSystemId,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"POST",
"/2015-02-01/delete-tags/$(FileSystemId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TagKeys" => TagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_access_points()
describe_access_points(params::Dict{String,<:Any})
Returns the description of a specific Amazon EFS access point if the AccessPointId is
provided. If you provide an EFS FileSystemId, it returns descriptions of all access points
for that file system. You can provide either an AccessPointId or a FileSystemId in the
request, but not both. This operation requires permissions for the
elasticfilesystem:DescribeAccessPoints action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessPointId"`: (Optional) Specifies an EFS access point to describe in the response;
mutually exclusive with FileSystemId.
- `"FileSystemId"`: (Optional) If you provide a FileSystemId, EFS returns all access points
for that file system; mutually exclusive with AccessPointId.
- `"MaxResults"`: (Optional) When retrieving all access points for a file system, you can
optionally specify the MaxItems parameter to limit the number of objects returned in a
response. The default value is 100.
- `"NextToken"`: NextToken is present if the response is paginated. You can use NextMarker
in the subsequent request to fetch the next page of access point descriptions.
"""
function describe_access_points(; aws_config::AbstractAWSConfig=global_aws_config())
return efs(
"GET",
"/2015-02-01/access-points";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_access_points(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/access-points",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_preferences()
describe_account_preferences(params::Dict{String,<:Any})
Returns the account preferences settings for the Amazon Web Services account associated
with the user making the request, in the current Amazon Web Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: (Optional) When retrieving account preferences, you can optionally
specify the MaxItems parameter to limit the number of objects returned in a response. The
default value is 100.
- `"NextToken"`: (Optional) You can use NextToken in a subsequent request to fetch the next
page of Amazon Web Services account preferences if the response payload was paginated.
"""
function describe_account_preferences(; aws_config::AbstractAWSConfig=global_aws_config())
return efs(
"GET",
"/2015-02-01/account-preferences";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_account_preferences(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/account-preferences",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_backup_policy(file_system_id)
describe_backup_policy(file_system_id, params::Dict{String,<:Any})
Returns the backup policy for the specified EFS file system.
# Arguments
- `file_system_id`: Specifies which EFS file system for which to retrieve the BackupPolicy.
"""
function describe_backup_policy(
FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/file-systems/$(FileSystemId)/backup-policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_backup_policy(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"GET",
"/2015-02-01/file-systems/$(FileSystemId)/backup-policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_file_system_policy(file_system_id)
describe_file_system_policy(file_system_id, params::Dict{String,<:Any})
Returns the FileSystemPolicy for the specified EFS file system. This operation requires
permissions for the elasticfilesystem:DescribeFileSystemPolicy action.
# Arguments
- `file_system_id`: Specifies which EFS file system to retrieve the FileSystemPolicy for.
"""
function describe_file_system_policy(
FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/file-systems/$(FileSystemId)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_file_system_policy(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"GET",
"/2015-02-01/file-systems/$(FileSystemId)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_file_systems()
describe_file_systems(params::Dict{String,<:Any})
Returns the description of a specific Amazon EFS file system if either the file system
CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all
file systems owned by the caller's Amazon Web Services account in the Amazon Web Services
Region of the endpoint that you're calling. When retrieving all file system descriptions,
you can optionally specify the MaxItems parameter to limit the number of descriptions in a
response. This number is automatically set to 100. If more file system descriptions remain,
Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should
send a subsequent request with the Marker request parameter set to the value of NextMarker.
To retrieve a list of your file system descriptions, this operation is used in an
iterative process, where DescribeFileSystems is called first without the Marker and then
the operation continues to call it with the Marker parameter set to the value of the
NextMarker from the previous response until the response has no NextMarker. The order of
file systems returned in the response of one DescribeFileSystems call and the order of file
systems returned across the responses of a multi-call iteration is unspecified. This
operation requires permissions for the elasticfilesystem:DescribeFileSystems action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreationToken"`: (Optional) Restricts the list to the file system with this creation
token (String). You specify a creation token when you create an Amazon EFS file system.
- `"FileSystemId"`: (Optional) ID of the file system whose description you want to retrieve
(String).
- `"Marker"`: (Optional) Opaque pagination token returned from a previous
DescribeFileSystems operation (String). If present, specifies to continue the list from
where the returning call had left off.
- `"MaxItems"`: (Optional) Specifies the maximum number of file systems to return in the
response (integer). This number is automatically set to 100. The response is paginated at
100 per page if you have more than 100 file systems.
"""
function describe_file_systems(; aws_config::AbstractAWSConfig=global_aws_config())
return efs(
"GET",
"/2015-02-01/file-systems";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_file_systems(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/file-systems",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_lifecycle_configuration(file_system_id)
describe_lifecycle_configuration(file_system_id, params::Dict{String,<:Any})
Returns the current LifecycleConfiguration object for the specified Amazon EFS file system.
Lifecycle management uses the LifecycleConfiguration object to identify when to move files
between storage classes. For a file system without a LifecycleConfiguration object, the
call returns an empty array in the response. This operation requires permissions for the
elasticfilesystem:DescribeLifecycleConfiguration operation.
# Arguments
- `file_system_id`: The ID of the file system whose LifecycleConfiguration object you want
to retrieve (String).
"""
function describe_lifecycle_configuration(
FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/file-systems/$(FileSystemId)/lifecycle-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_lifecycle_configuration(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"GET",
"/2015-02-01/file-systems/$(FileSystemId)/lifecycle-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_mount_target_security_groups(mount_target_id)
describe_mount_target_security_groups(mount_target_id, params::Dict{String,<:Any})
Returns the security groups currently in effect for a mount target. This operation requires
that the network interface of the mount target has been created and the lifecycle state of
the mount target is not deleted. This operation requires permissions for the following
actions: elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount
target's file system. ec2:DescribeNetworkInterfaceAttribute action on the mount
target's network interface.
# Arguments
- `mount_target_id`: The ID of the mount target whose security groups you want to retrieve.
"""
function describe_mount_target_security_groups(
MountTargetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/mount-targets/$(MountTargetId)/security-groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_mount_target_security_groups(
MountTargetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"GET",
"/2015-02-01/mount-targets/$(MountTargetId)/security-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_mount_targets()
describe_mount_targets(params::Dict{String,<:Any})
Returns the descriptions of all the current mount targets, or a specific mount target, for
a file system. When requesting all of the current mount targets, the order of mount targets
returned in the response is unspecified. This operation requires permissions for the
elasticfilesystem:DescribeMountTargets action, on either the file system ID that you
specify in FileSystemId, or on the file system of the mount target that you specify in
MountTargetId.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessPointId"`: (Optional) The ID of the access point whose mount targets that you
want to list. It must be included in your request if a FileSystemId or MountTargetId is not
included in your request. Accepts either an access point ID or ARN as input.
- `"FileSystemId"`: (Optional) ID of the file system whose mount targets you want to list
(String). It must be included in your request if an AccessPointId or MountTargetId is not
included. Accepts either a file system ID or ARN as input.
- `"Marker"`: (Optional) Opaque pagination token returned from a previous
DescribeMountTargets operation (String). If present, it specifies to continue the list from
where the previous returning call left off.
- `"MaxItems"`: (Optional) Maximum number of mount targets to return in the response.
Currently, this number is automatically set to 10, and other values are ignored. The
response is paginated at 100 per page if you have more than 100 mount targets.
- `"MountTargetId"`: (Optional) ID of the mount target that you want to have described
(String). It must be included in your request if FileSystemId is not included. Accepts
either a mount target ID or ARN as input.
"""
function describe_mount_targets(; aws_config::AbstractAWSConfig=global_aws_config())
return efs(
"GET",
"/2015-02-01/mount-targets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_mount_targets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/mount-targets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_configurations()
describe_replication_configurations(params::Dict{String,<:Any})
Retrieves the replication configuration for a specific file system. If a file system is not
specified, all of the replication configurations for the Amazon Web Services account in an
Amazon Web Services Region are retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FileSystemId"`: You can retrieve the replication configuration for a specific file
system by providing its file system ID.
- `"MaxResults"`: (Optional) To limit the number of objects returned in a response, you can
specify the MaxItems parameter. The default value is 100.
- `"NextToken"`: NextToken is present if the response is paginated. You can use NextToken
in a subsequent request to fetch the next page of output.
"""
function describe_replication_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/file-systems/replication-configurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replication_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/file-systems/replication-configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tags(file_system_id)
describe_tags(file_system_id, params::Dict{String,<:Any})
DEPRECATED - The DescribeTags action is deprecated and not maintained. To view tags
associated with EFS resources, use the ListTagsForResource API action. Returns the tags
associated with a file system. The order of tags returned in the response of one
DescribeTags call and the order of tags returned across the responses of a multiple-call
iteration (when using pagination) is unspecified. This operation requires permissions for
the elasticfilesystem:DescribeTags action.
# Arguments
- `file_system_id`: The ID of the file system whose tag set you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: (Optional) An opaque pagination token returned from a previous DescribeTags
operation (String). If present, it specifies to continue the list from where the previous
call left off.
- `"MaxItems"`: (Optional) The maximum number of file system tags to return in the
response. Currently, this number is automatically set to 100, and other values are ignored.
The response is paginated at 100 per page if you have more than 100 tags.
"""
function describe_tags(FileSystemId; aws_config::AbstractAWSConfig=global_aws_config())
return efs(
"GET",
"/2015-02-01/tags/$(FileSystemId)/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tags(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"GET",
"/2015-02-01/tags/$(FileSystemId)/",
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 all tags for a top-level EFS resource. You must provide the ID of the resource that
you want to retrieve the tags for. This operation requires permissions for the
elasticfilesystem:DescribeAccessPoints action.
# Arguments
- `resource_id`: Specifies the EFS resource you want to retrieve tags for. You can retrieve
tags for EFS file systems and access points using this API endpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: (Optional) Specifies the maximum number of tag objects to return in the
response. The default value is 100.
- `"NextToken"`: (Optional) You can use NextToken in a subsequent request to fetch the next
page of access point descriptions if the response payload was paginated.
"""
function list_tags_for_resource(
ResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"GET",
"/2015-02-01/resource-tags/$(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 efs(
"GET",
"/2015-02-01/resource-tags/$(ResourceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_mount_target_security_groups(mount_target_id)
modify_mount_target_security_groups(mount_target_id, params::Dict{String,<:Any})
Modifies the set of security groups in effect for a mount target. When you create a mount
target, Amazon EFS also creates a new network interface. For more information, see
CreateMountTarget. This operation replaces the security groups in effect for the network
interface associated with a mount target, with the SecurityGroups provided in the request.
This operation requires that the network interface of the mount target has been created and
the lifecycle state of the mount target is not deleted. The operation requires permissions
for the following actions: elasticfilesystem:ModifyMountTargetSecurityGroups action on
the mount target's file system. ec2:ModifyNetworkInterfaceAttribute action on the mount
target's network interface.
# Arguments
- `mount_target_id`: The ID of the mount target whose security groups you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SecurityGroups"`: An array of up to five VPC security group IDs.
"""
function modify_mount_target_security_groups(
MountTargetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"PUT",
"/2015-02-01/mount-targets/$(MountTargetId)/security-groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_mount_target_security_groups(
MountTargetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"PUT",
"/2015-02-01/mount-targets/$(MountTargetId)/security-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_account_preferences(resource_id_type)
put_account_preferences(resource_id_type, params::Dict{String,<:Any})
Use this operation to set the account preference in the current Amazon Web Services Region
to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS
file system and mount target resources. All existing resource IDs are not affected by any
changes you make. You can set the ID preference during the opt-in period as EFS transitions
to long resource IDs. For more information, see Managing Amazon EFS resource IDs. Starting
in October, 2021, you will receive an error if you try to set the account preference to use
the short 8 character format resource ID. Contact Amazon Web Services support if you
receive an error and must use short IDs for file system and mount target resources.
# Arguments
- `resource_id_type`: Specifies the EFS resource ID preference to set for the user's Amazon
Web Services account, in the current Amazon Web Services Region, either LONG_ID (17
characters), or SHORT_ID (8 characters). Starting in October, 2021, you will receive an
error when setting the account preference to SHORT_ID. Contact Amazon Web Services support
if you receive an error and must use short IDs for file system and mount target resources.
"""
function put_account_preferences(
ResourceIdType; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"PUT",
"/2015-02-01/account-preferences",
Dict{String,Any}("ResourceIdType" => ResourceIdType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_account_preferences(
ResourceIdType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"PUT",
"/2015-02-01/account-preferences",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceIdType" => ResourceIdType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_backup_policy(backup_policy, file_system_id)
put_backup_policy(backup_policy, file_system_id, params::Dict{String,<:Any})
Updates the file system's backup policy. Use this action to start or stop automatic backups
of the file system.
# Arguments
- `backup_policy`: The backup policy included in the PutBackupPolicy request.
- `file_system_id`: Specifies which EFS file system to update the backup policy for.
"""
function put_backup_policy(
BackupPolicy, FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"PUT",
"/2015-02-01/file-systems/$(FileSystemId)/backup-policy",
Dict{String,Any}("BackupPolicy" => BackupPolicy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_backup_policy(
BackupPolicy,
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"PUT",
"/2015-02-01/file-systems/$(FileSystemId)/backup-policy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BackupPolicy" => BackupPolicy), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_file_system_policy(file_system_id, policy)
put_file_system_policy(file_system_id, policy, params::Dict{String,<:Any})
Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy
is an IAM resource-based policy and can contain multiple policy statements. A file system
always has exactly one file system policy, which can be the default policy or an explicit
policy set or updated using this API operation. EFS file system policies have a 20,000
character limit. When an explicit policy is set, it overrides the default policy. For more
information about the default file system policy, see Default EFS File System Policy. EFS
file system policies have a 20,000 character limit. This operation requires permissions
for the elasticfilesystem:PutFileSystemPolicy action.
# Arguments
- `file_system_id`: The ID of the EFS file system that you want to create or update the
FileSystemPolicy for.
- `policy`: The FileSystemPolicy that you're creating. Accepts a JSON formatted policy
definition. EFS file system policies have a 20,000 character limit. To find out more about
the elements that make up a file system policy, see EFS Resource-based Policies.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BypassPolicyLockoutSafetyCheck"`: (Optional) A boolean that specifies whether or not to
bypass the FileSystemPolicy lockout safety check. The lockout safety check determines
whether the policy in the request will lock out, or prevent, the IAM principal that is
making the request from making future PutFileSystemPolicy requests on this file system. Set
BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal
that is making the request from making subsequent PutFileSystemPolicy requests on this file
system. The default value is False.
"""
function put_file_system_policy(
FileSystemId, Policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"PUT",
"/2015-02-01/file-systems/$(FileSystemId)/policy",
Dict{String,Any}("Policy" => Policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_file_system_policy(
FileSystemId,
Policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"PUT",
"/2015-02-01/file-systems/$(FileSystemId)/policy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Policy" => Policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_lifecycle_configuration(file_system_id, lifecycle_policies)
put_lifecycle_configuration(file_system_id, lifecycle_policies, params::Dict{String,<:Any})
Use this action to manage storage for your file system. A LifecycleConfiguration consists
of one or more LifecyclePolicy objects that define the following: TransitionToIA –
When to move files in the file system from primary storage (Standard storage class) into
the Infrequent Access (IA) storage. TransitionToArchive – When to move files in the
file system from their current storage class (either IA or Standard storage) into the
Archive storage. File systems cannot transition into Archive storage before transitioning
into IA storage. Therefore, TransitionToArchive must either not be set or must be later
than TransitionToIA. The Archive storage class is available only for file systems that
use the Elastic Throughput mode and the General Purpose Performance mode.
TransitionToPrimaryStorageClass – Whether to move files in the file system back to
primary storage (Standard storage class) after they are accessed in IA or Archive storage.
For more information, see Managing file system storage. Each Amazon EFS file system
supports one lifecycle configuration, which applies to all files in the file system. If a
LifecycleConfiguration object already exists for the specified file system, a
PutLifecycleConfiguration call modifies the existing configuration. A
PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body
deletes any existing LifecycleConfiguration. In the request, specify the following: The
ID for the file system for which you are enabling, disabling, or modifying Lifecycle
management. A LifecyclePolicies array of LifecyclePolicy objects that define when to move
files to IA storage, to Archive storage, and back to primary storage. Amazon EFS requires
that each LifecyclePolicy object have only have a single transition, so the
LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See
the example requests in the following section for more information. This operation
requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation. To
apply a LifecycleConfiguration object to an encrypted file system, you need the same Key
Management Service permissions as when you created the encrypted file system.
# Arguments
- `file_system_id`: The ID of the file system for which you are creating the
LifecycleConfiguration object (String).
- `lifecycle_policies`: An array of LifecyclePolicy objects that define the file system's
LifecycleConfiguration object. A LifecycleConfiguration object informs EFS Lifecycle
management of the following: TransitionToIA – When to move files in the file system
from primary storage (Standard storage class) into the Infrequent Access (IA) storage.
TransitionToArchive – When to move files in the file system from their current storage
class (either IA or Standard storage) into the Archive storage. File systems cannot
transition into Archive storage before transitioning into IA storage. Therefore,
TransitionToArchive must either not be set or must be later than TransitionToIA. The
Archive storage class is available only for file systems that use the Elastic Throughput
mode and the General Purpose Performance mode. TransitionToPrimaryStorageClass –
Whether to move files in the file system back to primary storage (Standard storage class)
after they are accessed in IA or Archive storage. When using the
put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon
EFS requires that each LifecyclePolicy object have only a single transition. This means
that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy
objects, one object for each storage transition. See the example requests in the following
section for more information.
"""
function put_lifecycle_configuration(
FileSystemId, LifecyclePolicies; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"PUT",
"/2015-02-01/file-systems/$(FileSystemId)/lifecycle-configuration",
Dict{String,Any}("LifecyclePolicies" => LifecyclePolicies);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_lifecycle_configuration(
FileSystemId,
LifecyclePolicies,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"PUT",
"/2015-02-01/file-systems/$(FileSystemId)/lifecycle-configuration",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LifecyclePolicies" => LifecyclePolicies), 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})
Creates a tag for an EFS resource. You can create tags for EFS file systems and access
points using this API operation. This operation requires permissions for the
elasticfilesystem:TagResource action.
# Arguments
- `resource_id`: The ID specifying the EFS resource that you want to create a tag for.
- `tags`: An array of Tag objects to add. Each Tag object is a key-value pair.
"""
function tag_resource(ResourceId, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return efs(
"POST",
"/2015-02-01/resource-tags/$(ResourceId)",
Dict{String,Any}("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 efs(
"POST",
"/2015-02-01/resource-tags/$(ResourceId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("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 tags from an EFS resource. You can remove tags from EFS file systems and access
points using this API operation. This operation requires permissions for the
elasticfilesystem:UntagResource action.
# Arguments
- `resource_id`: Specifies the EFS resource that you want to remove tags from.
- `tag_keys`: The keys of the key-value tag pairs that you want to remove from the
specified EFS resource.
"""
function untag_resource(
ResourceId, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"DELETE",
"/2015-02-01/resource-tags/$(ResourceId)",
Dict{String,Any}("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 efs(
"DELETE",
"/2015-02-01/resource-tags/$(ResourceId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tagKeys" => tagKeys), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_file_system(file_system_id)
update_file_system(file_system_id, params::Dict{String,<:Any})
Updates the throughput mode or the amount of provisioned throughput of an existing file
system.
# Arguments
- `file_system_id`: The ID of the file system that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ProvisionedThroughputInMibps"`: (Optional) The throughput, measured in mebibytes per
second (MiBps), that you want to provision for a file system that you're creating. Required
if ThroughputMode is set to provisioned. Valid values are 1-3414 MiBps, with the upper
limit depending on Region. To increase this limit, contact Amazon Web Services Support. For
more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
- `"ThroughputMode"`: (Optional) Updates the file system's throughput mode. If you're not
updating your throughput mode, you don't need to provide this value in your request. If you
are changing the ThroughputMode to provisioned, you must also set a value for
ProvisionedThroughputInMibps.
"""
function update_file_system(FileSystemId; aws_config::AbstractAWSConfig=global_aws_config())
return efs(
"PUT",
"/2015-02-01/file-systems/$(FileSystemId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_file_system(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"PUT",
"/2015-02-01/file-systems/$(FileSystemId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_file_system_protection(file_system_id)
update_file_system_protection(file_system_id, params::Dict{String,<:Any})
Updates protection on the file system. This operation requires permissions for the
elasticfilesystem:UpdateFileSystemProtection action.
# Arguments
- `file_system_id`: The ID of the file system to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReplicationOverwriteProtection"`: The status of the file system's replication overwrite
protection. ENABLED – The file system cannot be used as the destination file system in
a replication configuration. The file system is writeable. Replication overwrite protection
is ENABLED by default. DISABLED – The file system can be used as the destination file
system in a replication configuration. The file system is read-only and can only be
modified by EFS replication. REPLICATING – The file system is being used as the
destination file system in a replication configuration. The file system is read-only and is
only modified only by EFS replication. If the replication configuration is deleted, the
file system's replication overwrite protection is re-enabled, the file system becomes
writeable.
"""
function update_file_system_protection(
FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return efs(
"PUT",
"/2015-02-01/file-systems/$(FileSystemId)/protection";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_file_system_protection(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return efs(
"PUT",
"/2015-02-01/file-systems/$(FileSystemId)/protection",
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 | 118873 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: eks
using AWS.Compat
using AWS.UUIDs
"""
associate_access_policy(access_scope, name, policy_arn, principal_arn)
associate_access_policy(access_scope, name, policy_arn, principal_arn, params::Dict{String,<:Any})
Associates an access policy and its scope to an access entry. For more information about
associating access policies, see Associating and disassociating access policies to and from
access entries in the Amazon EKS User Guide.
# Arguments
- `access_scope`: The scope for the AccessPolicy. You can scope access policies to an
entire cluster or to specific Kubernetes namespaces.
- `name`: The name of your cluster.
- `policy_arn`: The ARN of the AccessPolicy that you're associating. For a list of ARNs,
use ListAccessPolicies.
- `principal_arn`: The Amazon Resource Name (ARN) of the IAM user or role for the
AccessEntry that you're associating the access policy to.
"""
function associate_access_policy(
accessScope,
name,
policyArn,
principalArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/access-entries/$(principalArn)/access-policies",
Dict{String,Any}("accessScope" => accessScope, "policyArn" => policyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_access_policy(
accessScope,
name,
policyArn,
principalArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/access-entries/$(principalArn)/access-policies",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("accessScope" => accessScope, "policyArn" => policyArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_encryption_config(encryption_config, name)
associate_encryption_config(encryption_config, name, params::Dict{String,<:Any})
Associates an encryption configuration to an existing cluster. Use this API to enable
encryption on existing clusters that don't already have encryption enabled. This allows you
to implement a defense-in-depth security strategy without migrating applications to new
Amazon EKS clusters.
# Arguments
- `encryption_config`: The configuration you are using for encryption.
- `name`: The name of your cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
"""
function associate_encryption_config(
encryptionConfig, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/encryption-config/associate",
Dict{String,Any}(
"encryptionConfig" => encryptionConfig, "clientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_encryption_config(
encryptionConfig,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/encryption-config/associate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"encryptionConfig" => encryptionConfig,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_identity_provider_config(name, oidc)
associate_identity_provider_config(name, oidc, params::Dict{String,<:Any})
Associates an identity provider configuration to a cluster. If you want to authenticate
identities using an identity provider, you can create an identity provider configuration
and associate it to your cluster. After configuring authentication to your cluster you can
create Kubernetes Role and ClusterRole objects, assign permissions to them, and then bind
them to the identities using Kubernetes RoleBinding and ClusterRoleBinding objects. For
more information see Using RBAC Authorization in the Kubernetes documentation.
# Arguments
- `name`: The name of your cluster.
- `oidc`: An object representing an OpenID Connect (OIDC) identity provider configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"tags"`: Metadata that assists with categorization and organization. Each tag consists
of a key and an optional value. You define both. Tags don't propagate to any other cluster
or Amazon Web Services resources.
"""
function associate_identity_provider_config(
name, oidc; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/identity-provider-configs/associate",
Dict{String,Any}("oidc" => oidc, "clientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_identity_provider_config(
name,
oidc,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/identity-provider-configs/associate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("oidc" => oidc, "clientRequestToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_entry(name, principal_arn)
create_access_entry(name, principal_arn, params::Dict{String,<:Any})
Creates an access entry. An access entry allows an IAM principal to access your cluster.
Access entries can replace the need to maintain entries in the aws-auth ConfigMap for
authentication. You have the following options for authorizing an IAM principal to access
Kubernetes objects on your cluster: Kubernetes role-based access control (RBAC), Amazon
EKS, or both. Kubernetes RBAC authorization requires you to create and manage Kubernetes
Role, ClusterRole, RoleBinding, and ClusterRoleBinding objects, in addition to managing
access entries. If you use Amazon EKS authorization exclusively, you don't need to create
and manage Kubernetes Role, ClusterRole, RoleBinding, and ClusterRoleBinding objects. For
more information about access entries, see Access entries in the Amazon EKS User Guide.
# Arguments
- `name`: The name of your cluster.
- `principal_arn`: The ARN of the IAM principal for the AccessEntry. You can specify one
ARN for each access entry. You can't specify the same ARN in more than one access entry.
This value can't be changed after access entry creation. The valid principals differ
depending on the type of the access entry in the type field. The only valid ARN is IAM
roles for the types of access entries for nodes: . You can use every IAM principal type
for STANDARD access entries. You can't use the STS session principal type with access
entries because this is a temporary principal for each session and not a permanent identity
that can be assigned permissions. IAM best practices recommend using IAM roles with
temporary credentials, rather than IAM users with long-term credentials.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"kubernetesGroups"`: The value for name that you've specified for kind: Group as a
subject in a Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn't
confirm that the value for name exists in any bindings on your cluster. You can specify one
or more names. Kubernetes authorizes the principalArn of the access entry to access any
cluster objects that you've specified in a Kubernetes Role or ClusterRole object that is
also specified in a binding's roleRef. For more information about creating Kubernetes
RoleBinding, ClusterRoleBinding, Role, or ClusterRole objects, see Using RBAC Authorization
in the Kubernetes documentation. If you want Amazon EKS to authorize the principalArn
(instead of, or in addition to Kubernetes authorizing the principalArn), you can associate
one or more access policies to the access entry using AssociateAccessPolicy. If you
associate any access policies, the principalARN has all permissions assigned in the
associated access policies and all permissions in any Kubernetes Role or ClusterRole
objects that the group names are bound to.
- `"tags"`: Metadata that assists with categorization and organization. Each tag consists
of a key and an optional value. You define both. Tags don't propagate to any other cluster
or Amazon Web Services resources.
- `"type"`: The type of the new access entry. Valid values are Standard, FARGATE_LINUX,
EC2_LINUX, and EC2_WINDOWS. If the principalArn is for an IAM role that's used for
self-managed Amazon EC2 nodes, specify EC2_LINUX or EC2_WINDOWS. Amazon EKS grants the
necessary permissions to the node for you. If the principalArn is for any other purpose,
specify STANDARD. If you don't specify a value, Amazon EKS sets the value to STANDARD. It's
unnecessary to create access entries for IAM roles used with Fargate profiles or managed
Amazon EC2 nodes, because Amazon EKS creates entries in the aws-auth ConfigMap for the
roles. You can't change this value once you've created the access entry. If you set the
value to EC2_LINUX or EC2_WINDOWS, you can't specify values for kubernetesGroups, or
associate an AccessPolicy to the access entry.
- `"username"`: The username to authenticate to Kubernetes with. We recommend not
specifying a username and letting Amazon EKS specify it for you. For more information about
the value Amazon EKS specifies for you, or constraints before specifying your own username,
see Creating access entries in the Amazon EKS User Guide.
"""
function create_access_entry(
name, principalArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/access-entries",
Dict{String,Any}(
"principalArn" => principalArn, "clientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_access_entry(
name,
principalArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/access-entries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"principalArn" => principalArn, "clientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_addon(addon_name, name)
create_addon(addon_name, name, params::Dict{String,<:Any})
Creates an Amazon EKS add-on. Amazon EKS add-ons help to automate the provisioning and
lifecycle management of common operational software for Amazon EKS clusters. For more
information, see Amazon EKS add-ons in the Amazon EKS User Guide.
# Arguments
- `addon_name`: The name of the add-on. The name must match one of the names returned by
DescribeAddonVersions.
- `name`: The name of your cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addonVersion"`: The version of the add-on. The version must match one of the versions
returned by DescribeAddonVersions .
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"configurationValues"`: The set of configuration values for the add-on that's created.
The values that you provide are validated against the schema returned by
DescribeAddonConfiguration.
- `"podIdentityAssociations"`: An array of Pod Identity Assocations to be created. Each EKS
Pod Identity association maps a Kubernetes service account to an IAM Role. For more
information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS
User Guide.
- `"resolveConflicts"`: How to resolve field value conflicts for an Amazon EKS add-on.
Conflicts are handled based on the value you choose: None – If the self-managed
version of the add-on is installed on your cluster, Amazon EKS doesn't change the value.
Creation of the add-on might fail. Overwrite – If the self-managed version of the
add-on is installed on your cluster and the Amazon EKS default value is different than the
existing value, Amazon EKS changes the value to the Amazon EKS default value. Preserve
– This is similar to the NONE option. If the self-managed version of the add-on is
installed on your cluster Amazon EKS doesn't change the add-on resource properties.
Creation of the add-on might fail if conflicts are detected. This option works differently
during the update operation. For more information, see UpdateAddon. If you don't
currently have the self-managed version of the add-on installed on your cluster, the Amazon
EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the
option that you specify.
- `"serviceAccountRoleArn"`: The Amazon Resource Name (ARN) of an existing IAM role to bind
to the add-on's service account. The role must be assigned the IAM permissions required by
the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions
assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the
Amazon EKS User Guide. To specify an existing IAM role, you must have an IAM OpenID
Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM
roles for service accounts on your cluster in the Amazon EKS User Guide.
- `"tags"`: Metadata that assists with categorization and organization. Each tag consists
of a key and an optional value. You define both. Tags don't propagate to any other cluster
or Amazon Web Services resources.
"""
function create_addon(addonName, name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"POST",
"/clusters/$(name)/addons",
Dict{String,Any}("addonName" => addonName, "clientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_addon(
addonName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/addons",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"addonName" => addonName, "clientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cluster(name, resources_vpc_config, role_arn)
create_cluster(name, resources_vpc_config, role_arn, params::Dict{String,<:Any})
Creates an Amazon EKS control plane. The Amazon EKS control plane consists of control plane
instances that run the Kubernetes software, such as etcd and the API server. The control
plane runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed
by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single
tenant and unique. It runs on its own set of Amazon EC2 instances. The cluster control
plane is provisioned across multiple Availability Zones and fronted by an Elastic Load
Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in
your VPC subnets to provide connectivity from the control plane instances to the nodes (for
example, to support kubectl exec, logs, and proxy data flows). Amazon EKS nodes run in your
Amazon Web Services account and connect to your cluster's control plane over the Kubernetes
API server endpoint and a certificate file that is created for your cluster. You can use
the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public
and private access to your cluster's Kubernetes API server endpoint. By default, public
access is enabled, and private access is disabled. For more information, see Amazon EKS
Cluster Endpoint Access Control in the Amazon EKS User Guide . You can use the logging
parameter to enable or disable exporting the Kubernetes control plane logs for your cluster
to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch
Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS
User Guide . CloudWatch Logs ingestion, archive storage, and data scanning rates apply to
exported control plane logs. For more information, see CloudWatch Pricing. In most cases,
it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you
must configure your Kubernetes tooling to communicate with the API server and launch nodes
into your cluster. For more information, see Allowing users to access your cluster and
Launching Amazon EKS nodes in the Amazon EKS User Guide.
# Arguments
- `name`: The unique name to give to your cluster.
- `resources_vpc_config`: The VPC configuration that's used by the cluster control plane.
Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For
more information, see Cluster VPC Considerations and Cluster Security Group Considerations
in the Amazon EKS User Guide. You must specify at least two subnets. You can specify up to
five security groups. However, we recommend that you use a dedicated security group for
your cluster control plane.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role that provides permissions for
the Kubernetes control plane to make calls to Amazon Web Services API operations on your
behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide
.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accessConfig"`: The access configuration for the cluster.
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"encryptionConfig"`: The encryption configuration for the cluster.
- `"kubernetesNetworkConfig"`: The Kubernetes network configuration for the cluster.
- `"logging"`: Enable or disable exporting the Kubernetes control plane logs for your
cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to
CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the
Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data scanning
rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
- `"outpostConfig"`: An object representing the configuration of your local Amazon EKS
cluster on an Amazon Web Services Outpost. Before creating a local cluster on an Outpost,
review Local clusters for Amazon EKS on Amazon Web Services Outposts in the Amazon EKS User
Guide. This object isn't available for creating Amazon EKS clusters on the Amazon Web
Services cloud.
- `"tags"`: Metadata that assists with categorization and organization. Each tag consists
of a key and an optional value. You define both. Tags don't propagate to any other cluster
or Amazon Web Services resources.
- `"version"`: The desired Kubernetes version for your cluster. If you don't specify a
value here, the default version available in Amazon EKS is used. The default version might
not be the latest version available.
"""
function create_cluster(
name, resourcesVpcConfig, roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters",
Dict{String,Any}(
"name" => name,
"resourcesVpcConfig" => resourcesVpcConfig,
"roleArn" => roleArn,
"clientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cluster(
name,
resourcesVpcConfig,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name,
"resourcesVpcConfig" => resourcesVpcConfig,
"roleArn" => roleArn,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_eks_anywhere_subscription(name, term)
create_eks_anywhere_subscription(name, term, params::Dict{String,<:Any})
Creates an EKS Anywhere subscription. When a subscription is created, it is a contract
agreement for the length of the term specified in the request. Licenses that are used to
validate support are provisioned in Amazon Web Services License Manager and the caller
account is granted access to EKS Anywhere Curated Packages.
# Arguments
- `name`: The unique name for your subscription. It must be unique in your Amazon Web
Services account in the Amazon Web Services Region you're creating the subscription in. The
name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores.
It must start with an alphabetic character and can't be longer than 100 characters.
- `term`: An object representing the term duration and term unit type of your subscription.
This determines the term length of your subscription. Valid values are MONTHS for term unit
and 12 or 36 for term duration, indicating a 12 month or 36 month subscription. This value
cannot be changed after creating the subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoRenew"`: A boolean indicating whether the subscription auto renews at the end of
the term.
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"licenseQuantity"`: The number of licenses to purchase with the subscription. Valid
values are between 1 and 100. This value can't be changed after creating the subscription.
- `"licenseType"`: The license type for all licenses in the subscription. Valid value is
CLUSTER. With the CLUSTER license type, each license covers support for a single EKS
Anywhere cluster.
- `"tags"`: The metadata for a subscription to assist with categorization and organization.
Each tag consists of a key and an optional value. Subscription tags don't propagate to any
other resources associated with the subscription.
"""
function create_eks_anywhere_subscription(
name, term; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/eks-anywhere-subscriptions",
Dict{String,Any}(
"name" => name, "term" => term, "clientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_eks_anywhere_subscription(
name,
term,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/eks-anywhere-subscriptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"name" => name, "term" => term, "clientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_fargate_profile(fargate_profile_name, name, pod_execution_role_arn)
create_fargate_profile(fargate_profile_name, name, pod_execution_role_arn, params::Dict{String,<:Any})
Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate
profile in a cluster to be able to run pods on Fargate. The Fargate profile allows an
administrator to declare which pods run on Fargate and specify which pods run on which
Fargate profile. This declaration is done through the profile’s selectors. Each profile
can have up to five selectors that contain a namespace and labels. A namespace is required
for every selector. The label field consists of multiple optional key-value pairs. Pods
that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of
the selectors in the Fargate profile, then that pod is run on Fargate. When you create a
Fargate profile, you must specify a pod execution role to use with the pods that are
scheduled with the profile. This role is added to the cluster's Kubernetes Role Based
Access Control (RBAC) for authorization so that the kubelet that is running on the Fargate
infrastructure can register with your Amazon EKS cluster so that it can appear in your
cluster as a node. The pod execution role also provides IAM permissions to the Fargate
infrastructure to allow read access to Amazon ECR image repositories. For more information,
see Pod Execution Role in the Amazon EKS User Guide. Fargate profiles are immutable.
However, you can create a new updated profile to replace an existing profile and then
delete the original after the updated profile has finished creating. If any Fargate
profiles in a cluster are in the DELETING status, you must wait for that Fargate profile to
finish deleting before you can create any other profiles in that cluster. For more
information, see Fargate profile in the Amazon EKS User Guide.
# Arguments
- `fargate_profile_name`: The name of the Fargate profile.
- `name`: The name of your cluster.
- `pod_execution_role_arn`: The Amazon Resource Name (ARN) of the Pod execution role to use
for a Pod that matches the selectors in the Fargate profile. The Pod execution role allows
Fargate infrastructure to register with your cluster as a node, and it provides read access
to Amazon ECR image repositories. For more information, see Pod execution role in the
Amazon EKS User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"selectors"`: The selectors to match for a Pod to use this Fargate profile. Each
selector must have an associated Kubernetes namespace. Optionally, you can also specify
labels for a namespace. You may specify up to five selectors in a Fargate profile.
- `"subnets"`: The IDs of subnets to launch a Pod into. A Pod running on Fargate isn't
assigned a public IP address, so only private subnets (with no direct route to an Internet
Gateway) are accepted for this parameter.
- `"tags"`: Metadata that assists with categorization and organization. Each tag consists
of a key and an optional value. You define both. Tags don't propagate to any other cluster
or Amazon Web Services resources.
"""
function create_fargate_profile(
fargateProfileName,
name,
podExecutionRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/fargate-profiles",
Dict{String,Any}(
"fargateProfileName" => fargateProfileName,
"podExecutionRoleArn" => podExecutionRoleArn,
"clientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fargate_profile(
fargateProfileName,
name,
podExecutionRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/fargate-profiles",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"fargateProfileName" => fargateProfileName,
"podExecutionRoleArn" => podExecutionRoleArn,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_nodegroup(name, node_role, nodegroup_name, subnets)
create_nodegroup(name, node_role, nodegroup_name, subnets, params::Dict{String,<:Any})
Creates a managed node group for an Amazon EKS cluster. You can only create a node group
for your cluster that is equal to the current Kubernetes version for the cluster. All node
groups are created with the latest AMI release version for the respective minor Kubernetes
version of the cluster, unless you deploy a custom AMI using a launch template. For more
information about using launch templates, see Customizing managed nodes with launch
templates. An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and
associated Amazon EC2 instances that are managed by Amazon Web Services for an Amazon EKS
cluster. For more information, see Managed node groups in the Amazon EKS User Guide.
Windows AMI types are only supported for commercial Amazon Web Services Regions that
support Windows on Amazon EKS.
# Arguments
- `name`: The name of your cluster.
- `node_role`: The Amazon Resource Name (ARN) of the IAM role to associate with your node
group. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on
your behalf. Nodes receive permissions for these API calls through an IAM instance profile
and associated policies. Before you can launch nodes and register them into a cluster, you
must create an IAM role for those nodes to use when they are launched. For more
information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify
launchTemplate, then don't specify IamInstanceProfile in your launch template, or the
node group deployment will fail. For more information about using launch templates with
Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User
Guide.
- `nodegroup_name`: The unique name to give your node group.
- `subnets`: The subnets to use for the Auto Scaling group that is created for your node
group. If you specify launchTemplate, then don't specify SubnetId in your launch
template, or the node group deployment will fail. For more information about using launch
templates with Amazon EKS, see Customizing managed nodes with launch templates in the
Amazon EKS User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"amiType"`: The AMI type for your node group. If you specify launchTemplate, and your
launch template uses a custom AMI, then don't specify amiType, or the node group deployment
will fail. If your launch template uses a Windows custom AMI, then add
eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. For more
information about using launch templates with Amazon EKS, see Customizing managed nodes
with launch templates in the Amazon EKS User Guide.
- `"capacityType"`: The capacity type for your node group.
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"diskSize"`: The root device disk size (in GiB) for your node group instances. The
default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for
Windows. If you specify launchTemplate, then don't specify diskSize, or the node group
deployment will fail. For more information about using launch templates with Amazon EKS,
see Customizing managed nodes with launch templates in the Amazon EKS User Guide.
- `"instanceTypes"`: Specify the instance types for a node group. If you specify a GPU
instance type, make sure to also specify an applicable GPU AMI type with the amiType
parameter. If you specify launchTemplate, then you can specify zero or one instance type in
your launch template or you can specify 0-20 instance types for instanceTypes. If however,
you specify an instance type in your launch template and specify any instanceTypes, the
node group deployment will fail. If you don't specify an instance type in a launch template
or for instanceTypes, then t3.medium is used, by default. If you specify Spot for
capacityType, then we recommend specifying multiple values for instanceTypes. For more
information, see Managed node group capacity types and Customizing managed nodes with
launch templates in the Amazon EKS User Guide.
- `"labels"`: The Kubernetes labels to apply to the nodes in the node group when they are
created.
- `"launchTemplate"`: An object representing a node group's launch template specification.
When using this object, don't directly specify instanceTypes, diskSize, or remoteAccess.
Make sure that the launch template meets the requirements in launchTemplateSpecification.
Also refer to Customizing managed nodes with launch templates in the Amazon EKS User Guide.
- `"releaseVersion"`: The AMI version of the Amazon EKS optimized AMI to use with your node
group. By default, the latest available AMI version for the node group's current Kubernetes
version is used. For information about Linux versions, see Amazon EKS optimized Amazon
Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the
November 2022 and later releases of the Windows AMIs. For information about Windows
versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide. If
you specify launchTemplate, and your launch template uses a custom AMI, then don't specify
releaseVersion, or the node group deployment will fail. For more information about using
launch templates with Amazon EKS, see Customizing managed nodes with launch templates in
the Amazon EKS User Guide.
- `"remoteAccess"`: The remote access configuration to use with your node group. For Linux,
the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then
don't specify remoteAccess, or the node group deployment will fail. For more information
about using launch templates with Amazon EKS, see Customizing managed nodes with launch
templates in the Amazon EKS User Guide.
- `"scalingConfig"`: The scaling configuration details for the Auto Scaling group that is
created for your node group.
- `"tags"`: Metadata that assists with categorization and organization. Each tag consists
of a key and an optional value. You define both. Tags don't propagate to any other cluster
or Amazon Web Services resources.
- `"taints"`: The Kubernetes taints to be applied to the nodes in the node group. For more
information, see Node taints on managed node groups.
- `"updateConfig"`: The node group update configuration.
- `"version"`: The Kubernetes version to use for your managed nodes. By default, the
Kubernetes version of the cluster is used, and this is the only accepted specified value.
If you specify launchTemplate, and your launch template uses a custom AMI, then don't
specify version, or the node group deployment will fail. For more information about using
launch templates with Amazon EKS, see Customizing managed nodes with launch templates in
the Amazon EKS User Guide.
"""
function create_nodegroup(
name,
nodeRole,
nodegroupName,
subnets;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/node-groups",
Dict{String,Any}(
"nodeRole" => nodeRole,
"nodegroupName" => nodegroupName,
"subnets" => subnets,
"clientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_nodegroup(
name,
nodeRole,
nodegroupName,
subnets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/node-groups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"nodeRole" => nodeRole,
"nodegroupName" => nodegroupName,
"subnets" => subnets,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_pod_identity_association(name, namespace, role_arn, service_account)
create_pod_identity_association(name, namespace, role_arn, service_account, params::Dict{String,<:Any})
Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster
and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM
credentials to pods and the credentials are rotated automatically. Amazon EKS Pod Identity
associations provide the ability to manage credentials for your applications, similar to
the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances. If a
pod uses a service account that has an association, Amazon EKS sets environment variables
in the containers of the pod. The environment variables configure the Amazon Web Services
SDKs, including the Command Line Interface, to use the EKS Pod Identity credentials. Pod
Identity is a simpler method than IAM roles for service accounts, as this method doesn't
use OIDC identity providers. Additionally, you can configure a role for Pod Identity once,
and reuse it across clusters.
# Arguments
- `name`: The name of the cluster to create the association in.
- `namespace`: The name of the Kubernetes namespace inside the cluster to create the
association in. The service account and the pods that use the service account must be in
this namespace.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role to associate with the service
account. The EKS Pod Identity agent manages credentials to assume this role for
applications in the containers in the pods that use this service account.
- `service_account`: The name of the Kubernetes service account inside the cluster to
associate the IAM credentials with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"tags"`: Metadata that assists with categorization and organization. Each tag consists
of a key and an optional value. You define both. Tags don't propagate to any other cluster
or Amazon Web Services resources. The following basic restrictions apply to tags: Maximum
number of tags per resource – 50 For each resource, each tag key must be unique, and
each tag key can have only one value. Maximum key length – 128 Unicode characters in
UTF-8 Maximum value length – 256 Unicode characters in UTF-8 If your tagging schema
is used across multiple services and resources, remember that other services may have
restrictions on allowed characters. Generally allowed characters are: letters, numbers, and
spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys
and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase
combination of such as a prefix for either keys or values as it is reserved for Amazon Web
Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this
prefix do not count against your tags per resource limit.
"""
function create_pod_identity_association(
name,
namespace,
roleArn,
serviceAccount;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/pod-identity-associations",
Dict{String,Any}(
"namespace" => namespace,
"roleArn" => roleArn,
"serviceAccount" => serviceAccount,
"clientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_pod_identity_association(
name,
namespace,
roleArn,
serviceAccount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/pod-identity-associations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"namespace" => namespace,
"roleArn" => roleArn,
"serviceAccount" => serviceAccount,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_entry(name, principal_arn)
delete_access_entry(name, principal_arn, params::Dict{String,<:Any})
Deletes an access entry. Deleting an access entry of a type other than Standard can cause
your cluster to function improperly. If you delete an access entry in error, you can
recreate it.
# Arguments
- `name`: The name of your cluster.
- `principal_arn`: The ARN of the IAM principal for the AccessEntry.
"""
function delete_access_entry(
name, principalArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"DELETE",
"/clusters/$(name)/access-entries/$(principalArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_entry(
name,
principalArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"DELETE",
"/clusters/$(name)/access-entries/$(principalArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_addon(addon_name, name)
delete_addon(addon_name, name, params::Dict{String,<:Any})
Deletes an Amazon EKS add-on. When you remove an add-on, it's deleted from the cluster. You
can always manually start an add-on on the cluster using the Kubernetes API.
# Arguments
- `addon_name`: The name of the add-on. The name must match one of the names returned by
ListAddons .
- `name`: The name of your cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"preserve"`: Specifying this option preserves the add-on software on your cluster but
Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with
the add-on, it isn't removed.
"""
function delete_addon(addonName, name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"DELETE",
"/clusters/$(name)/addons/$(addonName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_addon(
addonName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"DELETE",
"/clusters/$(name)/addons/$(addonName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cluster(name)
delete_cluster(name, params::Dict{String,<:Any})
Deletes an Amazon EKS cluster control plane. If you have active services in your cluster
that are associated with a load balancer, you must delete those services before deleting
the cluster so that the load balancers are deleted properly. Otherwise, you can have
orphaned resources in your VPC that prevent you from being able to delete the VPC. For more
information, see Deleting a cluster in the Amazon EKS User Guide. If you have managed node
groups or Fargate profiles attached to the cluster, you must delete them first. For more
information, see DeleteNodgroup and DeleteFargateProfile.
# Arguments
- `name`: The name of the cluster to delete.
"""
function delete_cluster(name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"DELETE",
"/clusters/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cluster(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"DELETE",
"/clusters/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_eks_anywhere_subscription(id)
delete_eks_anywhere_subscription(id, params::Dict{String,<:Any})
Deletes an expired or inactive subscription. Deleting inactive subscriptions removes them
from the Amazon Web Services Management Console view and from list/describe API responses.
Subscriptions can only be cancelled within 7 days of creation and are cancelled by creating
a ticket in the Amazon Web Services Support Center.
# Arguments
- `id`: The ID of the subscription.
"""
function delete_eks_anywhere_subscription(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"DELETE",
"/eks-anywhere-subscriptions/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_eks_anywhere_subscription(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"DELETE",
"/eks-anywhere-subscriptions/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fargate_profile(fargate_profile_name, name)
delete_fargate_profile(fargate_profile_name, name, params::Dict{String,<:Any})
Deletes an Fargate profile. When you delete a Fargate profile, any Pod running on Fargate
that was created with the profile is deleted. If the Pod matches another Fargate profile,
then it is scheduled on Fargate with that profile. If it no longer matches any Fargate
profiles, then it's not scheduled on Fargate and may remain in a pending state. Only one
Fargate profile in a cluster can be in the DELETING status at a time. You must wait for a
Fargate profile to finish deleting before you can delete any other profiles in that cluster.
# Arguments
- `fargate_profile_name`: The name of the Fargate profile to delete.
- `name`: The name of your cluster.
"""
function delete_fargate_profile(
fargateProfileName, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"DELETE",
"/clusters/$(name)/fargate-profiles/$(fargateProfileName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fargate_profile(
fargateProfileName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"DELETE",
"/clusters/$(name)/fargate-profiles/$(fargateProfileName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_nodegroup(name, nodegroup_name)
delete_nodegroup(name, nodegroup_name, params::Dict{String,<:Any})
Deletes a managed node group.
# Arguments
- `name`: The name of your cluster.
- `nodegroup_name`: The name of the node group to delete.
"""
function delete_nodegroup(
name, nodegroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"DELETE",
"/clusters/$(name)/node-groups/$(nodegroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_nodegroup(
name,
nodegroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"DELETE",
"/clusters/$(name)/node-groups/$(nodegroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_pod_identity_association(association_id, name)
delete_pod_identity_association(association_id, name, params::Dict{String,<:Any})
Deletes a EKS Pod Identity association. The temporary Amazon Web Services credentials from
the previous IAM role session might still be valid until the session expiry. If you need to
immediately revoke the temporary session credentials, then go to the role in the IAM
console.
# Arguments
- `association_id`: The ID of the association to be deleted.
- `name`: The cluster name that
"""
function delete_pod_identity_association(
associationId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"DELETE",
"/clusters/$(name)/pod-identity-associations/$(associationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_pod_identity_association(
associationId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"DELETE",
"/clusters/$(name)/pod-identity-associations/$(associationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_cluster(name)
deregister_cluster(name, params::Dict{String,<:Any})
Deregisters a connected cluster to remove it from the Amazon EKS control plane. A connected
cluster is a Kubernetes cluster that you've connected to your control plane using the
Amazon EKS Connector.
# Arguments
- `name`: The name of the connected cluster to deregister.
"""
function deregister_cluster(name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"DELETE",
"/cluster-registrations/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_cluster(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"DELETE",
"/cluster-registrations/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_access_entry(name, principal_arn)
describe_access_entry(name, principal_arn, params::Dict{String,<:Any})
Describes an access entry.
# Arguments
- `name`: The name of your cluster.
- `principal_arn`: The ARN of the IAM principal for the AccessEntry.
"""
function describe_access_entry(
name, principalArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/access-entries/$(principalArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_access_entry(
name,
principalArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"GET",
"/clusters/$(name)/access-entries/$(principalArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_addon(addon_name, name)
describe_addon(addon_name, name, params::Dict{String,<:Any})
Describes an Amazon EKS add-on.
# Arguments
- `addon_name`: The name of the add-on. The name must match one of the names returned by
ListAddons .
- `name`: The name of your cluster.
"""
function describe_addon(addonName, name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"GET",
"/clusters/$(name)/addons/$(addonName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_addon(
addonName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"GET",
"/clusters/$(name)/addons/$(addonName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_addon_configuration(addon_name, addon_version)
describe_addon_configuration(addon_name, addon_version, params::Dict{String,<:Any})
Returns configuration options.
# Arguments
- `addon_name`: The name of the add-on. The name must match one of the names returned by
DescribeAddonVersions.
- `addon_version`: The version of the add-on. The version must match one of the versions
returned by DescribeAddonVersions .
"""
function describe_addon_configuration(
addonName, addonVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/addons/configuration-schemas",
Dict{String,Any}("addonName" => addonName, "addonVersion" => addonVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_addon_configuration(
addonName,
addonVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"GET",
"/addons/configuration-schemas",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("addonName" => addonName, "addonVersion" => addonVersion),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_addon_versions()
describe_addon_versions(params::Dict{String,<:Any})
Describes the versions for an add-on. Information such as the Kubernetes versions that you
can use the add-on with, the owner, publisher, and the type of the add-on are returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addonName"`: The name of the add-on. The name must match one of the names returned by
ListAddons .
- `"kubernetesVersion"`: The Kubernetes versions that you can use the add-on with.
- `"maxResults"`: The maximum number of results, returned in paginated output. You receive
maxResults in a single page, along with a nextToken response element. You can see the
remaining results of the initial request by sending another request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100
results and a nextToken value, if applicable, are returned.
- `"nextToken"`: The nextToken value returned from a previous paginated request, where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is used only to retrieve the next items in a list and not for other
programmatic purposes.
- `"owners"`: The owner of the add-on. For valid owners, don't specify a value for this
property.
- `"publishers"`: The publisher of the add-on. For valid publishers, don't specify a value
for this property.
- `"types"`: The type of the add-on. For valid types, don't specify a value for this
property.
"""
function describe_addon_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"GET",
"/addons/supported-versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_addon_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/addons/supported-versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster(name)
describe_cluster(name, params::Dict{String,<:Any})
Describes an Amazon EKS cluster. The API server endpoint and certificate authority data
returned by this operation are required for kubelet and kubectl to communicate with your
Kubernetes API server. For more information, see Creating or updating a kubeconfig file for
an Amazon EKS cluster. The API server endpoint and certificate authority data aren't
available until the cluster reaches the ACTIVE state.
# Arguments
- `name`: The name of your cluster.
"""
function describe_cluster(name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"GET", "/clusters/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_cluster(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_eks_anywhere_subscription(id)
describe_eks_anywhere_subscription(id, params::Dict{String,<:Any})
Returns descriptive information about a subscription.
# Arguments
- `id`: The ID of the subscription.
"""
function describe_eks_anywhere_subscription(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/eks-anywhere-subscriptions/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_eks_anywhere_subscription(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/eks-anywhere-subscriptions/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fargate_profile(fargate_profile_name, name)
describe_fargate_profile(fargate_profile_name, name, params::Dict{String,<:Any})
Describes an Fargate profile.
# Arguments
- `fargate_profile_name`: The name of the Fargate profile to describe.
- `name`: The name of your cluster.
"""
function describe_fargate_profile(
fargateProfileName, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/fargate-profiles/$(fargateProfileName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fargate_profile(
fargateProfileName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"GET",
"/clusters/$(name)/fargate-profiles/$(fargateProfileName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_identity_provider_config(identity_provider_config, name)
describe_identity_provider_config(identity_provider_config, name, params::Dict{String,<:Any})
Describes an identity provider configuration.
# Arguments
- `identity_provider_config`: An object representing an identity provider configuration.
- `name`: The name of your cluster.
"""
function describe_identity_provider_config(
identityProviderConfig, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/identity-provider-configs/describe",
Dict{String,Any}("identityProviderConfig" => identityProviderConfig);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_identity_provider_config(
identityProviderConfig,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/identity-provider-configs/describe",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("identityProviderConfig" => identityProviderConfig),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_insight(id, name)
describe_insight(id, name, params::Dict{String,<:Any})
Returns details about an insight that you specify using its ID.
# Arguments
- `id`: The identity of the insight to describe.
- `name`: The name of the cluster to describe the insight for.
"""
function describe_insight(id, name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"GET",
"/clusters/$(name)/insights/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_insight(
id,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"GET",
"/clusters/$(name)/insights/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_nodegroup(name, nodegroup_name)
describe_nodegroup(name, nodegroup_name, params::Dict{String,<:Any})
Describes a managed node group.
# Arguments
- `name`: The name of your cluster.
- `nodegroup_name`: The name of the node group to describe.
"""
function describe_nodegroup(
name, nodegroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/node-groups/$(nodegroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_nodegroup(
name,
nodegroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"GET",
"/clusters/$(name)/node-groups/$(nodegroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_pod_identity_association(association_id, name)
describe_pod_identity_association(association_id, name, params::Dict{String,<:Any})
Returns descriptive information about an EKS Pod Identity association. This action requires
the ID of the association. You can get the ID from the response to the
CreatePodIdentityAssocation for newly created associations. Or, you can list the IDs for
associations with ListPodIdentityAssociations and filter the list by namespace or service
account.
# Arguments
- `association_id`: The ID of the association that you want the description of.
- `name`: The name of the cluster that the association is in.
"""
function describe_pod_identity_association(
associationId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/pod-identity-associations/$(associationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_pod_identity_association(
associationId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"GET",
"/clusters/$(name)/pod-identity-associations/$(associationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_update(name, update_id)
describe_update(name, update_id, params::Dict{String,<:Any})
Describes an update to an Amazon EKS resource. When the status of the update is Succeeded,
the update is complete. If an update fails, the status is Failed, and an error detail
explains the reason for the failure.
# Arguments
- `name`: The name of the Amazon EKS cluster associated with the update.
- `update_id`: The ID of the update to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addonName"`: The name of the add-on. The name must match one of the names returned by
ListAddons . This parameter is required if the update is an add-on update.
- `"nodegroupName"`: The name of the Amazon EKS node group associated with the update. This
parameter is required if the update is a node group update.
"""
function describe_update(name, updateId; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"GET",
"/clusters/$(name)/updates/$(updateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_update(
name,
updateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"GET",
"/clusters/$(name)/updates/$(updateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_access_policy(name, policy_arn, principal_arn)
disassociate_access_policy(name, policy_arn, principal_arn, params::Dict{String,<:Any})
Disassociates an access policy from an access entry.
# Arguments
- `name`: The name of your cluster.
- `policy_arn`: The ARN of the policy to disassociate from the access entry. For a list of
associated policies ARNs, use ListAssociatedAccessPolicies.
- `principal_arn`: The ARN of the IAM principal for the AccessEntry.
"""
function disassociate_access_policy(
name, policyArn, principalArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"DELETE",
"/clusters/$(name)/access-entries/$(principalArn)/access-policies/$(policyArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_access_policy(
name,
policyArn,
principalArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"DELETE",
"/clusters/$(name)/access-entries/$(principalArn)/access-policies/$(policyArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_identity_provider_config(identity_provider_config, name)
disassociate_identity_provider_config(identity_provider_config, name, params::Dict{String,<:Any})
Disassociates an identity provider configuration from a cluster. If you disassociate an
identity provider from your cluster, users included in the provider can no longer access
the cluster. However, you can still access the cluster with IAM principals.
# Arguments
- `identity_provider_config`: An object representing an identity provider configuration.
- `name`: The name of your cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
"""
function disassociate_identity_provider_config(
identityProviderConfig, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/identity-provider-configs/disassociate",
Dict{String,Any}(
"identityProviderConfig" => identityProviderConfig,
"clientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_identity_provider_config(
identityProviderConfig,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/identity-provider-configs/disassociate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"identityProviderConfig" => identityProviderConfig,
"clientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_entries(name)
list_access_entries(name, params::Dict{String,<:Any})
Lists the access entries for your cluster.
# Arguments
- `name`: The name of your cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"associatedPolicyArn"`: The ARN of an AccessPolicy. When you specify an access policy
ARN, only the access entries associated to that access policy are returned. For a list of
available policy ARNs, use ListAccessPolicies.
- `"maxResults"`: The maximum number of results, returned in paginated output. You receive
maxResults in a single page, along with a nextToken response element. You can see the
remaining results of the initial request by sending another request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100
results and a nextToken value, if applicable, are returned.
- `"nextToken"`: The nextToken value returned from a previous paginated request, where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is used only to retrieve the next items in a list and not for other
programmatic purposes.
"""
function list_access_entries(name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"GET",
"/clusters/$(name)/access-entries";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_access_entries(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/access-entries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_policies()
list_access_policies(params::Dict{String,<:Any})
Lists the available access policies.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results, returned in paginated output. You receive
maxResults in a single page, along with a nextToken response element. You can see the
remaining results of the initial request by sending another request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100
results and a nextToken value, if applicable, are returned.
- `"nextToken"`: The nextToken value returned from a previous paginated request, where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is used only to retrieve the next items in a list and not for other
programmatic purposes.
"""
function list_access_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"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 eks(
"GET",
"/access-policies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_addons(name)
list_addons(name, params::Dict{String,<:Any})
Lists the installed add-ons.
# Arguments
- `name`: The name of your cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results, returned in paginated output. You receive
maxResults in a single page, along with a nextToken response element. You can see the
remaining results of the initial request by sending another request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100
results and a nextToken value, if applicable, are returned.
- `"nextToken"`: The nextToken value returned from a previous paginated request, where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is used only to retrieve the next items in a list and not for other
programmatic purposes.
"""
function list_addons(name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"GET",
"/clusters/$(name)/addons";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_addons(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/addons",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_associated_access_policies(name, principal_arn)
list_associated_access_policies(name, principal_arn, params::Dict{String,<:Any})
Lists the access policies associated with an access entry.
# Arguments
- `name`: The name of your cluster.
- `principal_arn`: The ARN of the IAM principal for the AccessEntry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results, returned in paginated output. You receive
maxResults in a single page, along with a nextToken response element. You can see the
remaining results of the initial request by sending another request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100
results and a nextToken value, if applicable, are returned.
- `"nextToken"`: The nextToken value returned from a previous paginated request, where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is used only to retrieve the next items in a list and not for other
programmatic purposes.
"""
function list_associated_access_policies(
name, principalArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/access-entries/$(principalArn)/access-policies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_associated_access_policies(
name,
principalArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"GET",
"/clusters/$(name)/access-entries/$(principalArn)/access-policies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_clusters()
list_clusters(params::Dict{String,<:Any})
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon
Web Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"include"`: Indicates whether external clusters are included in the returned list. Use
'all' to return
https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.htmlconnected clusters, or
blank to return only Amazon EKS clusters. 'all' must be in lowercase otherwise an error
occurs.
- `"maxResults"`: The maximum number of results, returned in paginated output. You receive
maxResults in a single page, along with a nextToken response element. You can see the
remaining results of the initial request by sending another request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100
results and a nextToken value, if applicable, are returned.
- `"nextToken"`: The nextToken value returned from a previous paginated request, where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is used only to retrieve the next items in a list and not for other
programmatic purposes.
"""
function list_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return eks("GET", "/clusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET", "/clusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_eks_anywhere_subscriptions()
list_eks_anywhere_subscriptions(params::Dict{String,<:Any})
Displays the full description of the subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeStatus"`: An array of subscription statuses to filter on.
- `"maxResults"`: The maximum number of cluster results returned by
ListEksAnywhereSubscriptions in paginated output. When you use this parameter,
ListEksAnywhereSubscriptions returns only maxResults results in a single page along with a
nextToken response element. You can see the remaining results of the initial request by
sending another ListEksAnywhereSubscriptions request with the returned nextToken value.
This value can be between 1 and 100. If you don't use this parameter,
ListEksAnywhereSubscriptions returns up to 10 results and a nextToken value if applicable.
- `"nextToken"`: The nextToken value returned from a previous paginated
ListEksAnywhereSubscriptions request where maxResults was used and the results exceeded the
value of that parameter. Pagination continues from the end of the previous results that
returned the nextToken value.
"""
function list_eks_anywhere_subscriptions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/eks-anywhere-subscriptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_eks_anywhere_subscriptions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/eks-anywhere-subscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fargate_profiles(name)
list_fargate_profiles(name, params::Dict{String,<:Any})
Lists the Fargate profiles associated with the specified cluster in your Amazon Web
Services account in the specified Amazon Web Services Region.
# Arguments
- `name`: The name of your cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results, returned in paginated output. You receive
maxResults in a single page, along with a nextToken response element. You can see the
remaining results of the initial request by sending another request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100
results and a nextToken value, if applicable, are returned.
- `"nextToken"`: The nextToken value returned from a previous paginated request, where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is used only to retrieve the next items in a list and not for other
programmatic purposes.
"""
function list_fargate_profiles(name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"GET",
"/clusters/$(name)/fargate-profiles";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_fargate_profiles(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/fargate-profiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_identity_provider_configs(name)
list_identity_provider_configs(name, params::Dict{String,<:Any})
Lists the identity provider configurations for your cluster.
# Arguments
- `name`: The name of your cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results, returned in paginated output. You receive
maxResults in a single page, along with a nextToken response element. You can see the
remaining results of the initial request by sending another request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100
results and a nextToken value, if applicable, are returned.
- `"nextToken"`: The nextToken value returned from a previous paginated request, where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is used only to retrieve the next items in a list and not for other
programmatic purposes.
"""
function list_identity_provider_configs(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/identity-provider-configs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_identity_provider_configs(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/identity-provider-configs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_insights(name)
list_insights(name, params::Dict{String,<:Any})
Returns a list of all insights checked for against the specified cluster. You can filter
which insights are returned by category, associated Kubernetes version, and status.
# Arguments
- `name`: The name of the Amazon EKS cluster associated with the insights.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: The criteria to filter your list of insights for your cluster. You can filter
which insights are returned by category, associated Kubernetes version, and status.
- `"maxResults"`: The maximum number of identity provider configurations returned by
ListInsights in paginated output. When you use this parameter, ListInsights returns only
maxResults results in a single page along with a nextToken response element. You can see
the remaining results of the initial request by sending another ListInsights request with
the returned nextToken value. This value can be between 1 and 100. If you don't use this
parameter, ListInsights returns up to 100 results and a nextToken value, if applicable.
- `"nextToken"`: The nextToken value returned from a previous paginated ListInsights
request. When the results of a ListInsights request exceed maxResults, you can use this
value to retrieve the next page of results. This value is null when there are no more
results to return.
"""
function list_insights(name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"POST",
"/clusters/$(name)/insights";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_insights(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/insights",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_nodegroups(name)
list_nodegroups(name, params::Dict{String,<:Any})
Lists the managed node groups associated with the specified cluster in your Amazon Web
Services account in the specified Amazon Web Services Region. Self-managed node groups
aren't listed.
# Arguments
- `name`: The name of your cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results, returned in paginated output. You receive
maxResults in a single page, along with a nextToken response element. You can see the
remaining results of the initial request by sending another request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100
results and a nextToken value, if applicable, are returned.
- `"nextToken"`: The nextToken value returned from a previous paginated request, where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is used only to retrieve the next items in a list and not for other
programmatic purposes.
"""
function list_nodegroups(name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"GET",
"/clusters/$(name)/node-groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_nodegroups(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/node-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pod_identity_associations(name)
list_pod_identity_associations(name, params::Dict{String,<:Any})
List the EKS Pod Identity associations in a cluster. You can filter the list by the
namespace that the association is in or the service account that the association uses.
# Arguments
- `name`: The name of the cluster that the associations are in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of EKS Pod Identity association results returned by
ListPodIdentityAssociations in paginated output. When you use this parameter,
ListPodIdentityAssociations returns only maxResults results in a single page along with a
nextToken response element. You can see the remaining results of the initial request by
sending another ListPodIdentityAssociations request with the returned nextToken value. This
value can be between 1 and 100. If you don't use this parameter,
ListPodIdentityAssociations returns up to 100 results and a nextToken value if applicable.
- `"namespace"`: The name of the Kubernetes namespace inside the cluster that the
associations are in.
- `"nextToken"`: The nextToken value returned from a previous paginated ListUpdates request
where maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
token should be treated as an opaque identifier that is used only to retrieve the next
items in a list and not for other programmatic purposes.
- `"serviceAccount"`: The name of the Kubernetes service account that the associations use.
"""
function list_pod_identity_associations(
name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/pod-identity-associations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pod_identity_associations(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/pod-identity-associations",
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 for an Amazon EKS resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource to list tags
for.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"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 eks(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_updates(name)
list_updates(name, params::Dict{String,<:Any})
Lists the updates associated with an Amazon EKS resource in your Amazon Web Services
account, in the specified Amazon Web Services Region.
# Arguments
- `name`: The name of the Amazon EKS cluster to list updates for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addonName"`: The names of the installed add-ons that have available updates.
- `"maxResults"`: The maximum number of results, returned in paginated output. You receive
maxResults in a single page, along with a nextToken response element. You can see the
remaining results of the initial request by sending another request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100
results and a nextToken value, if applicable, are returned.
- `"nextToken"`: The nextToken value returned from a previous paginated request, where
maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value. This
value is null when there are no more results to return. This token should be treated as an
opaque identifier that is used only to retrieve the next items in a list and not for other
programmatic purposes.
- `"nodegroupName"`: The name of the Amazon EKS managed node group to list updates for.
"""
function list_updates(name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"GET",
"/clusters/$(name)/updates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_updates(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"GET",
"/clusters/$(name)/updates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_cluster(connector_config, name)
register_cluster(connector_config, name, params::Dict{String,<:Any})
Connects a Kubernetes cluster to the Amazon EKS control plane. Any Kubernetes cluster can
be connected to the Amazon EKS control plane to view current information about the cluster
and its nodes. Cluster connection requires two steps. First, send a
RegisterClusterRequest to add it to the Amazon EKS control plane. Second, a Manifest
containing the activationID and activationCode must be applied to the Kubernetes cluster
through it's native provider to provide visibility. After the manifest is updated and
applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest
isn't applied within three days, the connected cluster will no longer be visible and must
be deregistered using DeregisterCluster.
# Arguments
- `connector_config`: The configuration settings required to connect the Kubernetes cluster
to the Amazon EKS control plane.
- `name`: A unique name for this cluster in your Amazon Web Services Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"tags"`: Metadata that assists with categorization and organization. Each tag consists
of a key and an optional value. You define both. Tags don't propagate to any other cluster
or Amazon Web Services resources.
"""
function register_cluster(
connectorConfig, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/cluster-registrations",
Dict{String,Any}(
"connectorConfig" => connectorConfig,
"name" => name,
"clientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_cluster(
connectorConfig,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/cluster-registrations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"connectorConfig" => connectorConfig,
"name" => name,
"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})
Associates the specified tags to an Amazon EKS resource with the specified resourceArn. If
existing tags on a resource are not specified in the request parameters, they aren't
changed. When a resource is deleted, the tags associated with that resource are also
deleted. Tags that you create for Amazon EKS resources don't propagate to any other
resources associated with the cluster. For example, if you tag a cluster with this
operation, that tag doesn't automatically propagate to the subnets and nodes associated
with the cluster.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to add tags to.
- `tags`: Metadata that assists with categorization and organization. Each tag consists of
a key and an optional value. You define both. Tags don't propagate to any other cluster or
Amazon Web Services resources.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"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 eks(
"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 an Amazon EKS resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to delete tags from.
- `tag_keys`: The keys of the tags to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"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 eks(
"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_access_entry(name, principal_arn)
update_access_entry(name, principal_arn, params::Dict{String,<:Any})
Updates an access entry.
# Arguments
- `name`: The name of your cluster.
- `principal_arn`: The ARN of the IAM principal for the AccessEntry.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"kubernetesGroups"`: The value for name that you've specified for kind: Group as a
subject in a Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn't
confirm that the value for name exists in any bindings on your cluster. You can specify one
or more names. Kubernetes authorizes the principalArn of the access entry to access any
cluster objects that you've specified in a Kubernetes Role or ClusterRole object that is
also specified in a binding's roleRef. For more information about creating Kubernetes
RoleBinding, ClusterRoleBinding, Role, or ClusterRole objects, see Using RBAC Authorization
in the Kubernetes documentation. If you want Amazon EKS to authorize the principalArn
(instead of, or in addition to Kubernetes authorizing the principalArn), you can associate
one or more access policies to the access entry using AssociateAccessPolicy. If you
associate any access policies, the principalARN has all permissions assigned in the
associated access policies and all permissions in any Kubernetes Role or ClusterRole
objects that the group names are bound to.
- `"username"`: The username to authenticate to Kubernetes with. We recommend not
specifying a username and letting Amazon EKS specify it for you. For more information about
the value Amazon EKS specifies for you, or constraints before specifying your own username,
see Creating access entries in the Amazon EKS User Guide.
"""
function update_access_entry(
name, principalArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/access-entries/$(principalArn)",
Dict{String,Any}("clientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_access_entry(
name,
principalArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/access-entries/$(principalArn)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("clientRequestToken" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_addon(addon_name, name)
update_addon(addon_name, name, params::Dict{String,<:Any})
Updates an Amazon EKS add-on.
# Arguments
- `addon_name`: The name of the add-on. The name must match one of the names returned by
ListAddons .
- `name`: The name of your cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addonVersion"`: The version of the add-on. The version must match one of the versions
returned by DescribeAddonVersions .
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"configurationValues"`: The set of configuration values for the add-on that's created.
The values that you provide are validated against the schema returned by
DescribeAddonConfiguration.
- `"podIdentityAssociations"`: An array of Pod Identity Assocations to be updated. Each EKS
Pod Identity association maps a Kubernetes service account to an IAM Role. If this value is
left blank, no change. If an empty array is provided, existing Pod Identity Assocations
owned by the Addon are deleted. For more information, see Attach an IAM Role to an Amazon
EKS add-on using Pod Identity in the EKS User Guide.
- `"resolveConflicts"`: How to resolve field value conflicts for an Amazon EKS add-on if
you've changed a value from the Amazon EKS default value. Conflicts are handled based on
the option you choose: None – Amazon EKS doesn't change the value. The update might
fail. Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS
default value. Preserve – Amazon EKS preserves the value. If you choose this option,
we recommend that you test any field and value changes on a non-production cluster before
updating the add-on on your production cluster.
- `"serviceAccountRoleArn"`: The Amazon Resource Name (ARN) of an existing IAM role to bind
to the add-on's service account. The role must be assigned the IAM permissions required by
the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions
assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the
Amazon EKS User Guide. To specify an existing IAM role, you must have an IAM OpenID
Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM
roles for service accounts on your cluster in the Amazon EKS User Guide.
"""
function update_addon(addonName, name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"POST",
"/clusters/$(name)/addons/$(addonName)/update",
Dict{String,Any}("clientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_addon(
addonName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/addons/$(addonName)/update",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("clientRequestToken" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cluster_config(name)
update_cluster_config(name, params::Dict{String,<:Any})
Updates an Amazon EKS cluster configuration. Your cluster continues to function during the
update. The response output includes an update ID that you can use to track the status of
your cluster update with DescribeUpdate\"/>. You can use this API operation to enable or
disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By
default, cluster control plane logs aren't exported to CloudWatch Logs. For more
information, see Amazon EKS Cluster control plane logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported
control plane logs. For more information, see CloudWatch Pricing. You can also use this
API operation to enable or disable public and private access to your cluster's Kubernetes
API server endpoint. By default, public access is enabled, and private access is disabled.
For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS
User Guide . You can also use this API operation to choose different subnets and security
groups for the cluster. You must specify at least two subnets that are in different
Availability Zones. You can't change which VPC the subnets are from, the subnets must be in
the same VPC as the subnets that the cluster was created with. For more information about
the VPC requirements, see
https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User
Guide . Cluster updates are asynchronous, and they should finish within a few minutes.
During an update, the cluster status moves to UPDATING (this status transition is
eventually consistent). When the update is complete (either Failed or Successful), the
cluster status moves to Active.
# Arguments
- `name`: The name of the Amazon EKS cluster to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accessConfig"`: The access configuration for the cluster.
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"logging"`: Enable or disable exporting the Kubernetes control plane logs for your
cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to
CloudWatch Logs. For more information, see Amazon EKS cluster control plane logs in the
Amazon EKS User Guide . CloudWatch Logs ingestion, archive storage, and data scanning
rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
- `"resourcesVpcConfig"`:
"""
function update_cluster_config(name; aws_config::AbstractAWSConfig=global_aws_config())
return eks(
"POST",
"/clusters/$(name)/update-config",
Dict{String,Any}("clientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster_config(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/update-config",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("clientRequestToken" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cluster_version(name, version)
update_cluster_version(name, version, params::Dict{String,<:Any})
Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues
to function during the update. The response output includes an update ID that you can use
to track the status of your cluster update with the DescribeUpdate API operation. Cluster
updates are asynchronous, and they should finish within a few minutes. During an update,
the cluster status moves to UPDATING (this status transition is eventually consistent).
When the update is complete (either Failed or Successful), the cluster status moves to
Active. If your cluster has managed node groups attached to it, all of your node groups’
Kubernetes versions must match the cluster’s Kubernetes version in order to update the
cluster to a new Kubernetes version.
# Arguments
- `name`: The name of the Amazon EKS cluster to update.
- `version`: The desired Kubernetes version following a successful update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
"""
function update_cluster_version(
name, version; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/updates",
Dict{String,Any}("version" => version, "clientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cluster_version(
name,
version,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/updates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"version" => version, "clientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_eks_anywhere_subscription(auto_renew, id)
update_eks_anywhere_subscription(auto_renew, id, params::Dict{String,<:Any})
Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after
subscription creation.
# Arguments
- `auto_renew`: A boolean indicating whether or not to automatically renew the subscription.
- `id`: The ID of the subscription.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: Unique, case-sensitive identifier to ensure the idempotency of
the request.
"""
function update_eks_anywhere_subscription(
autoRenew, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/eks-anywhere-subscriptions/$(id)",
Dict{String,Any}("autoRenew" => autoRenew, "clientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_eks_anywhere_subscription(
autoRenew,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/eks-anywhere-subscriptions/$(id)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"autoRenew" => autoRenew, "clientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_nodegroup_config(name, nodegroup_name)
update_nodegroup_config(name, nodegroup_name, params::Dict{String,<:Any})
Updates an Amazon EKS managed node group configuration. Your node group continues to
function during the update. The response output includes an update ID that you can use to
track the status of your node group update with the DescribeUpdate API operation. Currently
you can update the Kubernetes labels for a node group or the scaling configuration.
# Arguments
- `name`: The name of your cluster.
- `nodegroup_name`: The name of the managed node group to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"labels"`: The Kubernetes labels to apply to the nodes in the node group after the
update.
- `"scalingConfig"`: The scaling configuration details for the Auto Scaling group after the
update.
- `"taints"`: The Kubernetes taints to be applied to the nodes in the node group after the
update. For more information, see Node taints on managed node groups.
- `"updateConfig"`: The node group update configuration.
"""
function update_nodegroup_config(
name, nodegroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/node-groups/$(nodegroupName)/update-config",
Dict{String,Any}("clientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_nodegroup_config(
name,
nodegroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/node-groups/$(nodegroupName)/update-config",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("clientRequestToken" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_nodegroup_version(name, nodegroup_name)
update_nodegroup_version(name, nodegroup_name, params::Dict{String,<:Any})
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group. You can
update a node group using a launch template only if the node group was originally deployed
with a launch template. If you need to update a custom AMI in a node group that was
deployed with a launch template, then update your custom AMI, specify the new ID in a new
version of the launch template, and then update the node group to the new version of the
launch template. If you update without a launch template, then you can update to the latest
available AMI version of a node group's current Kubernetes version by not specifying a
Kubernetes version in the request. You can update to the latest AMI version of your
cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the
request. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI
versions in the Amazon EKS User Guide. For information about Windows versions, see Amazon
EKS optimized Windows AMI versions in the Amazon EKS User Guide. You cannot roll back a
node group to an earlier Kubernetes version or AMI version. When a node in a managed node
group is terminated due to a scaling action or update, every Pod on that node is drained
first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to
do so. You can force the update if Amazon EKS is unable to drain the nodes as a result of a
Pod disruption budget issue.
# Arguments
- `name`: The name of your cluster.
- `nodegroup_name`: The name of the managed node group to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"force"`: Force the update if any Pod on the existing node group can't be drained due to
a Pod disruption budget issue. If an update fails because all Pods can't be drained, you
can force the update after it fails to terminate the old node whether or not any Pod is
running on the node.
- `"launchTemplate"`: An object representing a node group's launch template specification.
You can only update a node group using a launch template if the node group was originally
deployed with a launch template.
- `"releaseVersion"`: The AMI version of the Amazon EKS optimized AMI to use for the
update. By default, the latest available AMI version for the node group's Kubernetes
version is used. For information about Linux versions, see Amazon EKS optimized Amazon
Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the
November 2022 and later releases of the Windows AMIs. For information about Windows
versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide. If
you specify launchTemplate, and your launch template uses a custom AMI, then don't specify
releaseVersion, or the node group update will fail. For more information about using launch
templates with Amazon EKS, see Customizing managed nodes with launch templates in the
Amazon EKS User Guide.
- `"version"`: The Kubernetes version to update to. If no version is specified, then the
Kubernetes version of the node group does not change. You can specify the Kubernetes
version of the cluster to update the node group to the latest AMI version of the cluster's
Kubernetes version. If you specify launchTemplate, and your launch template uses a custom
AMI, then don't specify version, or the node group update will fail. For more information
about using launch templates with Amazon EKS, see Customizing managed nodes with launch
templates in the Amazon EKS User Guide.
"""
function update_nodegroup_version(
name, nodegroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/node-groups/$(nodegroupName)/update-version",
Dict{String,Any}("clientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_nodegroup_version(
name,
nodegroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/node-groups/$(nodegroupName)/update-version",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("clientRequestToken" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_pod_identity_association(association_id, name)
update_pod_identity_association(association_id, name, params::Dict{String,<:Any})
Updates a EKS Pod Identity association. Only the IAM role can be changed; an association
can't be moved between clusters, namespaces, or service accounts. If you need to edit the
namespace or service account, you need to delete the association and then create a new
association with your desired settings.
# Arguments
- `association_id`: The ID of the association to be updated.
- `name`: The name of the cluster that you want to update the association in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientRequestToken"`: A unique, case-sensitive identifier that you provide to ensure
the idempotency of the request.
- `"roleArn"`: The new IAM role to change the
"""
function update_pod_identity_association(
associationId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks(
"POST",
"/clusters/$(name)/pod-identity-associations/$(associationId)",
Dict{String,Any}("clientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pod_identity_association(
associationId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks(
"POST",
"/clusters/$(name)/pod-identity-associations/$(associationId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("clientRequestToken" => 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 | 1535 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: eks_auth
using AWS.Compat
using AWS.UUIDs
"""
assume_role_for_pod_identity(cluster_name, token)
assume_role_for_pod_identity(cluster_name, token, params::Dict{String,<:Any})
The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS
Pod Identity Agent. We recommend that applications use the Amazon Web Services SDKs to
connect to Amazon Web Services services; if credentials from an EKS Pod Identity
association are available in the pod, the latest versions of the SDKs use them
automatically.
# Arguments
- `cluster_name`: The name of the cluster for the request.
- `token`: The token of the Kubernetes service account for the pod.
"""
function assume_role_for_pod_identity(
clusterName, token; aws_config::AbstractAWSConfig=global_aws_config()
)
return eks_auth(
"POST",
"/clusters/$(clusterName)/assume-role-for-pod-identity",
Dict{String,Any}("token" => token);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function assume_role_for_pod_identity(
clusterName,
token,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eks_auth(
"POST",
"/clusters/$(clusterName)/assume-role-for-pod-identity",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("token" => token), 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 | 83942 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: elastic_beanstalk
using AWS.Compat
using AWS.UUIDs
"""
abort_environment_update()
abort_environment_update(params::Dict{String,<:Any})
Cancels in-progress environment configuration update or application version deployment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentId"`: This specifies the ID of the environment with the in-progress update
that you want to cancel.
- `"EnvironmentName"`: This specifies the name of the environment with the in-progress
update that you want to cancel.
"""
function abort_environment_update(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"AbortEnvironmentUpdate"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function abort_environment_update(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"AbortEnvironmentUpdate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
apply_environment_managed_action(action_id)
apply_environment_managed_action(action_id, params::Dict{String,<:Any})
Applies a scheduled managed action immediately. A managed action can be applied only if its
status is Scheduled. Get the status and action ID of a managed action with
DescribeEnvironmentManagedActions.
# Arguments
- `action_id`: The action ID of the scheduled managed action to execute.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentId"`: The environment ID of the target environment.
- `"EnvironmentName"`: The name of the target environment.
"""
function apply_environment_managed_action(
ActionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"ApplyEnvironmentManagedAction",
Dict{String,Any}("ActionId" => ActionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function apply_environment_managed_action(
ActionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"ApplyEnvironmentManagedAction",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ActionId" => ActionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_environment_operations_role(environment_name, operations_role)
associate_environment_operations_role(environment_name, operations_role, params::Dict{String,<:Any})
Add or change the operations role used by an environment. After this call is made, Elastic
Beanstalk uses the associated operations role for permissions to downstream services during
subsequent calls acting on this environment. For more information, see Operations roles in
the AWS Elastic Beanstalk Developer Guide.
# Arguments
- `environment_name`: The name of the environment to which to set the operations role.
- `operations_role`: The Amazon Resource Name (ARN) of an existing IAM role to be used as
the environment's operations role.
"""
function associate_environment_operations_role(
EnvironmentName, OperationsRole; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"AssociateEnvironmentOperationsRole",
Dict{String,Any}(
"EnvironmentName" => EnvironmentName, "OperationsRole" => OperationsRole
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_environment_operations_role(
EnvironmentName,
OperationsRole,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"AssociateEnvironmentOperationsRole",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EnvironmentName" => EnvironmentName, "OperationsRole" => OperationsRole
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
check_dnsavailability(cnameprefix)
check_dnsavailability(cnameprefix, params::Dict{String,<:Any})
Checks if the specified CNAME is available.
# Arguments
- `cnameprefix`: The prefix used when this CNAME is reserved.
"""
function check_dnsavailability(
CNAMEPrefix; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"CheckDNSAvailability",
Dict{String,Any}("CNAMEPrefix" => CNAMEPrefix);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function check_dnsavailability(
CNAMEPrefix,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"CheckDNSAvailability",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CNAMEPrefix" => CNAMEPrefix), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
compose_environments()
compose_environments(params::Dict{String,<:Any})
Create or update a group of environments that each run a separate component of a single
application. Takes a list of version labels that specify application source bundles for
each of the environments to create or update. The name of each environment and other
required information must be included in the source bundles in an environment manifest
named env.yaml. See Compose Environments for details.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationName"`: The name of the application to which the specified source bundles
belong.
- `"GroupName"`: The name of the group to which the target environments belong. Specify a
group name only if the environment name defined in each target environment's manifest ends
with a + (plus) character. See Environment Manifest (env.yaml) for details.
- `"VersionLabels"`: A list of version labels, specifying one or more application source
bundles that belong to the target application. Each source bundle must include an
environment manifest that specifies the name of the environment and the name of the
solution stack to use, and optionally can specify environment links to create.
"""
function compose_environments(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"ComposeEnvironments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function compose_environments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"ComposeEnvironments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application(application_name)
create_application(application_name, params::Dict{String,<:Any})
Creates an application that has one configuration template named default and no application
versions.
# Arguments
- `application_name`: The name of the application. Must be unique within your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: Your description of the application.
- `"ResourceLifecycleConfig"`: Specifies an application resource lifecycle configuration to
prevent your application from accumulating too many versions.
- `"Tags"`: Specifies the tags applied to the application. Elastic Beanstalk applies these
tags only to the application. Environments that you create in the application don't inherit
the tags.
"""
function create_application(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"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 elastic_beanstalk(
"CreateApplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application_version(application_name, version_label)
create_application_version(application_name, version_label, params::Dict{String,<:Any})
Creates an application version for the specified application. You can create an application
version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an
AWS CodeBuild build as follows: Specify a commit in an AWS CodeCommit repository with
SourceBuildInformation. Specify a build in an AWS CodeBuild with SourceBuildInformation and
BuildConfiguration. Specify a source bundle in S3 with SourceBundle Omit both
SourceBuildInformation and SourceBundle to use the default sample application. After you
create an application version with a specified Amazon S3 bucket and key location, you can't
change that Amazon S3 location. If you change the Amazon S3 location, you receive an
exception when you attempt to launch an environment from the application version.
# Arguments
- `application_name`: The name of the application. If no application is found with this
name, and AutoCreateApplication is false, returns an InvalidParameterValue error.
- `version_label`: A label identifying this version. Constraint: Must be unique per
application. If an application version already exists with this label for the specified
application, AWS Elastic Beanstalk returns an InvalidParameterValue error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoCreateApplication"`: Set to true to create an application with the specified name
if it doesn't already exist.
- `"BuildConfiguration"`: Settings for an AWS CodeBuild build.
- `"Description"`: A description of this application version.
- `"Process"`: Pre-processes and validates the environment manifest (env.yaml) and
configuration files (*.config files in the .ebextensions folder) in the source bundle.
Validating configuration files can identify issues prior to deploying the application
version to an environment. You must turn processing on for application versions that you
create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source
bundle in Amazon S3, processing is optional. The Process option validates Elastic
Beanstalk configuration files. It doesn't validate your application's configuration files,
like proxy server or Docker configuration.
- `"SourceBuildInformation"`: Specify a commit in an AWS CodeCommit Git repository to use
as the source code for the application version.
- `"SourceBundle"`: The Amazon S3 bucket and key that identify the location of the source
bundle for this version. The Amazon S3 bucket must be in the same region as the
environment. Specify a source bundle in S3 or a commit in an AWS CodeCommit repository
(with SourceBuildInformation), but not both. If neither SourceBundle nor
SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.
- `"Tags"`: Specifies the tags applied to the application version. Elastic Beanstalk
applies these tags only to the application version. Environments that use the application
version don't inherit the tags.
"""
function create_application_version(
ApplicationName, VersionLabel; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"CreateApplicationVersion",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "VersionLabel" => VersionLabel
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application_version(
ApplicationName,
VersionLabel,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"CreateApplicationVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName, "VersionLabel" => VersionLabel
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_configuration_template(application_name, template_name)
create_configuration_template(application_name, template_name, params::Dict{String,<:Any})
Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic
Beanstalk application. You define application configuration settings in a configuration
template. You can then use the configuration template to deploy different versions of the
application with the same configuration settings. Templates aren't associated with any
environment. The EnvironmentName response element is always null. Related Topics
DescribeConfigurationOptions DescribeConfigurationSettings
ListAvailableSolutionStacks
# Arguments
- `application_name`: The name of the Elastic Beanstalk application to associate with this
configuration template.
- `template_name`: The name of the configuration template. Constraint: This name must be
unique per application.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: An optional description for this configuration.
- `"EnvironmentId"`: The ID of an environment whose settings you want to use to create the
configuration template. You must specify EnvironmentId if you don't specify PlatformArn,
SolutionStackName, or SourceConfiguration.
- `"OptionSettings"`: Option values for the Elastic Beanstalk configuration, such as the
instance type. If specified, these values override the values obtained from the solution
stack or the source configuration template. For a complete list of Elastic Beanstalk
configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
- `"PlatformArn"`: The Amazon Resource Name (ARN) of the custom platform. For more
information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide. If you
specify PlatformArn, then don't specify SolutionStackName.
- `"SolutionStackName"`: The name of an Elastic Beanstalk solution stack (platform version)
that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java
7. A solution stack specifies the operating system, runtime, and application server for a
configuration template. It also determines the set of configuration options as well as the
possible and default values. For more information, see Supported Platforms in the AWS
Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify
PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks
API to obtain a list of available solution stacks.
- `"SourceConfiguration"`: An Elastic Beanstalk configuration template to base this one on.
If specified, Elastic Beanstalk uses the configuration values from the specified
configuration template to create a new configuration. Values specified in OptionSettings
override any values obtained from the SourceConfiguration. You must specify
SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.
Constraint: If both solution stack name and source configuration are specified, the
solution stack of the source configuration template must match the specified solution stack
name.
- `"Tags"`: Specifies the tags applied to the configuration template.
"""
function create_configuration_template(
ApplicationName, TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"CreateConfigurationTemplate",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "TemplateName" => TemplateName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_configuration_template(
ApplicationName,
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"CreateConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName, "TemplateName" => TemplateName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_environment(application_name)
create_environment(application_name, params::Dict{String,<:Any})
Launches an AWS Elastic Beanstalk environment for the specified application using the
specified configuration.
# Arguments
- `application_name`: The name of the application that is associated with this environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CNAMEPrefix"`: If specified, the environment attempts to use this value as the prefix
for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is
generated automatically by appending a random alphanumeric string to the environment name.
- `"Description"`: Your description for this environment.
- `"EnvironmentName"`: A unique name for the environment. Constraint: Must be from 4 to 40
characters in length. The name can contain only letters, numbers, and hyphens. It can't
start or end with a hyphen. This name must be unique within a region in your account. If
the specified name already exists in the region, Elastic Beanstalk returns an
InvalidParameterValue error. If you don't specify the CNAMEPrefix parameter, the
environment name becomes part of the CNAME, and therefore part of the visible URL for your
application.
- `"GroupName"`: The name of the group to which the target environment belongs. Specify a
group name only if the environment's name is specified in an environment manifest and not
with the environment name parameter. See Environment Manifest (env.yaml) for details.
- `"OperationsRole"`: The Amazon Resource Name (ARN) of an existing IAM role to be used as
the environment's operations role. If specified, Elastic Beanstalk uses the operations role
for permissions to downstream services during this call and during subsequent calls acting
on this environment. To specify an operations role, you must have the iam:PassRole
permission for the role. For more information, see Operations roles in the AWS Elastic
Beanstalk Developer Guide.
- `"OptionSettings"`: If specified, AWS Elastic Beanstalk sets the specified configuration
options to the requested value in the configuration set for the new environment. These
override the values obtained from the solution stack or the configuration template.
- `"OptionsToRemove"`: A list of custom user-defined configuration options to remove from
the configuration set for this new environment.
- `"PlatformArn"`: The Amazon Resource Name (ARN) of the custom platform to use with the
environment. For more information, see Custom Platforms in the AWS Elastic Beanstalk
Developer Guide. If you specify PlatformArn, don't specify SolutionStackName.
- `"SolutionStackName"`: The name of an Elastic Beanstalk solution stack (platform version)
to use with the environment. If specified, Elastic Beanstalk sets the configuration values
to the default values associated with the specified solution stack. For a list of current
solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk
Platforms guide. If you specify SolutionStackName, don't specify PlatformArn or
TemplateName.
- `"Tags"`: Specifies the tags applied to resources in the environment.
- `"TemplateName"`: The name of the Elastic Beanstalk configuration template to use with
the environment. If you specify TemplateName, then don't specify SolutionStackName.
- `"Tier"`: Specifies the tier to use in creating this environment. The environment tier
that you choose determines whether Elastic Beanstalk provisions resources to support a web
application that handles HTTP(S) requests or a web application that handles
background-processing tasks.
- `"VersionLabel"`: The name of the application version to deploy. Default: If not
specified, Elastic Beanstalk attempts to deploy the sample application.
"""
function create_environment(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"CreateEnvironment",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"CreateEnvironment",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_platform_version(platform_definition_bundle, platform_name, platform_version)
create_platform_version(platform_definition_bundle, platform_name, platform_version, params::Dict{String,<:Any})
Create a new version of your custom platform.
# Arguments
- `platform_definition_bundle`: The location of the platform definition archive in Amazon
S3.
- `platform_name`: The name of your custom platform.
- `platform_version`: The number, such as 1.0.2, for the new platform version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentName"`: The name of the builder environment.
- `"OptionSettings"`: The configuration option settings to apply to the builder environment.
- `"Tags"`: Specifies the tags applied to the new platform version. Elastic Beanstalk
applies these tags only to the platform version. Environments that you create using the
platform version don't inherit the tags.
"""
function create_platform_version(
PlatformDefinitionBundle,
PlatformName,
PlatformVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"CreatePlatformVersion",
Dict{String,Any}(
"PlatformDefinitionBundle" => PlatformDefinitionBundle,
"PlatformName" => PlatformName,
"PlatformVersion" => PlatformVersion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_platform_version(
PlatformDefinitionBundle,
PlatformName,
PlatformVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"CreatePlatformVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PlatformDefinitionBundle" => PlatformDefinitionBundle,
"PlatformName" => PlatformName,
"PlatformVersion" => PlatformVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_storage_location()
create_storage_location(params::Dict{String,<:Any})
Creates a bucket in Amazon S3 to store application versions, logs, and other files used by
Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the
first time you create an environment in a region. If the storage location already exists,
CreateStorageLocation still returns the bucket name but does not create a new bucket.
"""
function create_storage_location(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"CreateStorageLocation"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function create_storage_location(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"CreateStorageLocation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_name)
delete_application(application_name, params::Dict{String,<:Any})
Deletes the specified application along with all associated versions and configurations.
The application versions will not be deleted from your Amazon S3 bucket. You cannot delete
an application that has a running environment.
# Arguments
- `application_name`: The name of the application to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TerminateEnvByForce"`: When set to true, running environments will be terminated before
deleting the application.
"""
function delete_application(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DeleteApplication",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"DeleteApplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application_version(application_name, version_label)
delete_application_version(application_name, version_label, params::Dict{String,<:Any})
Deletes the specified version from the specified application. You cannot delete an
application version that is associated with a running environment.
# Arguments
- `application_name`: The name of the application to which the version belongs.
- `version_label`: The label of the version to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteSourceBundle"`: Set to true to delete the source bundle from your storage bucket.
Otherwise, the application version is deleted only from Elastic Beanstalk and the source
bundle remains in Amazon S3.
"""
function delete_application_version(
ApplicationName, VersionLabel; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DeleteApplicationVersion",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "VersionLabel" => VersionLabel
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_application_version(
ApplicationName,
VersionLabel,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"DeleteApplicationVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName, "VersionLabel" => VersionLabel
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_configuration_template(application_name, template_name)
delete_configuration_template(application_name, template_name, params::Dict{String,<:Any})
Deletes the specified configuration template. When you launch an environment using a
configuration template, the environment gets a copy of the template. You can delete or
modify the environment's copy of the template without affecting the running environment.
# Arguments
- `application_name`: The name of the application to delete the configuration template from.
- `template_name`: The name of the configuration template to delete.
"""
function delete_configuration_template(
ApplicationName, TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DeleteConfigurationTemplate",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "TemplateName" => TemplateName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_configuration_template(
ApplicationName,
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"DeleteConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName, "TemplateName" => TemplateName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment_configuration(application_name, environment_name)
delete_environment_configuration(application_name, environment_name, params::Dict{String,<:Any})
Deletes the draft configuration associated with the running environment. Updating a running
environment with any configuration changes creates a draft configuration set. You can get
the draft configuration using DescribeConfigurationSettings while the update is in progress
or if the update fails. The DeploymentStatus for the draft configuration indicates whether
the deployment is in process or has failed. The draft configuration remains in existence
until it is deleted with this action.
# Arguments
- `application_name`: The name of the application the environment is associated with.
- `environment_name`: The name of the environment to delete the draft configuration from.
"""
function delete_environment_configuration(
ApplicationName, EnvironmentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DeleteEnvironmentConfiguration",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "EnvironmentName" => EnvironmentName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_environment_configuration(
ApplicationName,
EnvironmentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"DeleteEnvironmentConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"EnvironmentName" => EnvironmentName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_platform_version()
delete_platform_version(params::Dict{String,<:Any})
Deletes the specified version of a custom platform.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PlatformArn"`: The ARN of the version of the custom platform.
"""
function delete_platform_version(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"DeletePlatformVersion"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_platform_version(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DeletePlatformVersion",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_attributes()
describe_account_attributes(params::Dict{String,<:Any})
Returns attributes related to AWS Elastic Beanstalk that are associated with the calling
AWS account. The result currently has one set of attributes—resource quotas.
"""
function describe_account_attributes(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"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 elastic_beanstalk(
"DescribeAccountAttributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_application_versions()
describe_application_versions(params::Dict{String,<:Any})
Retrieve a list of application versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationName"`: Specify an application name to show only application versions for
that application.
- `"MaxRecords"`: For a paginated request. Specify a maximum number of application versions
to include in each response. If no MaxRecords is specified, all available application
versions are retrieved in a single response.
- `"NextToken"`: For a paginated request. Specify a token from a previous response page to
retrieve the next response page. All other parameter values must be identical to the ones
specified in the initial request. If no NextToken is specified, the first page is retrieved.
- `"VersionLabels"`: Specify a version label to show a specific application version.
"""
function describe_application_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"DescribeApplicationVersions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_application_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeApplicationVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_applications()
describe_applications(params::Dict{String,<:Any})
Returns the descriptions of existing applications.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationNames"`: If specified, AWS Elastic Beanstalk restricts the returned
descriptions to only include those with the specified names.
"""
function describe_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"DescribeApplications"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_applications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeApplications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration_options()
describe_configuration_options(params::Dict{String,<:Any})
Describes the configuration options that are used in a particular configuration template or
environment, or that a specified solution stack defines. The description includes the
values the options, their default values, and an indication of the required action on a
running environment if an option value is changed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationName"`: The name of the application associated with the configuration
template or environment. Only needed if you want to describe the configuration options
associated with either the configuration template or environment.
- `"EnvironmentName"`: The name of the environment whose configuration options you want to
describe.
- `"Options"`: If specified, restricts the descriptions to only the specified options.
- `"PlatformArn"`: The ARN of the custom platform.
- `"SolutionStackName"`: The name of the solution stack whose configuration options you
want to describe.
- `"TemplateName"`: The name of the configuration template whose configuration options you
want to describe.
"""
function describe_configuration_options(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"DescribeConfigurationOptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeConfigurationOptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_configuration_settings(application_name)
describe_configuration_settings(application_name, params::Dict{String,<:Any})
Returns a description of the settings for the specified configuration set, that is, either
a configuration template or the configuration set associated with a running environment.
When describing the settings for the configuration set associated with a running
environment, it is possible to receive two sets of setting descriptions. One is the
deployed configuration set, and the other is a draft configuration of an environment that
is either in the process of deployment or that failed to deploy. Related Topics
DeleteEnvironmentConfiguration
# Arguments
- `application_name`: The application for the environment or configuration template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentName"`: The name of the environment to describe. Condition: You must
specify either this or a TemplateName, but not both. If you specify both, AWS Elastic
Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS
Elastic Beanstalk returns MissingRequiredParameter error.
- `"TemplateName"`: The name of the configuration template to describe. Conditional: You
must specify either this parameter or an EnvironmentName, but not both. If you specify
both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not
specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
"""
function describe_configuration_settings(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeConfigurationSettings",
Dict{String,Any}("ApplicationName" => ApplicationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_configuration_settings(
ApplicationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"DescribeConfigurationSettings",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_environment_health()
describe_environment_health(params::Dict{String,<:Any})
Returns information about the overall health of the specified environment. The
DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced
Health.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeNames"`: Specify the response elements to return. To retrieve all attributes,
set to All. If no attribute names are specified, returns the name of the environment.
- `"EnvironmentId"`: Specify the environment by ID. You must specify either this or an
EnvironmentName, or both.
- `"EnvironmentName"`: Specify the environment by name. You must specify either this or an
EnvironmentName, or both.
"""
function describe_environment_health(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"DescribeEnvironmentHealth"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_environment_health(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeEnvironmentHealth",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_environment_managed_action_history()
describe_environment_managed_action_history(params::Dict{String,<:Any})
Lists an environment's completed and failed managed actions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentId"`: The environment ID of the target environment.
- `"EnvironmentName"`: The name of the target environment.
- `"MaxItems"`: The maximum number of items to return for a single request.
- `"NextToken"`: The pagination token returned by a previous request.
"""
function describe_environment_managed_action_history(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeEnvironmentManagedActionHistory";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_environment_managed_action_history(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeEnvironmentManagedActionHistory",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_environment_managed_actions()
describe_environment_managed_actions(params::Dict{String,<:Any})
Lists an environment's upcoming and in-progress managed actions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentId"`: The environment ID of the target environment.
- `"EnvironmentName"`: The name of the target environment.
- `"Status"`: To show only actions with a particular status, specify a status.
"""
function describe_environment_managed_actions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeEnvironmentManagedActions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_environment_managed_actions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeEnvironmentManagedActions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_environment_resources()
describe_environment_resources(params::Dict{String,<:Any})
Returns AWS resources for this environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentId"`: The ID of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentName, or both. If you do not
specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
- `"EnvironmentName"`: The name of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify
either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
"""
function describe_environment_resources(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"DescribeEnvironmentResources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_environment_resources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeEnvironmentResources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_environments()
describe_environments(params::Dict{String,<:Any})
Returns descriptions for existing environments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationName"`: If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that are associated with this application.
- `"EnvironmentIds"`: If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that have the specified IDs.
- `"EnvironmentNames"`: If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those that have the specified names.
- `"IncludeDeleted"`: Indicates whether to include deleted environments: true:
Environments that have been deleted after IncludedDeletedBackTo are displayed. false: Do
not include deleted environments.
- `"IncludedDeletedBackTo"`: If specified when IncludeDeleted is set to true, then
environments deleted after this date are displayed.
- `"MaxRecords"`: For a paginated request. Specify a maximum number of environments to
include in each response. If no MaxRecords is specified, all available environments are
retrieved in a single response.
- `"NextToken"`: For a paginated request. Specify a token from a previous response page to
retrieve the next response page. All other parameter values must be identical to the ones
specified in the initial request. If no NextToken is specified, the first page is retrieved.
- `"VersionLabel"`: If specified, AWS Elastic Beanstalk restricts the returned descriptions
to include only those that are associated with this application version.
"""
function describe_environments(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"DescribeEnvironments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_environments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeEnvironments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Returns list of event descriptions matching criteria up to the last 6 weeks. This action
returns the most recent 1,000 events from the specified NextToken.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationName"`: If specified, AWS Elastic Beanstalk restricts the returned
descriptions to include only those associated with this application.
- `"EndTime"`: If specified, AWS Elastic Beanstalk restricts the returned descriptions to
those that occur up to, but not including, the EndTime.
- `"EnvironmentId"`: If specified, AWS Elastic Beanstalk restricts the returned
descriptions to those associated with this environment.
- `"EnvironmentName"`: If specified, AWS Elastic Beanstalk restricts the returned
descriptions to those associated with this environment.
- `"MaxRecords"`: Specifies the maximum number of events that can be returned, beginning
with the most recent event.
- `"NextToken"`: Pagination token. If specified, the events return the next batch of
results.
- `"PlatformArn"`: The ARN of a custom platform version. If specified, AWS Elastic
Beanstalk restricts the returned descriptions to those associated with this custom platform
version.
- `"RequestId"`: If specified, AWS Elastic Beanstalk restricts the described events to
include only those associated with this request ID.
- `"Severity"`: If specified, limits the events returned from this call to include only
those with the specified severity or higher.
- `"StartTime"`: If specified, AWS Elastic Beanstalk restricts the returned descriptions to
those that occur on or after this time.
- `"TemplateName"`: If specified, AWS Elastic Beanstalk restricts the returned descriptions
to those that are associated with this environment configuration.
- `"VersionLabel"`: If specified, AWS Elastic Beanstalk restricts the returned descriptions
to those associated with this application version.
"""
function describe_events(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeEvents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_instances_health()
describe_instances_health(params::Dict{String,<:Any})
Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk.
This operation requires enhanced health reporting.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AttributeNames"`: Specifies the response elements you wish to receive. To retrieve all
attributes, set to All. If no attribute names are specified, returns a list of instances.
- `"EnvironmentId"`: Specify the AWS Elastic Beanstalk environment by ID.
- `"EnvironmentName"`: Specify the AWS Elastic Beanstalk environment by name.
- `"NextToken"`: Specify the pagination token returned by a previous call.
"""
function describe_instances_health(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"DescribeInstancesHealth"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_instances_health(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribeInstancesHealth",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_platform_version()
describe_platform_version(params::Dict{String,<:Any})
Describes a platform version. Provides full details. Compare to ListPlatformVersions, which
provides summary information about a list of platform versions. For definitions of platform
version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PlatformArn"`: The ARN of the platform version.
"""
function describe_platform_version(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"DescribePlatformVersion"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_platform_version(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DescribePlatformVersion",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_environment_operations_role(environment_name)
disassociate_environment_operations_role(environment_name, params::Dict{String,<:Any})
Disassociate the operations role from an environment. After this call is made, Elastic
Beanstalk uses the caller's permissions for permissions to downstream services during
subsequent calls acting on this environment. For more information, see Operations roles in
the AWS Elastic Beanstalk Developer Guide.
# Arguments
- `environment_name`: The name of the environment from which to disassociate the operations
role.
"""
function disassociate_environment_operations_role(
EnvironmentName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"DisassociateEnvironmentOperationsRole",
Dict{String,Any}("EnvironmentName" => EnvironmentName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_environment_operations_role(
EnvironmentName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"DisassociateEnvironmentOperationsRole",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EnvironmentName" => EnvironmentName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_available_solution_stacks()
list_available_solution_stacks(params::Dict{String,<:Any})
Returns a list of the available solution stack names, with the public version first and
then in reverse chronological order.
"""
function list_available_solution_stacks(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"ListAvailableSolutionStacks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_available_solution_stacks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"ListAvailableSolutionStacks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_platform_branches()
list_platform_branches(params::Dict{String,<:Any})
Lists the platform branches available for your account in an AWS Region. Provides summary
information about each platform branch. For definitions of platform branch and other
platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Criteria for restricting the resulting list of platform branches. The filter
is evaluated as a logical conjunction (AND) of the separate SearchFilter terms. The
following list shows valid attribute values for each of the SearchFilter terms. Most
operators take a single value. The in and not_in operators can take multiple values.
Attribute = BranchName: Operator: = | != | begins_with | ends_with | contains | in |
not_in Attribute = LifecycleState: Operator: = | != | in | not_in Values: beta
| supported | deprecated | retired Attribute = PlatformName: Operator: = | != |
begins_with | ends_with | contains | in | not_in Attribute = TierType: Operator: =
| != Values: WebServer/Standard | Worker/SQS/HTTP Array size: limited to 10
SearchFilter objects. Within each SearchFilter item, the Values array is limited to 10
items.
- `"MaxRecords"`: The maximum number of platform branch values returned in one call.
- `"NextToken"`: For a paginated request. Specify a token from a previous response page to
retrieve the next response page. All other parameter values must be identical to the ones
specified in the initial request. If no NextToken is specified, the first page is retrieved.
"""
function list_platform_branches(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"ListPlatformBranches"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_platform_branches(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"ListPlatformBranches",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_platform_versions()
list_platform_versions(params::Dict{String,<:Any})
Lists the platform versions available for your account in an AWS Region. Provides summary
information about each platform version. Compare to DescribePlatformVersion, which provides
full details about a single platform version. For definitions of platform version and other
platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Criteria for restricting the resulting list of platform versions. The filter
is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.
- `"MaxRecords"`: The maximum number of platform version values returned in one call.
- `"NextToken"`: For a paginated request. Specify a token from a previous response page to
retrieve the next response page. All other parameter values must be identical to the ones
specified in the initial request. If no NextToken is specified, the first page is retrieved.
"""
function list_platform_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"ListPlatformVersions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_platform_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"ListPlatformVersions",
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})
Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list
of tag key-value pairs. Elastic Beanstalk supports tagging of all of its resources. For
details about resource tagging, see Tagging Application Resources.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resouce for which a tag list is
requested. Must be the ARN of an Elastic Beanstalk resource.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"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 elastic_beanstalk(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rebuild_environment()
rebuild_environment(params::Dict{String,<:Any})
Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load
balancer, etc.) for a specified environment and forces a restart.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentId"`: The ID of the environment to rebuild. Condition: You must specify
either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter error.
- `"EnvironmentName"`: The name of the environment to rebuild. Condition: You must specify
either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter error.
"""
function rebuild_environment(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"RebuildEnvironment"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function rebuild_environment(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"RebuildEnvironment", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
request_environment_info(info_type)
request_environment_info(info_type, params::Dict{String,<:Any})
Initiates a request to compile the specified type of information of the deployed
environment. Setting the InfoType to tail compiles the last lines from the application
server log files of every Amazon EC2 instance in your environment. Setting the InfoType
to bundle compresses the application server log files for every Amazon EC2 instance into a
.zip file. Legacy and .NET containers do not support bundle logs. Use
RetrieveEnvironmentInfo to obtain the set of logs. Related Topics
RetrieveEnvironmentInfo
# Arguments
- `info_type`: The type of information to request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentId"`: The ID of the environment of the requested data. If no such
environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not
specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
- `"EnvironmentName"`: The name of the environment of the requested data. If no such
environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify
either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
"""
function request_environment_info(
InfoType; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"RequestEnvironmentInfo",
Dict{String,Any}("InfoType" => InfoType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function request_environment_info(
InfoType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"RequestEnvironmentInfo",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InfoType" => InfoType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restart_app_server()
restart_app_server(params::Dict{String,<:Any})
Causes the environment to restart the application container server running on each Amazon
EC2 instance.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentId"`: The ID of the environment to restart the server for. Condition: You
must specify either this or an EnvironmentName, or both. If you do not specify either, AWS
Elastic Beanstalk returns MissingRequiredParameter error.
- `"EnvironmentName"`: The name of the environment to restart the server for. Condition:
You must specify either this or an EnvironmentId, or both. If you do not specify either,
AWS Elastic Beanstalk returns MissingRequiredParameter error.
"""
function restart_app_server(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"RestartAppServer"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function restart_app_server(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"RestartAppServer", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
retrieve_environment_info(info_type)
retrieve_environment_info(info_type, params::Dict{String,<:Any})
Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics
RequestEnvironmentInfo
# Arguments
- `info_type`: The type of information to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentId"`: The ID of the data's environment. If no such environment is found,
returns an InvalidParameterValue error. Condition: You must specify either this or an
EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
- `"EnvironmentName"`: The name of the data's environment. If no such environment is
found, returns an InvalidParameterValue error. Condition: You must specify either this or
an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
"""
function retrieve_environment_info(
InfoType; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"RetrieveEnvironmentInfo",
Dict{String,Any}("InfoType" => InfoType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function retrieve_environment_info(
InfoType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"RetrieveEnvironmentInfo",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("InfoType" => InfoType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
swap_environment_cnames()
swap_environment_cnames(params::Dict{String,<:Any})
Swaps the CNAMEs of two environments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DestinationEnvironmentId"`: The ID of the destination environment. Condition: You must
specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may
also specify both. You must specify the SourceEnvironmentId with the
DestinationEnvironmentId.
- `"DestinationEnvironmentName"`: The name of the destination environment. Condition: You
must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You
may also specify both. You must specify the SourceEnvironmentName with the
DestinationEnvironmentName.
- `"SourceEnvironmentId"`: The ID of the source environment. Condition: You must specify
at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both.
If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.
- `"SourceEnvironmentName"`: The name of the source environment. Condition: You must
specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify
both. If you specify the SourceEnvironmentName, you must specify the
DestinationEnvironmentName.
"""
function swap_environment_cnames(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"SwapEnvironmentCNAMEs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function swap_environment_cnames(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"SwapEnvironmentCNAMEs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
terminate_environment()
terminate_environment(params::Dict{String,<:Any})
Terminates the specified environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentId"`: The ID of the environment to terminate. Condition: You must specify
either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter error.
- `"EnvironmentName"`: The name of the environment to terminate. Condition: You must
specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
Beanstalk returns MissingRequiredParameter error.
- `"ForceTerminate"`: Terminates the target environment even if another environment in the
same group is dependent on it.
- `"TerminateResources"`: Indicates whether the associated AWS resources should shut down
when the environment is terminated: true: The specified environment as well as the
associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
false: AWS Elastic Beanstalk resource management is removed from the environment, but the
AWS resources continue to operate. For more information, see the AWS Elastic Beanstalk
User Guide. Default: true Valid Values: true | false
"""
function terminate_environment(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"TerminateEnvironment"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function terminate_environment(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"TerminateEnvironment",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application(application_name)
update_application(application_name, params::Dict{String,<:Any})
Updates the specified application to have the specified properties. If a property (for
example, description) is not provided, the value remains unchanged. To clear these
properties, specify an empty string.
# Arguments
- `application_name`: The name of the application to update. If no such application is
found, UpdateApplication returns an InvalidParameterValue error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A new description for the application. Default: If not specified, AWS
Elastic Beanstalk does not update the description.
"""
function update_application(
ApplicationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"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 elastic_beanstalk(
"UpdateApplication",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ApplicationName" => ApplicationName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application_resource_lifecycle(application_name, resource_lifecycle_config)
update_application_resource_lifecycle(application_name, resource_lifecycle_config, params::Dict{String,<:Any})
Modifies lifecycle settings for an application.
# Arguments
- `application_name`: The name of the application.
- `resource_lifecycle_config`: The lifecycle configuration.
"""
function update_application_resource_lifecycle(
ApplicationName,
ResourceLifecycleConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"UpdateApplicationResourceLifecycle",
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"ResourceLifecycleConfig" => ResourceLifecycleConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application_resource_lifecycle(
ApplicationName,
ResourceLifecycleConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"UpdateApplicationResourceLifecycle",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName,
"ResourceLifecycleConfig" => ResourceLifecycleConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_application_version(application_name, version_label)
update_application_version(application_name, version_label, params::Dict{String,<:Any})
Updates the specified application version to have the specified properties. If a property
(for example, description) is not provided, the value remains unchanged. To clear
properties, specify an empty string.
# Arguments
- `application_name`: The name of the application associated with this version. If no
application is found with this name, UpdateApplication returns an InvalidParameterValue
error.
- `version_label`: The name of the version to update. If no application version is found
with this label, UpdateApplication returns an InvalidParameterValue error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A new description for this version.
"""
function update_application_version(
ApplicationName, VersionLabel; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"UpdateApplicationVersion",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "VersionLabel" => VersionLabel
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application_version(
ApplicationName,
VersionLabel,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"UpdateApplicationVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName, "VersionLabel" => VersionLabel
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration_template(application_name, template_name)
update_configuration_template(application_name, template_name, params::Dict{String,<:Any})
Updates the specified configuration template to have the specified properties or
configuration option values. If a property (for example, ApplicationName) is not provided,
its value remains unchanged. To clear such properties, specify an empty string. Related
Topics DescribeConfigurationOptions
# Arguments
- `application_name`: The name of the application associated with the configuration
template to update. If no application is found with this name, UpdateConfigurationTemplate
returns an InvalidParameterValue error.
- `template_name`: The name of the configuration template to update. If no configuration
template is found with this name, UpdateConfigurationTemplate returns an
InvalidParameterValue error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A new description for the configuration.
- `"OptionSettings"`: A list of configuration option settings to update with the new
specified option value.
- `"OptionsToRemove"`: A list of configuration options to remove from the configuration
set. Constraint: You can remove only UserDefined configuration options.
"""
function update_configuration_template(
ApplicationName, TemplateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"UpdateConfigurationTemplate",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "TemplateName" => TemplateName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration_template(
ApplicationName,
TemplateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"UpdateConfigurationTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName, "TemplateName" => TemplateName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_environment()
update_environment(params::Dict{String,<:Any})
Updates the environment description, deploys a new application version, updates the
configuration settings to an entirely new configuration template, or updates select
configuration option values in the running environment. Attempting to update both the
release and configuration is not allowed and AWS Elastic Beanstalk returns an
InvalidParameterCombination error. When updating the configuration settings to a new
template or individual settings, a draft configuration is created and
DescribeConfigurationSettings for this environment returns two setting descriptions with
different DeploymentStatus values.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplicationName"`: The name of the application with which the environment is associated.
- `"Description"`: If this parameter is specified, AWS Elastic Beanstalk updates the
description of this environment.
- `"EnvironmentId"`: The ID of the environment to update. If no environment with this ID
exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must
specify either this or an EnvironmentName, or both. If you do not specify either, AWS
Elastic Beanstalk returns MissingRequiredParameter error.
- `"EnvironmentName"`: The name of the environment to update. If no environment with this
name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You
must specify either this or an EnvironmentId, or both. If you do not specify either, AWS
Elastic Beanstalk returns MissingRequiredParameter error.
- `"GroupName"`: The name of the group to which the target environment belongs. Specify a
group name only if the environment's name is specified in an environment manifest and not
with the environment name or environment ID parameters. See Environment Manifest (env.yaml)
for details.
- `"OptionSettings"`: If specified, AWS Elastic Beanstalk updates the configuration set
associated with the running environment and sets the specified configuration options to the
requested value.
- `"OptionsToRemove"`: A list of custom user-defined configuration options to remove from
the configuration set for this environment.
- `"PlatformArn"`: The ARN of the platform, if used.
- `"SolutionStackName"`: This specifies the platform version that the environment will run
after the environment is updated.
- `"TemplateName"`: If this parameter is specified, AWS Elastic Beanstalk deploys this
configuration template to the environment. If no such configuration template is found, AWS
Elastic Beanstalk returns an InvalidParameterValue error.
- `"Tier"`: This specifies the tier to use to update the environment. Condition: At this
time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns
InvalidParameterValue error.
- `"VersionLabel"`: If this parameter is specified, AWS Elastic Beanstalk deploys the named
application version to the environment. If no such application version is found, returns an
InvalidParameterValue error.
"""
function update_environment(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_beanstalk(
"UpdateEnvironment"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_environment(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"UpdateEnvironment", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
update_tags_for_resource(resource_arn)
update_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be
passed: TagsToAdd for tags to add or update, and TagsToRemove. Elastic Beanstalk supports
tagging of all of its resources. For details about resource tagging, see Tagging
Application Resources. If you create a custom IAM user policy to control permission to this
operation, specify one of the following two virtual actions (or both) instead of the API
operation name: elasticbeanstalk:AddTags Controls permission to call
UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.
elasticbeanstalk:RemoveTags Controls permission to call UpdateTagsForResource and pass a
list of tag keys to remove in the TagsToRemove parameter. For details about creating a
custom user policy, see Creating a Custom User Policy.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resouce to be updated. Must be the
ARN of an Elastic Beanstalk resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagsToAdd"`: A list of tags to add or update. If a key of an existing tag is added, the
tag's value is updated. Specify at least one of these parameters: TagsToAdd, TagsToRemove.
- `"TagsToRemove"`: A list of tag keys to remove. If a tag key doesn't exist, it is
silently ignored. Specify at least one of these parameters: TagsToAdd, TagsToRemove.
"""
function update_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"UpdateTagsForResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_tags_for_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"UpdateTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
validate_configuration_settings(application_name, option_settings)
validate_configuration_settings(application_name, option_settings, params::Dict{String,<:Any})
Takes a set of configuration settings and either a configuration template or environment,
and determines whether those values are valid. This action returns a list of messages
indicating any errors or warnings associated with the selection of option values.
# Arguments
- `application_name`: The name of the application that the configuration template or
environment belongs to.
- `option_settings`: A list of the options and desired values to evaluate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnvironmentName"`: The name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
- `"TemplateName"`: The name of the configuration template to validate the settings
against. Condition: You cannot specify both this and an environment name.
"""
function validate_configuration_settings(
ApplicationName, OptionSettings; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_beanstalk(
"ValidateConfigurationSettings",
Dict{String,Any}(
"ApplicationName" => ApplicationName, "OptionSettings" => OptionSettings
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function validate_configuration_settings(
ApplicationName,
OptionSettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_beanstalk(
"ValidateConfigurationSettings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplicationName" => ApplicationName, "OptionSettings" => OptionSettings
),
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 | 10411 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: elastic_inference
using AWS.Compat
using AWS.UUIDs
"""
describe_accelerator_offerings(location_type)
describe_accelerator_offerings(location_type, params::Dict{String,<:Any})
Describes the locations in which a given accelerator type or set of types is present in a
given region. February 15, 2023: Starting April 15, 2023, AWS will not onboard new
customers to Amazon Elastic Inference (EI), and will help current customers migrate their
workloads to options that offer better price and performance. After April 15, 2023, new
customers will not be able to launch instances with Amazon EI accelerators in Amazon
SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least
once during the past 30-day period are considered current customers and will be able to
continue using the service.
# Arguments
- `location_type`: The location type that you want to describe accelerator type offerings
for. It can assume the following values: region: will return the accelerator type offering
at the regional level. availability-zone: will return the accelerator type offering at the
availability zone level. availability-zone-id: will return the accelerator type offering at
the availability zone level returning the availability zone id.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"acceleratorTypes"`: The list of accelerator types to describe.
"""
function describe_accelerator_offerings(
locationType; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_inference(
"POST",
"/describe-accelerator-offerings",
Dict{String,Any}("locationType" => locationType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_accelerator_offerings(
locationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_inference(
"POST",
"/describe-accelerator-offerings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("locationType" => locationType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_accelerator_types()
describe_accelerator_types(params::Dict{String,<:Any})
Describes the accelerator types available in a given region, as well as their
characteristics, such as memory and throughput. February 15, 2023: Starting April 15,
2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help
current customers migrate their workloads to options that offer better price and
performance. After April 15, 2023, new customers will not be able to launch instances with
Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers
who have used Amazon EI at least once during the past 30-day period are considered current
customers and will be able to continue using the service.
"""
function describe_accelerator_types(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_inference(
"GET",
"/describe-accelerator-types";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_accelerator_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_inference(
"GET",
"/describe-accelerator-types",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_accelerators()
describe_accelerators(params::Dict{String,<:Any})
Describes information over a provided set of accelerators belonging to an account.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon
Elastic Inference (EI), and will help current customers migrate their workloads to options
that offer better price and performance. After April 15, 2023, new customers will not be
able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or
Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day
period are considered current customers and will be able to continue using the service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"acceleratorIds"`: The IDs of the accelerators to describe.
- `"filters"`: One or more filters. Filter names and values are case-sensitive. Valid
filter names are: accelerator-types: can provide a list of accelerator type names to filter
for. instance-id: can provide a list of EC2 instance ids to filter for.
- `"maxResults"`: The total number of items to return in the command's output. If the
total number of items available is more than the value specified, a NextToken is provided
in the command's output. To resume pagination, provide the NextToken value in the
starting-token argument of a subsequent command. Do not use the NextToken response element
directly outside of the AWS CLI.
- `"nextToken"`: A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
"""
function describe_accelerators(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_inference(
"POST",
"/describe-accelerators";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_accelerators(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_inference(
"POST",
"/describe-accelerators",
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 all tags of an Elastic Inference Accelerator. February 15, 2023: Starting April
15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will
help current customers migrate their workloads to options that offer better price and
performance. After April 15, 2023, new customers will not be able to launch instances with
Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers
who have used Amazon EI at least once during the past 30-day period are considered current
customers and will be able to continue using the service.
# Arguments
- `resource_arn`: The ARN of the Elastic Inference Accelerator to list the tags for.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_inference(
"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 elastic_inference(
"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 the specified tags to an Elastic Inference Accelerator. February 15, 2023: Starting
April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and
will help current customers migrate their workloads to options that offer better price and
performance. After April 15, 2023, new customers will not be able to launch instances with
Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers
who have used Amazon EI at least once during the past 30-day period are considered current
customers and will be able to continue using the service.
# Arguments
- `resource_arn`: The ARN of the Elastic Inference Accelerator to tag.
- `tags`: The tags to add to the Elastic Inference Accelerator.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_inference(
"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 elastic_inference(
"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 an Elastic Inference Accelerator. February 15, 2023:
Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference
(EI), and will help current customers migrate their workloads to options that offer better
price and performance. After April 15, 2023, new customers will not be able to launch
instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.
However, customers who have used Amazon EI at least once during the past 30-day period are
considered current customers and will be able to continue using the service.
# Arguments
- `resource_arn`: The ARN of the Elastic Inference Accelerator to untag.
- `tag_keys`: The list of tags to remove from the Elastic Inference Accelerator.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_inference(
"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 elastic_inference(
"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 | 51390 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: elastic_load_balancing
using AWS.Compat
using AWS.UUIDs
"""
add_tags(load_balancer_names, tags)
add_tags(load_balancer_names, tags, params::Dict{String,<:Any})
Adds the specified tags to the specified load balancer. Each load balancer can have a
maximum of 10 tags. Each tag consists of a key and an optional value. If a tag with the
same key is already associated with the load balancer, AddTags updates its value. For more
information, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.
# Arguments
- `load_balancer_names`: The name of the load balancer. You can specify one load balancer
only.
- `tags`: The tags.
"""
function add_tags(
LoadBalancerNames, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"AddTags",
Dict{String,Any}("LoadBalancerNames" => LoadBalancerNames, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags(
LoadBalancerNames,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"AddTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LoadBalancerNames" => LoadBalancerNames, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
apply_security_groups_to_load_balancer(load_balancer_name, security_groups)
apply_security_groups_to_load_balancer(load_balancer_name, security_groups, params::Dict{String,<:Any})
Associates one or more security groups with your load balancer in a virtual private cloud
(VPC). The specified security groups override the previously associated security groups.
For more information, see Security Groups for Load Balancers in a VPC in the Classic Load
Balancers Guide.
# Arguments
- `load_balancer_name`: The name of the load balancer.
- `security_groups`: The IDs of the security groups to associate with the load balancer.
Note that you cannot specify the name of the security group.
"""
function apply_security_groups_to_load_balancer(
LoadBalancerName, SecurityGroups; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"ApplySecurityGroupsToLoadBalancer",
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName, "SecurityGroups" => SecurityGroups
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function apply_security_groups_to_load_balancer(
LoadBalancerName,
SecurityGroups,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"ApplySecurityGroupsToLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName,
"SecurityGroups" => SecurityGroups,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_load_balancer_to_subnets(load_balancer_name, subnets)
attach_load_balancer_to_subnets(load_balancer_name, subnets, params::Dict{String,<:Any})
Adds one or more subnets to the set of configured subnets for the specified load balancer.
The load balancer evenly distributes requests across all registered subnets. For more
information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Classic Load
Balancers Guide.
# Arguments
- `load_balancer_name`: The name of the load balancer.
- `subnets`: The IDs of the subnets to add. You can add only one subnet per Availability
Zone.
"""
function attach_load_balancer_to_subnets(
LoadBalancerName, Subnets; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"AttachLoadBalancerToSubnets",
Dict{String,Any}("LoadBalancerName" => LoadBalancerName, "Subnets" => Subnets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_load_balancer_to_subnets(
LoadBalancerName,
Subnets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"AttachLoadBalancerToSubnets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName, "Subnets" => Subnets
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
configure_health_check(health_check, load_balancer_name)
configure_health_check(health_check, load_balancer_name, params::Dict{String,<:Any})
Specifies the health check settings to use when evaluating the health state of your EC2
instances. For more information, see Configure Health Checks for Your Load Balancer in the
Classic Load Balancers Guide.
# Arguments
- `health_check`: The configuration information.
- `load_balancer_name`: The name of the load balancer.
"""
function configure_health_check(
HealthCheck, LoadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"ConfigureHealthCheck",
Dict{String,Any}(
"HealthCheck" => HealthCheck, "LoadBalancerName" => LoadBalancerName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function configure_health_check(
HealthCheck,
LoadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"ConfigureHealthCheck",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"HealthCheck" => HealthCheck, "LoadBalancerName" => LoadBalancerName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_app_cookie_stickiness_policy(cookie_name, load_balancer_name, policy_name)
create_app_cookie_stickiness_policy(cookie_name, load_balancer_name, policy_name, params::Dict{String,<:Any})
Generates a stickiness policy with sticky session lifetimes that follow that of an
application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.
This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that
the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of
the application-generated cookie specified in the policy configuration. The load balancer
only inserts a new stickiness cookie when the application response includes a new
application cookie. If the application cookie is explicitly removed or expires, the session
stops being sticky until a new application cookie is issued. For more information, see
Application-Controlled Session Stickiness in the Classic Load Balancers Guide.
# Arguments
- `cookie_name`: The name of the application cookie used for stickiness.
- `load_balancer_name`: The name of the load balancer.
- `policy_name`: The name of the policy being created. Policy names must consist of
alphanumeric characters and dashes (-). This name must be unique within the set of policies
for this load balancer.
"""
function create_app_cookie_stickiness_policy(
CookieName,
LoadBalancerName,
PolicyName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"CreateAppCookieStickinessPolicy",
Dict{String,Any}(
"CookieName" => CookieName,
"LoadBalancerName" => LoadBalancerName,
"PolicyName" => PolicyName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_app_cookie_stickiness_policy(
CookieName,
LoadBalancerName,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"CreateAppCookieStickinessPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CookieName" => CookieName,
"LoadBalancerName" => LoadBalancerName,
"PolicyName" => PolicyName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_lbcookie_stickiness_policy(load_balancer_name, policy_name)
create_lbcookie_stickiness_policy(load_balancer_name, policy_name, params::Dict{String,<:Any})
Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of
the browser (user-agent) or a specified expiration period. This policy can be associated
only with HTTP/HTTPS listeners. When a load balancer implements this policy, the load
balancer uses a special cookie to track the instance for each request. When the load
balancer receives a request, it first checks to see if this cookie is present in the
request. If so, the load balancer sends the request to the application server specified in
the cookie. If not, the load balancer sends the request to a server that is chosen based on
the existing load-balancing algorithm. A cookie is inserted into the response for binding
subsequent requests from the same user to that server. The validity of the cookie is based
on the cookie expiration time, which is specified in the policy configuration. For more
information, see Duration-Based Session Stickiness in the Classic Load Balancers Guide.
# Arguments
- `load_balancer_name`: The name of the load balancer.
- `policy_name`: The name of the policy being created. Policy names must consist of
alphanumeric characters and dashes (-). This name must be unique within the set of policies
for this load balancer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CookieExpirationPeriod"`: The time period, in seconds, after which the cookie should be
considered stale. If you do not specify this parameter, the default value is 0, which
indicates that the sticky session should last for the duration of the browser session.
"""
function create_lbcookie_stickiness_policy(
LoadBalancerName, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"CreateLBCookieStickinessPolicy",
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName, "PolicyName" => PolicyName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_lbcookie_stickiness_policy(
LoadBalancerName,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"CreateLBCookieStickinessPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName, "PolicyName" => PolicyName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_load_balancer(listeners, load_balancer_name)
create_load_balancer(listeners, load_balancer_name, params::Dict{String,<:Any})
Creates a Classic Load Balancer. You can add listeners, security groups, subnets, and tags
when you create your load balancer, or you can add them later using
CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer,
AttachLoadBalancerToSubnets, and AddTags. To describe your current load balancers, see
DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using
DeleteLoadBalancer. You can create up to 20 load balancers per region per account. You can
request an increase for the number of load balancers for your account. For more
information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.
# Arguments
- `listeners`: The listeners. For more information, see Listeners for Your Classic Load
Balancer in the Classic Load Balancers Guide.
- `load_balancer_name`: The name of the load balancer. This name must be unique within your
set of load balancers for the region, must have a maximum of 32 characters, must contain
only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AvailabilityZones"`: One or more Availability Zones from the same region as the load
balancer. You must specify at least one Availability Zone. You can add more Availability
Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.
- `"Scheme"`: The type of a load balancer. Valid only for load balancers in a VPC. By
default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name
that resolves to public IP addresses. For more information about Internet-facing and
Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide.
Specify internal to create a load balancer with a DNS name that resolves to private IP
addresses.
- `"SecurityGroups"`: The IDs of the security groups to assign to the load balancer.
- `"Subnets"`: The IDs of the subnets in your VPC to attach to the load balancer. Specify
one subnet per Availability Zone specified in AvailabilityZones.
- `"Tags"`: A list of tags to assign to the load balancer. For more information about
tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load
Balancers Guide.
"""
function create_load_balancer(
Listeners, LoadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"CreateLoadBalancer",
Dict{String,Any}("Listeners" => Listeners, "LoadBalancerName" => LoadBalancerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_load_balancer(
Listeners,
LoadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"CreateLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Listeners" => Listeners, "LoadBalancerName" => LoadBalancerName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_load_balancer_listeners(listeners, load_balancer_name)
create_load_balancer_listeners(listeners, load_balancer_name, params::Dict{String,<:Any})
Creates one or more listeners for the specified load balancer. If a listener with the
specified port does not already exist, it is created; otherwise, the properties of the new
listener must match the properties of the existing listener. For more information, see
Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.
# Arguments
- `listeners`: The listeners.
- `load_balancer_name`: The name of the load balancer.
"""
function create_load_balancer_listeners(
Listeners, LoadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"CreateLoadBalancerListeners",
Dict{String,Any}("Listeners" => Listeners, "LoadBalancerName" => LoadBalancerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_load_balancer_listeners(
Listeners,
LoadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"CreateLoadBalancerListeners",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Listeners" => Listeners, "LoadBalancerName" => LoadBalancerName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_load_balancer_policy(load_balancer_name, policy_name, policy_type_name)
create_load_balancer_policy(load_balancer_name, policy_name, policy_type_name, params::Dict{String,<:Any})
Creates a policy with the specified attributes for the specified load balancer. Policies
are settings that are saved for your load balancer and that can be applied to the listener
or the application server, depending on the policy type.
# Arguments
- `load_balancer_name`: The name of the load balancer.
- `policy_name`: The name of the load balancer policy to be created. This name must be
unique within the set of policies for this load balancer.
- `policy_type_name`: The name of the base policy type. To get the list of policy types,
use DescribeLoadBalancerPolicyTypes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyAttributes"`: The policy attributes.
"""
function create_load_balancer_policy(
LoadBalancerName,
PolicyName,
PolicyTypeName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"CreateLoadBalancerPolicy",
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName,
"PolicyName" => PolicyName,
"PolicyTypeName" => PolicyTypeName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_load_balancer_policy(
LoadBalancerName,
PolicyName,
PolicyTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"CreateLoadBalancerPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName,
"PolicyName" => PolicyName,
"PolicyTypeName" => PolicyTypeName,
),
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 the specified load balancer. If you are attempting to recreate a load balancer, you
must reconfigure all settings. The DNS name associated with a deleted load balancer are no
longer usable. The name and associated DNS record of the deleted load balancer no longer
exist and traffic sent to any of its IP addresses is no longer delivered to your instances.
If the load balancer does not exist or has already been deleted, the call to
DeleteLoadBalancer still succeeds.
# Arguments
- `load_balancer_name`: The name of the load balancer.
"""
function delete_load_balancer(
LoadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"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 elastic_load_balancing(
"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_listeners(load_balancer_name, load_balancer_ports)
delete_load_balancer_listeners(load_balancer_name, load_balancer_ports, params::Dict{String,<:Any})
Deletes the specified listeners from the specified load balancer.
# Arguments
- `load_balancer_name`: The name of the load balancer.
- `load_balancer_ports`: The client port numbers of the listeners.
"""
function delete_load_balancer_listeners(
LoadBalancerName, LoadBalancerPorts; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DeleteLoadBalancerListeners",
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName, "LoadBalancerPorts" => LoadBalancerPorts
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_load_balancer_listeners(
LoadBalancerName,
LoadBalancerPorts,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"DeleteLoadBalancerListeners",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName,
"LoadBalancerPorts" => LoadBalancerPorts,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_load_balancer_policy(load_balancer_name, policy_name)
delete_load_balancer_policy(load_balancer_name, policy_name, params::Dict{String,<:Any})
Deletes the specified policy from the specified load balancer. This policy must not be
enabled for any listeners.
# Arguments
- `load_balancer_name`: The name of the load balancer.
- `policy_name`: The name of the policy.
"""
function delete_load_balancer_policy(
LoadBalancerName, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DeleteLoadBalancerPolicy",
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName, "PolicyName" => PolicyName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_load_balancer_policy(
LoadBalancerName,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"DeleteLoadBalancerPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName, "PolicyName" => PolicyName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_instances_from_load_balancer(instances, load_balancer_name)
deregister_instances_from_load_balancer(instances, load_balancer_name, params::Dict{String,<:Any})
Deregisters the specified instances from the specified load balancer. After the instance is
deregistered, it no longer receives traffic from the load balancer. You can use
DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.
For more information, see Register or De-Register EC2 Instances in the Classic Load
Balancers Guide.
# Arguments
- `instances`: The IDs of the instances.
- `load_balancer_name`: The name of the load balancer.
"""
function deregister_instances_from_load_balancer(
Instances, LoadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DeregisterInstancesFromLoadBalancer",
Dict{String,Any}("Instances" => Instances, "LoadBalancerName" => LoadBalancerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_instances_from_load_balancer(
Instances,
LoadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"DeregisterInstancesFromLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Instances" => Instances, "LoadBalancerName" => LoadBalancerName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_limits()
describe_account_limits(params::Dict{String,<:Any})
Describes the current Elastic Load Balancing resource limits for your AWS account. For more
information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"PageSize"`: The maximum number of results to return with this call.
"""
function describe_account_limits(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing(
"DescribeAccountLimits"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_account_limits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DescribeAccountLimits",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instance_health(load_balancer_name)
describe_instance_health(load_balancer_name, params::Dict{String,<:Any})
Describes the state of the specified instances with respect to the specified load balancer.
If no instances are specified, the call describes the state of all instances that are
currently registered with the load balancer. If instances are specified, their state is
returned even if they are no longer registered with the load balancer. The state of
terminated instances is not returned.
# Arguments
- `load_balancer_name`: The name of the load balancer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Instances"`: The IDs of the instances.
"""
function describe_instance_health(
LoadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DescribeInstanceHealth",
Dict{String,Any}("LoadBalancerName" => LoadBalancerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instance_health(
LoadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"DescribeInstanceHealth",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LoadBalancerName" => LoadBalancerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_load_balancer_attributes(load_balancer_name)
describe_load_balancer_attributes(load_balancer_name, params::Dict{String,<:Any})
Describes the attributes for the specified load balancer.
# Arguments
- `load_balancer_name`: The name of the load balancer.
"""
function describe_load_balancer_attributes(
LoadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DescribeLoadBalancerAttributes",
Dict{String,Any}("LoadBalancerName" => LoadBalancerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_load_balancer_attributes(
LoadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"DescribeLoadBalancerAttributes",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LoadBalancerName" => LoadBalancerName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_load_balancer_policies()
describe_load_balancer_policies(params::Dict{String,<:Any})
Describes the specified policies. If you specify a load balancer name, the action returns
the descriptions of all policies created for the load balancer. If you specify a policy
name associated with your load balancer, the action returns the description of that policy.
If you don't specify a load balancer name, the action returns descriptions of the specified
sample policies, or descriptions of all sample policies. The names of the sample policies
have the ELBSample- prefix.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LoadBalancerName"`: The name of the load balancer.
- `"PolicyNames"`: The names of the policies.
"""
function describe_load_balancer_policies(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DescribeLoadBalancerPolicies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_load_balancer_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DescribeLoadBalancerPolicies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_load_balancer_policy_types()
describe_load_balancer_policy_types(params::Dict{String,<:Any})
Describes the specified load balancer policy types or all load balancer policy types. The
description of each type indicates how it can be used. For example, some policies can be
used only with layer 7 listeners, some policies can be used only with layer 4 listeners,
and some policies can be used only with your EC2 instances. You can use
CreateLoadBalancerPolicy to create a policy configuration for any of these policy types.
Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or
SetLoadBalancerPoliciesForBackendServer to set the policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyTypeNames"`: The names of the policy types. If no names are specified, describes
all policy types defined by Elastic Load Balancing.
"""
function describe_load_balancer_policy_types(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DescribeLoadBalancerPolicyTypes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_load_balancer_policy_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DescribeLoadBalancerPolicyTypes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_load_balancers()
describe_load_balancers(params::Dict{String,<:Any})
Describes the specified the load balancers. If no load balancers are specified, the call
describes all of your load balancers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LoadBalancerNames"`: The names of the load balancers.
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"PageSize"`: The maximum number of results to return with this call (a number from 1 to
400). The default is 400.
"""
function describe_load_balancers(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing(
"DescribeLoadBalancers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_load_balancers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DescribeLoadBalancers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tags(load_balancer_names)
describe_tags(load_balancer_names, params::Dict{String,<:Any})
Describes the tags associated with the specified load balancers.
# Arguments
- `load_balancer_names`: The names of the load balancers.
"""
function describe_tags(LoadBalancerNames; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing(
"DescribeTags",
Dict{String,Any}("LoadBalancerNames" => LoadBalancerNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tags(
LoadBalancerNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"DescribeTags",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LoadBalancerNames" => LoadBalancerNames), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_load_balancer_from_subnets(load_balancer_name, subnets)
detach_load_balancer_from_subnets(load_balancer_name, subnets, params::Dict{String,<:Any})
Removes the specified subnets from the set of configured subnets for the load balancer.
After a subnet is removed, all EC2 instances registered with the load balancer in the
removed subnet go into the OutOfService state. Then, the load balancer balances the traffic
among the remaining routable subnets.
# Arguments
- `load_balancer_name`: The name of the load balancer.
- `subnets`: The IDs of the subnets.
"""
function detach_load_balancer_from_subnets(
LoadBalancerName, Subnets; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DetachLoadBalancerFromSubnets",
Dict{String,Any}("LoadBalancerName" => LoadBalancerName, "Subnets" => Subnets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_load_balancer_from_subnets(
LoadBalancerName,
Subnets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"DetachLoadBalancerFromSubnets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName, "Subnets" => Subnets
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_availability_zones_for_load_balancer(availability_zones, load_balancer_name)
disable_availability_zones_for_load_balancer(availability_zones, load_balancer_name, params::Dict{String,<:Any})
Removes the specified Availability Zones from the set of Availability Zones for the
specified load balancer in EC2-Classic or a default VPC. For load balancers in a
non-default VPC, use DetachLoadBalancerFromSubnets. There must be at least one Availability
Zone registered with a load balancer at all times. After an Availability Zone is removed,
all instances registered with the load balancer that are in the removed Availability Zone
go into the OutOfService state. Then, the load balancer attempts to equally balance the
traffic among its remaining Availability Zones. For more information, see Add or Remove
Availability Zones in the Classic Load Balancers Guide.
# Arguments
- `availability_zones`: The Availability Zones.
- `load_balancer_name`: The name of the load balancer.
"""
function disable_availability_zones_for_load_balancer(
AvailabilityZones, LoadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"DisableAvailabilityZonesForLoadBalancer",
Dict{String,Any}(
"AvailabilityZones" => AvailabilityZones, "LoadBalancerName" => LoadBalancerName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_availability_zones_for_load_balancer(
AvailabilityZones,
LoadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"DisableAvailabilityZonesForLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AvailabilityZones" => AvailabilityZones,
"LoadBalancerName" => LoadBalancerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_availability_zones_for_load_balancer(availability_zones, load_balancer_name)
enable_availability_zones_for_load_balancer(availability_zones, load_balancer_name, params::Dict{String,<:Any})
Adds the specified Availability Zones to the set of Availability Zones for the specified
load balancer in EC2-Classic or a default VPC. For load balancers in a non-default VPC, use
AttachLoadBalancerToSubnets. The load balancer evenly distributes requests across all its
registered Availability Zones that contain instances. For more information, see Add or
Remove Availability Zones in the Classic Load Balancers Guide.
# Arguments
- `availability_zones`: The Availability Zones. These must be in the same region as the
load balancer.
- `load_balancer_name`: The name of the load balancer.
"""
function enable_availability_zones_for_load_balancer(
AvailabilityZones, LoadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"EnableAvailabilityZonesForLoadBalancer",
Dict{String,Any}(
"AvailabilityZones" => AvailabilityZones, "LoadBalancerName" => LoadBalancerName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_availability_zones_for_load_balancer(
AvailabilityZones,
LoadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"EnableAvailabilityZonesForLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AvailabilityZones" => AvailabilityZones,
"LoadBalancerName" => LoadBalancerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_load_balancer_attributes(load_balancer_attributes, load_balancer_name)
modify_load_balancer_attributes(load_balancer_attributes, load_balancer_name, params::Dict{String,<:Any})
Modifies the attributes of the specified load balancer. You can modify the load balancer
attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either
enabling or disabling them. Or, you can modify the load balancer attribute
ConnectionSettings by specifying an idle connection timeout value for your load balancer.
For more information, see the following in the Classic Load Balancers Guide: Cross-Zone
Load Balancing Connection Draining Access Logs Idle Connection Timeout
# Arguments
- `load_balancer_attributes`: The attributes for the load balancer.
- `load_balancer_name`: The name of the load balancer.
"""
function modify_load_balancer_attributes(
LoadBalancerAttributes,
LoadBalancerName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"ModifyLoadBalancerAttributes",
Dict{String,Any}(
"LoadBalancerAttributes" => LoadBalancerAttributes,
"LoadBalancerName" => LoadBalancerName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_load_balancer_attributes(
LoadBalancerAttributes,
LoadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"ModifyLoadBalancerAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerAttributes" => LoadBalancerAttributes,
"LoadBalancerName" => LoadBalancerName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_instances_with_load_balancer(instances, load_balancer_name)
register_instances_with_load_balancer(instances, load_balancer_name, params::Dict{String,<:Any})
Adds the specified instances to the specified load balancer. The instance must be a running
instance in the same network as the load balancer (EC2-Classic or the same VPC). If you
have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can
link the EC2-Classic instances to that VPC and then register the linked EC2-Classic
instances with the load balancer in the VPC. Note that RegisterInstanceWithLoadBalancer
completes when the request has been registered. Instance registration takes a little time
to complete. To check the state of the registered instances, use DescribeLoadBalancers or
DescribeInstanceHealth. After the instance is registered, it starts receiving traffic and
requests from the load balancer. Any instance that is not in one of the Availability Zones
registered for the load balancer is moved to the OutOfService state. If an Availability
Zone is added to the load balancer later, any instances registered with the load balancer
move to the InService state. To deregister instances from a load balancer, use
DeregisterInstancesFromLoadBalancer. For more information, see Register or De-Register EC2
Instances in the Classic Load Balancers Guide.
# Arguments
- `instances`: The IDs of the instances.
- `load_balancer_name`: The name of the load balancer.
"""
function register_instances_with_load_balancer(
Instances, LoadBalancerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"RegisterInstancesWithLoadBalancer",
Dict{String,Any}("Instances" => Instances, "LoadBalancerName" => LoadBalancerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_instances_with_load_balancer(
Instances,
LoadBalancerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"RegisterInstancesWithLoadBalancer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Instances" => Instances, "LoadBalancerName" => LoadBalancerName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags(load_balancer_names, tags)
remove_tags(load_balancer_names, tags, params::Dict{String,<:Any})
Removes one or more tags from the specified load balancer.
# Arguments
- `load_balancer_names`: The name of the load balancer. You can specify a maximum of one
load balancer name.
- `tags`: The list of tag keys to remove.
"""
function remove_tags(
LoadBalancerNames, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing(
"RemoveTags",
Dict{String,Any}("LoadBalancerNames" => LoadBalancerNames, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags(
LoadBalancerNames,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"RemoveTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LoadBalancerNames" => LoadBalancerNames, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_load_balancer_listener_sslcertificate(load_balancer_name, load_balancer_port, sslcertificate_id)
set_load_balancer_listener_sslcertificate(load_balancer_name, load_balancer_port, sslcertificate_id, params::Dict{String,<:Any})
Sets the certificate that terminates the specified listener's SSL connections. The
specified certificate replaces any prior certificate that was used on the same load
balancer and port. For more information about updating your SSL certificate, see Replace
the SSL Certificate for Your Load Balancer in the Classic Load Balancers Guide.
# Arguments
- `load_balancer_name`: The name of the load balancer.
- `load_balancer_port`: The port that uses the specified SSL certificate.
- `sslcertificate_id`: The Amazon Resource Name (ARN) of the SSL certificate.
"""
function set_load_balancer_listener_sslcertificate(
LoadBalancerName,
LoadBalancerPort,
SSLCertificateId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"SetLoadBalancerListenerSSLCertificate",
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName,
"LoadBalancerPort" => LoadBalancerPort,
"SSLCertificateId" => SSLCertificateId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_load_balancer_listener_sslcertificate(
LoadBalancerName,
LoadBalancerPort,
SSLCertificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"SetLoadBalancerListenerSSLCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName,
"LoadBalancerPort" => LoadBalancerPort,
"SSLCertificateId" => SSLCertificateId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_load_balancer_policies_for_backend_server(instance_port, load_balancer_name, policy_names)
set_load_balancer_policies_for_backend_server(instance_port, load_balancer_name, policy_names, params::Dict{String,<:Any})
Replaces the set of policies associated with the specified port on which the EC2 instance
is listening with a new set of policies. At this time, only the back-end server
authentication policy type can be applied to the instance ports; this policy type is
composed of multiple public key policies. Each time you use
SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames
parameter to list the policies that you want to enable. You can use DescribeLoadBalancers
or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2
instance. For more information about enabling back-end instance authentication, see
Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more
information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load
Balancers Guide.
# Arguments
- `instance_port`: The port number associated with the EC2 instance.
- `load_balancer_name`: The name of the load balancer.
- `policy_names`: The names of the policies. If the list is empty, then all current polices
are removed from the EC2 instance.
"""
function set_load_balancer_policies_for_backend_server(
InstancePort,
LoadBalancerName,
PolicyNames;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"SetLoadBalancerPoliciesForBackendServer",
Dict{String,Any}(
"InstancePort" => InstancePort,
"LoadBalancerName" => LoadBalancerName,
"PolicyNames" => PolicyNames,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_load_balancer_policies_for_backend_server(
InstancePort,
LoadBalancerName,
PolicyNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"SetLoadBalancerPoliciesForBackendServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstancePort" => InstancePort,
"LoadBalancerName" => LoadBalancerName,
"PolicyNames" => PolicyNames,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_load_balancer_policies_of_listener(load_balancer_name, load_balancer_port, policy_names)
set_load_balancer_policies_of_listener(load_balancer_name, load_balancer_port, policy_names, params::Dict{String,<:Any})
Replaces the current set of policies for the specified load balancer port with the
specified set of policies. To enable back-end server authentication, use
SetLoadBalancerPoliciesForBackendServer. For more information about setting policies, see
Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and
Application-Controlled Session Stickiness in the Classic Load Balancers Guide.
# Arguments
- `load_balancer_name`: The name of the load balancer.
- `load_balancer_port`: The external port of the load balancer.
- `policy_names`: The names of the policies. This list must include all policies to be
enabled. If you omit a policy that is currently enabled, it is disabled. If the list is
empty, all current policies are disabled.
"""
function set_load_balancer_policies_of_listener(
LoadBalancerName,
LoadBalancerPort,
PolicyNames;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"SetLoadBalancerPoliciesOfListener",
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName,
"LoadBalancerPort" => LoadBalancerPort,
"PolicyNames" => PolicyNames,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_load_balancer_policies_of_listener(
LoadBalancerName,
LoadBalancerPort,
PolicyNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing(
"SetLoadBalancerPoliciesOfListener",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerName" => LoadBalancerName,
"LoadBalancerPort" => LoadBalancerPort,
"PolicyNames" => PolicyNames,
),
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 | 79118 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: elastic_load_balancing_v2
using AWS.Compat
using AWS.UUIDs
"""
add_listener_certificates(certificates, listener_arn)
add_listener_certificates(certificates, listener_arn, params::Dict{String,<:Any})
Adds the specified SSL server certificate to the certificate list for the specified HTTPS
or TLS listener. If the certificate in already in the certificate list, the call is
successful but the certificate is not added again. For more information, see HTTPS
listeners in the Application Load Balancers Guide or TLS listeners in the Network Load
Balancers Guide.
# Arguments
- `certificates`: The certificate to add. You can specify one certificate per call. Set
CertificateArn to the certificate ARN but do not set IsDefault.
- `listener_arn`: The Amazon Resource Name (ARN) of the listener.
"""
function add_listener_certificates(
Certificates, ListenerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"AddListenerCertificates",
Dict{String,Any}("Certificates" => Certificates, "ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_listener_certificates(
Certificates,
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"AddListenerCertificates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Certificates" => Certificates, "ListenerArn" => ListenerArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_tags(resource_arns, tags)
add_tags(resource_arns, tags, params::Dict{String,<:Any})
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your
Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups,
trust stores, listeners, and rules. Each tag consists of a key and an optional value. If a
resource already has a tag with the same key, AddTags updates its value.
# Arguments
- `resource_arns`: The Amazon Resource Name (ARN) of the resource.
- `tags`: The tags.
"""
function add_tags(ResourceArns, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"AddTags",
Dict{String,Any}("ResourceArns" => ResourceArns, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags(
ResourceArns,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"AddTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArns" => ResourceArns, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_trust_store_revocations(trust_store_arn)
add_trust_store_revocations(trust_store_arn, params::Dict{String,<:Any})
Adds the specified revocation file to the specified trust store.
# Arguments
- `trust_store_arn`: The Amazon Resource Name (ARN) of the trust store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RevocationContents"`: The revocation file to add.
"""
function add_trust_store_revocations(
TrustStoreArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"AddTrustStoreRevocations",
Dict{String,Any}("TrustStoreArn" => TrustStoreArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_trust_store_revocations(
TrustStoreArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"AddTrustStoreRevocations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TrustStoreArn" => TrustStoreArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_listener(default_actions, load_balancer_arn)
create_listener(default_actions, load_balancer_arn, params::Dict{String,<:Any})
Creates a listener for the specified Application Load Balancer, Network Load Balancer, or
Gateway Load Balancer. For more information, see the following: Listeners for your
Application Load Balancers Listeners for your Network Load Balancers Listeners for
your Gateway Load Balancers This operation is idempotent, which means that it completes
at most one time. If you attempt to create multiple listeners with the same settings, each
call succeeds.
# Arguments
- `default_actions`: The actions for the default rule.
- `load_balancer_arn`: The Amazon Resource Name (ARN) of the load balancer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlpnPolicy"`: [TLS listeners] The name of the Application-Layer Protocol Negotiation
(ALPN) policy. You can specify one policy name. The following are the possible values:
HTTP1Only HTTP2Only HTTP2Optional HTTP2Preferred None For more
information, see ALPN policies in the Network Load Balancers Guide.
- `"Certificates"`: [HTTPS and TLS listeners] The default certificate for the listener. You
must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not
set IsDefault.
- `"MutualAuthentication"`: The mutual authentication configuration information.
- `"Port"`: The port on which the load balancer is listening. You cannot specify a port for
a Gateway Load Balancer.
- `"Protocol"`: The protocol for connections from clients to the load balancer. For
Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load
Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the
UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a
Gateway Load Balancer.
- `"SslPolicy"`: [HTTPS and TLS listeners] The security policy that defines which protocols
and ciphers are supported. For more information, see Security policies in the Application
Load Balancers Guide and Security policies in the Network Load Balancers Guide.
- `"Tags"`: The tags to assign to the listener.
"""
function create_listener(
DefaultActions, LoadBalancerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"CreateListener",
Dict{String,Any}(
"DefaultActions" => DefaultActions, "LoadBalancerArn" => LoadBalancerArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_listener(
DefaultActions,
LoadBalancerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"CreateListener",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DefaultActions" => DefaultActions, "LoadBalancerArn" => LoadBalancerArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_load_balancer(name)
create_load_balancer(name, params::Dict{String,<:Any})
Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. For
more information, see the following: Application Load Balancers Network Load
Balancers Gateway Load Balancers This operation is idempotent, which means that it
completes at most one time. If you attempt to create multiple load balancers with the same
settings, each call succeeds.
# Arguments
- `name`: The name of the load balancer. This name must be unique per region per account,
can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens,
must not begin or end with a hyphen, and must not begin with \"internal-\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomerOwnedIpv4Pool"`: [Application Load Balancers on Outposts] The ID of the
customer-owned address pool (CoIP pool).
- `"IpAddressType"`: Note: Internal load balancers must use the ipv4 IP address type.
[Application Load Balancers] The IP address type. The possible values are ipv4 (for only
IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4
(for IPv6 only public addresses, with private IPv4 and IPv6 addresses). [Network Load
Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and
dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer
with a UDP or TCP_UDP listener. [Gateway Load Balancers] The IP address type. The possible
values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
- `"Scheme"`: The nodes of an Internet-facing load balancer have public IP addresses. The
DNS name of an Internet-facing load balancer is publicly resolvable to the public IP
addresses of the nodes. Therefore, Internet-facing load balancers can route requests from
clients over the internet. The nodes of an internal load balancer have only private IP
addresses. The DNS name of an internal load balancer is publicly resolvable to the private
IP addresses of the nodes. Therefore, internal load balancers can route requests only from
clients with access to the VPC for the load balancer. The default is an Internet-facing
load balancer. You cannot specify a scheme for a Gateway Load Balancer.
- `"SecurityGroups"`: [Application Load Balancers and Network Load Balancers] The IDs of
the security groups for the load balancer.
- `"SubnetMappings"`: The IDs of the subnets. You can specify only one subnet per
Availability Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability Zones.
You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on
Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones]
You can specify subnets from one or more Local Zones. [Network Load Balancers] You can
specify subnets from one or more Availability Zones. You can specify one Elastic IP address
per subnet if you need static IP addresses for your internet-facing load balancer. For
internal load balancers, you can specify one private IP address per subnet from the IPv4
range of the subnet. For internet-facing load balancer, you can specify one IPv6 address
per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability
Zones. You cannot specify Elastic IP addresses for your subnets.
- `"Subnets"`: The IDs of the subnets. You can specify only one subnet per Availability
Zone. You must specify either subnets or subnet mappings, but not both. To specify an
Elastic IP address, specify subnet mappings instead of subnets. [Application Load
Balancers] You must specify subnets from at least two Availability Zones. [Application Load
Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on
Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers]
You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You
can specify subnets from one or more Availability Zones.
- `"Tags"`: The tags to assign to the load balancer.
- `"Type"`: The type of load balancer. The default is application.
"""
function create_load_balancer(Name; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"CreateLoadBalancer",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_load_balancer(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"CreateLoadBalancer",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule(actions, conditions, listener_arn, priority)
create_rule(actions, conditions, listener_arn, priority, params::Dict{String,<:Any})
Creates a rule for the specified listener. The listener must be associated with an
Application Load Balancer. Each rule consists of a priority, one or more actions, and one
or more conditions. Rules are evaluated in priority order, from the lowest value to the
highest value. When the conditions for a rule are met, its actions are performed. If the
conditions for no rules are met, the actions for the default rule are performed. For more
information, see Listener rules in the Application Load Balancers Guide.
# Arguments
- `actions`: The actions.
- `conditions`: The conditions.
- `listener_arn`: The Amazon Resource Name (ARN) of the listener.
- `priority`: The rule priority. A listener can't have multiple rules with the same
priority.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to assign to the rule.
"""
function create_rule(
Actions,
Conditions,
ListenerArn,
Priority;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"CreateRule",
Dict{String,Any}(
"Actions" => Actions,
"Conditions" => Conditions,
"ListenerArn" => ListenerArn,
"Priority" => Priority,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule(
Actions,
Conditions,
ListenerArn,
Priority,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"CreateRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Actions" => Actions,
"Conditions" => Conditions,
"ListenerArn" => ListenerArn,
"Priority" => Priority,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_target_group(name)
create_target_group(name, params::Dict{String,<:Any})
Creates a target group. For more information, see the following: Target groups for your
Application Load Balancers Target groups for your Network Load Balancers Target
groups for your Gateway Load Balancers This operation is idempotent, which means that it
completes at most one time. If you attempt to create multiple target groups with the same
settings, each call succeeds.
# Arguments
- `name`: The name of the target group. This name must be unique per region per account,
can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens,
and must not begin or end with a hyphen.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HealthCheckEnabled"`: Indicates whether health checks are enabled. If the target type
is lambda, health checks are disabled by default but can be enabled. If the target type is
instance, ip, or alb, health checks are always enabled and cannot be disabled.
- `"HealthCheckIntervalSeconds"`: The approximate amount of time, in seconds, between
health checks of an individual target. The range is 5-300. If the target group protocol is
TCP, TLS, UDP, TCP_UDP, HTTP or HTTPS, the default is 30 seconds. If the target group
protocol is GENEVE, the default is 10 seconds. If the target type is lambda, the default is
35 seconds.
- `"HealthCheckPath"`: [HTTP/HTTPS health checks] The destination for health checks on the
targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol
version] The path of a custom health check method with the format /package.service/method.
The default is /Amazon Web Services.ALB/healthcheck.
- `"HealthCheckPort"`: The port the load balancer uses when performing health checks on
targets. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is
traffic-port, which is the port on which each target receives traffic from the load
balancer. If the protocol is GENEVE, the default is port 80.
- `"HealthCheckProtocol"`: The protocol the load balancer uses when performing health
checks on targets. For Application Load Balancers, the default is HTTP. For Network Load
Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported
for health checks if the protocol of the target group is HTTP or HTTPS. The GENEVE, TLS,
UDP, and TCP_UDP protocols are not supported for health checks.
- `"HealthCheckTimeoutSeconds"`: The amount of time, in seconds, during which no response
from a target means a failed health check. The range is 2–120 seconds. For target groups
with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of
TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE,
the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
- `"HealthyThresholdCount"`: The number of consecutive health check successes required
before considering a target healthy. The range is 2-10. If the target group protocol is
TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 5. For target groups with a protocol
of GENEVE, the default is 5. If the target type is lambda, the default is 5.
- `"IpAddressType"`: The type of IP address used for this target group. The possible values
are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type
defaults to ipv4.
- `"Matcher"`: [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a
successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP
or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range
is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.
- `"Port"`: The port on which the targets receive traffic. This port is used unless you
specify a port override when registering the target. If the target is a Lambda function,
this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
- `"Protocol"`: The protocol to use for routing traffic to the targets. For Application
Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the
supported protocols are TCP, TLS, UDP, or TCP_UDP. For Gateway Load Balancers, the
supported protocol is GENEVE. A TCP_UDP listener must be associated with a TCP_UDP target
group. If the target is a Lambda function, this parameter does not apply.
- `"ProtocolVersion"`: [HTTP/HTTPS protocol] The protocol version. Specify GRPC to send
requests to targets using gRPC. Specify HTTP2 to send requests to targets using HTTP/2. The
default is HTTP1, which sends requests to targets using HTTP/1.1.
- `"Tags"`: The tags to assign to the target group.
- `"TargetType"`: The type of target that you must specify when registering targets with
this target group. You can't specify targets for a target group using more than one target
type. instance - Register targets by instance ID. This is the default value. ip -
Register targets by IP address. You can specify IP addresses from the subnets of the
virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8,
172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't
specify publicly routable IP addresses. lambda - Register a single Lambda function as a
target. alb - Register a single Application Load Balancer as a target.
- `"UnhealthyThresholdCount"`: The number of consecutive health check failures required
before considering a target unhealthy. The range is 2-10. If the target group protocol is
TCP, TCP_UDP, UDP, TLS, HTTP or HTTPS, the default is 2. For target groups with a protocol
of GENEVE, the default is 2. If the target type is lambda, the default is 5.
- `"VpcId"`: The identifier of the virtual private cloud (VPC). If the target is a Lambda
function, this parameter does not apply. Otherwise, this parameter is required.
"""
function create_target_group(Name; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"CreateTargetGroup",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_target_group(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"CreateTargetGroup",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_trust_store(ca_certificates_bundle_s3_bucket, ca_certificates_bundle_s3_key, name)
create_trust_store(ca_certificates_bundle_s3_bucket, ca_certificates_bundle_s3_key, name, params::Dict{String,<:Any})
Creates a trust store.
# Arguments
- `ca_certificates_bundle_s3_bucket`: The Amazon S3 bucket for the ca certificates bundle.
- `ca_certificates_bundle_s3_key`: The Amazon S3 path for the ca certificates bundle.
- `name`: The name of the trust store. This name must be unique per region and cannot be
changed after creation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CaCertificatesBundleS3ObjectVersion"`: The Amazon S3 object version for the ca
certificates bundle. If undefined the current version is used.
- `"Tags"`: The tags to assign to the trust store.
"""
function create_trust_store(
CaCertificatesBundleS3Bucket,
CaCertificatesBundleS3Key,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"CreateTrustStore",
Dict{String,Any}(
"CaCertificatesBundleS3Bucket" => CaCertificatesBundleS3Bucket,
"CaCertificatesBundleS3Key" => CaCertificatesBundleS3Key,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_trust_store(
CaCertificatesBundleS3Bucket,
CaCertificatesBundleS3Key,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"CreateTrustStore",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CaCertificatesBundleS3Bucket" => CaCertificatesBundleS3Bucket,
"CaCertificatesBundleS3Key" => CaCertificatesBundleS3Key,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_listener(listener_arn)
delete_listener(listener_arn, params::Dict{String,<:Any})
Deletes the specified listener. Alternatively, your listener is deleted when you delete the
load balancer to which it is attached.
# Arguments
- `listener_arn`: The Amazon Resource Name (ARN) of the listener.
"""
function delete_listener(ListenerArn; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"DeleteListener",
Dict{String,Any}("ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_listener(
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DeleteListener",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ListenerArn" => ListenerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_load_balancer(load_balancer_arn)
delete_load_balancer(load_balancer_arn, params::Dict{String,<:Any})
Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load
Balancer. Deleting a load balancer also deletes its listeners. You can't delete a load
balancer if deletion protection is enabled. If the load balancer does not exist or has
already been deleted, the call succeeds. Deleting a load balancer does not affect its
registered targets. For example, your EC2 instances continue to run and are still
registered to their target groups. If you no longer need these EC2 instances, you can stop
or terminate them.
# Arguments
- `load_balancer_arn`: The Amazon Resource Name (ARN) of the load balancer.
"""
function delete_load_balancer(
LoadBalancerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DeleteLoadBalancer",
Dict{String,Any}("LoadBalancerArn" => LoadBalancerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_load_balancer(
LoadBalancerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DeleteLoadBalancer",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LoadBalancerArn" => LoadBalancerArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule(rule_arn)
delete_rule(rule_arn, params::Dict{String,<:Any})
Deletes the specified rule. You can't delete the default rule.
# Arguments
- `rule_arn`: The Amazon Resource Name (ARN) of the rule.
"""
function delete_rule(RuleArn; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"DeleteRule",
Dict{String,Any}("RuleArn" => RuleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule(
RuleArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DeleteRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RuleArn" => RuleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_target_group(target_group_arn)
delete_target_group(target_group_arn, params::Dict{String,<:Any})
Deletes the specified target group. You can delete a target group if it is not referenced
by any actions. Deleting a target group also deletes any associated health checks. Deleting
a target group does not affect its registered targets. For example, any EC2 instances
continue to run until you stop or terminate them.
# Arguments
- `target_group_arn`: The Amazon Resource Name (ARN) of the target group.
"""
function delete_target_group(
TargetGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DeleteTargetGroup",
Dict{String,Any}("TargetGroupArn" => TargetGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_target_group(
TargetGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DeleteTargetGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TargetGroupArn" => TargetGroupArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_trust_store(trust_store_arn)
delete_trust_store(trust_store_arn, params::Dict{String,<:Any})
Deletes a trust store.
# Arguments
- `trust_store_arn`: The Amazon Resource Name (ARN) of the trust store.
"""
function delete_trust_store(
TrustStoreArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DeleteTrustStore",
Dict{String,Any}("TrustStoreArn" => TrustStoreArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_trust_store(
TrustStoreArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DeleteTrustStore",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TrustStoreArn" => TrustStoreArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_targets(target_group_arn, targets)
deregister_targets(target_group_arn, targets, params::Dict{String,<:Any})
Deregisters the specified targets from the specified target group. After the targets are
deregistered, they no longer receive traffic from the load balancer. The load balancer
stops sending requests to targets that are deregistering, but uses connection draining to
ensure that in-flight traffic completes on the existing connections. This deregistration
delay is configured by default but can be updated for each target group. For more
information, see the following: Deregistration delay in the Application Load Balancers
User Guide Deregistration delay in the Network Load Balancers User Guide
Deregistration delay in the Gateway Load Balancers User Guide Note: If the specified
target does not exist, the action returns successfully.
# Arguments
- `target_group_arn`: The Amazon Resource Name (ARN) of the target group.
- `targets`: The targets. If you specified a port override when you registered a target,
you must specify both the target ID and the port when you deregister it.
"""
function deregister_targets(
TargetGroupArn, Targets; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DeregisterTargets",
Dict{String,Any}("TargetGroupArn" => TargetGroupArn, "Targets" => Targets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_targets(
TargetGroupArn,
Targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DeregisterTargets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TargetGroupArn" => TargetGroupArn, "Targets" => Targets),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_limits()
describe_account_limits(params::Dict{String,<:Any})
Describes the current Elastic Load Balancing resource limits for your Amazon Web Services
account. For more information, see the following: Quotas for your Application Load
Balancers Quotas for your Network Load Balancers Quotas for your Gateway Load
Balancers
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"PageSize"`: The maximum number of results to return with this call.
"""
function describe_account_limits(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"DescribeAccountLimits"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_account_limits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeAccountLimits",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_listener_certificates(listener_arn)
describe_listener_certificates(listener_arn, params::Dict{String,<:Any})
Describes the default certificate and the certificate list for the specified HTTPS or TLS
listener. If the default certificate is also in the certificate list, it appears twice in
the results (once with IsDefault set to true and once with IsDefault set to false). For
more information, see SSL certificates in the Application Load Balancers Guide or Server
certificates in the Network Load Balancers Guide.
# Arguments
- `listener_arn`: The Amazon Resource Names (ARN) of the listener.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"PageSize"`: The maximum number of results to return with this call.
"""
function describe_listener_certificates(
ListenerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeListenerCertificates",
Dict{String,Any}("ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_listener_certificates(
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DescribeListenerCertificates",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ListenerArn" => ListenerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_listeners()
describe_listeners(params::Dict{String,<:Any})
Describes the specified listeners or the listeners for the specified Application Load
Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load
balancer or one or more listeners.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ListenerArns"`: The Amazon Resource Names (ARN) of the listeners.
- `"LoadBalancerArn"`: The Amazon Resource Name (ARN) of the load balancer.
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"PageSize"`: The maximum number of results to return with this call.
"""
function describe_listeners(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"DescribeListeners"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_listeners(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeListeners", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_load_balancer_attributes(load_balancer_arn)
describe_load_balancer_attributes(load_balancer_arn, params::Dict{String,<:Any})
Describes the attributes for the specified Application Load Balancer, Network Load
Balancer, or Gateway Load Balancer. For more information, see the following: Load
balancer attributes in the Application Load Balancers Guide Load balancer attributes in
the Network Load Balancers Guide Load balancer attributes in the Gateway Load Balancers
Guide
# Arguments
- `load_balancer_arn`: The Amazon Resource Name (ARN) of the load balancer.
"""
function describe_load_balancer_attributes(
LoadBalancerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeLoadBalancerAttributes",
Dict{String,Any}("LoadBalancerArn" => LoadBalancerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_load_balancer_attributes(
LoadBalancerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DescribeLoadBalancerAttributes",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LoadBalancerArn" => LoadBalancerArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_load_balancers()
describe_load_balancers(params::Dict{String,<:Any})
Describes the specified load balancers or all of your load balancers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LoadBalancerArns"`: The Amazon Resource Names (ARN) of the load balancers. You can
specify up to 20 load balancers in a single call.
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"Names"`: The names of the load balancers.
- `"PageSize"`: The maximum number of results to return with this call.
"""
function describe_load_balancers(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"DescribeLoadBalancers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_load_balancers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeLoadBalancers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_rules()
describe_rules(params::Dict{String,<:Any})
Describes the specified rules or the rules for the specified listener. You must specify
either a listener or one or more rules.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ListenerArn"`: The Amazon Resource Name (ARN) of the listener.
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"PageSize"`: The maximum number of results to return with this call.
- `"RuleArns"`: The Amazon Resource Names (ARN) of the rules.
"""
function describe_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"DescribeRules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeRules", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_sslpolicies()
describe_sslpolicies(params::Dict{String,<:Any})
Describes the specified policies or all policies used for SSL negotiation. For more
information, see Security policies in the Application Load Balancers Guide or Security
policies in the Network Load Balancers Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LoadBalancerType"`: The type of load balancer. The default lists the SSL policies for
all load balancers.
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"Names"`: The names of the policies.
- `"PageSize"`: The maximum number of results to return with this call.
"""
function describe_sslpolicies(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"DescribeSSLPolicies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_sslpolicies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeSSLPolicies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_tags(resource_arns)
describe_tags(resource_arns, params::Dict{String,<:Any})
Describes the tags for the specified Elastic Load Balancing resources. You can describe the
tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load
Balancers, target groups, listeners, or rules.
# Arguments
- `resource_arns`: The Amazon Resource Names (ARN) of the resources. You can specify up to
20 resources in a single call.
"""
function describe_tags(ResourceArns; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"DescribeTags",
Dict{String,Any}("ResourceArns" => ResourceArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_tags(
ResourceArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DescribeTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArns" => ResourceArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_target_group_attributes(target_group_arn)
describe_target_group_attributes(target_group_arn, params::Dict{String,<:Any})
Describes the attributes for the specified target group. For more information, see the
following: Target group attributes in the Application Load Balancers Guide Target
group attributes in the Network Load Balancers Guide Target group attributes in the
Gateway Load Balancers Guide
# Arguments
- `target_group_arn`: The Amazon Resource Name (ARN) of the target group.
"""
function describe_target_group_attributes(
TargetGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeTargetGroupAttributes",
Dict{String,Any}("TargetGroupArn" => TargetGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_target_group_attributes(
TargetGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DescribeTargetGroupAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TargetGroupArn" => TargetGroupArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_target_groups()
describe_target_groups(params::Dict{String,<:Any})
Describes the specified target groups or all of your target groups. By default, all target
groups are described. Alternatively, you can specify one of the following to filter the
results: the ARN of the load balancer, the names of one or more target groups, or the ARNs
of one or more target groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LoadBalancerArn"`: The Amazon Resource Name (ARN) of the load balancer.
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"Names"`: The names of the target groups.
- `"PageSize"`: The maximum number of results to return with this call.
- `"TargetGroupArns"`: The Amazon Resource Names (ARN) of the target groups.
"""
function describe_target_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"DescribeTargetGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_target_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeTargetGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_target_health(target_group_arn)
describe_target_health(target_group_arn, params::Dict{String,<:Any})
Describes the health of the specified targets or all of your targets.
# Arguments
- `target_group_arn`: The Amazon Resource Name (ARN) of the target group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Include"`: Used to inclue anomaly detection information.
- `"Targets"`: The targets.
"""
function describe_target_health(
TargetGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeTargetHealth",
Dict{String,Any}("TargetGroupArn" => TargetGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_target_health(
TargetGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DescribeTargetHealth",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TargetGroupArn" => TargetGroupArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trust_store_associations(trust_store_arn)
describe_trust_store_associations(trust_store_arn, params::Dict{String,<:Any})
Describes all resources associated with the specified trust store.
# Arguments
- `trust_store_arn`: The Amazon Resource Name (ARN) of the trust store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"PageSize"`: The maximum number of results to return with this call.
"""
function describe_trust_store_associations(
TrustStoreArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeTrustStoreAssociations",
Dict{String,Any}("TrustStoreArn" => TrustStoreArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_trust_store_associations(
TrustStoreArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DescribeTrustStoreAssociations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TrustStoreArn" => TrustStoreArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trust_store_revocations(trust_store_arn)
describe_trust_store_revocations(trust_store_arn, params::Dict{String,<:Any})
Describes the revocation files in use by the specified trust store arn, or revocation ID.
# Arguments
- `trust_store_arn`: The Amazon Resource Name (ARN) of the trust store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"PageSize"`: The maximum number of results to return with this call.
- `"RevocationIds"`: The revocation IDs of the revocation files you want to describe.
"""
function describe_trust_store_revocations(
TrustStoreArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeTrustStoreRevocations",
Dict{String,Any}("TrustStoreArn" => TrustStoreArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_trust_store_revocations(
TrustStoreArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"DescribeTrustStoreRevocations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TrustStoreArn" => TrustStoreArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_trust_stores()
describe_trust_stores(params::Dict{String,<:Any})
Describes all trust stores for a given account by trust store arn’s or name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The marker for the next set of results. (You received this marker from a
previous call.)
- `"Names"`: The names of the trust stores.
- `"PageSize"`: The maximum number of results to return with this call.
- `"TrustStoreArns"`: The Amazon Resource Name (ARN) of the trust store.
"""
function describe_trust_stores(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"DescribeTrustStores"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_trust_stores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"DescribeTrustStores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_trust_store_ca_certificates_bundle(trust_store_arn)
get_trust_store_ca_certificates_bundle(trust_store_arn, params::Dict{String,<:Any})
Retrieves the ca certificate bundle. This action returns a pre-signed S3 URI which is
active for ten minutes.
# Arguments
- `trust_store_arn`: The Amazon Resource Name (ARN) of the trust store.
"""
function get_trust_store_ca_certificates_bundle(
TrustStoreArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"GetTrustStoreCaCertificatesBundle",
Dict{String,Any}("TrustStoreArn" => TrustStoreArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_trust_store_ca_certificates_bundle(
TrustStoreArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"GetTrustStoreCaCertificatesBundle",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TrustStoreArn" => TrustStoreArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_trust_store_revocation_content(revocation_id, trust_store_arn)
get_trust_store_revocation_content(revocation_id, trust_store_arn, params::Dict{String,<:Any})
Retrieves the specified revocation file. This action returns a pre-signed S3 URI which is
active for ten minutes.
# Arguments
- `revocation_id`: The revocation ID of the revocation file.
- `trust_store_arn`: The Amazon Resource Name (ARN) of the trust store.
"""
function get_trust_store_revocation_content(
RevocationId, TrustStoreArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"GetTrustStoreRevocationContent",
Dict{String,Any}("RevocationId" => RevocationId, "TrustStoreArn" => TrustStoreArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_trust_store_revocation_content(
RevocationId,
TrustStoreArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"GetTrustStoreRevocationContent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RevocationId" => RevocationId, "TrustStoreArn" => TrustStoreArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_listener(listener_arn)
modify_listener(listener_arn, params::Dict{String,<:Any})
Replaces the specified properties of the specified listener. Any properties that you do not
specify remain unchanged. Changing the protocol from HTTPS to HTTP, or from TLS to TCP,
removes the security policy and default certificate properties. If you change the protocol
from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default
certificate properties. To add an item to a list, remove an item from a list, or update an
item in a list, you must provide the entire list. For example, to add an action, specify a
list with the current actions plus the new action.
# Arguments
- `listener_arn`: The Amazon Resource Name (ARN) of the listener.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlpnPolicy"`: [TLS listeners] The name of the Application-Layer Protocol Negotiation
(ALPN) policy. You can specify one policy name. The following are the possible values:
HTTP1Only HTTP2Only HTTP2Optional HTTP2Preferred None For more
information, see ALPN policies in the Network Load Balancers Guide.
- `"Certificates"`: [HTTPS and TLS listeners] The default certificate for the listener. You
must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not
set IsDefault.
- `"DefaultActions"`: The actions for the default rule.
- `"MutualAuthentication"`: The mutual authentication configuration information.
- `"Port"`: The port for connections from clients to the load balancer. You cannot specify
a port for a Gateway Load Balancer.
- `"Protocol"`: The protocol for connections from clients to the load balancer. Application
Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the
TCP, TLS, UDP, and TCP_UDP protocols. You can’t change the protocol to UDP or TCP_UDP if
dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
- `"SslPolicy"`: [HTTPS and TLS listeners] The security policy that defines which protocols
and ciphers are supported. For more information, see Security policies in the Application
Load Balancers Guide or Security policies in the Network Load Balancers Guide.
"""
function modify_listener(ListenerArn; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"ModifyListener",
Dict{String,Any}("ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_listener(
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"ModifyListener",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ListenerArn" => ListenerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_load_balancer_attributes(attributes, load_balancer_arn)
modify_load_balancer_attributes(attributes, load_balancer_arn, params::Dict{String,<:Any})
Modifies the specified attributes of the specified Application Load Balancer, Network Load
Balancer, or Gateway Load Balancer. If any of the specified attributes can't be modified as
requested, the call fails. Any existing attributes that you do not modify retain their
current values.
# Arguments
- `attributes`: The load balancer attributes.
- `load_balancer_arn`: The Amazon Resource Name (ARN) of the load balancer.
"""
function modify_load_balancer_attributes(
Attributes, LoadBalancerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"ModifyLoadBalancerAttributes",
Dict{String,Any}("Attributes" => Attributes, "LoadBalancerArn" => LoadBalancerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_load_balancer_attributes(
Attributes,
LoadBalancerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"ModifyLoadBalancerAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Attributes" => Attributes, "LoadBalancerArn" => LoadBalancerArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_rule(rule_arn)
modify_rule(rule_arn, params::Dict{String,<:Any})
Replaces the specified properties of the specified rule. Any properties that you do not
specify are unchanged. To add an item to a list, remove an item from a list, or update an
item in a list, you must provide the entire list. For example, to add an action, specify a
list with the current actions plus the new action.
# Arguments
- `rule_arn`: The Amazon Resource Name (ARN) of the rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Actions"`: The actions.
- `"Conditions"`: The conditions.
"""
function modify_rule(RuleArn; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"ModifyRule",
Dict{String,Any}("RuleArn" => RuleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_rule(
RuleArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"ModifyRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RuleArn" => RuleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_target_group(target_group_arn)
modify_target_group(target_group_arn, params::Dict{String,<:Any})
Modifies the health checks used when evaluating the health state of the targets in the
specified target group.
# Arguments
- `target_group_arn`: The Amazon Resource Name (ARN) of the target group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HealthCheckEnabled"`: Indicates whether health checks are enabled.
- `"HealthCheckIntervalSeconds"`: The approximate amount of time, in seconds, between
health checks of an individual target.
- `"HealthCheckPath"`: [HTTP/HTTPS health checks] The destination for health checks on the
targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol
version] The path of a custom health check method with the format /package.service/method.
The default is /Amazon Web Services.ALB/healthcheck.
- `"HealthCheckPort"`: The port the load balancer uses when performing health checks on
targets.
- `"HealthCheckProtocol"`: The protocol the load balancer uses when performing health
checks on targets. For Application Load Balancers, the default is HTTP. For Network Load
Balancers and Gateway Load Balancers, the default is TCP. The TCP protocol is not supported
for health checks if the protocol of the target group is HTTP or HTTPS. It is supported for
health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The
GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health checks.
- `"HealthCheckTimeoutSeconds"`: [HTTP/HTTPS health checks] The amount of time, in seconds,
during which no response means a failed health check.
- `"HealthyThresholdCount"`: The number of consecutive health checks successes required
before considering an unhealthy target healthy.
- `"Matcher"`: [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a
successful response from a target. For target groups with a protocol of TCP, TCP_UDP, UDP
or TLS the range is 200-599. For target groups with a protocol of HTTP or HTTPS, the range
is 200-499. For target groups with a protocol of GENEVE, the range is 200-399.
- `"UnhealthyThresholdCount"`: The number of consecutive health check failures required
before considering the target unhealthy.
"""
function modify_target_group(
TargetGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"ModifyTargetGroup",
Dict{String,Any}("TargetGroupArn" => TargetGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_target_group(
TargetGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"ModifyTargetGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TargetGroupArn" => TargetGroupArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_target_group_attributes(attributes, target_group_arn)
modify_target_group_attributes(attributes, target_group_arn, params::Dict{String,<:Any})
Modifies the specified attributes of the specified target group.
# Arguments
- `attributes`: The attributes.
- `target_group_arn`: The Amazon Resource Name (ARN) of the target group.
"""
function modify_target_group_attributes(
Attributes, TargetGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"ModifyTargetGroupAttributes",
Dict{String,Any}("Attributes" => Attributes, "TargetGroupArn" => TargetGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_target_group_attributes(
Attributes,
TargetGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"ModifyTargetGroupAttributes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Attributes" => Attributes, "TargetGroupArn" => TargetGroupArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_trust_store(ca_certificates_bundle_s3_bucket, ca_certificates_bundle_s3_key, trust_store_arn)
modify_trust_store(ca_certificates_bundle_s3_bucket, ca_certificates_bundle_s3_key, trust_store_arn, params::Dict{String,<:Any})
Update the ca certificate bundle for a given trust store.
# Arguments
- `ca_certificates_bundle_s3_bucket`: The Amazon S3 bucket for the ca certificates bundle.
- `ca_certificates_bundle_s3_key`: The Amazon S3 path for the ca certificates bundle.
- `trust_store_arn`: The Amazon Resource Name (ARN) of the trust store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CaCertificatesBundleS3ObjectVersion"`: The Amazon S3 object version for the ca
certificates bundle. If undefined the current version is used.
"""
function modify_trust_store(
CaCertificatesBundleS3Bucket,
CaCertificatesBundleS3Key,
TrustStoreArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"ModifyTrustStore",
Dict{String,Any}(
"CaCertificatesBundleS3Bucket" => CaCertificatesBundleS3Bucket,
"CaCertificatesBundleS3Key" => CaCertificatesBundleS3Key,
"TrustStoreArn" => TrustStoreArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_trust_store(
CaCertificatesBundleS3Bucket,
CaCertificatesBundleS3Key,
TrustStoreArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"ModifyTrustStore",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CaCertificatesBundleS3Bucket" => CaCertificatesBundleS3Bucket,
"CaCertificatesBundleS3Key" => CaCertificatesBundleS3Key,
"TrustStoreArn" => TrustStoreArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_targets(target_group_arn, targets)
register_targets(target_group_arn, targets, params::Dict{String,<:Any})
Registers the specified targets with the specified target group. If the target is an EC2
instance, it must be in the running state when you register it. By default, the load
balancer routes requests to registered targets using the protocol and port for the target
group. Alternatively, you can override the port for a target when you register it. You can
register each EC2 instance or IP address with the same target group multiple times using
different ports. With a Network Load Balancer, you cannot register instances by instance ID
if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1,
HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.
# Arguments
- `target_group_arn`: The Amazon Resource Name (ARN) of the target group.
- `targets`: The targets.
"""
function register_targets(
TargetGroupArn, Targets; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"RegisterTargets",
Dict{String,Any}("TargetGroupArn" => TargetGroupArn, "Targets" => Targets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_targets(
TargetGroupArn,
Targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"RegisterTargets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TargetGroupArn" => TargetGroupArn, "Targets" => Targets),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_listener_certificates(certificates, listener_arn)
remove_listener_certificates(certificates, listener_arn, params::Dict{String,<:Any})
Removes the specified certificate from the certificate list for the specified HTTPS or TLS
listener.
# Arguments
- `certificates`: The certificate to remove. You can specify one certificate per call. Set
CertificateArn to the certificate ARN but do not set IsDefault.
- `listener_arn`: The Amazon Resource Name (ARN) of the listener.
"""
function remove_listener_certificates(
Certificates, ListenerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"RemoveListenerCertificates",
Dict{String,Any}("Certificates" => Certificates, "ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_listener_certificates(
Certificates,
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"RemoveListenerCertificates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Certificates" => Certificates, "ListenerArn" => ListenerArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags(resource_arns, tag_keys)
remove_tags(resource_arns, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the specified Elastic Load Balancing resources. You can
remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway
Load Balancers, target groups, listeners, or rules.
# Arguments
- `resource_arns`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: The tag keys for the tags to remove.
"""
function remove_tags(
ResourceArns, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"RemoveTags",
Dict{String,Any}("ResourceArns" => ResourceArns, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags(
ResourceArns,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"RemoveTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArns" => ResourceArns, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_trust_store_revocations(revocation_ids, trust_store_arn)
remove_trust_store_revocations(revocation_ids, trust_store_arn, params::Dict{String,<:Any})
Removes the specified revocation file from the specified trust store.
# Arguments
- `revocation_ids`: The revocation IDs of the revocation files you want to remove.
- `trust_store_arn`: The Amazon Resource Name (ARN) of the trust store.
"""
function remove_trust_store_revocations(
RevocationIds, TrustStoreArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"RemoveTrustStoreRevocations",
Dict{String,Any}(
"RevocationIds" => RevocationIds, "TrustStoreArn" => TrustStoreArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_trust_store_revocations(
RevocationIds,
TrustStoreArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"RemoveTrustStoreRevocations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"RevocationIds" => RevocationIds, "TrustStoreArn" => TrustStoreArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_ip_address_type(ip_address_type, load_balancer_arn)
set_ip_address_type(ip_address_type, load_balancer_arn, params::Dict{String,<:Any})
Sets the type of IP addresses used by the subnets of the specified load balancer.
# Arguments
- `ip_address_type`: Note: Internal load balancers must use the ipv4 IP address type.
[Application Load Balancers] The IP address type. The possible values are ipv4 (for only
IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and dualstack-without-public-ipv4
(for IPv6 only public addresses, with private IPv4 and IPv6 addresses). [Network Load
Balancers] The IP address type. The possible values are ipv4 (for only IPv4 addresses) and
dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer
with a UDP or TCP_UDP listener. [Gateway Load Balancers] The IP address type. The possible
values are ipv4 (for only IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
- `load_balancer_arn`: The Amazon Resource Name (ARN) of the load balancer.
"""
function set_ip_address_type(
IpAddressType, LoadBalancerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"SetIpAddressType",
Dict{String,Any}(
"IpAddressType" => IpAddressType, "LoadBalancerArn" => LoadBalancerArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_ip_address_type(
IpAddressType,
LoadBalancerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"SetIpAddressType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IpAddressType" => IpAddressType, "LoadBalancerArn" => LoadBalancerArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_rule_priorities(rule_priorities)
set_rule_priorities(rule_priorities, params::Dict{String,<:Any})
Sets the priorities of the specified rules. You can reorder the rules as long as there are
no priority conflicts in the new order. Any existing rules that you do not specify retain
their current priority.
# Arguments
- `rule_priorities`: The rule priorities.
"""
function set_rule_priorities(
RulePriorities; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"SetRulePriorities",
Dict{String,Any}("RulePriorities" => RulePriorities);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_rule_priorities(
RulePriorities,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"SetRulePriorities",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RulePriorities" => RulePriorities), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_security_groups(load_balancer_arn, security_groups)
set_security_groups(load_balancer_arn, security_groups, params::Dict{String,<:Any})
Associates the specified security groups with the specified Application Load Balancer or
Network Load Balancer. The specified security groups override the previously associated
security groups. You can't perform this operation on a Network Load Balancer unless you
specified a security group for the load balancer when you created it. You can't associate a
security group with a Gateway Load Balancer.
# Arguments
- `load_balancer_arn`: The Amazon Resource Name (ARN) of the load balancer.
- `security_groups`: The IDs of the security groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic"`: Indicates whether to evaluate
inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web
Services PrivateLink. The default is on.
"""
function set_security_groups(
LoadBalancerArn, SecurityGroups; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_load_balancing_v2(
"SetSecurityGroups",
Dict{String,Any}(
"LoadBalancerArn" => LoadBalancerArn, "SecurityGroups" => SecurityGroups
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_security_groups(
LoadBalancerArn,
SecurityGroups,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"SetSecurityGroups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoadBalancerArn" => LoadBalancerArn, "SecurityGroups" => SecurityGroups
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_subnets(load_balancer_arn)
set_subnets(load_balancer_arn, params::Dict{String,<:Any})
Enables the Availability Zones for the specified public subnets for the specified
Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified
subnets replace the previously enabled subnets. When you specify subnets for a Network Load
Balancer, or Gateway Load Balancer you must include all subnets that were enabled
previously, with their existing configurations, plus any additional subnets.
# Arguments
- `load_balancer_arn`: The Amazon Resource Name (ARN) of the load balancer.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IpAddressType"`: [Application Load Balancers] The IP address type. The possible values
are ipv4 (for only IPv4 addresses), dualstack (for IPv4 and IPv6 addresses), and
dualstack-without-public-ipv4 (for IPv6 only public addresses, with private IPv4 and IPv6
addresses). [Network Load Balancers] The type of IP addresses used by the subnets for your
load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4
and IPv6 addresses). You can’t specify dualstack for a load balancer with a UDP or
TCP_UDP listener. [Gateway Load Balancers] The type of IP addresses used by the subnets for
your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for
IPv4 and IPv6 addresses).
- `"SubnetMappings"`: The IDs of the public subnets. You can specify only one subnet per
Availability Zone. You must specify either subnets or subnet mappings. [Application Load
Balancers] You must specify subnets from at least two Availability Zones. You cannot
specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You
must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can
specify subnets from one or more Local Zones. [Network Load Balancers] You can specify
subnets from one or more Availability Zones. You can specify one Elastic IP address per
subnet if you need static IP addresses for your internet-facing load balancer. For internal
load balancers, you can specify one private IP address per subnet from the IPv4 range of
the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
- `"Subnets"`: The IDs of the public subnets. You can specify only one subnet per
Availability Zone. You must specify either subnets or subnet mappings. [Application Load
Balancers] You must specify subnets from at least two Availability Zones. [Application Load
Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on
Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers]
You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You
can specify subnets from one or more Availability Zones.
"""
function set_subnets(LoadBalancerArn; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_load_balancing_v2(
"SetSubnets",
Dict{String,Any}("LoadBalancerArn" => LoadBalancerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_subnets(
LoadBalancerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_load_balancing_v2(
"SetSubnets",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("LoadBalancerArn" => LoadBalancerArn), 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 | 42036 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: elastic_transcoder
using AWS.Compat
using AWS.UUIDs
"""
cancel_job(id)
cancel_job(id, params::Dict{String,<:Any})
The CancelJob operation cancels an unfinished job. You can only cancel a job that has a
status of Submitted. To prevent a pipeline from starting to process a job while you're
getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.
# Arguments
- `id`: The identifier of the job that you want to cancel. To get a list of the jobs
(including their jobId) that have a status of Submitted, use the ListJobsByStatus API
action.
"""
function cancel_job(Id; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"DELETE",
"/2012-09-25/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 elastic_transcoder(
"DELETE",
"/2012-09-25/jobs/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job(pipeline_id)
create_job(pipeline_id, params::Dict{String,<:Any})
When you create a job, Elastic Transcoder returns JSON data that includes the values that
you specified plus information about the job that is created. If you have specified more
than one output for your jobs (for example, one output for the Kindle Fire and another
output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list
the jobs (as opposed to the AWS Console).
# Arguments
- `pipeline_id`: The Id of the pipeline that you want Elastic Transcoder to use for
transcoding. The pipeline determines several settings, including the Amazon S3 bucket from
which Elastic Transcoder gets the files to transcode and the bucket into which Elastic
Transcoder puts the transcoded files.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Input"`: A section of the request body that provides information about the file that is
being transcoded.
- `"Inputs"`: A section of the request body that provides information about the files that
are being transcoded.
- `"Output"`: A section of the request body that provides information about the transcoded
(target) file. We strongly recommend that you use the Outputs syntax instead of the Output
syntax.
- `"OutputKeyPrefix"`: The value, if any, that you want Elastic Transcoder to prepend to
the names of all files that this job creates, including output files, thumbnails, and
playlists.
- `"Outputs"`: A section of the request body that provides information about the
transcoded (target) files. We recommend that you use the Outputs syntax instead of the
Output syntax.
- `"Playlists"`: If you specify a preset in PresetId for which the value of Container is
fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master
playlists that you want Elastic Transcoder to create. The maximum number of master
playlists in a job is 30.
- `"UserMetadata"`: User-defined metadata that you want to associate with an Elastic
Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value
pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in
the same order in which you specify them.
"""
function create_job(PipelineId; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"POST",
"/2012-09-25/jobs",
Dict{String,Any}("PipelineId" => PipelineId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job(
PipelineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_transcoder(
"POST",
"/2012-09-25/jobs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PipelineId" => PipelineId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_pipeline(input_bucket, name, role)
create_pipeline(input_bucket, name, role, params::Dict{String,<:Any})
The CreatePipeline operation creates a pipeline with settings that you specify.
# Arguments
- `input_bucket`: The Amazon S3 bucket in which you saved the media files that you want to
transcode.
- `name`: The name of the pipeline. We recommend that the name be unique within the AWS
account, but uniqueness is not enforced. Constraints: Maximum 40 characters.
- `role`: The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder
to use to create the pipeline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AwsKmsKeyArn"`: The AWS Key Management Service (AWS KMS) key that you want to use with
this pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need
to provide a key with your job because a default key, known as an AWS-KMS key, is created
for you automatically. You need to provide an AWS-KMS key only if you want to use a
non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,
or aes-gcm.
- `"ContentConfig"`: The optional ContentConfig object specifies information about the
Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and
playlists: which bucket to use, which users you want to have access to the files, the type
of access you want users to have, and the storage class that you want to assign to the
files. If you specify values for ContentConfig, you must also specify values for
ThumbnailConfig. If you specify values for ContentConfig and ThumbnailConfig, omit the
OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder
to save transcoded files and playlists. Permissions (Optional): The Permissions object
specifies which users you want to have access to transcoded files and the type of access
you want them to have. You can grant permissions to a maximum of 30 users and/or predefined
Amazon S3 groups. Grantee Type: Specify the type of value that appears in the Grantee
object: Canonical: The value in the Grantee object is either the canonical user ID for
an AWS account or an origin access identity for an Amazon CloudFront distribution. For more
information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon
Simple Storage Service Developer Guide. For more information about using CloudFront origin
access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see
Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. A canonical
user ID is not the same as an AWS account number. Email: The value in the Grantee
object is the registered email address of an AWS account. Group: The value in the
Grantee object is one of the following predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to
have access to transcoded files and playlists. To identify the user or group, you can
specify the canonical user ID for an AWS account, an origin access identity for a
CloudFront distribution, the registered email address of an AWS account, or a predefined
Amazon S3 group Access: The permission that you want to give to the AWS user that you
specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to
the bucket, including playlists and video files. Valid values include: READ: The
grantee can read the objects and metadata for objects that Elastic Transcoder adds to the
Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for objects that Elastic
Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for
the objects that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The
grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic
Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class,
Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video
files and playlists that it stores in your Amazon S3 bucket.
- `"Notifications"`: The Amazon Simple Notification Service (Amazon SNS) topic that you
want to notify to report job status. To receive notifications, you must also subscribe to
the new topic in the Amazon SNS console. Progressing: The topic ARN for the Amazon
Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic
Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS
returned when you created the topic. For more information, see Create a Topic in the Amazon
Simple Notification Service Developer Guide. Complete: The topic ARN for the Amazon SNS
topic that you want to notify when Elastic Transcoder has finished processing a job in this
pipeline. This is the ARN that Amazon SNS returned when you created the topic. Warning:
The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder
encounters a warning condition while processing a job in this pipeline. This is the ARN
that Amazon SNS returned when you created the topic. Error: The topic ARN for the Amazon
SNS topic that you want to notify when Elastic Transcoder encounters an error condition
while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you
created the topic.
- `"OutputBucket"`: The Amazon S3 bucket in which you want Elastic Transcoder to save the
transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
Specify this value when all of the following are true: You want to save transcoded files,
thumbnails (if any), and playlists (if any) together in one bucket. You do not want to
specify the users or groups who have access to the transcoded files, thumbnails, and
playlists. You do not want to specify the permissions that Elastic Transcoder grants to
the files. When Elastic Transcoder saves files in OutputBucket, it grants full control
over the files only to the AWS account that owns the role that is specified by Role. You
want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage
class. If you want to save transcoded files and playlists in one bucket and thumbnails in
another bucket, specify which users can access the transcoded files or the permissions the
users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for
ContentConfig and ThumbnailConfig instead.
- `"ThumbnailConfig"`: The ThumbnailConfig object specifies several values, including the
Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users
you want to have access to the files, the type of access you want users to have, and the
storage class that you want to assign to the files. If you specify values for
ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to
create thumbnails. If you specify values for ContentConfig and ThumbnailConfig, omit the
OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder
to save thumbnail files. Permissions (Optional): The Permissions object specifies which
users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and
the type of access you want them to have. You can grant permissions to a maximum of 30
users and/or predefined Amazon S3 groups. GranteeType: Specify the type of value that
appears in the Grantee object: Canonical: The value in the Grantee object is either the
canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront
distribution. A canonical user ID is not the same as an AWS account number. Email: The
value in the Grantee object is the registered email address of an AWS account. Group:
The value in the Grantee object is one of the following predefined Amazon S3 groups:
AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you
want to have access to thumbnail files. To identify the user or group, you can specify the
canonical user ID for an AWS account, an origin access identity for a CloudFront
distribution, the registered email address of an AWS account, or a predefined Amazon S3
group. Access: The permission that you want to give to the AWS user that you specified
in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to
the bucket. Valid values include: READ: The grantee can read the thumbnails and
metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The
grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon
S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic
Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP,
and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3
bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that
you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3
bucket.
"""
function create_pipeline(
InputBucket, Name, Role; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"POST",
"/2012-09-25/pipelines",
Dict{String,Any}("InputBucket" => InputBucket, "Name" => Name, "Role" => Role);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_pipeline(
InputBucket,
Name,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_transcoder(
"POST",
"/2012-09-25/pipelines",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InputBucket" => InputBucket, "Name" => Name, "Role" => Role
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_preset(container, name)
create_preset(container, name, params::Dict{String,<:Any})
The CreatePreset operation creates a preset with settings that you specify. Elastic
Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder
requirements and to determine whether they comply with H.264 standards. If your settings
are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response
(ValidationException) and does not create the preset. If the settings are valid for Elastic
Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder
creates the preset and returns a warning message in the response. This helps you determine
whether your settings comply with the H.264 standard while giving you greater flexibility
with respect to the video that Elastic Transcoder produces. Elastic Transcoder uses the
H.264 video-compression format. For more information, see the International
Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for
generic audiovisual services.
# Arguments
- `container`: The container type for the output file. Valid values include flac, flv,
fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.
- `name`: The name of the preset. We recommend that the name be unique within the AWS
account, but uniqueness is not enforced.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Audio"`: A section of the request body that specifies the audio parameters.
- `"Description"`: A description of the preset.
- `"Thumbnails"`: A section of the request body that specifies the thumbnail parameters, if
any.
- `"Video"`: A section of the request body that specifies the video parameters.
"""
function create_preset(Container, Name; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"POST",
"/2012-09-25/presets",
Dict{String,Any}("Container" => Container, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_preset(
Container,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_transcoder(
"POST",
"/2012-09-25/presets",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Container" => Container, "Name" => Name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_pipeline(id)
delete_pipeline(id, params::Dict{String,<:Any})
The DeletePipeline operation removes a pipeline. You can only delete a pipeline that has
never been used or that is not currently in use (doesn't contain any active jobs). If the
pipeline is currently in use, DeletePipeline returns an error.
# Arguments
- `id`: The identifier of the pipeline that you want to delete.
"""
function delete_pipeline(Id; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"DELETE",
"/2012-09-25/pipelines/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_pipeline(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"DELETE",
"/2012-09-25/pipelines/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_preset(id)
delete_preset(id, params::Dict{String,<:Any})
The DeletePreset operation removes a preset that you've added in an AWS region. You can't
delete the default presets that are included with Elastic Transcoder.
# Arguments
- `id`: The identifier of the preset for which you want to get detailed information.
"""
function delete_preset(Id; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"DELETE",
"/2012-09-25/presets/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_preset(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"DELETE",
"/2012-09-25/presets/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs_by_pipeline(pipeline_id)
list_jobs_by_pipeline(pipeline_id, params::Dict{String,<:Any})
The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline. Elastic
Transcoder returns all of the jobs currently in the specified pipeline. The response body
contains one element for each job that satisfies the search criteria.
# Arguments
- `pipeline_id`: The ID of the pipeline for which you want to get job information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Ascending"`: To list jobs in chronological order by the date and time that they were
submitted, enter true. To list jobs in reverse chronological order, enter false.
- `"PageToken"`: When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get each successive page of results.
"""
function list_jobs_by_pipeline(
PipelineId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"GET",
"/2012-09-25/jobsByPipeline/$(PipelineId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_jobs_by_pipeline(
PipelineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_transcoder(
"GET",
"/2012-09-25/jobsByPipeline/$(PipelineId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs_by_status(status)
list_jobs_by_status(status, params::Dict{String,<:Any})
The ListJobsByStatus operation gets a list of jobs that have a specified status. The
response body contains one element for each job that satisfies the search criteria.
# Arguments
- `status`: To get information about all of the jobs associated with the current AWS
account that have a given status, specify the following status: Submitted, Progressing,
Complete, Canceled, or Error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Ascending"`: To list jobs in chronological order by the date and time that they were
submitted, enter true. To list jobs in reverse chronological order, enter false.
- `"PageToken"`: When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get each successive page of results.
"""
function list_jobs_by_status(Status; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"GET",
"/2012-09-25/jobsByStatus/$(Status)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_jobs_by_status(
Status, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"GET",
"/2012-09-25/jobsByStatus/$(Status)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_pipelines()
list_pipelines(params::Dict{String,<:Any})
The ListPipelines operation gets a list of the pipelines associated with the current AWS
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Ascending"`: To list pipelines in chronological order by the date and time that they
were created, enter true. To list pipelines in reverse chronological order, enter false.
- `"PageToken"`: When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get each successive page of results.
"""
function list_pipelines(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"GET",
"/2012-09-25/pipelines";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_pipelines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"GET",
"/2012-09-25/pipelines",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_presets()
list_presets(params::Dict{String,<:Any})
The ListPresets operation gets a list of the default presets included with Elastic
Transcoder and the presets that you've added in an AWS region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Ascending"`: To list presets in chronological order by the date and time that they were
created, enter true. To list presets in reverse chronological order, enter false.
- `"PageToken"`: When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get each successive page of results.
"""
function list_presets(; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"GET", "/2012-09-25/presets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_presets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"GET",
"/2012-09-25/presets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
read_job(id)
read_job(id, params::Dict{String,<:Any})
The ReadJob operation returns detailed information about a job.
# Arguments
- `id`: The identifier of the job for which you want to get detailed information.
"""
function read_job(Id; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"GET",
"/2012-09-25/jobs/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function read_job(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"GET",
"/2012-09-25/jobs/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
read_pipeline(id)
read_pipeline(id, params::Dict{String,<:Any})
The ReadPipeline operation gets detailed information about a pipeline.
# Arguments
- `id`: The identifier of the pipeline to read.
"""
function read_pipeline(Id; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"GET",
"/2012-09-25/pipelines/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function read_pipeline(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"GET",
"/2012-09-25/pipelines/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
read_preset(id)
read_preset(id, params::Dict{String,<:Any})
The ReadPreset operation gets detailed information about a preset.
# Arguments
- `id`: The identifier of the preset for which you want to get detailed information.
"""
function read_preset(Id; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"GET",
"/2012-09-25/presets/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function read_preset(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"GET",
"/2012-09-25/presets/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_role(input_bucket, output_bucket, role, topics)
test_role(input_bucket, output_bucket, role, topics, params::Dict{String,<:Any})
The TestRole operation tests the IAM role used to create the pipeline. The TestRole action
lets you determine whether the IAM role you are using has sufficient permissions to let
Elastic Transcoder perform tasks associated with the transcoding process. The action
attempts to assume the specified IAM role, checks read access to the input and output
buckets, and tries to send a test notification to Amazon SNS topics that you specify.
# Arguments
- `input_bucket`: The Amazon S3 bucket that contains media files to be transcoded. The
action attempts to read from this bucket.
- `output_bucket`: The Amazon S3 bucket that Elastic Transcoder writes transcoded media
files to. The action attempts to read from this bucket.
- `role`: The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder
to test.
- `topics`: The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics
that you want the action to send a test notification to.
"""
function test_role(
InputBucket,
OutputBucket,
Role,
Topics;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_transcoder(
"POST",
"/2012-09-25/roleTests",
Dict{String,Any}(
"InputBucket" => InputBucket,
"OutputBucket" => OutputBucket,
"Role" => Role,
"Topics" => Topics,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_role(
InputBucket,
OutputBucket,
Role,
Topics,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_transcoder(
"POST",
"/2012-09-25/roleTests",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InputBucket" => InputBucket,
"OutputBucket" => OutputBucket,
"Role" => Role,
"Topics" => Topics,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_pipeline(id)
update_pipeline(id, params::Dict{String,<:Any})
Use the UpdatePipeline operation to update settings for a pipeline. When you change
pipeline settings, your changes take effect immediately. Jobs that you have already
submitted and that Elastic Transcoder has not started to process are affected in addition
to jobs that you submit after you change settings.
# Arguments
- `id`: The ID of the pipeline that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AwsKmsKeyArn"`: The AWS Key Management Service (AWS KMS) key that you want to use with
this pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need
to provide a key with your job because a default key, known as an AWS-KMS key, is created
for you automatically. You need to provide an AWS-KMS key only if you want to use a
non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,
or aes-gcm.
- `"ContentConfig"`: The optional ContentConfig object specifies information about the
Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and
playlists: which bucket to use, which users you want to have access to the files, the type
of access you want users to have, and the storage class that you want to assign to the
files. If you specify values for ContentConfig, you must also specify values for
ThumbnailConfig. If you specify values for ContentConfig and ThumbnailConfig, omit the
OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder
to save transcoded files and playlists. Permissions (Optional): The Permissions object
specifies which users you want to have access to transcoded files and the type of access
you want them to have. You can grant permissions to a maximum of 30 users and/or predefined
Amazon S3 groups. Grantee Type: Specify the type of value that appears in the Grantee
object: Canonical: The value in the Grantee object is either the canonical user ID for
an AWS account or an origin access identity for an Amazon CloudFront distribution. For more
information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon
Simple Storage Service Developer Guide. For more information about using CloudFront origin
access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see
Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. A canonical
user ID is not the same as an AWS account number. Email: The value in the Grantee
object is the registered email address of an AWS account. Group: The value in the
Grantee object is one of the following predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you want to
have access to transcoded files and playlists. To identify the user or group, you can
specify the canonical user ID for an AWS account, an origin access identity for a
CloudFront distribution, the registered email address of an AWS account, or a predefined
Amazon S3 group Access: The permission that you want to give to the AWS user that you
specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to
the bucket, including playlists and video files. Valid values include: READ: The
grantee can read the objects and metadata for objects that Elastic Transcoder adds to the
Amazon S3 bucket. READ_ACP: The grantee can read the object ACL for objects that Elastic
Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for
the objects that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The
grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic
Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3 storage class,
Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video
files and playlists that it stores in your Amazon S3 bucket.
- `"InputBucket"`: The Amazon S3 bucket in which you saved the media files that you want to
transcode and the graphics that you want to use as watermarks.
- `"Name"`: The name of the pipeline. We recommend that the name be unique within the AWS
account, but uniqueness is not enforced. Constraints: Maximum 40 characters
- `"Notifications"`: The topic ARN for the Amazon Simple Notification Service (Amazon SNS)
topic that you want to notify to report job status. To receive notifications, you must
also subscribe to the new topic in the Amazon SNS console. Progressing: The topic ARN
for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when
Elastic Transcoder has started to process jobs that are added to this pipeline. This is the
ARN that Amazon SNS returned when you created the topic. Complete: The topic ARN for the
Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a
job. This is the ARN that Amazon SNS returned when you created the topic. Warning: The
topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder
encounters a warning condition. This is the ARN that Amazon SNS returned when you created
the topic. Error: The topic ARN for the Amazon SNS topic that you want to notify when
Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned
when you created the topic.
- `"Role"`: The IAM Amazon Resource Name (ARN) for the role that you want Elastic
Transcoder to use to transcode jobs for this pipeline.
- `"ThumbnailConfig"`: The ThumbnailConfig object specifies several values, including the
Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users
you want to have access to the files, the type of access you want users to have, and the
storage class that you want to assign to the files. If you specify values for
ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to
create thumbnails. If you specify values for ContentConfig and ThumbnailConfig, omit the
OutputBucket object. Bucket: The Amazon S3 bucket in which you want Elastic Transcoder
to save thumbnail files. Permissions (Optional): The Permissions object specifies which
users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and
the type of access you want them to have. You can grant permissions to a maximum of 30
users and/or predefined Amazon S3 groups. GranteeType: Specify the type of value that
appears in the Grantee object: Canonical: The value in the Grantee object is either the
canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront
distribution. A canonical user ID is not the same as an AWS account number. Email: The
value in the Grantee object is the registered email address of an AWS account. Group:
The value in the Grantee object is one of the following predefined Amazon S3 groups:
AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group that you
want to have access to thumbnail files. To identify the user or group, you can specify the
canonical user ID for an AWS account, an origin access identity for a CloudFront
distribution, the registered email address of an AWS account, or a predefined Amazon S3
group. Access: The permission that you want to give to the AWS user that you specified
in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to
the bucket. Valid values include: READ: The grantee can read the thumbnails and
metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP: The
grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon
S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic
Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ, READ_ACP,
and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3
bucket. StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy,
that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon
S3 bucket.
"""
function update_pipeline(Id; aws_config::AbstractAWSConfig=global_aws_config())
return elastic_transcoder(
"PUT",
"/2012-09-25/pipelines/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pipeline(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"PUT",
"/2012-09-25/pipelines/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_pipeline_notifications(id, notifications)
update_pipeline_notifications(id, notifications, params::Dict{String,<:Any})
With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification
Service (Amazon SNS) notifications for a pipeline. When you update notifications for a
pipeline, Elastic Transcoder returns the values that you specified in the request.
# Arguments
- `id`: The identifier of the pipeline for which you want to change notification settings.
- `notifications`: The topic ARN for the Amazon Simple Notification Service (Amazon SNS)
topic that you want to notify to report job status. To receive notifications, you must
also subscribe to the new topic in the Amazon SNS console. Progressing: The topic ARN
for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when
Elastic Transcoder has started to process jobs that are added to this pipeline. This is the
ARN that Amazon SNS returned when you created the topic. Complete: The topic ARN for the
Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a
job. This is the ARN that Amazon SNS returned when you created the topic. Warning: The
topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder
encounters a warning condition. This is the ARN that Amazon SNS returned when you created
the topic. Error: The topic ARN for the Amazon SNS topic that you want to notify when
Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned
when you created the topic.
"""
function update_pipeline_notifications(
Id, Notifications; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"POST",
"/2012-09-25/pipelines/$(Id)/notifications",
Dict{String,Any}("Notifications" => Notifications);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pipeline_notifications(
Id,
Notifications,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_transcoder(
"POST",
"/2012-09-25/pipelines/$(Id)/notifications",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Notifications" => Notifications), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_pipeline_status(id, status)
update_pipeline_status(id, status, params::Dict{String,<:Any})
The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline
stops or restarts the processing of jobs. Changing the pipeline status is useful if you
want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started
processing them; if you pause the pipeline to which you submitted the jobs, you have more
time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob
request.
# Arguments
- `id`: The identifier of the pipeline to update.
- `status`: The desired status of the pipeline: Active: The pipeline is processing jobs.
Paused: The pipeline is not currently processing jobs.
"""
function update_pipeline_status(
Id, Status; aws_config::AbstractAWSConfig=global_aws_config()
)
return elastic_transcoder(
"POST",
"/2012-09-25/pipelines/$(Id)/status",
Dict{String,Any}("Status" => Status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pipeline_status(
Id,
Status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elastic_transcoder(
"POST",
"/2012-09-25/pipelines/$(Id)/status",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Status" => Status), 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 | 199686 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: elasticache
using AWS.Compat
using AWS.UUIDs
"""
add_tags_to_resource(resource_name, tag)
add_tags_to_resource(resource_name, tag, 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 ElastiCache resources, with the exception of global
replication group. When you add or remove tags on replication groups, those actions will be
replicated to all nodes in the replication group. For more information, see Resource-level
permissions. For example, you can use cost-allocation tags to your ElastiCache 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 in Amazon
ElastiCache in the ElastiCache User Guide.
# Arguments
- `resource_name`: The Amazon Resource Name (ARN) of the resource to which the tags are to
be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or
arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are
cluster and snapshot. For more information about ARNs, see Amazon Resource Names (ARNs) and
Amazon Service Namespaces.
- `tag`: 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.
# 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 add_tags_to_resource(
ResourceName, Tag; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"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 elasticache(
"AddTagsToResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceName" => ResourceName, "Tag" => Tag),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
authorize_cache_security_group_ingress(cache_security_group_name, ec2_security_group_name, ec2_security_group_owner_id)
authorize_cache_security_group_ingress(cache_security_group_name, ec2_security_group_name, ec2_security_group_owner_id, params::Dict{String,<:Any})
Allows network ingress to a cache security group. Applications using ElastiCache must be
running on Amazon EC2, and Amazon EC2 security groups are used as the authorization
mechanism. You cannot authorize ingress from an Amazon EC2 security group in one region to
an ElastiCache cluster in another region.
# Arguments
- `cache_security_group_name`: The cache security group that allows network ingress.
- `ec2_security_group_name`: The Amazon EC2 security group to be authorized for ingress to
the cache security group.
- `ec2_security_group_owner_id`: The Amazon account number of the Amazon EC2 security group
owner. Note that this is not the same thing as an Amazon access key ID - you must provide a
valid Amazon account number for this parameter.
"""
function authorize_cache_security_group_ingress(
CacheSecurityGroupName,
EC2SecurityGroupName,
EC2SecurityGroupOwnerId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"AuthorizeCacheSecurityGroupIngress",
Dict{String,Any}(
"CacheSecurityGroupName" => CacheSecurityGroupName,
"EC2SecurityGroupName" => EC2SecurityGroupName,
"EC2SecurityGroupOwnerId" => EC2SecurityGroupOwnerId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function authorize_cache_security_group_ingress(
CacheSecurityGroupName,
EC2SecurityGroupName,
EC2SecurityGroupOwnerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"AuthorizeCacheSecurityGroupIngress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CacheSecurityGroupName" => CacheSecurityGroupName,
"EC2SecurityGroupName" => EC2SecurityGroupName,
"EC2SecurityGroupOwnerId" => EC2SecurityGroupOwnerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_apply_update_action(service_update_name)
batch_apply_update_action(service_update_name, params::Dict{String,<:Any})
Apply the service update. For more information on service updates and applying them, see
Applying Service Updates.
# Arguments
- `service_update_name`: The unique ID of the service update
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheClusterIds"`: The cache cluster IDs
- `"ReplicationGroupIds"`: The replication group IDs
"""
function batch_apply_update_action(
ServiceUpdateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"BatchApplyUpdateAction",
Dict{String,Any}("ServiceUpdateName" => ServiceUpdateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_apply_update_action(
ServiceUpdateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"BatchApplyUpdateAction",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ServiceUpdateName" => ServiceUpdateName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_stop_update_action(service_update_name)
batch_stop_update_action(service_update_name, params::Dict{String,<:Any})
Stop the service update. For more information on service updates and stopping them, see
Stopping Service Updates.
# Arguments
- `service_update_name`: The unique ID of the service update
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheClusterIds"`: The cache cluster IDs
- `"ReplicationGroupIds"`: The replication group IDs
"""
function batch_stop_update_action(
ServiceUpdateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"BatchStopUpdateAction",
Dict{String,Any}("ServiceUpdateName" => ServiceUpdateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_stop_update_action(
ServiceUpdateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"BatchStopUpdateAction",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ServiceUpdateName" => ServiceUpdateName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
complete_migration(replication_group_id)
complete_migration(replication_group_id, params::Dict{String,<:Any})
Complete the migration of data.
# Arguments
- `replication_group_id`: The ID of the replication group to which data is being migrated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Force"`: Forces the migration to stop without ensuring that data is in sync. It is
recommended to use this option only to abort the migration and not recommended when
application wants to continue migration to ElastiCache.
"""
function complete_migration(
ReplicationGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"CompleteMigration",
Dict{String,Any}("ReplicationGroupId" => ReplicationGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function complete_migration(
ReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CompleteMigration",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReplicationGroupId" => ReplicationGroupId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_serverless_cache_snapshot(source_serverless_cache_snapshot_name, target_serverless_cache_snapshot_name)
copy_serverless_cache_snapshot(source_serverless_cache_snapshot_name, target_serverless_cache_snapshot_name, params::Dict{String,<:Any})
Creates a copy of an existing serverless cache’s snapshot. Available for Redis only.
# Arguments
- `source_serverless_cache_snapshot_name`: The identifier of the existing serverless
cache’s snapshot to be copied. Available for Redis only.
- `target_serverless_cache_snapshot_name`: The identifier for the snapshot to be created.
Available for Redis only.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"KmsKeyId"`: The identifier of the KMS key used to encrypt the target snapshot.
Available for Redis only.
- `"Tags"`: A list of tags to be added to the target snapshot resource. A tag is a
key-value pair. Available for Redis only. Default: NULL
"""
function copy_serverless_cache_snapshot(
SourceServerlessCacheSnapshotName,
TargetServerlessCacheSnapshotName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CopyServerlessCacheSnapshot",
Dict{String,Any}(
"SourceServerlessCacheSnapshotName" => SourceServerlessCacheSnapshotName,
"TargetServerlessCacheSnapshotName" => TargetServerlessCacheSnapshotName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_serverless_cache_snapshot(
SourceServerlessCacheSnapshotName,
TargetServerlessCacheSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CopyServerlessCacheSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceServerlessCacheSnapshotName" =>
SourceServerlessCacheSnapshotName,
"TargetServerlessCacheSnapshotName" =>
TargetServerlessCacheSnapshotName,
),
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. This operation is valid for Redis only. Users or
groups that have permissions to use the CopySnapshot operation can create their own Amazon
S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy
to control who has the ability to use the CopySnapshot operation. For more information
about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and
Authentication & Access Control. You could receive the following error messages.
Error Messages Error Message: The S3 bucket %s is outside of the region. Solution:
Create an Amazon S3 bucket in the same region as your snapshot. For more information, see
Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3
bucket %s does not exist. Solution: Create an Amazon S3 bucket in the same region as your
snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache
User Guide. Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more
information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error
Message: The authenticated user does not have sufficient permissions to perform the desired
activity. Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s. Solution: Give the
TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively
create a new Amazon S3 bucket and use this same value for TargetSnapshotName. Error
Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket. Solution:
Add List and Read permissions on the bucket. For more information, see Step 2: Grant
ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error
Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2:
Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error
Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant
ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
# 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. ElastiCache does not permit
overwriting a snapshot, therefore this name must be unique within its context - ElastiCache
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 Amazon ElastiCache has the needed permissions to this S3 bucket.
For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the
Amazon ElastiCache User Guide. For more information, see Exporting a Snapshot in the Amazon
ElastiCache User Guide.
"""
function copy_snapshot(
SourceSnapshotName,
TargetSnapshotName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"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 elasticache(
"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_cache_cluster(cache_cluster_id)
create_cache_cluster(cache_cluster_id, params::Dict{String,<:Any})
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine
software, either Memcached or Redis. This operation is not supported for Redis (cluster
mode enabled) clusters.
# Arguments
- `cache_cluster_id`: The node group (shard) identifier. This parameter is stored as a
lowercase string. Constraints: A name must contain from 1 to 50 alphanumeric characters
or hyphens. The first character must be a letter. A name cannot end with a hyphen or
contain two consecutive hyphens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AZMode"`: Specifies whether the nodes in this Memcached cluster are created in a single
Availability Zone or created across multiple Availability Zones in the cluster's region.
This parameter is only supported for Memcached clusters. If the AZMode and
PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
- `"AuthToken"`: Reserved parameter. The password used to access a password protected
server. Password constraints: Must be only printable ASCII characters. Must be at least
16 characters and no more than 128 characters in length. The only permitted printable
special characters are !, &, #, , ^, <, >, and -. Other printable special
characters cannot be used in the AUTH token. For more information, see AUTH password at
http://redis.io/commands/AUTH.
- `"AutoMinorVersionUpgrade"`: If you are running Redis engine version 6.0 or later, set
this parameter to yes if you want to opt-in to the next auto minor version upgrade
campaign. This parameter is disabled for previous versions.
- `"CacheNodeType"`: The compute and memory capacity of the nodes in the node group
(shard). The following node types are supported by ElastiCache. Generally speaking, the
current generation types provide more memory and computational power at lower cost when
compared to their equivalent previous generation counterparts. General purpose: Current
generation: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge,
cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge For region
availability, see Supported Node Types M6g node types (available only for Redis engine
version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large,
cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge,
cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types:
cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine
version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types:
cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro,
cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters
are still supported but creation of new clusters is not supported for these types.) T1
node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium,
cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large,
cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not
recommended. Existing clusters are still supported but creation of new clusters is not
supported for these types.) C1 node types: cache.c1.xlarge Memory optimized:
Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge,
cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region
availability, see Supported Node Types R6g node types (available only for Redis engine
version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large,
cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge,
cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge,
cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types:
cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge,
cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still
supported but creation of new clusters is not supported for these types.) M2 node types:
cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large,
cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node
type info All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ
with automatic failover is not supported on T1 instances. Redis configuration variables
appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
- `"CacheParameterGroupName"`: The name of the parameter group to associate with this
cluster. If this argument is omitted, the default parameter group for the specified engine
is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a
cluster.
- `"CacheSecurityGroupNames"`: A list of security group names to associate with this
cluster. Use this parameter only when you are creating a cluster outside of an Amazon
Virtual Private Cloud (Amazon VPC).
- `"CacheSubnetGroupName"`: The name of the subnet group to be used for the cluster. Use
this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud
(Amazon VPC). If you're going to launch your cluster in an Amazon VPC, you need to create
a subnet group before you start creating a cluster. For more information, see Subnets and
Subnet Groups.
- `"Engine"`: The name of the cache engine to be used for this cluster. Valid values for
this parameter are: memcached | redis
- `"EngineVersion"`: The version number of the cache engine to be used for this cluster. To
view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and
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 or replication group and
create it anew with the earlier engine version.
- `"IpDiscovery"`: The network type you choose when modifying a cluster, either ipv4 |
ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached
engine version 1.6.6 on all instances built on the Nitro system.
- `"LogDeliveryConfigurations"`: Specifies the destination, format and type of the logs.
- `"NetworkType"`: Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads
using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances
built on the Nitro system.
- `"NotificationTopicArn"`: The Amazon Resource Name (ARN) of the Amazon Simple
Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic
owner must be the same as the cluster owner.
- `"NumCacheNodes"`: The initial number of cache nodes that the cluster has. For clusters
running Redis, this value must be 1. For clusters running Memcached, this value must be
between 1 and 40. If you need more than 40 nodes for your Memcached cluster, please fill
out the ElastiCache Limit Increase Request form at
http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
- `"OutpostMode"`: Specifies whether the nodes in the cluster are created in a single
outpost or across multiple outposts.
- `"Port"`: The port number on which each of the cache nodes accepts connections.
- `"PreferredAvailabilityZone"`: The EC2 Availability Zone in which the cluster is created.
All nodes belonging to this cluster are placed in the preferred Availability Zone. If you
want to create your nodes across multiple Availability Zones, use
PreferredAvailabilityZones. Default: System chosen Availability Zone.
- `"PreferredAvailabilityZones"`: A list of the Availability Zones in which cache nodes are
created. The order of the zones in the list is not important. This option is only supported
on Memcached. If you are creating your cluster in an Amazon VPC (recommended) you can only
locate nodes in Availability Zones that are associated with the subnets in the selected
subnet group. The number of Availability Zones listed must equal the value of
NumCacheNodes. If you want all the nodes in the same Availability Zone, use
PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the
list. Default: System chosen Availability Zones.
- `"PreferredMaintenanceWindow"`: 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.
- `"PreferredOutpostArn"`: The outpost ARN in which the cache cluster is created.
- `"PreferredOutpostArns"`: The outpost ARNs in which the cache cluster is created.
- `"ReplicationGroupId"`: The ID of the replication group to which this cluster should
belong. If this parameter is specified, the cluster is added to the specified replication
group as a read replica; otherwise, the cluster is a standalone primary that is not part of
any replication group. If the specified replication group is Multi-AZ enabled and the
Availability Zone is not specified, the cluster is created in Availability Zones that
provide the best spread of read replicas across Availability Zones. This parameter is only
valid if the Engine parameter is redis.
- `"SecurityGroupIds"`: One or more VPC security groups associated with the cluster. Use
this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud
(Amazon VPC).
- `"SnapshotArns"`: A single-element string list containing an Amazon Resource Name (ARN)
that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file
is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot
contain any commas. This parameter is only valid if the Engine parameter is redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
- `"SnapshotName"`: The name of a Redis snapshot from which to restore data into the new
node group (shard). The snapshot status changes to restoring while the new node group
(shard) is being created. This parameter is only valid if the Engine parameter is redis.
- `"SnapshotRetentionLimit"`: The number of days for which ElastiCache retains automatic
snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a
snapshot taken today is retained for 5 days before being deleted. This parameter is only
valid if the Engine parameter is redis. Default: 0 (i.e., automatic backups are disabled
for this cache cluster).
- `"SnapshotWindow"`: The daily time range (in UTC) during which ElastiCache begins taking
a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify
this parameter, ElastiCache automatically chooses an appropriate time range. This
parameter is only valid if the Engine parameter is redis.
- `"Tags"`: A list of tags to be added to this resource.
- `"TransitEncryptionEnabled"`: A flag that enables in-transit encryption when set to true.
"""
function create_cache_cluster(
CacheClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"CreateCacheCluster",
Dict{String,Any}("CacheClusterId" => CacheClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cache_cluster(
CacheClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateCacheCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CacheClusterId" => CacheClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cache_parameter_group(cache_parameter_group_family, cache_parameter_group_name, description)
create_cache_parameter_group(cache_parameter_group_family, cache_parameter_group_name, description, params::Dict{String,<:Any})
Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter
group is a collection of parameters and their values that are applied to all of the nodes
in any cluster or replication group using the CacheParameterGroup. A newly created
CacheParameterGroup is an exact duplicate of the default parameter group for the
CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can
change the values of specific parameters. For more information, see:
ModifyCacheParameterGroup in the ElastiCache API Reference. Parameters and Parameter
Groups in the ElastiCache User Guide.
# Arguments
- `cache_parameter_group_family`: The name of the cache parameter group family that the
cache parameter group can be used with. Valid values are: memcached1.4 | memcached1.5 |
memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7
- `cache_parameter_group_name`: A user-specified name for the cache parameter group.
- `description`: A user-specified description for the cache parameter group.
# 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_cache_parameter_group(
CacheParameterGroupFamily,
CacheParameterGroupName,
Description;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateCacheParameterGroup",
Dict{String,Any}(
"CacheParameterGroupFamily" => CacheParameterGroupFamily,
"CacheParameterGroupName" => CacheParameterGroupName,
"Description" => Description,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cache_parameter_group(
CacheParameterGroupFamily,
CacheParameterGroupName,
Description,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateCacheParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CacheParameterGroupFamily" => CacheParameterGroupFamily,
"CacheParameterGroupName" => CacheParameterGroupName,
"Description" => Description,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cache_security_group(cache_security_group_name, description)
create_cache_security_group(cache_security_group_name, description, params::Dict{String,<:Any})
Creates a new cache security group. Use a cache security group to control access to one or
more clusters. Cache security groups are only used when you are creating a cluster outside
of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a
VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
# Arguments
- `cache_security_group_name`: A name for the cache security group. This value is stored as
a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters.
Cannot be the word \"Default\". Example: mysecuritygroup
- `description`: A description for the cache security group.
# 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_cache_security_group(
CacheSecurityGroupName, Description; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"CreateCacheSecurityGroup",
Dict{String,Any}(
"CacheSecurityGroupName" => CacheSecurityGroupName, "Description" => Description
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cache_security_group(
CacheSecurityGroupName,
Description,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateCacheSecurityGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CacheSecurityGroupName" => CacheSecurityGroupName,
"Description" => Description,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cache_subnet_group(cache_subnet_group_description, cache_subnet_group_name, subnet_identifier)
create_cache_subnet_group(cache_subnet_group_description, cache_subnet_group_name, subnet_identifier, params::Dict{String,<:Any})
Creates a new cache subnet group. Use this parameter only when you are creating a cluster
in an Amazon Virtual Private Cloud (Amazon VPC).
# Arguments
- `cache_subnet_group_description`: A description for the cache subnet group.
- `cache_subnet_group_name`: A name for the cache subnet group. This value is stored as a
lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or
hyphens. Example: mysubnetgroup
- `subnet_identifier`: A list of VPC subnet IDs for the cache subnet group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SubnetIds"`: A list of VPC subnet IDs for the cache 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_cache_subnet_group(
CacheSubnetGroupDescription,
CacheSubnetGroupName,
SubnetIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateCacheSubnetGroup",
Dict{String,Any}(
"CacheSubnetGroupDescription" => CacheSubnetGroupDescription,
"CacheSubnetGroupName" => CacheSubnetGroupName,
"SubnetIdentifier" => SubnetIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cache_subnet_group(
CacheSubnetGroupDescription,
CacheSubnetGroupName,
SubnetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateCacheSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CacheSubnetGroupDescription" => CacheSubnetGroupDescription,
"CacheSubnetGroupName" => CacheSubnetGroupName,
"SubnetIdentifier" => SubnetIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_global_replication_group(global_replication_group_id_suffix, primary_replication_group_id)
create_global_replication_group(global_replication_group_id_suffix, primary_replication_group_id, params::Dict{String,<:Any})
Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region
replication. Using Global Datastore for Redis, you can create cross-region read replica
clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across
regions. For more information, see Replication Across Regions Using Global Datastore.
The GlobalReplicationGroupIdSuffix is the name of the Global datastore. The
PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes
and will replicate updates to the secondary cluster.
# Arguments
- `global_replication_group_id_suffix`: The suffix name of a Global datastore. Amazon
ElastiCache automatically applies a prefix to the Global datastore ID when it is created.
Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the
US-West-1 region will begin with \"dsdfu\" along with the suffix name you provide. The
suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global
datastore name across multiple regions. For a full list of Amazon Regions and their
respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .
- `primary_replication_group_id`: The name of the primary cluster that accepts writes and
will replicate updates to the secondary cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GlobalReplicationGroupDescription"`: Provides details of the Global datastore
"""
function create_global_replication_group(
GlobalReplicationGroupIdSuffix,
PrimaryReplicationGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateGlobalReplicationGroup",
Dict{String,Any}(
"GlobalReplicationGroupIdSuffix" => GlobalReplicationGroupIdSuffix,
"PrimaryReplicationGroupId" => PrimaryReplicationGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_global_replication_group(
GlobalReplicationGroupIdSuffix,
PrimaryReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateGlobalReplicationGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalReplicationGroupIdSuffix" => GlobalReplicationGroupIdSuffix,
"PrimaryReplicationGroupId" => PrimaryReplicationGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_replication_group(replication_group_description, replication_group_id)
create_replication_group(replication_group_description, replication_group_id, params::Dict{String,<:Any})
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication
group. This API can be used to create a standalone regional replication group or a
secondary replication group associated with a Global datastore. A Redis (cluster mode
disabled) replication group is a collection of nodes, where one of the nodes is a
read/write primary and the others are read-only replicas. Writes to the primary are
asynchronously propagated to the replicas. A Redis cluster-mode enabled cluster is
comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and
up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas
to 15 shards and 5 replicas, which is the maximum number or replicas allowed. The node or
shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is
5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges
between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and
no replicas). Make sure there are enough available IP addresses to accommodate the
increase. Common pitfalls include the subnets in the subnet group have too small a CIDR
range or the subnets are shared and heavily used by other clusters. For more information,
see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster. To
request a limit increase, see Amazon Service Limits and choose the limit type Nodes per
cluster per instance type. When a Redis (cluster mode disabled) replication group has been
successfully created, you can add one or more read replicas to it, up to a total of 5 read
replicas. If you need to increase or decrease the number of node groups (console: shards),
you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling
ElastiCache for Redis Clusters in the ElastiCache User Guide. This operation is valid for
Redis only.
# Arguments
- `replication_group_description`: A user-created description for the replication group.
- `replication_group_id`: The replication group identifier. This parameter is stored as a
lowercase string. Constraints: A name must contain from 1 to 40 alphanumeric characters
or hyphens. The first character must be a letter. A name cannot end with a hyphen or
contain two consecutive hyphens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AtRestEncryptionEnabled"`: A flag that enables encryption at rest when set to true. You
cannot modify the value of AtRestEncryptionEnabled after the replication group is created.
To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to
true when you create the replication group. Required: Only available when creating a
replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false
- `"AuthToken"`: Reserved parameter. The password used to access a password protected
server. AuthToken can be specified only on replication groups where
TransitEncryptionEnabled is true. For HIPAA compliance, you must specify
TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. Password
constraints: Must be only printable ASCII characters. Must be at least 16 characters
and no more than 128 characters in length. The only permitted printable special
characters are !, &, #, , ^, <, >, and -. Other printable special characters
cannot be used in the AUTH token. For more information, see AUTH password at
http://redis.io/commands/AUTH.
- `"AutoMinorVersionUpgrade"`: If you are running Redis engine version 6.0 or later, set
this parameter to yes if you want to opt-in to the next auto minor version upgrade
campaign. This parameter is disabled for previous versions.
- `"AutomaticFailoverEnabled"`: Specifies whether a read-only replica is automatically
promoted to read/write primary if the existing primary fails. AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups. Default: false
- `"CacheNodeType"`: The compute and memory capacity of the nodes in the node group
(shard). The following node types are supported by ElastiCache. Generally speaking, the
current generation types provide more memory and computational power at lower cost when
compared to their equivalent previous generation counterparts. General purpose: Current
generation: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge,
cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge For region
availability, see Supported Node Types M6g node types (available only for Redis engine
version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large,
cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge,
cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types:
cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine
version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types:
cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro,
cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters
are still supported but creation of new clusters is not supported for these types.) T1
node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium,
cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large,
cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not
recommended. Existing clusters are still supported but creation of new clusters is not
supported for these types.) C1 node types: cache.c1.xlarge Memory optimized:
Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge,
cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region
availability, see Supported Node Types R6g node types (available only for Redis engine
version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large,
cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge,
cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge,
cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types:
cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge,
cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still
supported but creation of new clusters is not supported for these types.) M2 node types:
cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large,
cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node
type info All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ
with automatic failover is not supported on T1 instances. Redis configuration variables
appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
- `"CacheParameterGroupName"`: The name of the parameter group to associate with this
replication group. If this argument is omitted, the default cache parameter group for the
specified engine is used. If you are running Redis version 3.2.4 or later, only one node
group (shard), and want to use a default parameter group, we recommend that you specify the
parameter group by name. To create a Redis (cluster mode disabled) replication group,
use CacheParameterGroupName=default.redis3.2. To create a Redis (cluster mode enabled)
replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
- `"CacheSecurityGroupNames"`: A list of cache security group names to associate with this
replication group.
- `"CacheSubnetGroupName"`: The name of the cache subnet group to be used for the
replication group. If you're going to launch your cluster in an Amazon VPC, you need to
create a subnet group before you start creating a cluster. For more information, see
Subnets and Subnet Groups.
- `"ClusterMode"`: Enabled or Disabled. To modify cluster mode from Disabled to Enabled,
you must first set the cluster mode to Compatible. Compatible mode allows your Redis
clients to connect using both cluster mode enabled and cluster mode disabled. After you
migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode
configuration and set the cluster mode to Enabled.
- `"DataTieringEnabled"`: Enables data tiering. Data tiering is only supported for
replication groups using the r6gd node type. This parameter must be set to true when using
r6gd nodes. For more information, see Data tiering.
- `"Engine"`: The name of the cache engine to be used for the clusters in this replication
group. The value must be set to Redis.
- `"EngineVersion"`: The version number of the cache engine to be used for the clusters in
this replication group. To view the supported cache engine versions, use the
DescribeCacheEngineVersions operation. Important: You can upgrade to a newer engine
version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you
cannot downgrade to an earlier engine version. If you want to use an earlier engine
version, you must delete the existing cluster or replication group and create it anew with
the earlier engine version.
- `"GlobalReplicationGroupId"`: The name of the Global datastore
- `"IpDiscovery"`: The network type you choose when creating a replication group, either
ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or
Memcached engine version 1.6.6 on all instances built on the Nitro system.
- `"KmsKeyId"`: The ID of the KMS key used to encrypt the disk in the cluster.
- `"LogDeliveryConfigurations"`: Specifies the destination, format and type of the logs.
- `"MultiAZEnabled"`: A flag indicating if you have Multi-AZ enabled to enhance fault
tolerance. For more information, see Minimizing Downtime: Multi-AZ.
- `"NetworkType"`: Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads
using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances
built on the Nitro system.
- `"NodeGroupConfiguration"`: A list of node group (shard) configuration options. Each node
group (shard) configuration has the following members: PrimaryAvailabilityZone,
ReplicaAvailabilityZones, ReplicaCount, and Slots. If you're creating a Redis (cluster mode
disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter
to individually configure each node group (shard), or you can omit this parameter. However,
it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You
must configure each node group (shard) using this parameter because you must specify the
slots for each node group.
- `"NotificationTopicArn"`: The Amazon Resource Name (ARN) of the Amazon Simple
Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic
owner must be the same as the cluster owner.
- `"NumCacheClusters"`: The number of clusters this replication group initially has. This
parameter is not used if there is more than one node group (shard). You should use
ReplicasPerNodeGroup instead. If AutomaticFailoverEnabled is true, the value of this
parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this
parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
- `"NumNodeGroups"`: An optional parameter that specifies the number of node groups
(shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode
disabled) either omit this parameter or set it to 1. Default: 1
- `"Port"`: The port number on which each member of the replication group accepts
connections.
- `"PreferredCacheClusterAZs"`: A list of EC2 Availability Zones in which the replication
group's clusters are created. The order of the Availability Zones in the list is the order
in which clusters are allocated. The primary cluster is created in the first AZ in the
list. This parameter is not used if there is more than one node group (shard). You should
use NodeGroupConfiguration instead. If you are creating your replication group in an
Amazon VPC (recommended), you can only locate clusters in Availability Zones associated
with the subnets in the selected subnet group. The number of Availability Zones listed must
equal the value of NumCacheClusters. Default: system chosen Availability Zones.
- `"PreferredMaintenanceWindow"`: 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
- `"PrimaryClusterId"`: The identifier of the cluster that serves as the primary for this
replication group. This cluster must already exist and have a status of available. This
parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is
specified.
- `"ReplicasPerNodeGroup"`: An optional parameter that specifies the number of replica
nodes in each node group (shard). Valid values are 0 to 5.
- `"SecurityGroupIds"`: One or more Amazon VPC security groups associated with this
replication group. Use this parameter only when you are creating a replication group in an
Amazon Virtual Private Cloud (Amazon VPC).
- `"ServerlessCacheSnapshotName"`: The name of the snapshot used to create a replication
group. Available for Redis only.
- `"SnapshotArns"`: A list of Amazon Resource Names (ARN) that uniquely identify the Redis
RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new
replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new
replication group will have the number of node groups (console: shards) specified by the
parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration
regardless of the number of ARNs specified here. Example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
- `"SnapshotName"`: The name of a snapshot from which to restore data into the new
replication group. The snapshot status changes to restoring while the new replication group
is being created.
- `"SnapshotRetentionLimit"`: The number of days for which ElastiCache 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. Default: 0
(i.e., automatic backups are disabled for this cluster).
- `"SnapshotWindow"`: The daily time range (in UTC) during which ElastiCache begins taking
a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify
this parameter, ElastiCache automatically chooses an appropriate time range.
- `"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. Tags on replication
groups will be replicated to all nodes.
- `"TransitEncryptionEnabled"`: A flag that enables in-transit encryption when set to true.
This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter
is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC. If you enable
in-transit encryption, you must also specify a value for CacheSubnetGroup. Required: Only
available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x
or later. Default: false For HIPAA compliance, you must specify TransitEncryptionEnabled
as true, an AuthToken, and a CacheSubnetGroup.
- `"TransitEncryptionMode"`: A setting that allows you to migrate your clients to use
in-transit encryption, with no downtime. When setting TransitEncryptionEnabled to true, you
can set your TransitEncryptionMode to preferred in the same request, to allow both
encrypted and unencrypted connections at the same time. Once you migrate all your Redis
clients to use encrypted connections you can modify the value to required to allow
encrypted connections only. Setting TransitEncryptionMode to required is a two-step process
that requires you to first set the TransitEncryptionMode to preferred, after that you can
set TransitEncryptionMode to required. This process will not trigger the replacement of the
replication group.
- `"UserGroupIds"`: The user group to associate with the replication group.
"""
function create_replication_group(
ReplicationGroupDescription,
ReplicationGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateReplicationGroup",
Dict{String,Any}(
"ReplicationGroupDescription" => ReplicationGroupDescription,
"ReplicationGroupId" => ReplicationGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_replication_group(
ReplicationGroupDescription,
ReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateReplicationGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReplicationGroupDescription" => ReplicationGroupDescription,
"ReplicationGroupId" => ReplicationGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_serverless_cache(engine, serverless_cache_name)
create_serverless_cache(engine, serverless_cache_name, params::Dict{String,<:Any})
Creates a serverless cache.
# Arguments
- `engine`: The name of the cache engine to be used for creating the serverless cache.
- `serverless_cache_name`: User-provided identifier for the serverless cache. This
parameter is stored as a lowercase string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheUsageLimits"`: Sets the cache usage limits for storage and ElastiCache Processing
Units for the cache.
- `"DailySnapshotTime"`: The daily time that snapshots will be created from the new
serverless cache. By default this number is populated with 0, i.e. no snapshots will be
created on an automatic daily basis. Available for Redis only.
- `"Description"`: User-provided description for the serverless cache. The default is NULL,
i.e. if no description is provided then an empty string will be returned. The maximum
length is 255 characters.
- `"KmsKeyId"`: ARN of the customer managed key for encrypting the data at rest. If no KMS
key is provided, a default service key is used.
- `"MajorEngineVersion"`: The version of the cache engine that will be used to create the
serverless cache.
- `"SecurityGroupIds"`: A list of the one or more VPC security groups to be associated with
the serverless cache. The security group will authorize traffic access for the VPC
end-point (private-link). If no other information is given this will be the VPC’s Default
Security Group that is associated with the cluster VPC end-point.
- `"SnapshotArnsToRestore"`: The ARN(s) of the snapshot that the new serverless cache will
be created from. Available for Redis only.
- `"SnapshotRetentionLimit"`: The number of snapshots that will be retained for the
serverless cache that is being created. As new snapshots beyond this limit are added, the
oldest snapshots will be deleted on a rolling basis. Available for Redis only.
- `"SubnetIds"`: A list of the identifiers of the subnets where the VPC endpoint for the
serverless cache will be deployed. All the subnetIds must belong to the same VPC.
- `"Tags"`: The list of tags (key, value) pairs to be added to the serverless cache
resource. Default is NULL.
- `"UserGroupId"`: The identifier of the UserGroup to be associated with the serverless
cache. Available for Redis only. Default is NULL.
"""
function create_serverless_cache(
Engine, ServerlessCacheName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"CreateServerlessCache",
Dict{String,Any}("Engine" => Engine, "ServerlessCacheName" => ServerlessCacheName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_serverless_cache(
Engine,
ServerlessCacheName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateServerlessCache",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Engine" => Engine, "ServerlessCacheName" => ServerlessCacheName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_serverless_cache_snapshot(serverless_cache_name, serverless_cache_snapshot_name)
create_serverless_cache_snapshot(serverless_cache_name, serverless_cache_snapshot_name, params::Dict{String,<:Any})
This API creates a copy of an entire ServerlessCache at a specific moment in time.
Available for Redis only.
# Arguments
- `serverless_cache_name`: The name of an existing serverless cache. The snapshot is
created from this cache. Available for Redis only.
- `serverless_cache_snapshot_name`: The name for the snapshot being created. Must be unique
for the customer account. Available for Redis only. Must be between 1 and 255 characters.
# 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. Available for Redis
only. Default: NULL
- `"Tags"`: A list of tags to be added to the snapshot resource. A tag is a key-value pair.
Available for Redis only.
"""
function create_serverless_cache_snapshot(
ServerlessCacheName,
ServerlessCacheSnapshotName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateServerlessCacheSnapshot",
Dict{String,Any}(
"ServerlessCacheName" => ServerlessCacheName,
"ServerlessCacheSnapshotName" => ServerlessCacheSnapshotName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_serverless_cache_snapshot(
ServerlessCacheName,
ServerlessCacheSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateServerlessCacheSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServerlessCacheName" => ServerlessCacheName,
"ServerlessCacheSnapshotName" => ServerlessCacheSnapshotName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot(snapshot_name)
create_snapshot(snapshot_name, params::Dict{String,<:Any})
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
# Arguments
- `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:
- `"CacheClusterId"`: The identifier of an existing cluster. The snapshot is created from
this cluster.
- `"KmsKeyId"`: The ID of the KMS key used to encrypt the snapshot.
- `"ReplicationGroupId"`: The identifier of an existing replication group. The snapshot is
created from this replication 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_snapshot(SnapshotName; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"CreateSnapshot",
Dict{String,Any}("SnapshotName" => SnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot(
SnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotName" => SnapshotName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(access_string, engine, user_id, user_name)
create_user(access_string, engine, user_id, user_name, params::Dict{String,<:Any})
For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using
Role Based Access Control (RBAC).
# Arguments
- `access_string`: Access permissions string used for this user.
- `engine`: The current supported value is Redis.
- `user_id`: The ID of the user.
- `user_name`: The username of the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthenticationMode"`: Specifies how to authenticate the user.
- `"NoPasswordRequired"`: Indicates a password is not required for this user.
- `"Passwords"`: Passwords used for this user. You can create up to two passwords for each
user.
- `"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,
Engine,
UserId,
UserName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateUser",
Dict{String,Any}(
"AccessString" => AccessString,
"Engine" => Engine,
"UserId" => UserId,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
AccessString,
Engine,
UserId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AccessString" => AccessString,
"Engine" => Engine,
"UserId" => UserId,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_group(engine, user_group_id)
create_user_group(engine, user_group_id, params::Dict{String,<:Any})
For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see
Using Role Based Access Control (RBAC)
# Arguments
- `engine`: The current supported value is Redis.
- `user_group_id`: The ID of the user group.
# 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. Available for Redis only.
- `"UserIds"`: The list of user IDs that belong to the user group.
"""
function create_user_group(
Engine, UserGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"CreateUserGroup",
Dict{String,Any}("Engine" => Engine, "UserGroupId" => UserGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_group(
Engine,
UserGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"CreateUserGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Engine" => Engine, "UserGroupId" => UserGroupId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
decrease_node_groups_in_global_replication_group(apply_immediately, global_replication_group_id, node_group_count)
decrease_node_groups_in_global_replication_group(apply_immediately, global_replication_group_id, node_group_count, params::Dict{String,<:Any})
Decreases the number of node groups in a Global datastore
# Arguments
- `apply_immediately`: Indicates that the shard reconfiguration process begins immediately.
At present, the only permitted value for this parameter is true.
- `global_replication_group_id`: The name of the Global datastore
- `node_group_count`: The number of node groups (shards) that results from the modification
of the shard configuration
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GlobalNodeGroupsToRemove"`: If the value of NodeGroupCount is less than the current
number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is
required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by
GlobalNodeGroupsToRemove from the cluster.
- `"GlobalNodeGroupsToRetain"`: If the value of NodeGroupCount is less than the current
number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is
required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster.
ElastiCache for Redis will attempt to retain all node groups listed by
GlobalNodeGroupsToRetain from the cluster.
"""
function decrease_node_groups_in_global_replication_group(
ApplyImmediately,
GlobalReplicationGroupId,
NodeGroupCount;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DecreaseNodeGroupsInGlobalReplicationGroup",
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
"NodeGroupCount" => NodeGroupCount,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function decrease_node_groups_in_global_replication_group(
ApplyImmediately,
GlobalReplicationGroupId,
NodeGroupCount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DecreaseNodeGroupsInGlobalReplicationGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
"NodeGroupCount" => NodeGroupCount,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
decrease_replica_count(apply_immediately, replication_group_id)
decrease_replica_count(apply_immediately, replication_group_id, params::Dict{String,<:Any})
Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication
group or the number of replica nodes in one or more node groups (shards) of a Redis
(cluster mode enabled) replication group. This operation is performed with no cluster down
time.
# Arguments
- `apply_immediately`: If True, the number of replica nodes is decreased immediately.
ApplyImmediately=False is not currently supported.
- `replication_group_id`: The id of the replication group from which you want to remove
replica nodes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NewReplicaCount"`: The number of read replica nodes you want at the completion of this
operation. For Redis (cluster mode disabled) replication groups, this is the number of
replica nodes in the replication group. For Redis (cluster mode enabled) replication
groups, this is the number of replica nodes in each of the replication group's node groups.
The minimum number of replicas in a shard or replication group is: Redis (cluster mode
disabled) If Multi-AZ is enabled: 1 If Multi-AZ is not enabled: 0 Redis (cluster
mode enabled): 0 (though you will not be able to failover to a replica if your primary node
fails)
- `"ReplicaConfiguration"`: A list of ConfigureShard objects that can be used to configure
each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has
three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
- `"ReplicasToRemove"`: A list of the node ids to remove from the replication group or node
group (shard).
"""
function decrease_replica_count(
ApplyImmediately, ReplicationGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DecreaseReplicaCount",
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"ReplicationGroupId" => ReplicationGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function decrease_replica_count(
ApplyImmediately,
ReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DecreaseReplicaCount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"ReplicationGroupId" => ReplicationGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cache_cluster(cache_cluster_id)
delete_cache_cluster(cache_cluster_id, params::Dict{String,<:Any})
Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache
nodes, node endpoints and the cluster itself. When you receive a successful response from
this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot
cancel or revert this operation. This operation is not valid for: Redis (cluster mode
enabled) clusters Redis (cluster mode disabled) clusters A cluster that is the last
read replica of a replication group A cluster that is the primary node of a replication
group A node group (shard) that has Multi-AZ mode enabled A cluster from a Redis
(cluster mode enabled) replication group A cluster that is not in the available state
# Arguments
- `cache_cluster_id`: The cluster identifier for the cluster to be deleted. This parameter
is not case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FinalSnapshotIdentifier"`: The user-supplied name of a final cluster snapshot. This is
the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then
deletes the cluster immediately afterward.
"""
function delete_cache_cluster(
CacheClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DeleteCacheCluster",
Dict{String,Any}("CacheClusterId" => CacheClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cache_cluster(
CacheClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DeleteCacheCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CacheClusterId" => CacheClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cache_parameter_group(cache_parameter_group_name)
delete_cache_parameter_group(cache_parameter_group_name, params::Dict{String,<:Any})
Deletes the specified cache parameter group. You cannot delete a cache parameter group if
it is associated with any cache clusters. You cannot delete the default cache parameter
groups in your account.
# Arguments
- `cache_parameter_group_name`: The name of the cache parameter group to delete. The
specified cache security group must not be associated with any clusters.
"""
function delete_cache_parameter_group(
CacheParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DeleteCacheParameterGroup",
Dict{String,Any}("CacheParameterGroupName" => CacheParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cache_parameter_group(
CacheParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DeleteCacheParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CacheParameterGroupName" => CacheParameterGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cache_security_group(cache_security_group_name)
delete_cache_security_group(cache_security_group_name, params::Dict{String,<:Any})
Deletes a cache security group. You cannot delete a cache security group if it is
associated with any clusters.
# Arguments
- `cache_security_group_name`: The name of the cache security group to delete. You cannot
delete the default security group.
"""
function delete_cache_security_group(
CacheSecurityGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DeleteCacheSecurityGroup",
Dict{String,Any}("CacheSecurityGroupName" => CacheSecurityGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cache_security_group(
CacheSecurityGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DeleteCacheSecurityGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CacheSecurityGroupName" => CacheSecurityGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cache_subnet_group(cache_subnet_group_name)
delete_cache_subnet_group(cache_subnet_group_name, params::Dict{String,<:Any})
Deletes a cache subnet group. You cannot delete a default cache subnet group or one that
is associated with any clusters.
# Arguments
- `cache_subnet_group_name`: The name of the cache subnet group to delete. Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
"""
function delete_cache_subnet_group(
CacheSubnetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DeleteCacheSubnetGroup",
Dict{String,Any}("CacheSubnetGroupName" => CacheSubnetGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cache_subnet_group(
CacheSubnetGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DeleteCacheSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CacheSubnetGroupName" => CacheSubnetGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_global_replication_group(global_replication_group_id, retain_primary_replication_group)
delete_global_replication_group(global_replication_group_id, retain_primary_replication_group, params::Dict{String,<:Any})
Deleting a Global datastore is a two-step process: First, you must
DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global
datastore. Once the Global datastore contains only the primary cluster, you can use the
DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the
primary cluster using RetainPrimaryReplicationGroup=true. Since the Global Datastore has
only a primary cluster, you can delete the Global Datastore while retaining the primary by
setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when
deleting a Global Datastore. It can only be deleted when it no longer is associated with
any Global Datastore. When you receive a successful response from this operation, Amazon
ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert
this operation.
# Arguments
- `global_replication_group_id`: The name of the Global datastore
- `retain_primary_replication_group`: The primary replication group is retained as a
standalone replication group.
"""
function delete_global_replication_group(
GlobalReplicationGroupId,
RetainPrimaryReplicationGroup;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DeleteGlobalReplicationGroup",
Dict{String,Any}(
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
"RetainPrimaryReplicationGroup" => RetainPrimaryReplicationGroup,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_global_replication_group(
GlobalReplicationGroupId,
RetainPrimaryReplicationGroup,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DeleteGlobalReplicationGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
"RetainPrimaryReplicationGroup" => RetainPrimaryReplicationGroup,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_replication_group(replication_group_id)
delete_replication_group(replication_group_id, params::Dict{String,<:Any})
Deletes an existing replication group. By default, this operation deletes the entire
replication group, including the primary/primaries and all of the read replicas. If the
replication group has only one primary, you can optionally delete only the read replicas,
while retaining the primary by setting RetainPrimaryCluster=true. When you receive a
successful response from this operation, Amazon ElastiCache immediately begins deleting the
selected resources; you cannot cancel or revert this operation. This operation is valid
for Redis only.
# Arguments
- `replication_group_id`: The identifier for the cluster to be deleted. This parameter is
not case sensitive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FinalSnapshotIdentifier"`: The name of a final node group (shard) snapshot. ElastiCache
creates the snapshot from the primary node in the cluster, rather than one of the replicas;
this is to ensure that it captures the freshest data. After the final snapshot is taken,
the replication group is immediately deleted.
- `"RetainPrimaryCluster"`: If set to true, all of the read replicas are deleted, but the
primary node is retained.
"""
function delete_replication_group(
ReplicationGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DeleteReplicationGroup",
Dict{String,Any}("ReplicationGroupId" => ReplicationGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_replication_group(
ReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DeleteReplicationGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReplicationGroupId" => ReplicationGroupId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_serverless_cache(serverless_cache_name)
delete_serverless_cache(serverless_cache_name, params::Dict{String,<:Any})
Deletes a specified existing serverless cache.
# Arguments
- `serverless_cache_name`: The identifier of the serverless cache to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FinalSnapshotName"`: Name of the final snapshot to be taken before the serverless cache
is deleted. Available for Redis only. Default: NULL, i.e. a final snapshot is not taken.
"""
function delete_serverless_cache(
ServerlessCacheName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DeleteServerlessCache",
Dict{String,Any}("ServerlessCacheName" => ServerlessCacheName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_serverless_cache(
ServerlessCacheName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DeleteServerlessCache",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerlessCacheName" => ServerlessCacheName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_serverless_cache_snapshot(serverless_cache_snapshot_name)
delete_serverless_cache_snapshot(serverless_cache_snapshot_name, params::Dict{String,<:Any})
Deletes an existing serverless cache snapshot. Available for Redis only.
# Arguments
- `serverless_cache_snapshot_name`: Idenfitier of the snapshot to be deleted. Available for
Redis only.
"""
function delete_serverless_cache_snapshot(
ServerlessCacheSnapshotName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DeleteServerlessCacheSnapshot",
Dict{String,Any}("ServerlessCacheSnapshotName" => ServerlessCacheSnapshotName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_serverless_cache_snapshot(
ServerlessCacheSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DeleteServerlessCacheSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServerlessCacheSnapshotName" => ServerlessCacheSnapshotName
),
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,
ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this
operation. This operation is valid for Redis only.
# Arguments
- `snapshot_name`: The name of the snapshot to be deleted.
"""
function delete_snapshot(SnapshotName; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"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 elasticache(
"DeleteSnapshot",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SnapshotName" => SnapshotName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(user_id)
delete_user(user_id, params::Dict{String,<:Any})
For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all
user groups and in turn removed from all replication groups. For more information, see
Using Role Based Access Control (RBAC).
# Arguments
- `user_id`: The ID of the user.
"""
function delete_user(UserId; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DeleteUser",
Dict{String,Any}("UserId" => UserId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
UserId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DeleteUser",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("UserId" => UserId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_group(user_group_id)
delete_user_group(user_group_id, params::Dict{String,<:Any})
For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be
disassociated from the replication group before it can be deleted. For more information,
see Using Role Based Access Control (RBAC).
# Arguments
- `user_group_id`: The ID of the user group.
"""
function delete_user_group(UserGroupId; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DeleteUserGroup",
Dict{String,Any}("UserGroupId" => UserGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_group(
UserGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DeleteUserGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserGroupId" => UserGroupId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cache_clusters()
describe_cache_clusters(params::Dict{String,<:Any})
Returns information about all provisioned clusters if no cluster identifier is specified,
or about a specific cache cluster if a cluster identifier is supplied. By default,
abbreviated information about the clusters is returned. You can use the optional
ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated
with the clusters. These details include the DNS address and port for the cache node
endpoint. If the cluster is in the creating state, only cluster-level information is
displayed until all of the nodes are successfully provisioned. If the cluster is in the
deleting state, only cluster-level information is displayed. If cache nodes are currently
being added to the cluster, node endpoint information and creation time for the additional
nodes are not displayed until they are completely provisioned. When the cluster state is
available, the cluster is ready for use. If cache nodes are currently being removed from
the cluster, no endpoint information for the removed nodes is displayed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheClusterId"`: The user-supplied cluster identifier. If this parameter is specified,
only information about that specific cluster is returned. This parameter isn't case
sensitive.
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
- `"ShowCacheClustersNotInReplicationGroups"`: An optional flag that can be included in the
DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of
a replication group. In practice, this mean Memcached and single node Redis clusters.
- `"ShowCacheNodeInfo"`: An optional flag that can be included in the DescribeCacheCluster
request to retrieve information about the individual cache nodes.
"""
function describe_cache_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DescribeCacheClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_cache_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeCacheClusters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cache_engine_versions()
describe_cache_engine_versions(params::Dict{String,<:Any})
Returns a list of the available cache engines and their versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheParameterGroupFamily"`: The name of a specific cache parameter group family to
return details for. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6
| redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7 Constraints:
Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end
with a hyphen or contain two consecutive hyphens
- `"DefaultOnly"`: If true, specifies that only the default version of the specified engine
or engine and major version combination is to be returned.
- `"Engine"`: The cache engine to return. Valid values: memcached | redis
- `"EngineVersion"`: The cache engine version to return. Example: 1.4.14
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
"""
function describe_cache_engine_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DescribeCacheEngineVersions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cache_engine_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeCacheEngineVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cache_parameter_groups()
describe_cache_parameter_groups(params::Dict{String,<:Any})
Returns a list of cache parameter group descriptions. If a cache 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:
- `"CacheParameterGroupName"`: The name of a specific cache parameter group to return
details for.
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
"""
function describe_cache_parameter_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeCacheParameterGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cache_parameter_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeCacheParameterGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cache_parameters(cache_parameter_group_name)
describe_cache_parameters(cache_parameter_group_name, params::Dict{String,<:Any})
Returns the detailed parameter list for a particular cache parameter group.
# Arguments
- `cache_parameter_group_name`: The name of a specific cache parameter group to return
details for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
- `"Source"`: The parameter types to return. Valid values: user | system | engine-default
"""
function describe_cache_parameters(
CacheParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeCacheParameters",
Dict{String,Any}("CacheParameterGroupName" => CacheParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cache_parameters(
CacheParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DescribeCacheParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CacheParameterGroupName" => CacheParameterGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cache_security_groups()
describe_cache_security_groups(params::Dict{String,<:Any})
Returns a list of cache security group descriptions. If a cache security group name is
specified, the list contains only the description of that group. This applicable only when
you have ElastiCache in Classic setup
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheSecurityGroupName"`: The name of the cache security group to return details for.
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
"""
function describe_cache_security_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DescribeCacheSecurityGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cache_security_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeCacheSecurityGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cache_subnet_groups()
describe_cache_subnet_groups(params::Dict{String,<:Any})
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the
list contains only the description of that group. This is applicable only when you have
ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheSubnetGroupName"`: The name of the cache subnet group to return details for.
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
"""
function describe_cache_subnet_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DescribeCacheSubnetGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_cache_subnet_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeCacheSubnetGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_engine_default_parameters(cache_parameter_group_family)
describe_engine_default_parameters(cache_parameter_group_family, params::Dict{String,<:Any})
Returns the default engine and system parameter information for the specified cache engine.
# Arguments
- `cache_parameter_group_family`: The name of the cache parameter group family. Valid
values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 |
redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
"""
function describe_engine_default_parameters(
CacheParameterGroupFamily; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeEngineDefaultParameters",
Dict{String,Any}("CacheParameterGroupFamily" => CacheParameterGroupFamily);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_engine_default_parameters(
CacheParameterGroupFamily,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DescribeEngineDefaultParameters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CacheParameterGroupFamily" => CacheParameterGroupFamily),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Returns events related to clusters, cache security groups, and cache parameter groups. You
can obtain events specific to a particular cluster, cache security group, or cache
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
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
- `"SourceIdentifier"`: 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 elasticache(
"DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeEvents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_global_replication_groups()
describe_global_replication_groups(params::Dict{String,<:Any})
Returns information about a particular global replication group. If no identifier is
specified, returns information about all Global datastores.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GlobalReplicationGroupId"`: The name of the Global datastore
- `"Marker"`: 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.
- `"MaxRecords"`: 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.
- `"ShowMemberInfo"`: Returns the list of members that comprise the Global datastore.
"""
function describe_global_replication_groups(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeGlobalReplicationGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_global_replication_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeGlobalReplicationGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replication_groups()
describe_replication_groups(params::Dict{String,<:Any})
Returns information about a particular replication group. If no identifier is specified,
DescribeReplicationGroups returns information about all replication groups. This operation
is valid for Redis only.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
- `"ReplicationGroupId"`: The identifier for the replication group to be described. This
parameter is not case sensitive. If you do not specify this parameter, information about
all replication groups is returned.
"""
function describe_replication_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DescribeReplicationGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_replication_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeReplicationGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_cache_nodes()
describe_reserved_cache_nodes(params::Dict{String,<:Any})
Returns information about reserved cache nodes for this account, or about a specified
reserved cache node.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheNodeType"`: The cache node type filter value. Use this parameter to show only
those reservations matching the specified cache node type. The following node types are
supported by ElastiCache. Generally speaking, the current generation types provide more
memory and computational power at lower cost when compared to their equivalent previous
generation counterparts. General purpose: Current generation: M7g node types:
cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached
engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node
types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge,
cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge,
cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for
Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro,
cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small,
cache.t2.medium Previous generation: (not recommended. Existing clusters are still
supported but creation of new clusters is not supported for these types.) T1 node types:
cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
cache.m3.2xlarge Compute optimized: Previous generation: (not recommended. Existing
clusters are still supported but creation of new clusters is not supported for these
types.) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R7g
node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge,
cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see
Supported Node Types R6g node types (available only for Redis engine version 5.0.6
onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge,
cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large,
cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation
of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge,
cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge,
cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All
current generation instance types are created in Amazon VPC by default. Redis append-only
files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic
failover is not supported on T1 instances. Redis configuration variables appendonly and
appendfsync are not supported on Redis version 2.8.22 and later.
- `"Duration"`: The duration filter value, specified in years or seconds. Use this
parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 |
94608000
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
- `"OfferingType"`: The offering type filter value. Use this parameter to show only the
available offerings matching the specified offering type. Valid values: \"Light
Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All Upfront\"|\"Partial
Upfront\"| \"No Upfront\"
- `"ProductDescription"`: The product description filter value. Use this parameter to show
only those reservations matching the specified product description.
- `"ReservedCacheNodeId"`: The reserved cache node identifier filter value. Use this
parameter to show only the reservation that matches the specified reservation ID.
- `"ReservedCacheNodesOfferingId"`: The offering identifier filter value. Use this
parameter to show only purchased reservations matching the specified offering identifier.
"""
function describe_reserved_cache_nodes(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DescribeReservedCacheNodes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_reserved_cache_nodes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeReservedCacheNodes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_cache_nodes_offerings()
describe_reserved_cache_nodes_offerings(params::Dict{String,<:Any})
Lists available reserved cache node offerings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheNodeType"`: The cache node type filter value. Use this parameter to show only the
available offerings matching the specified cache node type. The following node types are
supported by ElastiCache. Generally speaking, the current generation types provide more
memory and computational power at lower cost when compared to their equivalent previous
generation counterparts. General purpose: Current generation: M7g node types:
cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge,
cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached
engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node
types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge,
cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge,
cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for
Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro,
cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small,
cache.t2.medium Previous generation: (not recommended. Existing clusters are still
supported but creation of new clusters is not supported for these types.) T1 node types:
cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
cache.m3.2xlarge Compute optimized: Previous generation: (not recommended. Existing
clusters are still supported but creation of new clusters is not supported for these
types.) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R7g
node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge,
cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see
Supported Node Types R6g node types (available only for Redis engine version 5.0.6
onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge,
cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large,
cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation
of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge,
cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge,
cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All
current generation instance types are created in Amazon VPC by default. Redis append-only
files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic
failover is not supported on T1 instances. Redis configuration variables appendonly and
appendfsync are not supported on Redis version 2.8.22 and later.
- `"Duration"`: Duration filter value, specified in years or seconds. Use this parameter to
show only reservations for a given duration. Valid Values: 1 | 3 | 31536000 | 94608000
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 100 Constraints: minimum 20; maximum 100.
- `"OfferingType"`: The offering type filter value. Use this parameter to show only the
available offerings matching the specified offering type. Valid Values: \"Light
Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All Upfront\"|\"Partial
Upfront\"| \"No Upfront\"
- `"ProductDescription"`: The product description filter value. Use this parameter to show
only the available offerings matching the specified product description.
- `"ReservedCacheNodesOfferingId"`: The offering identifier filter value. Use this
parameter to show only the available offering that matches the specified reservation
identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
"""
function describe_reserved_cache_nodes_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeReservedCacheNodesOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_cache_nodes_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeReservedCacheNodesOfferings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_serverless_cache_snapshots()
describe_serverless_cache_snapshots(params::Dict{String,<:Any})
Returns information about serverless cache snapshots. By default, this API lists all of the
customer’s serverless cache snapshots. It can also describe a single serverless cache
snapshot, or the snapshots associated with a particular serverless cache. Available for
Redis only.
# 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 max-results value, a market is included in the response so that
remaining results can be retrieved. Available for Redis only.The default is 50. The
Validation Constraints are a maximum of 50.
- `"NextToken"`: An optional marker returned from a prior request to support 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 max-results. Available for Redis
only.
- `"ServerlessCacheName"`: The identifier of serverless cache. If this parameter is
specified, only snapshots associated with that specific serverless cache are described.
Available for Redis only.
- `"ServerlessCacheSnapshotName"`: The identifier of the serverless cache’s snapshot. If
this parameter is specified, only this snapshot is described. Available for Redis only.
- `"SnapshotType"`: The type of snapshot that is being described. Available for Redis only.
"""
function describe_serverless_cache_snapshots(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeServerlessCacheSnapshots";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_serverless_cache_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeServerlessCacheSnapshots",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_serverless_caches()
describe_serverless_caches(params::Dict{String,<:Any})
Returns information about a specific serverless cache. If no identifier is specified, then
the API returns information on all the serverless caches belonging to this 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 records in the response. If more records exist than
the specified max-records value, the next token is included in the response so that
remaining results can be retrieved. The default is 50.
- `"NextToken"`: An optional marker returned from a prior request to support 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 MaxResults.
- `"ServerlessCacheName"`: The identifier for the serverless cache. If this parameter is
specified, only information about that specific serverless cache is returned. Default: NULL
"""
function describe_serverless_caches(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DescribeServerlessCaches"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_serverless_caches(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeServerlessCaches",
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:
- `"Marker"`: 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.
- `"MaxRecords"`: The maximum number of records to include in the response
- `"ServiceUpdateName"`: The unique ID of the service update
- `"ServiceUpdateStatus"`: The status of the service update
"""
function describe_service_updates(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"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 elasticache(
"DescribeServiceUpdates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshots()
describe_snapshots(params::Dict{String,<:Any})
Returns information about cluster or replication group snapshots. By default,
DescribeSnapshots lists all of your snapshots; it can optionally describe a single
snapshot, or just the snapshots associated with a particular cache cluster. This operation
is valid for Redis only.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheClusterId"`: A user-supplied cluster identifier. If this parameter is specified,
only snapshots associated with that specific cluster are described.
- `"Marker"`: 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.
- `"MaxRecords"`: 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. Default: 50 Constraints: minimum 20; maximum 50.
- `"ReplicationGroupId"`: A user-supplied replication group identifier. If this parameter
is specified, only snapshots associated with that specific replication group are described.
- `"ShowNodeGroupConfig"`: A Boolean value which if true, the node group (shard)
configuration is included in the snapshot description.
- `"SnapshotName"`: A user-supplied name of the snapshot. If this parameter is specified,
only this snapshot are described.
- `"SnapshotSource"`: If set to system, the output shows snapshots that were automatically
created by ElastiCache. 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 elasticache(
"DescribeSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeSnapshots", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_update_actions()
describe_update_actions(params::Dict{String,<:Any})
Returns details of the update actions
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheClusterIds"`: The cache cluster IDs
- `"Engine"`: The Elasticache engine to which the update applies. Either Redis or Memcached
- `"Marker"`: 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.
- `"MaxRecords"`: The maximum number of records to include in the response
- `"ReplicationGroupIds"`: The replication group IDs
- `"ServiceUpdateName"`: The unique ID of the service update
- `"ServiceUpdateStatus"`: The status of the service update
- `"ServiceUpdateTimeRange"`: The range of time specified to search for service updates
that are in available status
- `"ShowNodeLevelUpdateStatus"`: Dictates whether to include node level update status in
the response
- `"UpdateActionStatus"`: The status of the update action.
"""
function describe_update_actions(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DescribeUpdateActions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_update_actions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeUpdateActions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user_groups()
describe_user_groups(params::Dict{String,<:Any})
Returns a list of user groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: 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. >
- `"MaxRecords"`: 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.
- `"UserGroupId"`: The ID of the user group.
"""
function describe_user_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DescribeUserGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_user_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeUserGroups", 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:
- `"Engine"`: The Redis engine.
- `"Filters"`: Filter to determine the list of User IDs to return.
- `"Marker"`: 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. >
- `"MaxRecords"`: 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.
- `"UserId"`: The ID of the user.
"""
function describe_users(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"DescribeUsers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_users(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"DescribeUsers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
disassociate_global_replication_group(global_replication_group_id, replication_group_id, replication_group_region)
disassociate_global_replication_group(global_replication_group_id, replication_group_id, replication_group_region, params::Dict{String,<:Any})
Remove a secondary cluster from the Global datastore using the Global datastore name. The
secondary cluster will no longer receive updates from the primary cluster, but will remain
as a standalone cluster in that Amazon region.
# Arguments
- `global_replication_group_id`: The name of the Global datastore
- `replication_group_id`: The name of the secondary cluster you wish to remove from the
Global datastore
- `replication_group_region`: The Amazon region of secondary cluster you wish to remove
from the Global datastore
"""
function disassociate_global_replication_group(
GlobalReplicationGroupId,
ReplicationGroupId,
ReplicationGroupRegion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DisassociateGlobalReplicationGroup",
Dict{String,Any}(
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
"ReplicationGroupId" => ReplicationGroupId,
"ReplicationGroupRegion" => ReplicationGroupRegion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_global_replication_group(
GlobalReplicationGroupId,
ReplicationGroupId,
ReplicationGroupRegion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"DisassociateGlobalReplicationGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
"ReplicationGroupId" => ReplicationGroupId,
"ReplicationGroupRegion" => ReplicationGroupRegion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
export_serverless_cache_snapshot(s3_bucket_name, serverless_cache_snapshot_name)
export_serverless_cache_snapshot(s3_bucket_name, serverless_cache_snapshot_name, params::Dict{String,<:Any})
Provides the functionality to export the serverless cache snapshot data to Amazon S3.
Available for Redis only.
# Arguments
- `s3_bucket_name`: Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3
bucket must also be in same region as the snapshot. Available for Redis only.
- `serverless_cache_snapshot_name`: The identifier of the serverless cache snapshot to be
exported to S3. Available for Redis only.
"""
function export_serverless_cache_snapshot(
S3BucketName,
ServerlessCacheSnapshotName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ExportServerlessCacheSnapshot",
Dict{String,Any}(
"S3BucketName" => S3BucketName,
"ServerlessCacheSnapshotName" => ServerlessCacheSnapshotName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function export_serverless_cache_snapshot(
S3BucketName,
ServerlessCacheSnapshotName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ExportServerlessCacheSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"S3BucketName" => S3BucketName,
"ServerlessCacheSnapshotName" => ServerlessCacheSnapshotName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
failover_global_replication_group(global_replication_group_id, primary_region, primary_replication_group_id)
failover_global_replication_group(global_replication_group_id, primary_region, primary_replication_group_id, params::Dict{String,<:Any})
Used to failover the primary region to a secondary region. The secondary region will become
primary, and all other clusters will become secondary.
# Arguments
- `global_replication_group_id`: The name of the Global datastore
- `primary_region`: The Amazon region of the primary cluster of the Global datastore
- `primary_replication_group_id`: The name of the primary replication group
"""
function failover_global_replication_group(
GlobalReplicationGroupId,
PrimaryRegion,
PrimaryReplicationGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"FailoverGlobalReplicationGroup",
Dict{String,Any}(
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
"PrimaryRegion" => PrimaryRegion,
"PrimaryReplicationGroupId" => PrimaryReplicationGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function failover_global_replication_group(
GlobalReplicationGroupId,
PrimaryRegion,
PrimaryReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"FailoverGlobalReplicationGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
"PrimaryRegion" => PrimaryRegion,
"PrimaryReplicationGroupId" => PrimaryReplicationGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
increase_node_groups_in_global_replication_group(apply_immediately, global_replication_group_id, node_group_count)
increase_node_groups_in_global_replication_group(apply_immediately, global_replication_group_id, node_group_count, params::Dict{String,<:Any})
Increase the number of node groups in the Global datastore
# Arguments
- `apply_immediately`: Indicates that the process begins immediately. At present, the only
permitted value for this parameter is true.
- `global_replication_group_id`: The name of the Global datastore
- `node_group_count`: Total number of node groups you want
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RegionalConfigurations"`: Describes the replication group IDs, the Amazon regions where
they are stored and the shard configuration for each that comprise the Global datastore
"""
function increase_node_groups_in_global_replication_group(
ApplyImmediately,
GlobalReplicationGroupId,
NodeGroupCount;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"IncreaseNodeGroupsInGlobalReplicationGroup",
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
"NodeGroupCount" => NodeGroupCount,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function increase_node_groups_in_global_replication_group(
ApplyImmediately,
GlobalReplicationGroupId,
NodeGroupCount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"IncreaseNodeGroupsInGlobalReplicationGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
"NodeGroupCount" => NodeGroupCount,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
increase_replica_count(apply_immediately, replication_group_id)
increase_replica_count(apply_immediately, replication_group_id, params::Dict{String,<:Any})
Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication
group or the number of replica nodes in one or more node groups (shards) of a Redis
(cluster mode enabled) replication group. This operation is performed with no cluster down
time.
# Arguments
- `apply_immediately`: If True, the number of replica nodes is increased immediately.
ApplyImmediately=False is not currently supported.
- `replication_group_id`: The id of the replication group to which you want to add replica
nodes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NewReplicaCount"`: The number of read replica nodes you want at the completion of this
operation. For Redis (cluster mode disabled) replication groups, this is the number of
replica nodes in the replication group. For Redis (cluster mode enabled) replication
groups, this is the number of replica nodes in each of the replication group's node groups.
- `"ReplicaConfiguration"`: A list of ConfigureShard objects that can be used to configure
each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has
three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
"""
function increase_replica_count(
ApplyImmediately, ReplicationGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"IncreaseReplicaCount",
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"ReplicationGroupId" => ReplicationGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function increase_replica_count(
ApplyImmediately,
ReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"IncreaseReplicaCount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"ReplicationGroupId" => ReplicationGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_allowed_node_type_modifications()
list_allowed_node_type_modifications(params::Dict{String,<:Any})
Lists all available node types that you can scale your Redis cluster's or replication
group's current node type. When you use the ModifyCacheCluster or ModifyReplicationGroup
operations to scale your cluster or replication group, the value of the CacheNodeType
parameter must be one of the node types returned by this operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheClusterId"`: The name of the cluster you want to scale up to a larger node
instanced type. ElastiCache uses the cluster id to identify the current node type of this
cluster and from that to create a list of node types you can scale up to. You must provide
a value for either the CacheClusterId or the ReplicationGroupId.
- `"ReplicationGroupId"`: The name of the replication group want to scale up to a larger
node type. ElastiCache uses the replication group id to identify the current node type
being used by this replication group, and from that to create a list of node types you can
scale up to. You must provide a value for either the CacheClusterId or the
ReplicationGroupId.
"""
function list_allowed_node_type_modifications(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"ListAllowedNodeTypeModifications";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_allowed_node_type_modifications(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"ListAllowedNodeTypeModifications",
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 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 all your ElastiCache
resources, with the exception of global replication group. When you add or remove tags on
replication groups, those actions will be replicated to all nodes in the replication group.
For more information, see Resource-level permissions. If the cluster is not in the
available state, ListTagsForResource returns an error.
# Arguments
- `resource_name`: The Amazon Resource Name (ARN) of the resource for which you want the
list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or
arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. For more information about
ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
"""
function list_tags_for_resource(
ResourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"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 elasticache(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceName" => ResourceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cache_cluster(cache_cluster_id)
modify_cache_cluster(cache_cluster_id, params::Dict{String,<:Any})
Modifies the settings for a cluster. You can use this operation to change one or more
cluster configuration parameters by specifying the parameters and the new values.
# Arguments
- `cache_cluster_id`: The cluster identifier. This value is stored as a lowercase string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AZMode"`: Specifies whether the new nodes in this Memcached cluster are all created in
a single Availability Zone or created across multiple Availability Zones. Valid values:
single-az | cross-az. This option is only supported for Memcached clusters. You cannot
specify single-az if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az is specified, existing Memcached nodes remain in their
current Availability Zone. Only newly created nodes are located in different Availability
Zones.
- `"ApplyImmediately"`: If true, this parameter causes the modifications in this request
and any pending modifications to be applied, asynchronously and as soon as possible,
regardless of the PreferredMaintenanceWindow setting for the cluster. If false, changes to
the cluster are applied on the next maintenance reboot, or the next failure reboot,
whichever occurs first. If you perform a ModifyCacheCluster before a pending modification
is applied, the pending modification is replaced by the newer modification. Valid values:
true | false Default: false
- `"AuthToken"`: Reserved parameter. The password used to access a password protected
server. This parameter must be specified with the auth-token-update parameter. Password
constraints: Must be only printable ASCII characters Must be at least 16 characters and
no more than 128 characters in length Cannot contain any of the following characters:
'/', '\"', or '@', '%' For more information, see AUTH password at AUTH.
- `"AuthTokenUpdateStrategy"`: Specifies the strategy to use to update the AUTH token. This
parameter must be specified with the auth-token parameter. Possible values: ROTATE -
default, if no update strategy is provided SET - allowed only after ROTATE DELETE -
allowed only when transitioning to RBAC For more information, see Authenticating Users
with Redis AUTH
- `"AutoMinorVersionUpgrade"`: If you are running Redis engine version 6.0 or later, set
this parameter to yes if you want to opt-in to the next auto minor version upgrade
campaign. This parameter is disabled for previous versions.
- `"CacheNodeIdsToRemove"`: A list of cache node IDs to be removed. A node ID is a numeric
identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than
the existing number of cache nodes. The number of cache node IDs supplied in this parameter
must match the difference between the existing number of cache nodes in the cluster or
pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of
cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to
remove.
- `"CacheNodeType"`: A valid cache node type that you want to scale this cluster up to.
- `"CacheParameterGroupName"`: The name of the cache parameter group to apply to this
cluster. This change is asynchronously applied as soon as possible for parameters when the
ApplyImmediately parameter is specified as true for this request.
- `"CacheSecurityGroupNames"`: A list of cache security group names to authorize on this
cluster. This change is asynchronously applied as soon as possible. You can use this
parameter only with clusters that are created outside of an Amazon Virtual Private Cloud
(Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not
be \"Default\".
- `"EngineVersion"`: The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and
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.
- `"IpDiscovery"`: The network type you choose when modifying a cluster, either ipv4 |
ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached
engine version 1.6.6 on all instances built on the Nitro system.
- `"LogDeliveryConfigurations"`: Specifies the destination, format and type of the logs.
- `"NewAvailabilityZones"`: This option is only supported on Memcached clusters. The list
of Availability Zones where the new Memcached cache nodes are created. This parameter is
only valid when NumCacheNodes in the request is greater than the sum of the number of
active cache nodes and the number of cache nodes pending creation (which may be zero). The
number of Availability Zones supplied in this list must match the cache nodes being added
in this request. Scenarios: Scenario 1: You have 3 active nodes and wish to add 2 nodes.
Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two
new nodes. Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the
scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and
optionally specify an Availability Zone for the new node. Scenario 3: You want to cancel
all pending operations. Specify NumCacheNodes=3 to cancel all pending operations. The
Availability Zone placement of nodes pending creation cannot be modified. If you wish to
cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of
current nodes. If cross-az is specified, existing Memcached nodes remain in their current
Availability Zone. Only newly created nodes can be located in different Availability Zones.
For guidance on how to move existing Memcached nodes to different Availability Zones, see
the Availability Zone Considerations section of Cache Node Considerations for Memcached.
Impact of new add/remove requests upon pending requests Scenario-1 Pending Action:
Delete New Request: Delete Result: The new delete, pending or immediate, replaces the
pending delete. Scenario-2 Pending Action: Delete New Request: Create Result: The
new create, pending or immediate, replaces the pending delete. Scenario-3 Pending
Action: Create New Request: Delete Result: The new delete, pending or immediate,
replaces the pending create. Scenario-4 Pending Action: Create New Request: Create
Result: The new create is added to the pending create. Important: If the new create
request is Apply Immediately - Yes, all creates are performed immediately. If the new
create request is Apply Immediately - No, all creates are pending.
- `"NotificationTopicArn"`: The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications are sent. The Amazon SNS topic owner must be same as the cluster owner.
- `"NotificationTopicStatus"`: The status of the Amazon SNS notification topic.
Notifications are sent only if the status is active. Valid values: active | inactive
- `"NumCacheNodes"`: The number of cache nodes that the cluster should have. If the value
for NumCacheNodes is greater than the sum of the number of current cache nodes and the
number of cache nodes pending creation (which may be zero), more nodes are added. If the
value is less than the number of existing cache nodes, nodes are removed. If the value is
equal to the number of current cache nodes, any pending add or remove requests are
canceled. If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter
to provide the IDs of the specific cache nodes to remove. For clusters running Redis, this
value must be 1. For clusters running Memcached, this value must be between 1 and 40.
Adding or removing Memcached cache nodes can be applied immediately or as a pending
operation (see ApplyImmediately). A pending operation to modify the number of cache nodes
in a cluster during its maintenance window, whether by adding or removing nodes in
accordance with the scale out architecture, is not queued. The customer's latest request to
add or remove nodes to the cluster overrides any previous pending operations to modify the
number of cache nodes in the cluster. For example, a request to remove 2 nodes would
override a previous pending operation to remove 3 nodes. Similarly, a request to add 2
nodes would override a previous pending operation to remove 3 nodes and vice versa. As
Memcached cache nodes may now be provisioned in different Availability Zones with flexible
cache node placement, a request to add nodes does not automatically override a previous
pending operation to add nodes. The customer can modify the previous pending operation to
add more nodes or explicitly cancel the pending request and retry the new request. To
cancel pending operations to modify the number of cache nodes in a cluster, use the
ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes
currently in the cluster.
- `"PreferredMaintenanceWindow"`: 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
- `"SecurityGroupIds"`: Specifies the VPC Security Groups associated with the cluster. This
parameter can be used only with clusters that are created in an Amazon Virtual Private
Cloud (Amazon VPC).
- `"SnapshotRetentionLimit"`: The number of days for which ElastiCache 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. If the
value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
- `"SnapshotWindow"`: The daily time range (in UTC) during which ElastiCache begins taking
a daily snapshot of your cluster.
"""
function modify_cache_cluster(
CacheClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"ModifyCacheCluster",
Dict{String,Any}("CacheClusterId" => CacheClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cache_cluster(
CacheClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyCacheCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CacheClusterId" => CacheClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cache_parameter_group(cache_parameter_group_name, parameter_name_value)
modify_cache_parameter_group(cache_parameter_group_name, parameter_name_value, params::Dict{String,<:Any})
Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a
single request by submitting a list parameter name and value pairs.
# Arguments
- `cache_parameter_group_name`: The name of the cache parameter group to modify.
- `parameter_name_value`: 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 modified per request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ParameterNameValues"`: 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 modified per request.
"""
function modify_cache_parameter_group(
CacheParameterGroupName,
ParameterNameValue;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyCacheParameterGroup",
Dict{String,Any}(
"CacheParameterGroupName" => CacheParameterGroupName,
"ParameterNameValue" => ParameterNameValue,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cache_parameter_group(
CacheParameterGroupName,
ParameterNameValue,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyCacheParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CacheParameterGroupName" => CacheParameterGroupName,
"ParameterNameValue" => ParameterNameValue,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cache_subnet_group(cache_subnet_group_name)
modify_cache_subnet_group(cache_subnet_group_name, params::Dict{String,<:Any})
Modifies an existing cache subnet group.
# Arguments
- `cache_subnet_group_name`: The name for the cache subnet group. This value is stored as a
lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or
hyphens. Example: mysubnetgroup
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheSubnetGroupDescription"`: A description of the cache subnet group.
- `"SubnetIds"`: The EC2 subnet IDs for the cache subnet group.
"""
function modify_cache_subnet_group(
CacheSubnetGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"ModifyCacheSubnetGroup",
Dict{String,Any}("CacheSubnetGroupName" => CacheSubnetGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cache_subnet_group(
CacheSubnetGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyCacheSubnetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CacheSubnetGroupName" => CacheSubnetGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_global_replication_group(apply_immediately, global_replication_group_id)
modify_global_replication_group(apply_immediately, global_replication_group_id, params::Dict{String,<:Any})
Modifies the settings for a Global datastore.
# Arguments
- `apply_immediately`: This parameter causes the modifications in this request and any
pending modifications to be applied, asynchronously and as soon as possible. Modifications
to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.
- `global_replication_group_id`: The name of the Global datastore
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutomaticFailoverEnabled"`: Determines whether a read replica is automatically promoted
to read/write primary if the existing primary encounters a failure.
- `"CacheNodeType"`: A valid cache node type that you want to scale this Global datastore
to.
- `"CacheParameterGroupName"`: The name of the cache parameter group to use with the Global
datastore. It must be compatible with the major engine version used by the Global datastore.
- `"EngineVersion"`: The upgraded version of the cache engine to be run on the clusters in
the Global datastore.
- `"GlobalReplicationGroupDescription"`: A description of the Global datastore
"""
function modify_global_replication_group(
ApplyImmediately,
GlobalReplicationGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyGlobalReplicationGroup",
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_global_replication_group(
ApplyImmediately,
GlobalReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyGlobalReplicationGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_replication_group(replication_group_id)
modify_replication_group(replication_group_id, params::Dict{String,<:Any})
Modifies the settings for a replication group. This is limited to Redis 7 and newer.
Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User
Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This
operation is valid for Redis only.
# Arguments
- `replication_group_id`: The identifier of the replication group to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ApplyImmediately"`: If true, this parameter causes the modifications in this request
and any pending modifications to be applied, asynchronously and as soon as possible,
regardless of the PreferredMaintenanceWindow setting for the replication group. If false,
changes to the nodes in the replication group are applied on the next maintenance reboot,
or the next failure reboot, whichever occurs first. Valid values: true | false Default:
false
- `"AuthToken"`: Reserved parameter. The password used to access a password protected
server. This parameter must be specified with the auth-token-update-strategy parameter.
Password constraints: Must be only printable ASCII characters Must be at least 16
characters and no more than 128 characters in length Cannot contain any of the following
characters: '/', '\"', or '@', '%' For more information, see AUTH password at AUTH.
- `"AuthTokenUpdateStrategy"`: Specifies the strategy to use to update the AUTH token. This
parameter must be specified with the auth-token parameter. Possible values: ROTATE -
default, if no update strategy is provided SET - allowed only after ROTATE DELETE -
allowed only when transitioning to RBAC For more information, see Authenticating Users
with Redis AUTH
- `"AutoMinorVersionUpgrade"`: If you are running Redis engine version 6.0 or later, set
this parameter to yes if you want to opt-in to the next auto minor version upgrade
campaign. This parameter is disabled for previous versions.
- `"AutomaticFailoverEnabled"`: Determines whether a read replica is automatically promoted
to read/write primary if the existing primary encounters a failure. Valid values: true |
false
- `"CacheNodeType"`: A valid cache node type that you want to scale this replication group
to.
- `"CacheParameterGroupName"`: The name of the cache parameter group to apply to all of the
clusters in this replication group. This change is asynchronously applied as soon as
possible for parameters when the ApplyImmediately parameter is specified as true for this
request.
- `"CacheSecurityGroupNames"`: A list of cache security group names to authorize for the
clusters in this replication group. This change is asynchronously applied as soon as
possible. This parameter can be used only with replication group containing clusters
running outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain
no more than 255 alphanumeric characters. Must not be Default.
- `"ClusterMode"`: Enabled or Disabled. To modify cluster mode from Disabled to Enabled,
you must first set the cluster mode to Compatible. Compatible mode allows your Redis
clients to connect using both cluster mode enabled and cluster mode disabled. After you
migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode
configuration and set the cluster mode to Enabled.
- `"EngineVersion"`: The upgraded version of the cache engine to be run on the clusters in
the replication group. Important: You can upgrade to a newer engine version (see Selecting
a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you
want to use an earlier engine version, you must delete the existing replication group and
create it anew with the earlier engine version.
- `"IpDiscovery"`: The network type you choose when modifying a cluster, either ipv4 |
ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached
engine version 1.6.6 on all instances built on the Nitro system.
- `"LogDeliveryConfigurations"`: Specifies the destination, format and type of the logs.
- `"MultiAZEnabled"`: A flag to indicate MultiAZ is enabled.
- `"NodeGroupId"`: Deprecated. This parameter is not used.
- `"NotificationTopicArn"`: The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications are sent. The Amazon SNS topic owner must be same as the replication group
owner.
- `"NotificationTopicStatus"`: The status of the Amazon SNS notification topic for the
replication group. Notifications are sent only if the status is active. Valid values:
active | inactive
- `"PreferredMaintenanceWindow"`: 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
- `"PrimaryClusterId"`: For replication groups with a single primary, if this parameter is
specified, ElastiCache promotes the specified cluster in the specified replication group to
the primary role. The nodes of all other clusters in the replication group are read
replicas.
- `"RemoveUserGroups"`: Removes the user group associated with this replication group.
- `"ReplicationGroupDescription"`: A description for the replication group. Maximum length
is 255 characters.
- `"SecurityGroupIds"`: Specifies the VPC Security Groups associated with the clusters in
the replication group. This parameter can be used only with replication group containing
clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
- `"SnapshotRetentionLimit"`: The number of days for which ElastiCache retains automatic
node group (shard) 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. Important If the value of SnapshotRetentionLimit is set to zero (0),
backups are turned off.
- `"SnapshotWindow"`: The daily time range (in UTC) during which ElastiCache begins taking
a daily snapshot of the node group (shard) specified by SnapshottingClusterId. Example:
05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an
appropriate time range.
- `"SnapshottingClusterId"`: The cluster ID that is used as the daily snapshot source for
the replication group. This parameter cannot be set for Redis (cluster mode enabled)
replication groups.
- `"TransitEncryptionEnabled"`: A flag that enables in-transit encryption when set to true.
If you are enabling in-transit encryption for an existing cluster, you must also set
TransitEncryptionMode to preferred.
- `"TransitEncryptionMode"`: A setting that allows you to migrate your clients to use
in-transit encryption, with no downtime. You must set TransitEncryptionEnabled to true, for
your existing cluster, and set TransitEncryptionMode to preferred in the same request to
allow both encrypted and unencrypted connections at the same time. Once you migrate all
your Redis clients to use encrypted connections you can set the value to required to allow
encrypted connections only. Setting TransitEncryptionMode to required is a two-step process
that requires you to first set the TransitEncryptionMode to preferred, after that you can
set TransitEncryptionMode to required.
- `"UserGroupIdsToAdd"`: The ID of the user group you are associating with the replication
group.
- `"UserGroupIdsToRemove"`: The ID of the user group to disassociate from the replication
group, meaning the users in the group no longer can access the replication group.
"""
function modify_replication_group(
ReplicationGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"ModifyReplicationGroup",
Dict{String,Any}("ReplicationGroupId" => ReplicationGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_replication_group(
ReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyReplicationGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ReplicationGroupId" => ReplicationGroupId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_replication_group_shard_configuration(apply_immediately, node_group_count, replication_group_id)
modify_replication_group_shard_configuration(apply_immediately, node_group_count, replication_group_id, params::Dict{String,<:Any})
Modifies a replication group's shards (node groups) by allowing you to add shards, remove
shards, or rebalance the keyspaces among existing shards.
# Arguments
- `apply_immediately`: Indicates that the shard reconfiguration process begins immediately.
At present, the only permitted value for this parameter is true. Value: true
- `node_group_count`: The number of node groups (shards) that results from the modification
of the shard configuration.
- `replication_group_id`: The name of the Redis (cluster mode enabled) cluster (replication
group) on which the shards are to be configured.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NodeGroupsToRemove"`: If the value of NodeGroupCount is less than the current number of
node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for
Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
- `"NodeGroupsToRetain"`: If the value of NodeGroupCount is less than the current number of
node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.
NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster. ElastiCache for
Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from
the cluster.
- `"ReshardingConfiguration"`: Specifies the preferred availability zones for each node
group in the cluster. If the value of NodeGroupCount is greater than the current number of
node groups (shards), you can use this parameter to specify the preferred availability
zones of the cluster's shards. If you omit this parameter ElastiCache selects availability
zones for you. You can specify this parameter only if the value of NodeGroupCount is
greater than the current number of node groups (shards).
"""
function modify_replication_group_shard_configuration(
ApplyImmediately,
NodeGroupCount,
ReplicationGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyReplicationGroupShardConfiguration",
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"NodeGroupCount" => NodeGroupCount,
"ReplicationGroupId" => ReplicationGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_replication_group_shard_configuration(
ApplyImmediately,
NodeGroupCount,
ReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyReplicationGroupShardConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"NodeGroupCount" => NodeGroupCount,
"ReplicationGroupId" => ReplicationGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_serverless_cache(serverless_cache_name)
modify_serverless_cache(serverless_cache_name, params::Dict{String,<:Any})
This API modifies the attributes of a serverless cache.
# Arguments
- `serverless_cache_name`: User-provided identifier for the serverless cache to be modified.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheUsageLimits"`: Modify the cache usage limit for the serverless cache.
- `"DailySnapshotTime"`: The daily time during which Elasticache begins taking a daily
snapshot of the serverless cache. Available for Redis only. The default is NULL, i.e. the
existing snapshot time configured for the cluster is not removed.
- `"Description"`: User provided description for the serverless cache. Default = NULL, i.e.
the existing description is not removed/modified. The description has a maximum length of
255 characters.
- `"RemoveUserGroup"`: The identifier of the UserGroup to be removed from association with
the Redis serverless cache. Available for Redis only. Default is NULL.
- `"SecurityGroupIds"`: The new list of VPC security groups to be associated with the
serverless cache. Populating this list means the current VPC security groups will be
removed. This security group is used to authorize traffic access for the VPC end-point
(private-link). Default = NULL - the existing list of VPC security groups is not removed.
- `"SnapshotRetentionLimit"`: The number of days for which Elasticache retains automatic
snapshots before deleting them. Available for Redis only. Default = NULL, i.e. the existing
snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35
days.
- `"UserGroupId"`: The identifier of the UserGroup to be associated with the serverless
cache. Available for Redis only. Default is NULL - the existing UserGroup is not removed.
"""
function modify_serverless_cache(
ServerlessCacheName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"ModifyServerlessCache",
Dict{String,Any}("ServerlessCacheName" => ServerlessCacheName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_serverless_cache(
ServerlessCacheName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyServerlessCache",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerlessCacheName" => ServerlessCacheName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_user(user_id)
modify_user(user_id, params::Dict{String,<:Any})
Changes user password(s) and/or access string.
# Arguments
- `user_id`: The ID 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.
- `"AppendAccessString"`: Adds additional user permissions to the access string.
- `"AuthenticationMode"`: Specifies how to authenticate the user.
- `"NoPasswordRequired"`: Indicates no password is required for the user.
- `"Passwords"`: The passwords belonging to the user. You are allowed up to two.
"""
function modify_user(UserId; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"ModifyUser",
Dict{String,Any}("UserId" => UserId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_user(
UserId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"ModifyUser",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("UserId" => UserId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_user_group(user_group_id)
modify_user_group(user_group_id, params::Dict{String,<:Any})
Changes the list of users that belong to the user group.
# Arguments
- `user_group_id`: The ID of the user group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserIdsToAdd"`: The list of user IDs to add to the user group.
- `"UserIdsToRemove"`: The list of user IDs to remove from the user group.
"""
function modify_user_group(UserGroupId; aws_config::AbstractAWSConfig=global_aws_config())
return elasticache(
"ModifyUserGroup",
Dict{String,Any}("UserGroupId" => UserGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_user_group(
UserGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ModifyUserGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserGroupId" => UserGroupId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_reserved_cache_nodes_offering(reserved_cache_nodes_offering_id)
purchase_reserved_cache_nodes_offering(reserved_cache_nodes_offering_id, params::Dict{String,<:Any})
Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for
cancellation and are non-refundable. For more information, see Managing Costs with Reserved
Nodes for Redis or Managing Costs with Reserved Nodes for Memcached.
# Arguments
- `reserved_cache_nodes_offering_id`: The ID of the reserved cache node offering to
purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheNodeCount"`: The number of cache node instances to reserve. Default: 1
- `"ReservedCacheNodeId"`: A customer-specified identifier to track this reservation. The
Reserved Cache Node ID is an unique customer-specified identifier to track this
reservation. If this parameter is not specified, ElastiCache automatically generates an
identifier for the reservation. Example: myreservationID
- `"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_cache_nodes_offering(
ReservedCacheNodesOfferingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"PurchaseReservedCacheNodesOffering",
Dict{String,Any}("ReservedCacheNodesOfferingId" => ReservedCacheNodesOfferingId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_reserved_cache_nodes_offering(
ReservedCacheNodesOfferingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"PurchaseReservedCacheNodesOffering",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReservedCacheNodesOfferingId" => ReservedCacheNodesOfferingId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
rebalance_slots_in_global_replication_group(apply_immediately, global_replication_group_id)
rebalance_slots_in_global_replication_group(apply_immediately, global_replication_group_id, params::Dict{String,<:Any})
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
# Arguments
- `apply_immediately`: If True, redistribution is applied immediately.
- `global_replication_group_id`: The name of the Global datastore
"""
function rebalance_slots_in_global_replication_group(
ApplyImmediately,
GlobalReplicationGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"RebalanceSlotsInGlobalReplicationGroup",
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function rebalance_slots_in_global_replication_group(
ApplyImmediately,
GlobalReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"RebalanceSlotsInGlobalReplicationGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ApplyImmediately" => ApplyImmediately,
"GlobalReplicationGroupId" => GlobalReplicationGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reboot_cache_cluster(cache_cluster_id, cache_node_id)
reboot_cache_cluster(cache_cluster_id, cache_node_id, params::Dict{String,<:Any})
Reboots some, or all, of the cache nodes within a provisioned cluster. This operation
applies any modified cache parameter groups to the cluster. The reboot operation takes
place as soon as possible, and results in a momentary outage to the cluster. During the
reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache
(for each cache node being rebooted) to be lost. When the reboot is complete, a cluster
event is created. Rebooting a cluster is currently supported on Memcached and Redis
(cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode
enabled) clusters. If you make changes to parameters that require a Redis (cluster mode
enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an
alternate process.
# Arguments
- `cache_cluster_id`: The cluster identifier. This parameter is stored as a lowercase
string.
- `cache_node_id`: A list of cache node IDs to reboot. A node ID is a numeric identifier
(0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CacheNodeIdsToReboot"`: A list of cache node IDs to reboot. A node ID is a numeric
identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node
IDs.
"""
function reboot_cache_cluster(
CacheClusterId, CacheNodeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"RebootCacheCluster",
Dict{String,Any}("CacheClusterId" => CacheClusterId, "CacheNodeId" => CacheNodeId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reboot_cache_cluster(
CacheClusterId,
CacheNodeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"RebootCacheCluster",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CacheClusterId" => CacheClusterId, "CacheNodeId" => CacheNodeId
),
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 the tags identified by the TagKeys list from the 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 all your ElastiCache resources, with the exception of global replication group.
When you add or remove tags on replication groups, those actions will be replicated to all
nodes in the replication group. For more information, see Resource-level permissions.
# Arguments
- `resource_name`: The Amazon Resource Name (ARN) of the resource from which you want the
tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or
arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. For more information about
ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
- `tag_keys`: A list of TagKeys identifying the tags you want removed from the named
resource.
"""
function remove_tags_from_resource(
ResourceName, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"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 elasticache(
"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_cache_parameter_group(cache_parameter_group_name)
reset_cache_parameter_group(cache_parameter_group_name, params::Dict{String,<:Any})
Modifies the parameters of a cache 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 cache parameter group, specify the ResetAllParameters and CacheParameterGroupName
parameters.
# Arguments
- `cache_parameter_group_name`: The name of the cache parameter group to reset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ParameterNameValues"`: An array of parameter names to reset to their default values. If
ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false,
you must specify the name of at least one parameter to reset.
- `"ResetAllParameters"`: If true, all parameters in the cache parameter group are reset to
their default values. If false, only the parameters listed by ParameterNameValues are reset
to their default values. Valid values: true | false
"""
function reset_cache_parameter_group(
CacheParameterGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"ResetCacheParameterGroup",
Dict{String,Any}("CacheParameterGroupName" => CacheParameterGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_cache_parameter_group(
CacheParameterGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"ResetCacheParameterGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CacheParameterGroupName" => CacheParameterGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
revoke_cache_security_group_ingress(cache_security_group_name, ec2_security_group_name, ec2_security_group_owner_id)
revoke_cache_security_group_ingress(cache_security_group_name, ec2_security_group_name, ec2_security_group_owner_id, params::Dict{String,<:Any})
Revokes ingress from a cache security group. Use this operation to disallow access from an
Amazon EC2 security group that had been previously authorized.
# Arguments
- `cache_security_group_name`: The name of the cache security group to revoke ingress from.
- `ec2_security_group_name`: The name of the Amazon EC2 security group to revoke access
from.
- `ec2_security_group_owner_id`: The Amazon account number of the Amazon EC2 security group
owner. Note that this is not the same thing as an Amazon access key ID - you must provide a
valid Amazon account number for this parameter.
"""
function revoke_cache_security_group_ingress(
CacheSecurityGroupName,
EC2SecurityGroupName,
EC2SecurityGroupOwnerId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"RevokeCacheSecurityGroupIngress",
Dict{String,Any}(
"CacheSecurityGroupName" => CacheSecurityGroupName,
"EC2SecurityGroupName" => EC2SecurityGroupName,
"EC2SecurityGroupOwnerId" => EC2SecurityGroupOwnerId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function revoke_cache_security_group_ingress(
CacheSecurityGroupName,
EC2SecurityGroupName,
EC2SecurityGroupOwnerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"RevokeCacheSecurityGroupIngress",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CacheSecurityGroupName" => CacheSecurityGroupName,
"EC2SecurityGroupName" => EC2SecurityGroupName,
"EC2SecurityGroupOwnerId" => EC2SecurityGroupOwnerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_migration(customer_node_endpoint_list, replication_group_id)
start_migration(customer_node_endpoint_list, replication_group_id, params::Dict{String,<:Any})
Start the migration of data.
# Arguments
- `customer_node_endpoint_list`: List of endpoints from which data should be migrated. For
Redis (cluster mode disabled), list should have only one element.
- `replication_group_id`: The ID of the replication group to which data should be migrated.
"""
function start_migration(
CustomerNodeEndpointList,
ReplicationGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"StartMigration",
Dict{String,Any}(
"CustomerNodeEndpointList" => CustomerNodeEndpointList,
"ReplicationGroupId" => ReplicationGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_migration(
CustomerNodeEndpointList,
ReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"StartMigration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CustomerNodeEndpointList" => CustomerNodeEndpointList,
"ReplicationGroupId" => ReplicationGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_failover(node_group_id, replication_group_id)
test_failover(node_group_id, replication_group_id, params::Dict{String,<:Any})
Represents the input of a TestFailover operation which tests automatic failover on a
specified node group (called shard in the console) in a replication group (called cluster
in the console). This API is designed for testing the behavior of your application in case
of ElastiCache failover. It is not designed to be an operational 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. Note the
following A customer can use this operation to test automatic failover on up to 15
shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour
period. If calling this operation on shards in different clusters (called replication
groups in the API and CLI), the calls can be made concurrently. If calling this
operation multiple times on different shards in the same Redis (cluster mode enabled)
replication group, the first node replacement must complete before a subsequent call can be
made. To determine whether the node replacement is complete you can check Events using
the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the
following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message: Failover from primary node <primary-node-id> to replica node
<node-id> completed Replication group message: Failover from primary node
<primary-node-id> to replica node <node-id> completed Cache cluster message:
Recovering cache nodes <node-id> Cache cluster message: Finished recovery for
cache nodes <node-id> For more information see: Viewing ElastiCache Events in
the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference Also
see, Testing Multi-AZ in the ElastiCache User Guide.
# Arguments
- `node_group_id`: The name of the node group (called shard in the console) in this
replication group on which automatic failover is to be tested. You may test automatic
failover on up to 15 node groups in any rolling 24-hour period.
- `replication_group_id`: The name of the replication group (console: cluster) whose
automatic failover is being tested by this operation.
"""
function test_failover(
NodeGroupId, ReplicationGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticache(
"TestFailover",
Dict{String,Any}(
"NodeGroupId" => NodeGroupId, "ReplicationGroupId" => ReplicationGroupId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_failover(
NodeGroupId,
ReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"TestFailover",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NodeGroupId" => NodeGroupId, "ReplicationGroupId" => ReplicationGroupId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_migration(customer_node_endpoint_list, replication_group_id)
test_migration(customer_node_endpoint_list, replication_group_id, params::Dict{String,<:Any})
Async API to test connection between source and target replication group.
# Arguments
- `customer_node_endpoint_list`: List of endpoints from which data should be migrated.
List should have only one element.
- `replication_group_id`: The ID of the replication group to which data is to be migrated.
"""
function test_migration(
CustomerNodeEndpointList,
ReplicationGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"TestMigration",
Dict{String,Any}(
"CustomerNodeEndpointList" => CustomerNodeEndpointList,
"ReplicationGroupId" => ReplicationGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_migration(
CustomerNodeEndpointList,
ReplicationGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticache(
"TestMigration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CustomerNodeEndpointList" => CustomerNodeEndpointList,
"ReplicationGroupId" => ReplicationGroupId,
),
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 | 67086 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: elasticsearch_service
using AWS.Compat
using AWS.UUIDs
"""
accept_inbound_cross_cluster_search_connection(connection_id)
accept_inbound_cross_cluster_search_connection(connection_id, params::Dict{String,<:Any})
Allows the destination domain owner to accept an inbound cross-cluster search connection
request.
# Arguments
- `connection_id`: The id of the inbound connection that you want to accept.
"""
function accept_inbound_cross_cluster_search_connection(
ConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"PUT",
"/2015-01-01/es/ccs/inboundConnection/$(ConnectionId)/accept";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_inbound_cross_cluster_search_connection(
ConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"PUT",
"/2015-01-01/es/ccs/inboundConnection/$(ConnectionId)/accept",
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 Elasticsearch domain. Tags are a set of case-sensitive key
value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon
Elasticsearch Service Domains for more information.
# Arguments
- `arn`: Specify the ARN for which you want to add the tags.
- `tag_list`: List of Tag that need to be added for the Elasticsearch domain.
"""
function add_tags(ARN, TagList; aws_config::AbstractAWSConfig=global_aws_config())
return elasticsearch_service(
"POST",
"/2015-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 elasticsearch_service(
"POST",
"/2015-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 ES domain.
# Arguments
- `domain_name`: Name of the domain that you want to associate the package with.
- `package_id`: Internal ID of the package that you want to associate with a domain. Use
DescribePackages to find this value.
"""
function associate_package(
DomainName, PackageID; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-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 elasticsearch_service(
"POST",
"/2015-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 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 elasticsearch_service(
"POST",
"/2015-01-01/es/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 elasticsearch_service(
"POST",
"/2015-01-01/es/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`: Name of the OpenSearch Service domain configuration request to cancel.
# 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 elasticsearch_service(
"POST",
"/2015-01-01/es/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 elasticsearch_service(
"POST",
"/2015-01-01/es/domain/$(DomainName)/config/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_elasticsearch_service_software_update(domain_name)
cancel_elasticsearch_service_software_update(domain_name, params::Dict{String,<:Any})
Cancels a scheduled service software update for an Amazon ES domain. You can only perform
this operation before the AutomatedUpdateDate and when the UpdateStatus is in the
PENDING_UPDATE state.
# Arguments
- `domain_name`: The name of the domain that you want to stop the latest service software
update on.
"""
function cancel_elasticsearch_service_software_update(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/serviceSoftwareUpdate/cancel",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_elasticsearch_service_software_update(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/serviceSoftwareUpdate/cancel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_elasticsearch_domain(domain_name)
create_elasticsearch_domain(domain_name, params::Dict{String,<:Any})
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch
Domains in the Amazon Elasticsearch Service Developer Guide.
# Arguments
- `domain_name`: The name of the Elasticsearch domain that you are creating. Domain names
are unique across the domains owned by an account within an AWS region. Domain names must
start with a lowercase letter and can contain the following characters: a-z (lowercase),
0-9, and - (hyphen).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessPolicies"`: IAM access policy as a JSON-formatted string.
- `"AdvancedOptions"`: Option to allow references to indices in an HTTP request body. Must
be false when configuring access to individual sub-resources. By default, the value is
true. See Configuration Advanced Options for more information.
- `"AdvancedSecurityOptions"`: Specifies advanced security options.
- `"AutoTuneOptions"`: Specifies Auto-Tune options.
- `"CognitoOptions"`: Options to specify the Cognito user and identity pools for Kibana
authentication. For more information, see Amazon Cognito Authentication for Kibana.
- `"DomainEndpointOptions"`: Options to specify configuration that will be applied to the
domain endpoint.
- `"EBSOptions"`: Options to enable, disable and specify the type and size of EBS storage
volumes.
- `"ElasticsearchClusterConfig"`: Configuration options for an Elasticsearch domain.
Specifies the instance type and number of instances in the domain cluster.
- `"ElasticsearchVersion"`: String of format X.Y to specify version for the Elasticsearch
domain eg. \"1.5\" or \"2.3\". For more information, see Creating Elasticsearch Domains in
the Amazon Elasticsearch Service Developer Guide.
- `"EncryptionAtRestOptions"`: Specifies the Encryption At Rest Options.
- `"LogPublishingOptions"`: Map of LogType and LogPublishingOption, each containing options
to publish a given type of Elasticsearch log.
- `"NodeToNodeEncryptionOptions"`: Specifies the NodeToNodeEncryptionOptions.
- `"SnapshotOptions"`: Option to set time, in UTC format, of the daily automated snapshot.
Default value is 0 hours.
- `"TagList"`: A list of Tag added during domain creation.
- `"VPCOptions"`: Options to specify the subnets and security groups for VPC endpoint. For
more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service
Domains
"""
function create_elasticsearch_domain(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/domain",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_elasticsearch_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/domain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_outbound_cross_cluster_search_connection(connection_alias, destination_domain_info, source_domain_info)
create_outbound_cross_cluster_search_connection(connection_alias, destination_domain_info, source_domain_info, params::Dict{String,<:Any})
Creates a new cross-cluster search connection from a source domain to a destination domain.
# Arguments
- `connection_alias`: Specifies the connection alias that will be used by the customer for
this connection.
- `destination_domain_info`: Specifies the DomainInformation for the destination
Elasticsearch domain.
- `source_domain_info`: Specifies the DomainInformation for the source Elasticsearch domain.
"""
function create_outbound_cross_cluster_search_connection(
ConnectionAlias,
DestinationDomainInfo,
SourceDomainInfo;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/ccs/outboundConnection",
Dict{String,Any}(
"ConnectionAlias" => ConnectionAlias,
"DestinationDomainInfo" => DestinationDomainInfo,
"SourceDomainInfo" => SourceDomainInfo,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_outbound_cross_cluster_search_connection(
ConnectionAlias,
DestinationDomainInfo,
SourceDomainInfo,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/ccs/outboundConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectionAlias" => ConnectionAlias,
"DestinationDomainInfo" => DestinationDomainInfo,
"SourceDomainInfo" => SourceDomainInfo,
),
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})
Create a package for use with Amazon ES domains.
# Arguments
- `package_name`: Unique identifier for the package.
- `package_source`: The customer S3 location PackageSource for importing the package.
- `package_type`: Type of package. Currently supports only TXT-DICTIONARY.
# 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 elasticsearch_service(
"POST",
"/2015-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 elasticsearch_service(
"POST",
"/2015-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 grant access to.
- `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 elasticsearch_service(
"POST",
"/2015-01-01/es/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 elasticsearch_service(
"POST",
"/2015-01-01/es/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_elasticsearch_domain(domain_name)
delete_elasticsearch_domain(domain_name, params::Dict{String,<:Any})
Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain
is deleted, it cannot be recovered.
# Arguments
- `domain_name`: The name of the Elasticsearch domain that you want to permanently delete.
"""
function delete_elasticsearch_domain(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"DELETE",
"/2015-01-01/es/domain/$(DomainName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_elasticsearch_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"DELETE",
"/2015-01-01/es/domain/$(DomainName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_elasticsearch_service_role()
delete_elasticsearch_service_role(params::Dict{String,<:Any})
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC
domains. Role deletion will fail if any existing VPC domains use the role. You must delete
any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service
Role in VPC Endpoints for Amazon Elasticsearch Service Domains.
"""
function delete_elasticsearch_service_role(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"DELETE",
"/2015-01-01/es/role";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_elasticsearch_service_role(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"DELETE",
"/2015-01-01/es/role",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_inbound_cross_cluster_search_connection(connection_id)
delete_inbound_cross_cluster_search_connection(connection_id, params::Dict{String,<:Any})
Allows the destination domain owner to delete an existing inbound cross-cluster search
connection.
# Arguments
- `connection_id`: The id of the inbound connection that you want to permanently delete.
"""
function delete_inbound_cross_cluster_search_connection(
ConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"DELETE",
"/2015-01-01/es/ccs/inboundConnection/$(ConnectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_inbound_cross_cluster_search_connection(
ConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"DELETE",
"/2015-01-01/es/ccs/inboundConnection/$(ConnectionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_outbound_cross_cluster_search_connection(connection_id)
delete_outbound_cross_cluster_search_connection(connection_id, params::Dict{String,<:Any})
Allows the source domain owner to delete an existing outbound cross-cluster search
connection.
# Arguments
- `connection_id`: The id of the outbound connection that you want to permanently delete.
"""
function delete_outbound_cross_cluster_search_connection(
ConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"DELETE",
"/2015-01-01/es/ccs/outboundConnection/$(ConnectionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_outbound_cross_cluster_search_connection(
ConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"DELETE",
"/2015-01-01/es/ccs/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})
Delete the package.
# Arguments
- `package_id`: Internal ID of the package that you want to delete. Use DescribePackages to
find this value.
"""
function delete_package(PackageID; aws_config::AbstractAWSConfig=global_aws_config())
return elasticsearch_service(
"DELETE",
"/2015-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 elasticsearch_service(
"DELETE",
"/2015-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 to be deleted.
"""
function delete_vpc_endpoint(
VpcEndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"DELETE",
"/2015-01-01/es/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 elasticsearch_service(
"DELETE",
"/2015-01-01/es/vpcEndpoints/$(VpcEndpointId)",
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})
Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune
action type, description, severity, and scheduled date.
# Arguments
- `domain_name`: Specifies the domain name for which you want Auto-Tune action details.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Set this value to limit the number of results returned. If not specified,
defaults to 100.
- `"NextToken"`: NextToken is sent in case the earlier API call results contain the
NextToken. It is used for pagination.
"""
function describe_domain_auto_tunes(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/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 elasticsearch_service(
"GET",
"/2015-01-01/es/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 a domain,
including a change ID, status, and progress stages.
# Arguments
- `domain_name`: The domain you want to get the progress information about.
# 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. This
is an optional parameter. If omitted, the service returns information about the most recent
configuration change.
"""
function describe_domain_change_progress(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/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 elasticsearch_service(
"GET",
"/2015-01-01/es/domain/$(DomainName)/progress",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_elasticsearch_domain(domain_name)
describe_elasticsearch_domain(domain_name, params::Dict{String,<:Any})
Returns domain configuration information about the specified Elasticsearch domain,
including the domain ID, domain endpoint, and domain ARN.
# Arguments
- `domain_name`: The name of the Elasticsearch domain for which you want information.
"""
function describe_elasticsearch_domain(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/domain/$(DomainName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_elasticsearch_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/domain/$(DomainName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_elasticsearch_domain_config(domain_name)
describe_elasticsearch_domain_config(domain_name, params::Dict{String,<:Any})
Provides cluster configuration information about the specified Elasticsearch domain, such
as the state, creation date, update version, and update date for cluster options.
# Arguments
- `domain_name`: The Elasticsearch domain that you want to get information about.
"""
function describe_elasticsearch_domain_config(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/domain/$(DomainName)/config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_elasticsearch_domain_config(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/domain/$(DomainName)/config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_elasticsearch_domains(domain_names)
describe_elasticsearch_domains(domain_names, params::Dict{String,<:Any})
Returns domain configuration information about the specified Elasticsearch domains,
including the domain ID, domain endpoint, and domain ARN.
# Arguments
- `domain_names`: The Elasticsearch domains for which you want information.
"""
function describe_elasticsearch_domains(
DomainNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/domain-info",
Dict{String,Any}("DomainNames" => DomainNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_elasticsearch_domains(
DomainNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/domain-info",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainNames" => DomainNames), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_elasticsearch_instance_type_limits(elasticsearch_version, instance_type)
describe_elasticsearch_instance_type_limits(elasticsearch_version, instance_type, params::Dict{String,<:Any})
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When
modifying existing Domain, specify the DomainName to know what Limits are supported for
modifying.
# Arguments
- `elasticsearch_version`: Version of Elasticsearch for which Limits are needed.
- `instance_type`: The instance type for an Elasticsearch cluster for which Elasticsearch
Limits are needed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domainName"`: DomainName represents the name of the Domain that we are trying to
modify. This should be present only if we are querying for Elasticsearch Limits for
existing domain.
"""
function describe_elasticsearch_instance_type_limits(
ElasticsearchVersion, InstanceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/instanceTypeLimits/$(ElasticsearchVersion)/$(InstanceType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_elasticsearch_instance_type_limits(
ElasticsearchVersion,
InstanceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/instanceTypeLimits/$(ElasticsearchVersion)/$(InstanceType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_inbound_cross_cluster_search_connections()
describe_inbound_cross_cluster_search_connections(params::Dict{String,<:Any})
Lists all the inbound cross-cluster search connections for a destination domain.
# 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 search
connection. Available Filter names for this operation are:
cross-cluster-search-connection-id source-domain-info.domain-name
source-domain-info.owner-id source-domain-info.region destination-domain-info.domain-name
- `"MaxResults"`: Set this value to limit the number of results returned. If not specified,
defaults to 100.
- `"NextToken"`: NextToken is sent in case the earlier API call results contain the
NextToken. It is used for pagination.
"""
function describe_inbound_cross_cluster_search_connections(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/ccs/inboundConnection/search";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_inbound_cross_cluster_search_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/ccs/inboundConnection/search",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_outbound_cross_cluster_search_connections()
describe_outbound_cross_cluster_search_connections(params::Dict{String,<:Any})
Lists all the outbound cross-cluster search connections for a source domain.
# 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 outbound cross-cluster
search connection. Available Filter names for this operation are:
cross-cluster-search-connection-id destination-domain-info.domain-name
destination-domain-info.owner-id destination-domain-info.region
source-domain-info.domain-name
- `"MaxResults"`: Set this value to limit the number of results returned. If not specified,
defaults to 100.
- `"NextToken"`: NextToken is sent in case the earlier API call results contain the
NextToken. It is used for pagination.
"""
function describe_outbound_cross_cluster_search_connections(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/ccs/outboundConnection/search";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_outbound_cross_cluster_search_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/ccs/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 Amazon ES. Includes options for filtering, limiting the
number of results, and pagination.
# 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"`: Limits results to a maximum number of packages.
- `"NextToken"`: Used for pagination. Only necessary if a previous API call includes a
non-null NextToken value. If provided, returns results for the next page.
"""
function describe_packages(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticsearch_service(
"POST",
"/2015-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 elasticsearch_service(
"POST",
"/2015-01-01/packages/describe",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_elasticsearch_instance_offerings()
describe_reserved_elasticsearch_instance_offerings(params::Dict{String,<:Any})
Lists available reserved Elasticsearch instance offerings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Set this value to limit the number of results returned. If not specified,
defaults to 100.
- `"nextToken"`: NextToken should be sent in case if earlier API call produced result
containing NextToken. It is used for pagination.
- `"offeringId"`: The offering identifier filter value. Use this parameter to show only the
available offering that matches the specified reservation identifier.
"""
function describe_reserved_elasticsearch_instance_offerings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/reservedInstanceOfferings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_elasticsearch_instance_offerings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/reservedInstanceOfferings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_reserved_elasticsearch_instances()
describe_reserved_elasticsearch_instances(params::Dict{String,<:Any})
Returns information about reserved Elasticsearch instances for this account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Set this value to limit the number of results returned. If not specified,
defaults to 100.
- `"nextToken"`: NextToken should be sent in case if earlier API call produced result
containing NextToken. It is used for pagination.
- `"reservationId"`: The reserved instance identifier filter value. Use this parameter to
show only the reservation that matches the specified reserved Elasticsearch instance ID.
"""
function describe_reserved_elasticsearch_instances(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/reservedInstances";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_reserved_elasticsearch_instances(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/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 elasticsearch_service(
"POST",
"/2015-01-01/es/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 elasticsearch_service(
"POST",
"/2015-01-01/es/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})
Dissociates a package from the Amazon ES domain.
# Arguments
- `domain_name`: Name of the domain that you want to associate the package with.
- `package_id`: Internal ID of the package that you want to associate with a domain. Use
DescribePackages to find this value.
"""
function dissociate_package(
DomainName, PackageID; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-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 elasticsearch_service(
"POST",
"/2015-01-01/packages/dissociate/$(PackageID)/$(DomainName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compatible_elasticsearch_versions()
get_compatible_elasticsearch_versions(params::Dict{String,<:Any})
Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a
DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domainName"`:
"""
function get_compatible_elasticsearch_versions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/compatibleVersions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_compatible_elasticsearch_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/compatibleVersions",
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 versions of the package, along with their creation time and commit
message.
# Arguments
- `package_id`: Returns an audit history of versions of the package.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Limits results to a maximum number of versions.
- `"nextToken"`: Used for pagination. Only necessary if a previous API call includes a
non-null NextToken value. If provided, returns results for the next page.
"""
function get_package_version_history(
PackageID; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-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 elasticsearch_service(
"GET",
"/2015-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 that were performed on the domain.
# Arguments
- `domain_name`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`:
"""
function get_upgrade_history(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return elasticsearch_service(
"GET",
"/2015-01-01/es/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 elasticsearch_service(
"GET",
"/2015-01-01/es/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})
Retrieves the latest status of the last upgrade or upgrade eligibility check that was
performed on the domain.
# Arguments
- `domain_name`:
"""
function get_upgrade_status(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return elasticsearch_service(
"GET",
"/2015-01-01/es/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 elasticsearch_service(
"GET",
"/2015-01-01/es/upgradeDomain/$(DomainName)/status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domain_names()
list_domain_names(params::Dict{String,<:Any})
Returns the name of all Elasticsearch domains owned by the current user's account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"engineType"`: Optional parameter to filter the output by domain engine type.
Acceptable values are 'Elasticsearch' and 'OpenSearch'.
"""
function list_domain_names(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticsearch_service(
"GET", "/2015-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 elasticsearch_service(
"GET",
"/2015-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 ES domains associated with the package.
# Arguments
- `package_id`: The package for which to list domains.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Limits results to a maximum number of domains.
- `"nextToken"`: Used for pagination. Only necessary if a previous API call includes a
non-null NextToken value. If provided, returns results for the next page.
"""
function list_domains_for_package(
PackageID; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-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 elasticsearch_service(
"GET",
"/2015-01-01/packages/$(PackageID)/domains",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_elasticsearch_instance_types(elasticsearch_version)
list_elasticsearch_instance_types(elasticsearch_version, params::Dict{String,<:Any})
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
# Arguments
- `elasticsearch_version`: Version of Elasticsearch for which list of supported
elasticsearch instance types are needed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domainName"`: DomainName represents the name of the Domain that we are trying to
modify. This should be present only if we are querying for list of available Elasticsearch
instance types when modifying existing domain.
- `"maxResults"`: Set this value to limit the number of results returned. Value provided
must be greater than 30 else it wont be honored.
- `"nextToken"`: NextToken should be sent in case if earlier API call produced result
containing NextToken. It is used for pagination.
"""
function list_elasticsearch_instance_types(
ElasticsearchVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/instanceTypes/$(ElasticsearchVersion)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_elasticsearch_instance_types(
ElasticsearchVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/instanceTypes/$(ElasticsearchVersion)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_elasticsearch_versions()
list_elasticsearch_versions(params::Dict{String,<:Any})
List all supported Elasticsearch versions
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Set this value to limit the number of results returned. Value provided
must be greater than 10 else it wont be honored.
- `"nextToken"`:
"""
function list_elasticsearch_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticsearch_service(
"GET",
"/2015-01-01/es/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_elasticsearch_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/versions",
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 the Amazon ES domain.
# 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"`: Limits results to a maximum number of packages.
- `"nextToken"`: Used for pagination. Only necessary if a previous API call includes a
non-null NextToken value. If provided, returns results for the next page.
"""
function list_packages_for_domain(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-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 elasticsearch_service(
"GET",
"/2015-01-01/domain/$(DomainName)/packages",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags(arn)
list_tags(arn, params::Dict{String,<:Any})
Returns all tags for the given Elasticsearch domain.
# Arguments
- `arn`: Specify the ARN for the Elasticsearch domain to which the tags are attached that
you want to view.
"""
function list_tags(arn; aws_config::AbstractAWSConfig=global_aws_config())
return elasticsearch_service(
"GET",
"/2015-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 elasticsearch_service(
"GET",
"/2015-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_vpc_endpoint_access(domain_name)
list_vpc_endpoint_access(domain_name, params::Dict{String,<:Any})
Retrieves information about each 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"`: Provides an identifier to allow retrieval of paginated results.
"""
function list_vpc_endpoint_access(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/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 elasticsearch_service(
"GET",
"/2015-01-01/es/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 account and
Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: Identifier to allow retrieval of paginated results.
"""
function list_vpc_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return elasticsearch_service(
"GET",
"/2015-01-01/es/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 elasticsearch_service(
"GET",
"/2015-01-01/es/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`: Name of the ElasticSearch domain whose VPC endpoints are to be listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: Provides an identifier to allow retrieval of paginated results.
"""
function list_vpc_endpoints_for_domain(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"GET",
"/2015-01-01/es/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 elasticsearch_service(
"GET",
"/2015-01-01/es/domain/$(DomainName)/vpcEndpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_reserved_elasticsearch_instance_offering(reservation_name, reserved_elasticsearch_instance_offering_id)
purchase_reserved_elasticsearch_instance_offering(reservation_name, reserved_elasticsearch_instance_offering_id, params::Dict{String,<:Any})
Allows you to purchase reserved Elasticsearch instances.
# Arguments
- `reservation_name`: A customer-specified identifier to track this reservation.
- `reserved_elasticsearch_instance_offering_id`: The ID of the reserved Elasticsearch
instance offering to purchase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceCount"`: The number of Elasticsearch instances to reserve.
"""
function purchase_reserved_elasticsearch_instance_offering(
ReservationName,
ReservedElasticsearchInstanceOfferingId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/purchaseReservedInstanceOffering",
Dict{String,Any}(
"ReservationName" => ReservationName,
"ReservedElasticsearchInstanceOfferingId" =>
ReservedElasticsearchInstanceOfferingId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_reserved_elasticsearch_instance_offering(
ReservationName,
ReservedElasticsearchInstanceOfferingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/purchaseReservedInstanceOffering",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ReservationName" => ReservationName,
"ReservedElasticsearchInstanceOfferingId" =>
ReservedElasticsearchInstanceOfferingId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_inbound_cross_cluster_search_connection(connection_id)
reject_inbound_cross_cluster_search_connection(connection_id, params::Dict{String,<:Any})
Allows the destination domain owner to reject an inbound cross-cluster search connection
request.
# Arguments
- `connection_id`: The id of the inbound connection that you want to reject.
"""
function reject_inbound_cross_cluster_search_connection(
ConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"PUT",
"/2015-01-01/es/ccs/inboundConnection/$(ConnectionId)/reject";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_inbound_cross_cluster_search_connection(
ConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"PUT",
"/2015-01-01/es/ccs/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 the specified Elasticsearch domain.
# Arguments
- `arn`: Specifies the ARN for the Elasticsearch domain from which you want to delete the
specified tags.
- `tag_keys`: Specifies the TagKey list which you want to remove from the Elasticsearch
domain.
"""
function remove_tags(ARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return elasticsearch_service(
"POST",
"/2015-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 elasticsearch_service(
"POST",
"/2015-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 elasticsearch_service(
"POST",
"/2015-01-01/es/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 elasticsearch_service(
"POST",
"/2015-01-01/es/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_elasticsearch_service_software_update(domain_name)
start_elasticsearch_service_software_update(domain_name, params::Dict{String,<:Any})
Schedules a service software update for an Amazon ES domain.
# Arguments
- `domain_name`: The name of the domain that you want to update to the latest service
software.
"""
function start_elasticsearch_service_software_update(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/serviceSoftwareUpdate/start",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_elasticsearch_service_software_update(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/serviceSoftwareUpdate/start",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_elasticsearch_domain_config(domain_name)
update_elasticsearch_domain_config(domain_name, params::Dict{String,<:Any})
Modifies the cluster configuration of the specified Elasticsearch domain, setting as
setting the instance type and the number of instances.
# Arguments
- `domain_name`: The name of the Elasticsearch domain that you are updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AccessPolicies"`: IAM access policy as a JSON-formatted string.
- `"AdvancedOptions"`: Modifies the advanced option to allow references to indices in an
HTTP request body. Must be false when configuring access to individual sub-resources. By
default, the value is true. See Configuration Advanced Options for more information.
- `"AdvancedSecurityOptions"`: Specifies advanced security options.
- `"AutoTuneOptions"`: Specifies Auto-Tune options.
- `"CognitoOptions"`: Options to specify the Cognito user and identity pools for Kibana
authentication. For more information, see Amazon Cognito Authentication for Kibana.
- `"DomainEndpointOptions"`: Options to specify configuration that will be applied to the
domain endpoint.
- `"DryRun"`: This flag, when set to True, specifies whether the UpdateElasticsearchDomain
request should return the results of validation checks without actually applying the
change. This flag, when set to True, specifies the deployment mechanism through which the
update shall be applied on the domain. This will not actually perform the Update.
- `"EBSOptions"`: Specify the type and size of the EBS volume that you want to use.
- `"ElasticsearchClusterConfig"`: The type and number of instances to instantiate for the
domain cluster.
- `"EncryptionAtRestOptions"`: Specifies the Encryption At Rest Options.
- `"LogPublishingOptions"`: Map of LogType and LogPublishingOption, each containing options
to publish a given type of Elasticsearch log.
- `"NodeToNodeEncryptionOptions"`: Specifies the NodeToNodeEncryptionOptions.
- `"SnapshotOptions"`: Option to set the time, in UTC format, for the daily automated
snapshot. Default value is 0 hours.
- `"VPCOptions"`: Options to specify the subnets and security groups for VPC endpoint. For
more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service
Domains
"""
function update_elasticsearch_domain_config(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/domain/$(DomainName)/config";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_elasticsearch_domain_config(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/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 ES domains.
# Arguments
- `package_id`: Unique identifier for the package.
- `package_source`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CommitMessage"`: An info message for the new version which will be shown as part of
GetPackageVersionHistoryResponse.
- `"PackageDescription"`: New description of the package.
"""
function update_package(
PackageID, PackageSource; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-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 elasticsearch_service(
"POST",
"/2015-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_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`: Unique identifier of the VPC endpoint to be updated.
- `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 elasticsearch_service(
"POST",
"/2015-01-01/es/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 elasticsearch_service(
"POST",
"/2015-01-01/es/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_elasticsearch_domain(domain_name, target_version)
upgrade_elasticsearch_domain(domain_name, target_version, params::Dict{String,<:Any})
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a
compatible Elasticsearch version.
# Arguments
- `domain_name`:
- `target_version`: The version of Elasticsearch that you intend to upgrade the domain to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PerformCheckOnly"`: This flag, when set to True, indicates that an Upgrade Eligibility
Check needs to be performed. This will not actually perform the Upgrade.
"""
function upgrade_elasticsearch_domain(
DomainName, TargetVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/upgradeDomain",
Dict{String,Any}("DomainName" => DomainName, "TargetVersion" => TargetVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upgrade_elasticsearch_domain(
DomainName,
TargetVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return elasticsearch_service(
"POST",
"/2015-01-01/es/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 | 99641 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: emr
using AWS.Compat
using AWS.UUIDs
"""
add_instance_fleet(cluster_id, instance_fleet)
add_instance_fleet(cluster_id, instance_fleet, params::Dict{String,<:Any})
Adds an instance fleet to a running cluster. The instance fleet configuration is available
only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x.
# Arguments
- `cluster_id`: The unique identifier of the cluster.
- `instance_fleet`: Specifies the configuration of the instance fleet.
"""
function add_instance_fleet(
ClusterId, InstanceFleet; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"AddInstanceFleet",
Dict{String,Any}("ClusterId" => ClusterId, "InstanceFleet" => InstanceFleet);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_instance_fleet(
ClusterId,
InstanceFleet,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"AddInstanceFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterId" => ClusterId, "InstanceFleet" => InstanceFleet
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_instance_groups(instance_groups, job_flow_id)
add_instance_groups(instance_groups, job_flow_id, params::Dict{String,<:Any})
Adds one or more instance groups to a running cluster.
# Arguments
- `instance_groups`: Instance groups to add.
- `job_flow_id`: Job flow in which to add the instance groups.
"""
function add_instance_groups(
InstanceGroups, JobFlowId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"AddInstanceGroups",
Dict{String,Any}("InstanceGroups" => InstanceGroups, "JobFlowId" => JobFlowId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_instance_groups(
InstanceGroups,
JobFlowId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"AddInstanceGroups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceGroups" => InstanceGroups, "JobFlowId" => JobFlowId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_job_flow_steps(job_flow_id, steps)
add_job_flow_steps(job_flow_id, steps, params::Dict{String,<:Any})
AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in
each job flow. If your cluster is long-running (such as a Hive data warehouse) or complex,
you may require more than 256 steps to process your data. You can bypass the 256-step
limitation in various ways, including using SSH to connect to the master node and
submitting queries directly to the software running on the master node, such as Hive and
Hadoop. A step specifies the location of a JAR file stored either on the master node of the
cluster or in Amazon S3. Each step is performed by the main function of the main class of
the JAR file. The main class can be specified either in the manifest of the JAR or by using
the MainFunction parameter of the step. Amazon EMR executes each step in the order listed.
For a step to be considered complete, the main function must exit with a zero exit code and
all Hadoop jobs started while the step was running must have completed and run
successfully. You can only add steps to a cluster that is in one of the following states:
STARTING, BOOTSTRAPPING, RUNNING, or WAITING. The string values passed into HadoopJarStep
object cannot exceed a total of 10240 characters.
# Arguments
- `job_flow_id`: A string that uniquely identifies the job flow. This identifier is
returned by RunJobFlow and can also be obtained from ListClusters.
- `steps`: A list of StepConfig to be executed by the job flow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExecutionRoleArn"`: The Amazon Resource Name (ARN) of the runtime role for a step on
the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a
combination of account ID, role name, and role type using the following format:
arn:partition:service:region:account:resource. For example,
arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN.
"""
function add_job_flow_steps(
JobFlowId, Steps; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"AddJobFlowSteps",
Dict{String,Any}("JobFlowId" => JobFlowId, "Steps" => Steps);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_job_flow_steps(
JobFlowId,
Steps,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"AddJobFlowSteps",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("JobFlowId" => JobFlowId, "Steps" => Steps), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_tags(resource_id, tags)
add_tags(resource_id, tags, params::Dict{String,<:Any})
Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio. Tags make
it easier to associate resources in various ways, such as grouping clusters to track your
Amazon EMR resource allocation costs. For more information, see Tag Clusters.
# Arguments
- `resource_id`: The Amazon EMR resource identifier to which tags will be added. For
example, a cluster identifier or an Amazon EMR Studio ID.
- `tags`: A list of tags to associate with a resource. Tags are user-defined key-value
pairs that consist of a required key string with a maximum of 128 characters, and an
optional value string with a maximum of 256 characters.
"""
function add_tags(ResourceId, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"AddTags",
Dict{String,Any}("ResourceId" => ResourceId, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags(
ResourceId,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"AddTags",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ResourceId" => ResourceId, "Tags" => Tags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_steps(cluster_id, step_ids)
cancel_steps(cluster_id, step_ids, params::Dict{String,<:Any})
Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions
4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each
CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee that
a step will be canceled, even if the request is successfully submitted. When you use Amazon
EMR releases 5.28.0 and later, you can cancel steps that are in a PENDING or RUNNING state.
In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.
# Arguments
- `cluster_id`: The ClusterID for the specified steps that will be canceled. Use RunJobFlow
and ListClusters to get ClusterIDs.
- `step_ids`: The list of StepIDs to cancel. Use ListSteps to get steps and their states
for the specified cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StepCancellationOption"`: The option to choose to cancel RUNNING steps. By default, the
value is SEND_INTERRUPT.
"""
function cancel_steps(ClusterId, StepIds; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"CancelSteps",
Dict{String,Any}("ClusterId" => ClusterId, "StepIds" => StepIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_steps(
ClusterId,
StepIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"CancelSteps",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClusterId" => ClusterId, "StepIds" => StepIds),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_security_configuration(name, security_configuration)
create_security_configuration(name, security_configuration, params::Dict{String,<:Any})
Creates a security configuration, which is stored in the service and can be specified when
a cluster is created.
# Arguments
- `name`: The name of the security configuration.
- `security_configuration`: The security configuration details in JSON format. For JSON
parameters and examples, see Use Security Configurations to Set Up Cluster Security in the
Amazon EMR Management Guide.
"""
function create_security_configuration(
Name, SecurityConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"CreateSecurityConfiguration",
Dict{String,Any}("Name" => Name, "SecurityConfiguration" => SecurityConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_security_configuration(
Name,
SecurityConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"CreateSecurityConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "SecurityConfiguration" => SecurityConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_studio(auth_mode, default_s3_location, engine_security_group_id, name, service_role, subnet_ids, vpc_id, workspace_security_group_id)
create_studio(auth_mode, default_s3_location, engine_security_group_id, name, service_role, subnet_ids, vpc_id, workspace_security_group_id, params::Dict{String,<:Any})
Creates a new Amazon EMR Studio.
# Arguments
- `auth_mode`: Specifies whether the Studio authenticates users using IAM or IAM Identity
Center.
- `default_s3_location`: The Amazon S3 location to back up Amazon EMR Studio Workspaces and
notebook files.
- `engine_security_group_id`: The ID of the Amazon EMR Studio Engine security group. The
Engine security group allows inbound network traffic from the Workspace security group, and
it must be in the same VPC specified by VpcId.
- `name`: A descriptive name for the Amazon EMR Studio.
- `service_role`: The IAM role that the Amazon EMR Studio assumes. The service role
provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services
services.
- `subnet_ids`: A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can
have a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId. Studio
users can create a Workspace in any of the specified subnets.
- `vpc_id`: The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the
Studio.
- `workspace_security_group_id`: The ID of the Amazon EMR Studio Workspace security group.
The Workspace security group allows outbound network traffic to resources in the Engine
security group, and it must be in the same VPC specified by VpcId.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A detailed description of the Amazon EMR Studio.
- `"EncryptionKeyArn"`: The KMS key identifier (ARN) used to encrypt Amazon EMR Studio
workspace and notebook files when backed up to Amazon S3.
- `"IdcInstanceArn"`: The ARN of the IAM Identity Center instance to create the Studio
application.
- `"IdcUserAssignment"`: Specifies whether IAM Identity Center user assignment is REQUIRED
or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the
Studio application to access the Studio.
- `"IdpAuthUrl"`: The authentication endpoint of your identity provider (IdP). Specify this
value when you use IAM authentication and want to let federated users log in to a Studio
with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to
this endpoint to enter credentials.
- `"IdpRelayStateParameterName"`: The name that your identity provider (IdP) uses for its
RelayState parameter. For example, RelayState or TargetSource. Specify this value when you
use IAM authentication and want to let federated users log in to a Studio using the Studio
URL. The RelayState parameter differs by IdP.
- `"Tags"`: A list of tags to associate with the Amazon EMR Studio. Tags are user-defined
key-value pairs that consist of a required key string with a maximum of 128 characters, and
an optional value string with a maximum of 256 characters.
- `"TrustedIdentityPropagationEnabled"`: A Boolean indicating whether to enable Trusted
identity propagation for the Studio. The default value is false.
- `"UserRole"`: The IAM user role that users and groups assume when logged in to an Amazon
EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The
permissions attached to the UserRole can be scoped down for each user or group using
session policies.
"""
function create_studio(
AuthMode,
DefaultS3Location,
EngineSecurityGroupId,
Name,
ServiceRole,
SubnetIds,
VpcId,
WorkspaceSecurityGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"CreateStudio",
Dict{String,Any}(
"AuthMode" => AuthMode,
"DefaultS3Location" => DefaultS3Location,
"EngineSecurityGroupId" => EngineSecurityGroupId,
"Name" => Name,
"ServiceRole" => ServiceRole,
"SubnetIds" => SubnetIds,
"VpcId" => VpcId,
"WorkspaceSecurityGroupId" => WorkspaceSecurityGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_studio(
AuthMode,
DefaultS3Location,
EngineSecurityGroupId,
Name,
ServiceRole,
SubnetIds,
VpcId,
WorkspaceSecurityGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"CreateStudio",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthMode" => AuthMode,
"DefaultS3Location" => DefaultS3Location,
"EngineSecurityGroupId" => EngineSecurityGroupId,
"Name" => Name,
"ServiceRole" => ServiceRole,
"SubnetIds" => SubnetIds,
"VpcId" => VpcId,
"WorkspaceSecurityGroupId" => WorkspaceSecurityGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_studio_session_mapping(identity_type, session_policy_arn, studio_id)
create_studio_session_mapping(identity_type, session_policy_arn, studio_id, params::Dict{String,<:Any})
Maps a user or group to the Amazon EMR Studio specified by StudioId, and applies a session
policy to refine Studio permissions for that user or group. Use CreateStudioSessionMapping
to assign users to a Studio when you use IAM Identity Center authentication. For
instructions on how to assign users to a Studio when you use IAM authentication, see Assign
a user or group to your EMR Studio.
# Arguments
- `identity_type`: Specifies whether the identity to map to the Amazon EMR Studio is a user
or a group.
- `session_policy_arn`: The Amazon Resource Name (ARN) for the session policy that will be
applied to the user or group. You should specify the ARN for the session policy that you
want to apply, not the ARN of your user role. For more information, see Create an Amazon
EMR Studio User Role with Session Policies.
- `studio_id`: The ID of the Amazon EMR Studio to which the user or group will be mapped.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdentityId"`: The globally unique identifier (GUID) of the user or group from the IAM
Identity Center Identity Store. For more information, see UserId and GroupId in the IAM
Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be
specified, but not both.
- `"IdentityName"`: The name of the user or group. For more information, see UserName and
DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName or
IdentityId must be specified, but not both.
"""
function create_studio_session_mapping(
IdentityType,
SessionPolicyArn,
StudioId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"CreateStudioSessionMapping",
Dict{String,Any}(
"IdentityType" => IdentityType,
"SessionPolicyArn" => SessionPolicyArn,
"StudioId" => StudioId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_studio_session_mapping(
IdentityType,
SessionPolicyArn,
StudioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"CreateStudioSessionMapping",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityType" => IdentityType,
"SessionPolicyArn" => SessionPolicyArn,
"StudioId" => StudioId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_security_configuration(name)
delete_security_configuration(name, params::Dict{String,<:Any})
Deletes a security configuration.
# Arguments
- `name`: The name of the security configuration.
"""
function delete_security_configuration(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"DeleteSecurityConfiguration",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_security_configuration(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"DeleteSecurityConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_studio(studio_id)
delete_studio(studio_id, params::Dict{String,<:Any})
Removes an Amazon EMR Studio from the Studio metadata store.
# Arguments
- `studio_id`: The ID of the Amazon EMR Studio.
"""
function delete_studio(StudioId; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"DeleteStudio",
Dict{String,Any}("StudioId" => StudioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_studio(
StudioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"DeleteStudio",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StudioId" => StudioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_studio_session_mapping(identity_type, studio_id)
delete_studio_session_mapping(identity_type, studio_id, params::Dict{String,<:Any})
Removes a user or group from an Amazon EMR Studio.
# Arguments
- `identity_type`: Specifies whether the identity to delete from the Amazon EMR Studio is a
user or a group.
- `studio_id`: The ID of the Amazon EMR Studio.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdentityId"`: The globally unique identifier (GUID) of the user or group to remove from
the Amazon EMR Studio. For more information, see UserId and GroupId in the IAM Identity
Center Identity Store API Reference. Either IdentityName or IdentityId must be specified.
- `"IdentityName"`: The name of the user name or group to remove from the Amazon EMR
Studio. For more information, see UserName and DisplayName in the IAM Identity Center Store
API Reference. Either IdentityName or IdentityId must be specified.
"""
function delete_studio_session_mapping(
IdentityType, StudioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"DeleteStudioSessionMapping",
Dict{String,Any}("IdentityType" => IdentityType, "StudioId" => StudioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_studio_session_mapping(
IdentityType,
StudioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"DeleteStudioSessionMapping",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IdentityType" => IdentityType, "StudioId" => StudioId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cluster(cluster_id)
describe_cluster(cluster_id, params::Dict{String,<:Any})
Provides cluster-level details including status, hardware and software configuration, VPC
settings, and so on.
# Arguments
- `cluster_id`: The identifier of the cluster to describe.
"""
function describe_cluster(ClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"DescribeCluster",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cluster(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"DescribeCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job_flows()
describe_job_flows(params::Dict{String,<:Any})
This API is no longer supported and will eventually be removed. We recommend you use
ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions
instead. DescribeJobFlows returns a list of job flows that match all of the supplied
parameters. The parameters can include a list of job flow IDs, job flow states, and
restrictions on job flow creation date and time. Regardless of supplied parameters, only
job flows created within the last two months are returned. If no parameters are supplied,
then job flows matching either of the following criteria are returned: Job flows created
and completed in the last two weeks Job flows created within the last two months that
are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING Amazon EMR
can return a maximum of 512 job flow descriptions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CreatedAfter"`: Return only job flows created after this date and time.
- `"CreatedBefore"`: Return only job flows created before this date and time.
- `"JobFlowIds"`: Return only job flows whose job flow ID is contained in this list.
- `"JobFlowStates"`: Return only job flows whose state is contained in this list.
"""
function describe_job_flows(; aws_config::AbstractAWSConfig=global_aws_config())
return emr("DescribeJobFlows"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_job_flows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"DescribeJobFlows", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_notebook_execution(notebook_execution_id)
describe_notebook_execution(notebook_execution_id, params::Dict{String,<:Any})
Provides details of a notebook execution.
# Arguments
- `notebook_execution_id`: The unique identifier of the notebook execution.
"""
function describe_notebook_execution(
NotebookExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"DescribeNotebookExecution",
Dict{String,Any}("NotebookExecutionId" => NotebookExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_notebook_execution(
NotebookExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"DescribeNotebookExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NotebookExecutionId" => NotebookExecutionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_release_label()
describe_release_label(params::Dict{String,<:Any})
Provides Amazon EMR release label details, such as the releases available the Region where
the API request is run, and the available applications for a specific Amazon EMR release
label. Can also list Amazon EMR releases that support a specified version of Spark.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Reserved for future use. Currently set to null.
- `"NextToken"`: The pagination token. Reserved for future use. Currently set to null.
- `"ReleaseLabel"`: The target release label to be described.
"""
function describe_release_label(; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"DescribeReleaseLabel"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_release_label(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"DescribeReleaseLabel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_security_configuration(name)
describe_security_configuration(name, params::Dict{String,<:Any})
Provides the details of a security configuration by returning the configuration JSON.
# Arguments
- `name`: The name of the security configuration.
"""
function describe_security_configuration(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"DescribeSecurityConfiguration",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_security_configuration(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"DescribeSecurityConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_step(cluster_id, step_id)
describe_step(cluster_id, step_id, params::Dict{String,<:Any})
Provides more detail about the cluster step.
# Arguments
- `cluster_id`: The identifier of the cluster with steps to describe.
- `step_id`: The identifier of the step to describe.
"""
function describe_step(ClusterId, StepId; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"DescribeStep",
Dict{String,Any}("ClusterId" => ClusterId, "StepId" => StepId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_step(
ClusterId,
StepId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"DescribeStep",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ClusterId" => ClusterId, "StepId" => StepId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_studio(studio_id)
describe_studio(studio_id, params::Dict{String,<:Any})
Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access
URL, and so on.
# Arguments
- `studio_id`: The Amazon EMR Studio ID.
"""
function describe_studio(StudioId; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"DescribeStudio",
Dict{String,Any}("StudioId" => StudioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_studio(
StudioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"DescribeStudio",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StudioId" => StudioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_auto_termination_policy(cluster_id)
get_auto_termination_policy(cluster_id, params::Dict{String,<:Any})
Returns the auto-termination policy for an Amazon EMR cluster.
# Arguments
- `cluster_id`: Specifies the ID of the Amazon EMR cluster for which the auto-termination
policy will be fetched.
"""
function get_auto_termination_policy(
ClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"GetAutoTerminationPolicy",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_auto_termination_policy(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"GetAutoTerminationPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_block_public_access_configuration()
get_block_public_access_configuration(params::Dict{String,<:Any})
Returns the Amazon EMR block public access configuration for your Amazon Web Services
account in the current Region. For more information see Configure Block Public Access for
Amazon EMR in the Amazon EMR Management Guide.
"""
function get_block_public_access_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"GetBlockPublicAccessConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_block_public_access_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"GetBlockPublicAccessConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cluster_session_credentials(cluster_id)
get_cluster_session_credentials(cluster_id, params::Dict{String,<:Any})
Provides temporary, HTTP basic credentials that are associated with a given runtime IAM
role and used by a cluster with fine-grained access control activated. You can use these
credentials to connect to cluster endpoints that support username and password
authentication.
# Arguments
- `cluster_id`: The unique identifier of the cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExecutionRoleArn"`: The Amazon Resource Name (ARN) of the runtime role for interactive
workload submission on the cluster. The runtime role can be a cross-account IAM role. The
runtime role ARN is a combination of account ID, role name, and role type using the
following format: arn:partition:service:region:account:resource.
"""
function get_cluster_session_credentials(
ClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"GetClusterSessionCredentials",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cluster_session_credentials(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"GetClusterSessionCredentials",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_managed_scaling_policy(cluster_id)
get_managed_scaling_policy(cluster_id, params::Dict{String,<:Any})
Fetches the attached managed scaling policy for an Amazon EMR cluster.
# Arguments
- `cluster_id`: Specifies the ID of the cluster for which the managed scaling policy will
be fetched.
"""
function get_managed_scaling_policy(
ClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"GetManagedScalingPolicy",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_managed_scaling_policy(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"GetManagedScalingPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_studio_session_mapping(identity_type, studio_id)
get_studio_session_mapping(identity_type, studio_id, params::Dict{String,<:Any})
Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
# Arguments
- `identity_type`: Specifies whether the identity to fetch is a user or a group.
- `studio_id`: The ID of the Amazon EMR Studio.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdentityId"`: The globally unique identifier (GUID) of the user or group. For more
information, see UserId and GroupId in the IAM Identity Center Identity Store API
Reference. Either IdentityName or IdentityId must be specified.
- `"IdentityName"`: The name of the user or group to fetch. For more information, see
UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either
IdentityName or IdentityId must be specified.
"""
function get_studio_session_mapping(
IdentityType, StudioId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"GetStudioSessionMapping",
Dict{String,Any}("IdentityType" => IdentityType, "StudioId" => StudioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_studio_session_mapping(
IdentityType,
StudioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"GetStudioSessionMapping",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IdentityType" => IdentityType, "StudioId" => StudioId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bootstrap_actions(cluster_id)
list_bootstrap_actions(cluster_id, params::Dict{String,<:Any})
Provides information about the bootstrap actions associated with a cluster.
# Arguments
- `cluster_id`: The cluster identifier for the bootstrap actions to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The pagination token that indicates the next set of results to retrieve.
"""
function list_bootstrap_actions(
ClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"ListBootstrapActions",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bootstrap_actions(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"ListBootstrapActions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_clusters()
list_clusters(params::Dict{String,<:Any})
Provides the status of all clusters visible to this Amazon Web Services account. Allows you
to filter the list of clusters based on certain criteria; for example, filtering by cluster
creation date and time or by status. This call returns a maximum of 50 clusters in unsorted
order per call, but returns a marker to track the paging of the cluster list across
multiple ListClusters calls.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterStates"`: The cluster state filters to apply when listing clusters. Clusters
that change state while this action runs may be not be returned as expected in the list of
clusters.
- `"CreatedAfter"`: The creation date and time beginning value filter for listing clusters.
- `"CreatedBefore"`: The creation date and time end value filter for listing clusters.
- `"Marker"`: The pagination token that indicates the next set of results to retrieve.
"""
function list_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return emr("ListClusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"ListClusters", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_instance_fleets(cluster_id)
list_instance_fleets(cluster_id, params::Dict{String,<:Any})
Lists all available details about the instance fleets in a cluster. The instance fleet
configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x
versions.
# Arguments
- `cluster_id`: The unique identifier of the cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The pagination token that indicates the next set of results to retrieve.
"""
function list_instance_fleets(ClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"ListInstanceFleets",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_instance_fleets(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"ListInstanceFleets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instance_groups(cluster_id)
list_instance_groups(cluster_id, params::Dict{String,<:Any})
Provides all available details about the instance groups in a cluster.
# Arguments
- `cluster_id`: The identifier of the cluster for which to list the instance groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The pagination token that indicates the next set of results to retrieve.
"""
function list_instance_groups(ClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"ListInstanceGroups",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_instance_groups(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"ListInstanceGroups",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instances(cluster_id)
list_instances(cluster_id, params::Dict{String,<:Any})
Provides information for all active Amazon EC2 instances and Amazon EC2 instances
terminated in the last 30 days, up to a maximum of 2,000. Amazon EC2 instances in any of
the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING,
BOOTSTRAPPING, RUNNING.
# Arguments
- `cluster_id`: The identifier of the cluster for which to list the instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceFleetId"`: The unique identifier of the instance fleet.
- `"InstanceFleetType"`: The node type of the instance fleet. For example MASTER, CORE, or
TASK.
- `"InstanceGroupId"`: The identifier of the instance group for which to list the instances.
- `"InstanceGroupTypes"`: The type of instance group for which to list the instances.
- `"InstanceStates"`: A list of instance states that will filter the instances returned
with this request.
- `"Marker"`: The pagination token that indicates the next set of results to retrieve.
"""
function list_instances(ClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"ListInstances",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_instances(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"ListInstances",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_notebook_executions()
list_notebook_executions(params::Dict{String,<:Any})
Provides summaries of all notebook executions. You can filter the list based on multiple
criteria such as status, time range, and editor id. Returns a maximum of 50 notebook
executions and a marker to track the paging of a longer notebook execution list across
multiple ListNotebookExecutions calls.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EditorId"`: The unique ID of the editor associated with the notebook execution.
- `"ExecutionEngineId"`: The unique ID of the execution engine.
- `"From"`: The beginning of time range filter for listing notebook executions. The default
is the timestamp of 30 days ago.
- `"Marker"`: The pagination token, returned by a previous ListNotebookExecutions call,
that indicates the start of the list for this ListNotebookExecutions call.
- `"Status"`: The status filter for listing notebook executions. START_PENDING indicates
that the cluster has received the execution request but execution has not begun.
STARTING indicates that the execution is starting on the cluster. RUNNING indicates that
the execution is being processed by the cluster. FINISHING indicates that execution
processing is in the final stages. FINISHED indicates that the execution has completed
without error. FAILING indicates that the execution is failing and will not finish
successfully. FAILED indicates that the execution failed. STOP_PENDING indicates that
the cluster has received a StopNotebookExecution request and the stop is pending.
STOPPING indicates that the cluster is in the process of stopping the execution as a result
of a StopNotebookExecution request. STOPPED indicates that the execution stopped because
of a StopNotebookExecution request.
- `"To"`: The end of time range filter for listing notebook executions. The default is the
current timestamp.
"""
function list_notebook_executions(; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"ListNotebookExecutions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_notebook_executions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"ListNotebookExecutions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_release_labels()
list_release_labels(params::Dict{String,<:Any})
Retrieves release labels of Amazon EMR services in the Region where the API is called.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters the results of the request. Prefix specifies the prefix of release
labels to return. Application specifies the application (with/without version) of release
labels to return.
- `"MaxResults"`: Defines the maximum number of release labels to return in a single
response. The default is 100.
- `"NextToken"`: Specifies the next page of results. If NextToken is not specified, which
is usually the case for the first request of ListReleaseLabels, the first page of results
are determined by other filtering parameters or by the latest version. The
ListReleaseLabels request fails if the identity (Amazon Web Services account ID) and all
filtering parameters are different from the original request, or if the NextToken is
expired or tampered with.
"""
function list_release_labels(; aws_config::AbstractAWSConfig=global_aws_config())
return emr("ListReleaseLabels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_release_labels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"ListReleaseLabels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_security_configurations()
list_security_configurations(params::Dict{String,<:Any})
Lists all the security configurations visible to this account, providing their creation
dates and times, and their names. This call returns a maximum of 50 clusters per call, but
returns a marker to track the paging of the cluster list across multiple
ListSecurityConfigurations calls.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The pagination token that indicates the set of results to retrieve.
"""
function list_security_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"ListSecurityConfigurations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_security_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"ListSecurityConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_steps(cluster_id)
list_steps(cluster_id, params::Dict{String,<:Any})
Provides a list of steps for the cluster in reverse order unless you specify stepIds with
the request or filter by StepStates. You can specify a maximum of 10 stepIDs. The CLI
automatically paginates results to return a list greater than 50 steps. To return more than
50 steps using the CLI, specify a Marker, which is a pagination token that indicates the
next set of steps to retrieve.
# Arguments
- `cluster_id`: The identifier of the cluster for which to list the steps.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The maximum number of steps that a single ListSteps action returns is 50. To
return a longer list of steps, use multiple ListSteps actions along with the Marker
parameter, which is a pagination token that indicates the next set of results to retrieve.
- `"StepIds"`: The filter to limit the step list based on the identifier of the steps. You
can specify a maximum of ten Step IDs. The character constraint applies to the overall
length of the array.
- `"StepStates"`: The filter to limit the step list based on certain states.
"""
function list_steps(ClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"ListSteps",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_steps(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"ListSteps",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_studio_session_mappings()
list_studio_session_mappings(params::Dict{String,<:Any})
Returns a list of all user or group session mappings for the Amazon EMR Studio specified by
StudioId.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdentityType"`: Specifies whether to return session mappings for users or groups. If
not specified, the results include session mapping details for both users and groups.
- `"Marker"`: The pagination token that indicates the set of results to retrieve.
- `"StudioId"`: The ID of the Amazon EMR Studio.
"""
function list_studio_session_mappings(; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"ListStudioSessionMappings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_studio_session_mappings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"ListStudioSessionMappings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_studios()
list_studios(params::Dict{String,<:Any})
Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account.
The list includes details such as ID, Studio Access URL, and creation time for each Studio.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The pagination token that indicates the set of results to retrieve.
"""
function list_studios(; aws_config::AbstractAWSConfig=global_aws_config())
return emr("ListStudios"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_studios(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"ListStudios", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_supported_instance_types(release_label)
list_supported_instance_types(release_label, params::Dict{String,<:Any})
A list of the instance types that Amazon EMR supports. You can filter the list by Amazon
Web Services Region and Amazon EMR release.
# Arguments
- `release_label`: The Amazon EMR release label determines the versions of open-source
application packages that Amazon EMR has installed on the cluster. Release labels are in
the format emr-x.x.x, where x.x.x is an Amazon EMR release number such as emr-6.10.0. For
more information about Amazon EMR releases and their included application versions and
features, see the Amazon EMR Release Guide .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: The pagination token that marks the next set of results to retrieve.
"""
function list_supported_instance_types(
ReleaseLabel; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"ListSupportedInstanceTypes",
Dict{String,Any}("ReleaseLabel" => ReleaseLabel);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_supported_instance_types(
ReleaseLabel,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"ListSupportedInstanceTypes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ReleaseLabel" => ReleaseLabel), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_cluster(cluster_id)
modify_cluster(cluster_id, params::Dict{String,<:Any})
Modifies the number of steps that can be executed concurrently for the cluster specified
using ClusterID.
# Arguments
- `cluster_id`: The unique identifier of the cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"StepConcurrencyLevel"`: The number of steps that can be executed concurrently. You can
specify a minimum of 1 step and a maximum of 256 steps. We recommend that you do not change
this parameter while steps are running or the ActionOnFailure setting may not behave as
expected. For more information see StepActionOnFailure.
"""
function modify_cluster(ClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"ModifyCluster",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_cluster(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"ModifyCluster",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_fleet(cluster_id, instance_fleet)
modify_instance_fleet(cluster_id, instance_fleet, params::Dict{String,<:Any})
Modifies the target On-Demand and target Spot capacities for the instance fleet with the
specified InstanceFleetID within the cluster specified using ClusterID. The call either
succeeds or fails atomically. The instance fleet configuration is available only in Amazon
EMR releases 4.8.0 and later, excluding 5.0.x versions.
# Arguments
- `cluster_id`: The unique identifier of the cluster.
- `instance_fleet`: The configuration parameters of the instance fleet.
"""
function modify_instance_fleet(
ClusterId, InstanceFleet; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"ModifyInstanceFleet",
Dict{String,Any}("ClusterId" => ClusterId, "InstanceFleet" => InstanceFleet);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function modify_instance_fleet(
ClusterId,
InstanceFleet,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"ModifyInstanceFleet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterId" => ClusterId, "InstanceFleet" => InstanceFleet
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
modify_instance_groups()
modify_instance_groups(params::Dict{String,<:Any})
ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance
group. The input parameters include the new target instance count for the group and the
instance group ID. The call will either succeed or fail atomically.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClusterId"`: The ID of the cluster to which the instance group belongs.
- `"InstanceGroups"`: Instance groups to change.
"""
function modify_instance_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"ModifyInstanceGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function modify_instance_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"ModifyInstanceGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_auto_scaling_policy(auto_scaling_policy, cluster_id, instance_group_id)
put_auto_scaling_policy(auto_scaling_policy, cluster_id, instance_group_id, params::Dict{String,<:Any})
Creates or updates an automatic scaling policy for a core instance group or task instance
group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group
dynamically adds and terminates Amazon EC2 instances in response to the value of a
CloudWatch metric.
# Arguments
- `auto_scaling_policy`: Specifies the definition of the automatic scaling policy.
- `cluster_id`: Specifies the ID of a cluster. The instance group to which the automatic
scaling policy is applied is within this cluster.
- `instance_group_id`: Specifies the ID of the instance group to which the automatic
scaling policy is applied.
"""
function put_auto_scaling_policy(
AutoScalingPolicy,
ClusterId,
InstanceGroupId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"PutAutoScalingPolicy",
Dict{String,Any}(
"AutoScalingPolicy" => AutoScalingPolicy,
"ClusterId" => ClusterId,
"InstanceGroupId" => InstanceGroupId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_auto_scaling_policy(
AutoScalingPolicy,
ClusterId,
InstanceGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"PutAutoScalingPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AutoScalingPolicy" => AutoScalingPolicy,
"ClusterId" => ClusterId,
"InstanceGroupId" => InstanceGroupId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_auto_termination_policy(cluster_id)
put_auto_termination_policy(cluster_id, params::Dict{String,<:Any})
Auto-termination is supported in Amazon EMR releases 5.30.0 and 6.1.0 and later. For more
information, see Using an auto-termination policy. Creates or updates an auto-termination
policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle
time in seconds after which a cluster automatically terminates. For alternative cluster
termination options, see Control cluster termination.
# Arguments
- `cluster_id`: Specifies the ID of the Amazon EMR cluster to which the auto-termination
policy will be attached.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoTerminationPolicy"`: Specifies the auto-termination policy to attach to the cluster.
"""
function put_auto_termination_policy(
ClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"PutAutoTerminationPolicy",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_auto_termination_policy(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"PutAutoTerminationPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_block_public_access_configuration(block_public_access_configuration)
put_block_public_access_configuration(block_public_access_configuration, params::Dict{String,<:Any})
Creates or updates an Amazon EMR block public access configuration for your Amazon Web
Services account in the current Region. For more information see Configure Block Public
Access for Amazon EMR in the Amazon EMR Management Guide.
# Arguments
- `block_public_access_configuration`: A configuration for Amazon EMR block public access.
The configuration applies to all clusters created in your account for the current Region.
The configuration specifies whether block public access is enabled. If block public access
is enabled, security groups associated with the cluster cannot have rules that allow
inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an
exception using PermittedPublicSecurityGroupRuleRanges in the
BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public
access is allowed on this port. You can change this by updating
BlockPublicSecurityGroupRules to remove the exception. For accounts that created clusters
in a Region before November 25, 2019, block public access is disabled by default in that
Region. To use this feature, you must manually enable and configure it. For accounts that
did not create an Amazon EMR cluster in a Region before this date, block public access is
enabled by default in that Region.
"""
function put_block_public_access_configuration(
BlockPublicAccessConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"PutBlockPublicAccessConfiguration",
Dict{String,Any}(
"BlockPublicAccessConfiguration" => BlockPublicAccessConfiguration
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_block_public_access_configuration(
BlockPublicAccessConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"PutBlockPublicAccessConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BlockPublicAccessConfiguration" => BlockPublicAccessConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_managed_scaling_policy(cluster_id, managed_scaling_policy)
put_managed_scaling_policy(cluster_id, managed_scaling_policy, params::Dict{String,<:Any})
Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling
policy defines the limits for resources, such as Amazon EC2 instances that can be added or
terminated from a cluster. The policy only applies to the core and task nodes. The master
node cannot be scaled after initial configuration.
# Arguments
- `cluster_id`: Specifies the ID of an Amazon EMR cluster where the managed scaling policy
is attached.
- `managed_scaling_policy`: Specifies the constraints for the managed scaling policy.
"""
function put_managed_scaling_policy(
ClusterId, ManagedScalingPolicy; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"PutManagedScalingPolicy",
Dict{String,Any}(
"ClusterId" => ClusterId, "ManagedScalingPolicy" => ManagedScalingPolicy
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_managed_scaling_policy(
ClusterId,
ManagedScalingPolicy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"PutManagedScalingPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterId" => ClusterId, "ManagedScalingPolicy" => ManagedScalingPolicy
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_auto_scaling_policy(cluster_id, instance_group_id)
remove_auto_scaling_policy(cluster_id, instance_group_id, params::Dict{String,<:Any})
Removes an automatic scaling policy from a specified instance group within an Amazon EMR
cluster.
# Arguments
- `cluster_id`: Specifies the ID of a cluster. The instance group to which the automatic
scaling policy is applied is within this cluster.
- `instance_group_id`: Specifies the ID of the instance group to which the scaling policy
is applied.
"""
function remove_auto_scaling_policy(
ClusterId, InstanceGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"RemoveAutoScalingPolicy",
Dict{String,Any}("ClusterId" => ClusterId, "InstanceGroupId" => InstanceGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_auto_scaling_policy(
ClusterId,
InstanceGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"RemoveAutoScalingPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClusterId" => ClusterId, "InstanceGroupId" => InstanceGroupId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_auto_termination_policy(cluster_id)
remove_auto_termination_policy(cluster_id, params::Dict{String,<:Any})
Removes an auto-termination policy from an Amazon EMR cluster.
# Arguments
- `cluster_id`: Specifies the ID of the Amazon EMR cluster from which the auto-termination
policy will be removed.
"""
function remove_auto_termination_policy(
ClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"RemoveAutoTerminationPolicy",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_auto_termination_policy(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"RemoveAutoTerminationPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_managed_scaling_policy(cluster_id)
remove_managed_scaling_policy(cluster_id, params::Dict{String,<:Any})
Removes a managed scaling policy from a specified Amazon EMR cluster.
# Arguments
- `cluster_id`: Specifies the ID of the cluster from which the managed scaling policy will
be removed.
"""
function remove_managed_scaling_policy(
ClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"RemoveManagedScalingPolicy",
Dict{String,Any}("ClusterId" => ClusterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_managed_scaling_policy(
ClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"RemoveManagedScalingPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ClusterId" => ClusterId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags(resource_id, tag_keys)
remove_tags(resource_id, tag_keys, params::Dict{String,<:Any})
Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make
it easier to associate resources in various ways, such as grouping clusters to track your
Amazon EMR resource allocation costs. For more information, see Tag Clusters. The
following example removes the stack tag with value Prod from a cluster:
# Arguments
- `resource_id`: The Amazon EMR resource identifier from which tags will be removed. For
example, a cluster identifier or an Amazon EMR Studio ID.
- `tag_keys`: A list of tag keys to remove from the resource.
"""
function remove_tags(ResourceId, TagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"RemoveTags",
Dict{String,Any}("ResourceId" => ResourceId, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags(
ResourceId,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"RemoveTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceId" => ResourceId, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
run_job_flow(instances, name)
run_job_flow(instances, name, params::Dict{String,<:Any})
RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps
specified. After the steps complete, the cluster stops and the HDFS partition is lost. To
prevent loss of data, configure the last step of the job flow to store results in Amazon
S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the
cluster transitions to the WAITING state rather than shutting down after the steps have
completed. For additional protection, you can set the JobFlowInstancesConfig
TerminationProtected parameter to TRUE to lock the cluster and prevent it from being
terminated by API call, user intervention, or in the event of a job flow error. A maximum
of 256 steps are allowed in each job flow. If your cluster is long-running (such as a Hive
data warehouse) or complex, you may require more than 256 steps to process your data. You
can bypass the 256-step limitation in various ways, including using the SSH shell to
connect to the master node and submitting queries directly to the software running on the
master node, such as Hive and Hadoop. For long-running clusters, we recommend that you
periodically store your results. The instance fleets configuration is available only in
Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can
contain InstanceFleets parameters or InstanceGroups parameters, but not both.
# Arguments
- `instances`: A specification of the number and type of Amazon EC2 instances.
- `name`: The name of the job flow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalInfo"`: A JSON string for selecting additional features.
- `"AmiVersion"`: Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR
releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.
- `"Applications"`: Applies to Amazon EMR releases 4.0 and later. A case-insensitive list
of applications for Amazon EMR to install and configure when launching the cluster. For a
list of applications available for each Amazon EMR release version, see the Amazon
EMRRelease Guide.
- `"AutoScalingRole"`: An IAM role for automatic scaling policies. The default role is
EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling
feature requires to launch and terminate Amazon EC2 instances in an instance group.
- `"AutoTerminationPolicy"`:
- `"BootstrapActions"`: A list of bootstrap actions to run before Hadoop starts on the
cluster nodes.
- `"Configurations"`: For Amazon EMR releases 4.0 and later. The list of configurations
supplied for the Amazon EMR cluster that you are creating.
- `"CustomAmiId"`: Available only in Amazon EMR releases 5.7.0 and later. The ID of a
custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches
cluster Amazon EC2 instances. For more information about custom AMIs in Amazon EMR, see
Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the
base Linux AMI for the ReleaseLabel specified. For Amazon EMR releases 2.x and 3.x, use
AmiVersion instead. For information about creating a custom AMI, see Creating an Amazon
EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
For information about finding an AMI ID, see Finding a Linux AMI.
- `"EbsRootVolumeIops"`: The IOPS, of the Amazon EBS root device volume of the Linux AMI
that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and
later.
- `"EbsRootVolumeSize"`: The size, in GiB, of the Amazon EBS root device volume of the
Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x
and later.
- `"EbsRootVolumeThroughput"`: The throughput, in MiB/s, of the Amazon EBS root device
volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR
releases 6.15.0 and later.
- `"JobFlowRole"`: Also called instance profile and Amazon EC2 role. An IAM role for an
Amazon EMR cluster. The Amazon EC2 instances of the cluster assume this role. The default
role is EMR_EC2_DefaultRole. In order to use the default role, you must have already
created it using the CLI or console.
- `"KerberosAttributes"`: Attributes for Kerberos configuration when Kerberos
authentication is enabled using a security configuration. For more information see Use
Kerberos Authentication in the Amazon EMR Management Guide.
- `"LogEncryptionKmsKeyId"`: The KMS key used for encrypting log files. If a value is not
provided, the logs remain encrypted by AES-256. This attribute is only available with
Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0.
- `"LogUri"`: The location in Amazon S3 to write the log files of the job flow. If a value
is not provided, logs are not created.
- `"ManagedScalingPolicy"`: The specified managed scaling policy for an Amazon EMR
cluster.
- `"NewSupportedProducts"`: For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases
4.x and later, use Applications. A list of strings that indicates third-party software to
use with the job flow that accepts a user argument list. Amazon EMR accepts and forwards
the argument list to the corresponding installation script as bootstrap action arguments.
For more information, see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the
Amazon EMR Developer Guide. Supported values are: \"mapr-m3\" - launch the cluster using
MapR M3 Edition. \"mapr-m5\" - launch the cluster using MapR M5 Edition. \"mapr\" with
the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the job flow
using MapR M3 or M5 Edition respectively. \"mapr-m7\" - launch the cluster using MapR M7
Edition. \"hunk\" - launch the cluster with the Hunk Big Data Analytics Platform.
\"hue\"- launch the cluster with Hue installed. \"spark\" - launch the cluster with
Apache Spark installed. \"ganglia\" - launch the cluster with the Ganglia Monitoring
System installed.
- `"OSReleaseLabel"`: Specifies a particular Amazon Linux release for all nodes in a
cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the
latest validated Amazon Linux release for cluster launch.
- `"PlacementGroupConfigs"`: The specified placement group configuration for an Amazon EMR
cluster.
- `"ReleaseLabel"`: The Amazon EMR release label, which determines the version of
open-source application packages installed on the cluster. Release labels are in the form
emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more
information about Amazon EMR release versions and included application versions and
features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label
applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.
- `"RepoUpgradeOnBoot"`: Applies only when CustomAmiID is used. Specifies which updates
from the Amazon Linux AMI package repositories to apply automatically when the instance
boots using the AMI. If omitted, the default is SECURITY, which indicates that only
security updates are applied. If NONE is specified, no updates are applied, and all updates
must be applied manually.
- `"ScaleDownBehavior"`: Specifies the way that individual Amazon EC2 instances terminate
when an automatic scale-in activity occurs or an instance group is resized.
TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour
boundary, regardless of when the request to terminate the instance was submitted. This
option is only available with Amazon EMR 5.1.0 and later and is the default for clusters
created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds
nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2
instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR
removes the least active nodes first and blocks instance termination if it could lead to
HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR releases 4.1.0
and later, and is the default for releases of Amazon EMR earlier than 5.1.0.
- `"SecurityConfiguration"`: The name of a security configuration to apply to the cluster.
- `"ServiceRole"`: The IAM role that Amazon EMR assumes in order to access Amazon Web
Services resources on your behalf. If you've created a custom service role path, you must
specify it for the service role when you launch your cluster.
- `"StepConcurrencyLevel"`: Specifies the number of steps that can be executed
concurrently. The default value is 1. The maximum value is 256.
- `"Steps"`: A list of steps to run.
- `"SupportedProducts"`: For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x
and later, use Applications. A list of strings that indicates third-party software to use.
For more information, see the Amazon EMR Developer Guide. Currently supported values are:
\"mapr-m3\" - launch the job flow using MapR M3 Edition. \"mapr-m5\" - launch the job
flow using MapR M5 Edition.
- `"Tags"`: A list of tags to associate with a cluster and propagate to Amazon EC2
instances.
- `"VisibleToAllUsers"`: The VisibleToAllUsers parameter is no longer supported. By
default, the value is set to true. Setting it to false now has no effect. Set this value
to true so that IAM principals in the Amazon Web Services account associated with the
cluster can perform Amazon EMR actions on the cluster that their IAM policies allow. This
value defaults to true for clusters created using the Amazon EMR API or the CLI
create-cluster command. When set to false, only the IAM principal that created the cluster
and the Amazon Web Services account root user can perform Amazon EMR actions for the
cluster, regardless of the IAM permissions policies attached to other IAM principals. For
more information, see Understanding the Amazon EMR cluster VisibleToAllUsers setting in the
Amazon EMR Management Guide.
"""
function run_job_flow(Instances, Name; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"RunJobFlow",
Dict{String,Any}("Instances" => Instances, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function run_job_flow(
Instances,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"RunJobFlow",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Instances" => Instances, "Name" => Name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_keep_job_flow_alive_when_no_steps(job_flow_ids, keep_job_flow_alive_when_no_steps)
set_keep_job_flow_alive_when_no_steps(job_flow_ids, keep_job_flow_alive_when_no_steps, params::Dict{String,<:Any})
You can use the SetKeepJobFlowAliveWhenNoSteps to configure a cluster (job flow) to
terminate after the step execution, i.e., all your steps are executed. If you want a
transient cluster that shuts down after the last of the current executing steps are
completed, you can configure SetKeepJobFlowAliveWhenNoSteps to false. If you want a long
running cluster, configure SetKeepJobFlowAliveWhenNoSteps to true. For more information,
see Managing Cluster Termination in the Amazon EMR Management Guide.
# Arguments
- `job_flow_ids`: A list of strings that uniquely identify the clusters to protect. This
identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows.
- `keep_job_flow_alive_when_no_steps`: A Boolean that indicates whether to terminate the
cluster after all steps are executed.
"""
function set_keep_job_flow_alive_when_no_steps(
JobFlowIds,
KeepJobFlowAliveWhenNoSteps;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"SetKeepJobFlowAliveWhenNoSteps",
Dict{String,Any}(
"JobFlowIds" => JobFlowIds,
"KeepJobFlowAliveWhenNoSteps" => KeepJobFlowAliveWhenNoSteps,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_keep_job_flow_alive_when_no_steps(
JobFlowIds,
KeepJobFlowAliveWhenNoSteps,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"SetKeepJobFlowAliveWhenNoSteps",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"JobFlowIds" => JobFlowIds,
"KeepJobFlowAliveWhenNoSteps" => KeepJobFlowAliveWhenNoSteps,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_termination_protection(job_flow_ids, termination_protected)
set_termination_protection(job_flow_ids, termination_protected, params::Dict{String,<:Any})
SetTerminationProtection locks a cluster (job flow) so the Amazon EC2 instances in the
cluster cannot be terminated by user intervention, an API call, or in the event of a
job-flow error. The cluster still terminates upon successful completion of the job flow.
Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2
DisableAPITermination API on all Amazon EC2 instances in a cluster.
SetTerminationProtection is used to prevent accidental termination of a cluster and to
ensure that in the event of an error, the instances persist so that you can recover any
data stored in their ephemeral instance storage. To terminate a cluster that has been
locked by setting SetTerminationProtection to true, you must first unlock the job flow by a
subsequent call to SetTerminationProtection in which you set the value to false. For more
information, see Managing Cluster Termination in the Amazon EMR Management Guide.
# Arguments
- `job_flow_ids`: A list of strings that uniquely identify the clusters to protect. This
identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .
- `termination_protected`: A Boolean that indicates whether to protect the cluster and
prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user
intervention, or job-flow error.
"""
function set_termination_protection(
JobFlowIds, TerminationProtected; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"SetTerminationProtection",
Dict{String,Any}(
"JobFlowIds" => JobFlowIds, "TerminationProtected" => TerminationProtected
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_termination_protection(
JobFlowIds,
TerminationProtected,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"SetTerminationProtection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"JobFlowIds" => JobFlowIds,
"TerminationProtected" => TerminationProtected,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_unhealthy_node_replacement(job_flow_ids, unhealthy_node_replacement)
set_unhealthy_node_replacement(job_flow_ids, unhealthy_node_replacement, params::Dict{String,<:Any})
Specify whether to enable unhealthy node replacement, which lets Amazon EMR gracefully
replace core nodes on a cluster if any nodes become unhealthy. For example, a node becomes
unhealthy if disk usage is above 90%. If unhealthy node replacement is on and
TerminationProtected are off, Amazon EMR immediately terminates the unhealthy core nodes.
To use unhealthy node replacement and retain unhealthy core nodes, use to turn on
termination protection. In such cases, Amazon EMR adds the unhealthy nodes to a denylist,
reducing job interruptions and failures. If unhealthy node replacement is on, Amazon EMR
notifies YARN and other applications on the cluster to stop scheduling tasks with these
nodes, moves the data, and then terminates the nodes. For more information, see graceful
node replacement in the Amazon EMR Management Guide.
# Arguments
- `job_flow_ids`: The list of strings that uniquely identify the clusters for which to turn
on unhealthy node replacement. You can get these identifiers by running the RunJobFlow or
the DescribeJobFlows operations.
- `unhealthy_node_replacement`: Indicates whether to turn on or turn off graceful unhealthy
node replacement.
"""
function set_unhealthy_node_replacement(
JobFlowIds, UnhealthyNodeReplacement; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"SetUnhealthyNodeReplacement",
Dict{String,Any}(
"JobFlowIds" => JobFlowIds,
"UnhealthyNodeReplacement" => UnhealthyNodeReplacement,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_unhealthy_node_replacement(
JobFlowIds,
UnhealthyNodeReplacement,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"SetUnhealthyNodeReplacement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"JobFlowIds" => JobFlowIds,
"UnhealthyNodeReplacement" => UnhealthyNodeReplacement,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_visible_to_all_users(job_flow_ids, visible_to_all_users)
set_visible_to_all_users(job_flow_ids, visible_to_all_users, params::Dict{String,<:Any})
The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to
all users in your account. To restrict cluster access using an IAM policy, see Identity and
Access Management for Amazon EMR. Sets the ClusterVisibleToAllUsers value for an Amazon
EMR cluster. When true, IAM principals in the Amazon Web Services account can perform
Amazon EMR cluster actions that their IAM policies allow. When false, only the IAM
principal that created the cluster and the Amazon Web Services account root user can
perform Amazon EMR actions on the cluster, regardless of IAM permissions policies attached
to other IAM principals. This action works on running clusters. When you create a cluster,
use the RunJobFlowInputVisibleToAllUsers parameter. For more information, see Understanding
the Amazon EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide.
# Arguments
- `job_flow_ids`: The unique identifier of the job flow (cluster).
- `visible_to_all_users`: A value of true indicates that an IAM principal in the Amazon Web
Services account can perform Amazon EMR actions on the cluster that the IAM policies
attached to the principal allow. A value of false indicates that only the IAM principal
that created the cluster and the Amazon Web Services root user can perform Amazon EMR
actions on the cluster.
"""
function set_visible_to_all_users(
JobFlowIds, VisibleToAllUsers; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"SetVisibleToAllUsers",
Dict{String,Any}(
"JobFlowIds" => JobFlowIds, "VisibleToAllUsers" => VisibleToAllUsers
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_visible_to_all_users(
JobFlowIds,
VisibleToAllUsers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"SetVisibleToAllUsers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"JobFlowIds" => JobFlowIds, "VisibleToAllUsers" => VisibleToAllUsers
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_notebook_execution(execution_engine, service_role)
start_notebook_execution(execution_engine, service_role, params::Dict{String,<:Any})
Starts a notebook execution.
# Arguments
- `execution_engine`: Specifies the execution engine (cluster) that runs the notebook
execution.
- `service_role`: The name or ARN of the IAM role that is used as the service role for
Amazon EMR (the Amazon EMR role) for the notebook execution.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EditorId"`: The unique identifier of the Amazon EMR Notebook to use for notebook
execution.
- `"EnvironmentVariables"`: The environment variables associated with the notebook
execution.
- `"NotebookExecutionName"`: An optional name for the notebook execution.
- `"NotebookInstanceSecurityGroupId"`: The unique identifier of the Amazon EC2 security
group to associate with the Amazon EMR Notebook for this notebook execution.
- `"NotebookParams"`: Input parameters in JSON format passed to the Amazon EMR Notebook at
runtime for execution.
- `"NotebookS3Location"`: The Amazon S3 location for the notebook execution input.
- `"OutputNotebookFormat"`: The output format for the notebook execution.
- `"OutputNotebookS3Location"`: The Amazon S3 location for the notebook execution output.
- `"RelativePath"`: The path and file name of the notebook file for this execution,
relative to the path specified for the Amazon EMR Notebook. For example, if you specify a
path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook
with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a
RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file
for the notebook execution is
s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execut
ion.ipynb.
- `"Tags"`: A list of tags associated with a notebook execution. Tags are user-defined
key-value pairs that consist of a required key string with a maximum of 128 characters and
an optional value string with a maximum of 256 characters.
"""
function start_notebook_execution(
ExecutionEngine, ServiceRole; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"StartNotebookExecution",
Dict{String,Any}(
"ExecutionEngine" => ExecutionEngine, "ServiceRole" => ServiceRole
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_notebook_execution(
ExecutionEngine,
ServiceRole,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"StartNotebookExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExecutionEngine" => ExecutionEngine, "ServiceRole" => ServiceRole
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_notebook_execution(notebook_execution_id)
stop_notebook_execution(notebook_execution_id, params::Dict{String,<:Any})
Stops a notebook execution.
# Arguments
- `notebook_execution_id`: The unique identifier of the notebook execution.
"""
function stop_notebook_execution(
NotebookExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr(
"StopNotebookExecution",
Dict{String,Any}("NotebookExecutionId" => NotebookExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_notebook_execution(
NotebookExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"StopNotebookExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("NotebookExecutionId" => NotebookExecutionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
terminate_job_flows(job_flow_ids)
terminate_job_flows(job_flow_ids, params::Dict{String,<:Any})
TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down,
any step not yet completed is canceled and the Amazon EC2 instances on which the cluster is
running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri
was specified when the cluster was created. The maximum number of clusters allowed is 10.
The call to TerminateJobFlows is asynchronous. Depending on the configuration of the
cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release
allocated resources, such as Amazon EC2 instances.
# Arguments
- `job_flow_ids`: A list of job flows to be shut down.
"""
function terminate_job_flows(JobFlowIds; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"TerminateJobFlows",
Dict{String,Any}("JobFlowIds" => JobFlowIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function terminate_job_flows(
JobFlowIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"TerminateJobFlows",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("JobFlowIds" => JobFlowIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_studio(studio_id)
update_studio(studio_id, params::Dict{String,<:Any})
Updates an Amazon EMR Studio configuration, including attributes such as name, description,
and subnets.
# Arguments
- `studio_id`: The ID of the Amazon EMR Studio to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultS3Location"`: The Amazon S3 location to back up Workspaces and notebook files
for the Amazon EMR Studio.
- `"Description"`: A detailed description to assign to the Amazon EMR Studio.
- `"EncryptionKeyArn"`: The KMS key identifier (ARN) used to encrypt Amazon EMR Studio
workspace and notebook files when backed up to Amazon S3.
- `"Name"`: A descriptive name for the Amazon EMR Studio.
- `"SubnetIds"`: A list of subnet IDs to associate with the Amazon EMR Studio. The list can
include new subnet IDs, but must also include all of the subnet IDs previously associated
with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets.
The subnets must belong to the same VPC as the Studio.
"""
function update_studio(StudioId; aws_config::AbstractAWSConfig=global_aws_config())
return emr(
"UpdateStudio",
Dict{String,Any}("StudioId" => StudioId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_studio(
StudioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"UpdateStudio",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("StudioId" => StudioId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_studio_session_mapping(identity_type, session_policy_arn, studio_id)
update_studio_session_mapping(identity_type, session_policy_arn, studio_id, params::Dict{String,<:Any})
Updates the session policy attached to the user or group for the specified Amazon EMR
Studio.
# Arguments
- `identity_type`: Specifies whether the identity to update is a user or a group.
- `session_policy_arn`: The Amazon Resource Name (ARN) of the session policy to associate
with the specified user or group.
- `studio_id`: The ID of the Amazon EMR Studio.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdentityId"`: The globally unique identifier (GUID) of the user or group. For more
information, see UserId and GroupId in the IAM Identity Center Identity Store API
Reference. Either IdentityName or IdentityId must be specified.
- `"IdentityName"`: The name of the user or group to update. For more information, see
UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either
IdentityName or IdentityId must be specified.
"""
function update_studio_session_mapping(
IdentityType,
SessionPolicyArn,
StudioId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"UpdateStudioSessionMapping",
Dict{String,Any}(
"IdentityType" => IdentityType,
"SessionPolicyArn" => SessionPolicyArn,
"StudioId" => StudioId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_studio_session_mapping(
IdentityType,
SessionPolicyArn,
StudioId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr(
"UpdateStudioSessionMapping",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityType" => IdentityType,
"SessionPolicyArn" => SessionPolicyArn,
"StudioId" => StudioId,
),
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 | 35081 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: emr_containers
using AWS.Compat
using AWS.UUIDs
"""
cancel_job_run(job_run_id, virtual_cluster_id)
cancel_job_run(job_run_id, virtual_cluster_id, params::Dict{String,<:Any})
Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or
SparkSQL query, that you submit to Amazon EMR on EKS.
# Arguments
- `job_run_id`: The ID of the job run to cancel.
- `virtual_cluster_id`: The ID of the virtual cluster for which the job run will be
canceled.
"""
function cancel_job_run(
jobRunId, virtualClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"DELETE",
"/virtualclusters/$(virtualClusterId)/jobruns/$(jobRunId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_job_run(
jobRunId,
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"DELETE",
"/virtualclusters/$(virtualClusterId)/jobruns/$(jobRunId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job_template(client_token, job_template_data, name)
create_job_template(client_token, job_template_data, name, params::Dict{String,<:Any})
Creates a job template. Job template stores values of StartJobRun API request in a template
and can be used to start a job run. Job template allows two use cases: avoid repeating
recurring StartJobRun API request values, enforcing certain values in StartJobRun API
request.
# Arguments
- `client_token`: The client token of the job template.
- `job_template_data`: The job template data which holds values of StartJobRun API request.
- `name`: The specified name of the job template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"kmsKeyArn"`: The KMS key ARN used to encrypt the job template.
- `"tags"`: The tags that are associated with the job template.
"""
function create_job_template(
clientToken, jobTemplateData, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"POST",
"/jobtemplates",
Dict{String,Any}(
"clientToken" => clientToken,
"jobTemplateData" => jobTemplateData,
"name" => name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job_template(
clientToken,
jobTemplateData,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"POST",
"/jobtemplates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"jobTemplateData" => jobTemplateData,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_managed_endpoint(client_token, execution_role_arn, name, release_label, type, virtual_cluster_id)
create_managed_endpoint(client_token, execution_role_arn, name, release_label, type, virtual_cluster_id, params::Dict{String,<:Any})
Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio
to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
# Arguments
- `client_token`: The client idempotency token for this create call.
- `execution_role_arn`: The ARN of the execution role.
- `name`: The name of the managed endpoint.
- `release_label`: The Amazon EMR release version.
- `type`: The type of the managed endpoint.
- `virtual_cluster_id`: The ID of the virtual cluster for which a managed endpoint is
created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"certificateArn"`: The certificate ARN provided by users for the managed endpoint. This
field is under deprecation and will be removed in future releases.
- `"configurationOverrides"`: The configuration settings that will be used to override
existing configurations.
- `"tags"`: The tags of the managed endpoint.
"""
function create_managed_endpoint(
clientToken,
executionRoleArn,
name,
releaseLabel,
type,
virtualClusterId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"POST",
"/virtualclusters/$(virtualClusterId)/endpoints",
Dict{String,Any}(
"clientToken" => clientToken,
"executionRoleArn" => executionRoleArn,
"name" => name,
"releaseLabel" => releaseLabel,
"type" => type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_managed_endpoint(
clientToken,
executionRoleArn,
name,
releaseLabel,
type,
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"POST",
"/virtualclusters/$(virtualClusterId)/endpoints",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"executionRoleArn" => executionRoleArn,
"name" => name,
"releaseLabel" => releaseLabel,
"type" => type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_security_configuration(client_token, name, security_configuration_data)
create_security_configuration(client_token, name, security_configuration_data, params::Dict{String,<:Any})
Creates a security configuration. Security configurations in Amazon EMR on EKS are
templates for different security setups. You can use security configurations to configure
the Lake Formation integration setup. You can also create a security configuration to
re-use a security setup each time you create a virtual cluster.
# Arguments
- `client_token`: The client idempotency token to use when creating the security
configuration.
- `name`: The name of the security configuration.
- `security_configuration_data`: Security configuration input for the request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tags to add to the security configuration.
"""
function create_security_configuration(
clientToken,
name,
securityConfigurationData;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"POST",
"/securityconfigurations",
Dict{String,Any}(
"clientToken" => clientToken,
"name" => name,
"securityConfigurationData" => securityConfigurationData,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_security_configuration(
clientToken,
name,
securityConfigurationData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"POST",
"/securityconfigurations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"name" => name,
"securityConfigurationData" => securityConfigurationData,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_virtual_cluster(client_token, container_provider, name)
create_virtual_cluster(client_token, container_provider, name, params::Dict{String,<:Any})
Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You
can create, describe, list and delete virtual clusters. They do not consume any additional
resource in your system. A single virtual cluster maps to a single Kubernetes namespace.
Given this relationship, you can model virtual clusters the same way you model Kubernetes
namespaces to meet your requirements.
# Arguments
- `client_token`: The client token of the virtual cluster.
- `container_provider`: The container provider of the virtual cluster.
- `name`: The specified name of the virtual cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"securityConfigurationId"`: The ID of the security configuration.
- `"tags"`: The tags assigned to the virtual cluster.
"""
function create_virtual_cluster(
clientToken, containerProvider, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"POST",
"/virtualclusters",
Dict{String,Any}(
"clientToken" => clientToken,
"containerProvider" => containerProvider,
"name" => name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_virtual_cluster(
clientToken,
containerProvider,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"POST",
"/virtualclusters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"containerProvider" => containerProvider,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_job_template(template_id)
delete_job_template(template_id, params::Dict{String,<:Any})
Deletes a job template. Job template stores values of StartJobRun API request in a template
and can be used to start a job run. Job template allows two use cases: avoid repeating
recurring StartJobRun API request values, enforcing certain values in StartJobRun API
request.
# Arguments
- `template_id`: The ID of the job template that will be deleted.
"""
function delete_job_template(templateId; aws_config::AbstractAWSConfig=global_aws_config())
return emr_containers(
"DELETE",
"/jobtemplates/$(templateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_job_template(
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"DELETE",
"/jobtemplates/$(templateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_managed_endpoint(endpoint_id, virtual_cluster_id)
delete_managed_endpoint(endpoint_id, virtual_cluster_id, params::Dict{String,<:Any})
Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio
to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
# Arguments
- `endpoint_id`: The ID of the managed endpoint.
- `virtual_cluster_id`: The ID of the endpoint's virtual cluster.
"""
function delete_managed_endpoint(
endpointId, virtualClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"DELETE",
"/virtualclusters/$(virtualClusterId)/endpoints/$(endpointId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_managed_endpoint(
endpointId,
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"DELETE",
"/virtualclusters/$(virtualClusterId)/endpoints/$(endpointId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_virtual_cluster(virtual_cluster_id)
delete_virtual_cluster(virtual_cluster_id, params::Dict{String,<:Any})
Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You
can create, describe, list and delete virtual clusters. They do not consume any additional
resource in your system. A single virtual cluster maps to a single Kubernetes namespace.
Given this relationship, you can model virtual clusters the same way you model Kubernetes
namespaces to meet your requirements.
# Arguments
- `virtual_cluster_id`: The ID of the virtual cluster that will be deleted.
"""
function delete_virtual_cluster(
virtualClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"DELETE",
"/virtualclusters/$(virtualClusterId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_virtual_cluster(
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"DELETE",
"/virtualclusters/$(virtualClusterId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job_run(job_run_id, virtual_cluster_id)
describe_job_run(job_run_id, virtual_cluster_id, params::Dict{String,<:Any})
Displays detailed information about a job run. A job run is a unit of work, such as a Spark
jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
# Arguments
- `job_run_id`: The ID of the job run request.
- `virtual_cluster_id`: The ID of the virtual cluster for which the job run is submitted.
"""
function describe_job_run(
jobRunId, virtualClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"GET",
"/virtualclusters/$(virtualClusterId)/jobruns/$(jobRunId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_job_run(
jobRunId,
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"GET",
"/virtualclusters/$(virtualClusterId)/jobruns/$(jobRunId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job_template(template_id)
describe_job_template(template_id, params::Dict{String,<:Any})
Displays detailed information about a specified job template. Job template stores values of
StartJobRun API request in a template and can be used to start a job run. Job template
allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing
certain values in StartJobRun API request.
# Arguments
- `template_id`: The ID of the job template that will be described.
"""
function describe_job_template(
templateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"GET",
"/jobtemplates/$(templateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_job_template(
templateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"GET",
"/jobtemplates/$(templateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_managed_endpoint(endpoint_id, virtual_cluster_id)
describe_managed_endpoint(endpoint_id, virtual_cluster_id, params::Dict{String,<:Any})
Displays detailed information about a managed endpoint. A managed endpoint is a gateway
that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can
communicate with your virtual cluster.
# Arguments
- `endpoint_id`: This output displays ID of the managed endpoint.
- `virtual_cluster_id`: The ID of the endpoint's virtual cluster.
"""
function describe_managed_endpoint(
endpointId, virtualClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"GET",
"/virtualclusters/$(virtualClusterId)/endpoints/$(endpointId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_managed_endpoint(
endpointId,
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"GET",
"/virtualclusters/$(virtualClusterId)/endpoints/$(endpointId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_security_configuration(security_configuration_id)
describe_security_configuration(security_configuration_id, params::Dict{String,<:Any})
Displays detailed information about a specified security configuration. Security
configurations in Amazon EMR on EKS are templates for different security setups. You can
use security configurations to configure the Lake Formation integration setup. You can also
create a security configuration to re-use a security setup each time you create a virtual
cluster.
# Arguments
- `security_configuration_id`: The ID of the security configuration.
"""
function describe_security_configuration(
securityConfigurationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"GET",
"/securityconfigurations/$(securityConfigurationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_security_configuration(
securityConfigurationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"GET",
"/securityconfigurations/$(securityConfigurationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_virtual_cluster(virtual_cluster_id)
describe_virtual_cluster(virtual_cluster_id, params::Dict{String,<:Any})
Displays detailed information about a specified virtual cluster. Virtual cluster is a
managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual
clusters. They do not consume any additional resource in your system. A single virtual
cluster maps to a single Kubernetes namespace. Given this relationship, you can model
virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
# Arguments
- `virtual_cluster_id`: The ID of the virtual cluster that will be described.
"""
function describe_virtual_cluster(
virtualClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"GET",
"/virtualclusters/$(virtualClusterId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_virtual_cluster(
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"GET",
"/virtualclusters/$(virtualClusterId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_managed_endpoint_session_credentials(credential_type, endpoint_id, execution_role_arn, virtual_cluster_id)
get_managed_endpoint_session_credentials(credential_type, endpoint_id, execution_role_arn, virtual_cluster_id, params::Dict{String,<:Any})
Generate a session token to connect to a managed endpoint.
# Arguments
- `credential_type`: Type of the token requested. Currently supported and default value of
this field is “TOKEN.”
- `endpoint_id`: The ARN of the managed endpoint for which the request is submitted.
- `execution_role_arn`: The IAM Execution Role ARN that will be used by the job run.
- `virtual_cluster_id`: The ARN of the Virtual Cluster which the Managed Endpoint belongs
to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The client idempotency token of the job run request.
- `"durationInSeconds"`: Duration in seconds for which the session token is valid. The
default duration is 15 minutes and the maximum is 12 hours.
- `"logContext"`: String identifier used to separate sections of the execution logs
uploaded to S3.
"""
function get_managed_endpoint_session_credentials(
credentialType,
endpointId,
executionRoleArn,
virtualClusterId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"POST",
"/virtualclusters/$(virtualClusterId)/endpoints/$(endpointId)/credentials",
Dict{String,Any}(
"credentialType" => credentialType,
"executionRoleArn" => executionRoleArn,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_managed_endpoint_session_credentials(
credentialType,
endpointId,
executionRoleArn,
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"POST",
"/virtualclusters/$(virtualClusterId)/endpoints/$(endpointId)/credentials",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"credentialType" => credentialType,
"executionRoleArn" => executionRoleArn,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_job_runs(virtual_cluster_id)
list_job_runs(virtual_cluster_id, params::Dict{String,<:Any})
Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark
jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
# Arguments
- `virtual_cluster_id`: The ID of the virtual cluster for which to list the job run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"createdAfter"`: The date and time after which the job runs were submitted.
- `"createdBefore"`: The date and time before which the job runs were submitted.
- `"maxResults"`: The maximum number of job runs that can be listed.
- `"name"`: The name of the job run.
- `"nextToken"`: The token for the next set of job runs to return.
- `"states"`: The states of the job run.
"""
function list_job_runs(virtualClusterId; aws_config::AbstractAWSConfig=global_aws_config())
return emr_containers(
"GET",
"/virtualclusters/$(virtualClusterId)/jobruns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_job_runs(
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"GET",
"/virtualclusters/$(virtualClusterId)/jobruns",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_job_templates()
list_job_templates(params::Dict{String,<:Any})
Lists job templates based on a set of parameters. Job template stores values of StartJobRun
API request in a template and can be used to start a job run. Job template allows two use
cases: avoid repeating recurring StartJobRun API request values, enforcing certain values
in StartJobRun API request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"createdAfter"`: The date and time after which the job templates were created.
- `"createdBefore"`: The date and time before which the job templates were created.
- `"maxResults"`: The maximum number of job templates that can be listed.
- `"nextToken"`: The token for the next set of job templates to return.
"""
function list_job_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return emr_containers(
"GET", "/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 emr_containers(
"GET",
"/jobtemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_managed_endpoints(virtual_cluster_id)
list_managed_endpoints(virtual_cluster_id, params::Dict{String,<:Any})
Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that
connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate
with your virtual cluster.
# Arguments
- `virtual_cluster_id`: The ID of the virtual cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"createdAfter"`: The date and time after which the endpoints are created.
- `"createdBefore"`: The date and time before which the endpoints are created.
- `"maxResults"`: The maximum number of managed endpoints that can be listed.
- `"nextToken"`: The token for the next set of managed endpoints to return.
- `"states"`: The states of the managed endpoints.
- `"types"`: The types of the managed endpoints.
"""
function list_managed_endpoints(
virtualClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"GET",
"/virtualclusters/$(virtualClusterId)/endpoints";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_managed_endpoints(
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"GET",
"/virtualclusters/$(virtualClusterId)/endpoints",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_security_configurations()
list_security_configurations(params::Dict{String,<:Any})
Lists security configurations based on a set of parameters. Security configurations in
Amazon EMR on EKS are templates for different security setups. You can use security
configurations to configure the Lake Formation integration setup. You can also create a
security configuration to re-use a security setup each time you create a virtual cluster.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"createdAfter"`: The date and time after which the security configuration was created.
- `"createdBefore"`: The date and time before which the security configuration was created.
- `"maxResults"`: The maximum number of security configurations the operation can list.
- `"nextToken"`: The token for the next set of security configurations to return.
"""
function list_security_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return emr_containers(
"GET",
"/securityconfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_security_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"GET",
"/securityconfigurations",
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 the resources.
# Arguments
- `resource_arn`: The ARN of tagged resources.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"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 emr_containers(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_virtual_clusters()
list_virtual_clusters(params::Dict{String,<:Any})
Lists information about the specified virtual cluster. Virtual cluster is a managed entity
on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do
not consume any additional resource in your system. A single virtual cluster maps to a
single Kubernetes namespace. Given this relationship, you can model virtual clusters the
same way you model Kubernetes namespaces to meet your requirements.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"containerProviderId"`: The container provider ID of the virtual cluster.
- `"containerProviderType"`: The container provider type of the virtual cluster. Amazon EKS
is the only supported type as of now.
- `"createdAfter"`: The date and time after which the virtual clusters are created.
- `"createdBefore"`: The date and time before which the virtual clusters are created.
- `"eksAccessEntryIntegrated"`: Optional Boolean that specifies whether the operation
should return the virtual clusters that have the access entry integration enabled or
disabled. If not specified, the operation returns all applicable virtual clusters.
- `"maxResults"`: The maximum number of virtual clusters that can be listed.
- `"nextToken"`: The token for the next set of virtual clusters to return.
- `"states"`: The states of the requested virtual clusters.
"""
function list_virtual_clusters(; aws_config::AbstractAWSConfig=global_aws_config())
return emr_containers(
"GET", "/virtualclusters"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_virtual_clusters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"GET",
"/virtualclusters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_job_run(client_token, virtual_cluster_id)
start_job_run(client_token, virtual_cluster_id, params::Dict{String,<:Any})
Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or
SparkSQL query, that you submit to Amazon EMR on EKS.
# Arguments
- `client_token`: The client idempotency token of the job run request.
- `virtual_cluster_id`: The virtual cluster ID for which the job run request is submitted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"configurationOverrides"`: The configuration overrides for the job run.
- `"executionRoleArn"`: The execution role ARN for the job run.
- `"jobDriver"`: The job driver for the job run.
- `"jobTemplateId"`: The job template ID to be used to start the job run.
- `"jobTemplateParameters"`: The values of job template parameters to start a job run.
- `"name"`: The name of the job run.
- `"releaseLabel"`: The Amazon EMR release version to use for the job run.
- `"retryPolicyConfiguration"`: The retry policy configuration for the job run.
- `"tags"`: The tags assigned to job runs.
"""
function start_job_run(
clientToken, virtualClusterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"POST",
"/virtualclusters/$(virtualClusterId)/jobruns",
Dict{String,Any}("clientToken" => clientToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_job_run(
clientToken,
virtualClusterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_containers(
"POST",
"/virtualclusters/$(virtualClusterId)/jobruns",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => clientToken), 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 tags to resources. A tag is a label that you assign to an Amazon Web Services
resource. Each tag consists of a key and an optional value, both of which you define. Tags
enable you to categorize your Amazon Web Services resources by attributes such as purpose,
owner, or environment. When you have many resources of the same type, you can quickly
identify a specific resource based on the tags you've assigned to it. For example, you can
define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's
owner and stack level. We recommend that you devise a consistent set of tag keys for each
resource type. You can then search and filter the resources based on the tags that you add.
# Arguments
- `resource_arn`: The ARN of resources.
- `tags`: The tags assigned to resources.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return emr_containers(
"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 emr_containers(
"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 resources.
# Arguments
- `resource_arn`: The ARN of resources.
- `tag_keys`: The tag keys of the resources.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_containers(
"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 emr_containers(
"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 | 23699 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: emr_serverless
using AWS.Compat
using AWS.UUIDs
"""
cancel_job_run(application_id, job_run_id)
cancel_job_run(application_id, job_run_id, params::Dict{String,<:Any})
Cancels a job run.
# Arguments
- `application_id`: The ID of the application on which the job run will be canceled.
- `job_run_id`: The ID of the job run to cancel.
"""
function cancel_job_run(
applicationId, jobRunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_serverless(
"DELETE",
"/applications/$(applicationId)/jobruns/$(jobRunId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_job_run(
applicationId,
jobRunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_serverless(
"DELETE",
"/applications/$(applicationId)/jobruns/$(jobRunId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_application(client_token, release_label, type)
create_application(client_token, release_label, type, params::Dict{String,<:Any})
Creates an application.
# Arguments
- `client_token`: The client idempotency token of the application to create. Its value must
be unique for each request.
- `release_label`: The Amazon EMR release associated with the application.
- `type`: The type of application you want to start, such as Spark or Hive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"architecture"`: The CPU architecture of an application.
- `"autoStartConfiguration"`: The configuration for an application to automatically start
on job submission.
- `"autoStopConfiguration"`: The configuration for an application to automatically stop
after a certain amount of time being idle.
- `"imageConfiguration"`: The image configuration for all worker types. You can either set
this parameter or imageConfiguration for each worker type in workerTypeSpecifications.
- `"initialCapacity"`: The capacity to initialize when the application is created.
- `"interactiveConfiguration"`: The interactive configuration object that enables the
interactive use cases to use when running an application.
- `"maximumCapacity"`: The maximum capacity to allocate when the application is created.
This is cumulative across all workers at any given point in time, not just when an
application is created. No new resources will be created once any one of the defined limits
is hit.
- `"monitoringConfiguration"`: The configuration setting for monitoring.
- `"name"`: The name of the application.
- `"networkConfiguration"`: The network configuration for customer VPC connectivity.
- `"runtimeConfiguration"`: The Configuration specifications to use when creating an
application. Each configuration consists of a classification and properties. This
configuration is applied to all the job runs submitted under the application.
- `"tags"`: The tags assigned to the application.
- `"workerTypeSpecifications"`: The key-value pairs that specify worker type to
WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a
Spark or Hive application. Valid worker types include Driver and Executor for Spark
applications and HiveDriver and TezTask for Hive applications. You can either set image
details in this parameter for each worker type, or in imageConfiguration for all worker
types.
"""
function create_application(
clientToken, releaseLabel, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_serverless(
"POST",
"/applications",
Dict{String,Any}(
"clientToken" => clientToken, "releaseLabel" => releaseLabel, "type" => type
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_application(
clientToken,
releaseLabel,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_serverless(
"POST",
"/applications",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"releaseLabel" => releaseLabel,
"type" => type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_application(application_id)
delete_application(application_id, params::Dict{String,<:Any})
Deletes an application. An application has to be in a stopped or created state in order to
be deleted.
# Arguments
- `application_id`: The ID of the application that will be deleted.
"""
function delete_application(
applicationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_serverless(
"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 emr_serverless(
"DELETE",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_application(application_id)
get_application(application_id, params::Dict{String,<:Any})
Displays detailed information about a specified application.
# Arguments
- `application_id`: The ID of the application that will be described.
"""
function get_application(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return emr_serverless(
"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 emr_serverless(
"GET",
"/applications/$(applicationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dashboard_for_job_run(application_id, job_run_id)
get_dashboard_for_job_run(application_id, job_run_id, params::Dict{String,<:Any})
Creates and returns a URL that you can use to access the application UIs for a job run. For
jobs in a running state, the application UI is a live user interface such as the Spark or
Tez web UI. For completed jobs, the application UI is a persistent application user
interface such as the Spark History Server or persistent Tez UI. The URL is valid for one
hour after you generate it. To access the application UI after that hour elapses, you must
invoke the API again to generate a new URL.
# Arguments
- `application_id`: The ID of the application.
- `job_run_id`: The ID of the job run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attempt"`: An optimal parameter that indicates the amount of attempts for the job. If
not specified, this value defaults to the attempt of the latest job.
"""
function get_dashboard_for_job_run(
applicationId, jobRunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_serverless(
"GET",
"/applications/$(applicationId)/jobruns/$(jobRunId)/dashboard";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dashboard_for_job_run(
applicationId,
jobRunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_serverless(
"GET",
"/applications/$(applicationId)/jobruns/$(jobRunId)/dashboard",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job_run(application_id, job_run_id)
get_job_run(application_id, job_run_id, params::Dict{String,<:Any})
Displays detailed information about a job run.
# Arguments
- `application_id`: The ID of the application on which the job run is submitted.
- `job_run_id`: The ID of the job run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attempt"`: An optimal parameter that indicates the amount of attempts for the job. If
not specified, this value defaults to the attempt of the latest job.
"""
function get_job_run(
applicationId, jobRunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_serverless(
"GET",
"/applications/$(applicationId)/jobruns/$(jobRunId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job_run(
applicationId,
jobRunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_serverless(
"GET",
"/applications/$(applicationId)/jobruns/$(jobRunId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_applications()
list_applications(params::Dict{String,<:Any})
Lists applications based on a set of parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of applications that can be listed.
- `"nextToken"`: The token for the next set of application results.
- `"states"`: An optional filter for application states. Note that if this filter contains
multiple states, the resulting list will be grouped by the state.
"""
function list_applications(; aws_config::AbstractAWSConfig=global_aws_config())
return emr_serverless(
"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 emr_serverless(
"GET",
"/applications",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_job_run_attempts(application_id, job_run_id)
list_job_run_attempts(application_id, job_run_id, params::Dict{String,<:Any})
Lists all attempt of a job run.
# Arguments
- `application_id`: The ID of the application for which to list job runs.
- `job_run_id`: The ID of the job run to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of job run attempts to list.
- `"nextToken"`: The token for the next set of job run attempt results.
"""
function list_job_run_attempts(
applicationId, jobRunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_serverless(
"GET",
"/applications/$(applicationId)/jobruns/$(jobRunId)/attempts";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_job_run_attempts(
applicationId,
jobRunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_serverless(
"GET",
"/applications/$(applicationId)/jobruns/$(jobRunId)/attempts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_job_runs(application_id)
list_job_runs(application_id, params::Dict{String,<:Any})
Lists job runs based on a set of parameters.
# Arguments
- `application_id`: The ID of the application for which to list the job run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"createdAtAfter"`: The lower bound of the option to filter by creation date and time.
- `"createdAtBefore"`: The upper bound of the option to filter by creation date and time.
- `"maxResults"`: The maximum number of job runs that can be listed.
- `"mode"`: The mode of the job runs to list.
- `"nextToken"`: The token for the next set of job run results.
- `"states"`: An optional filter for job run states. Note that if this filter contains
multiple states, the resulting list will be grouped by the state.
"""
function list_job_runs(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return emr_serverless(
"GET",
"/applications/$(applicationId)/jobruns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_job_runs(
applicationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_serverless(
"GET",
"/applications/$(applicationId)/jobruns",
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 the resources.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource to list the
tags for. Currently, the supported resources are Amazon EMR Serverless applications and job
runs.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_serverless(
"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 emr_serverless(
"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 a specified application and initializes initial capacity if configured.
# Arguments
- `application_id`: The ID of the application to start.
"""
function start_application(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return emr_serverless(
"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 emr_serverless(
"POST",
"/applications/$(applicationId)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_job_run(application_id, client_token, execution_role_arn)
start_job_run(application_id, client_token, execution_role_arn, params::Dict{String,<:Any})
Starts a job run.
# Arguments
- `application_id`: The ID of the application on which to run the job.
- `client_token`: The client idempotency token of the job run to start. Its value must be
unique for each request.
- `execution_role_arn`: The execution role ARN for the job run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"configurationOverrides"`: The configuration overrides for the job run.
- `"executionTimeoutMinutes"`: The maximum duration for the job run to run. If the job run
runs beyond this duration, it will be automatically cancelled.
- `"jobDriver"`: The job driver for the job run.
- `"mode"`: The mode of the job run when it starts.
- `"name"`: The optional job run name. This doesn't have to be unique.
- `"retryPolicy"`: The retry policy when job run starts.
- `"tags"`: The tags assigned to the job run.
"""
function start_job_run(
applicationId,
clientToken,
executionRoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_serverless(
"POST",
"/applications/$(applicationId)/jobruns",
Dict{String,Any}(
"clientToken" => clientToken, "executionRoleArn" => executionRoleArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_job_run(
applicationId,
clientToken,
executionRoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_serverless(
"POST",
"/applications/$(applicationId)/jobruns",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken, "executionRoleArn" => executionRoleArn
),
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 specified application and releases initial capacity if configured. All scheduled
and running jobs must be completed or cancelled before stopping an application.
# Arguments
- `application_id`: The ID of the application to stop.
"""
function stop_application(applicationId; aws_config::AbstractAWSConfig=global_aws_config())
return emr_serverless(
"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 emr_serverless(
"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})
Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services
resource. Each tag consists of a key and an optional value, both of which you define. Tags
enable you to categorize your Amazon Web Services resources by attributes such as purpose,
owner, or environment. When you have many resources of the same type, you can quickly
identify a specific resource based on the tags you've assigned to it.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource to list the
tags for. Currently, the supported resources are Amazon EMR Serverless applications and job
runs.
- `tags`: The tags to add to the resource. A tag is an array of key-value pairs.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return emr_serverless(
"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 emr_serverless(
"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 resources.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource to list the
tags for. Currently, the supported resources are Amazon EMR Serverless applications and job
runs.
- `tag_keys`: The keys of the tags to be removed.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_serverless(
"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 emr_serverless(
"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, client_token)
update_application(application_id, client_token, params::Dict{String,<:Any})
Updates a specified application. An application has to be in a stopped or created state in
order to be updated.
# Arguments
- `application_id`: The ID of the application to update.
- `client_token`: The client idempotency token of the application to update. Its value must
be unique for each request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"architecture"`: The CPU architecture of an application.
- `"autoStartConfiguration"`: The configuration for an application to automatically start
on job submission.
- `"autoStopConfiguration"`: The configuration for an application to automatically stop
after a certain amount of time being idle.
- `"imageConfiguration"`: The image configuration to be used for all worker types. You can
either set this parameter or imageConfiguration for each worker type in
WorkerTypeSpecificationInput.
- `"initialCapacity"`: The capacity to initialize when the application is updated.
- `"interactiveConfiguration"`: The interactive configuration object that contains new
interactive use cases when the application is updated.
- `"maximumCapacity"`: The maximum capacity to allocate when the application is updated.
This is cumulative across all workers at any given point in time during the lifespan of the
application. No new resources will be created once any one of the defined limits is hit.
- `"monitoringConfiguration"`: The configuration setting for monitoring.
- `"networkConfiguration"`:
- `"releaseLabel"`: The Amazon EMR release label for the application. You can change the
release label to use a different release of Amazon EMR.
- `"runtimeConfiguration"`: The Configuration specifications to use when updating an
application. Each configuration consists of a classification and properties. This
configuration is applied across all the job runs submitted under the application.
- `"workerTypeSpecifications"`: The key-value pairs that specify worker type to
WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a
Spark or Hive application. Valid worker types include Driver and Executor for Spark
applications and HiveDriver and TezTask for Hive applications. You can either set image
details in this parameter for each worker type, or in imageConfiguration for all worker
types.
"""
function update_application(
applicationId, clientToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return emr_serverless(
"PATCH",
"/applications/$(applicationId)",
Dict{String,Any}("clientToken" => clientToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_application(
applicationId,
clientToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return emr_serverless(
"PATCH",
"/applications/$(applicationId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => clientToken), 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 | 48936 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: entityresolution
using AWS.Compat
using AWS.UUIDs
"""
add_policy_statement(action, arn, effect, principal, statement_id)
add_policy_statement(action, arn, effect, principal, statement_id, params::Dict{String,<:Any})
Adds a policy statement object. To retrieve a list of existing policy statements, use the
GetPolicy API.
# Arguments
- `action`: The action that the principal can use on the resource. For example,
entityresolution:GetIdMappingJob, entityresolution:GetMatchingJob.
- `arn`: The Amazon Resource Name (ARN) of the resource that will be accessed by the
principal.
- `effect`: Determines whether the permissions specified in the policy are to be allowed
(Allow) or denied (Deny).
- `principal`: The Amazon Web Services service or Amazon Web Services account that can
access the resource defined as ARN.
- `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:
- `"condition"`: A set of condition keys that you can use in key policies.
"""
function add_policy_statement(
action,
arn,
effect,
principal,
statementId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/policies/$(arn)/$(statementId)",
Dict{String,Any}("action" => action, "effect" => effect, "principal" => principal);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_policy_statement(
action,
arn,
effect,
principal,
statementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/policies/$(arn)/$(statementId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"action" => action, "effect" => effect, "principal" => principal
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_unique_id(unique_ids, workflow_name)
batch_delete_unique_id(unique_ids, workflow_name, params::Dict{String,<:Any})
Deletes multiple unique IDs in a matching workflow.
# Arguments
- `unique_ids`: The unique IDs to delete.
- `workflow_name`: The name of the workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"inputSource"`: The input source for the batch delete unique ID operation.
"""
function batch_delete_unique_id(
uniqueIds, workflowName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"DELETE",
"/matchingworkflows/$(workflowName)/uniqueids",
Dict{String,Any}("headers" => Dict{String,Any}("uniqueIds" => uniqueIds));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_unique_id(
uniqueIds,
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"DELETE",
"/matchingworkflows/$(workflowName)/uniqueids",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("headers" => Dict{String,Any}("uniqueIds" => uniqueIds)),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_id_mapping_workflow(id_mapping_techniques, input_source_config, role_arn, workflow_name)
create_id_mapping_workflow(id_mapping_techniques, input_source_config, role_arn, workflow_name, params::Dict{String,<:Any})
Creates an IdMappingWorkflow object which stores the configuration of the data processing
job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an
existing workflow, use the UpdateIdMappingWorkflow API.
# Arguments
- `id_mapping_techniques`: An object which defines the idMappingType and the
providerProperties.
- `input_source_config`: A list of InputSource objects, which have the fields
InputSourceARN and SchemaName.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes
this role to create resources on your behalf as part of workflow execution.
- `workflow_name`: The name of the workflow. There can't be multiple IdMappingWorkflows
with the same name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the workflow.
- `"outputSourceConfig"`: A list of IdMappingWorkflowOutputSource objects, each of which
contains fields OutputS3Path and Output.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_id_mapping_workflow(
idMappingTechniques,
inputSourceConfig,
roleArn,
workflowName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/idmappingworkflows",
Dict{String,Any}(
"idMappingTechniques" => idMappingTechniques,
"inputSourceConfig" => inputSourceConfig,
"roleArn" => roleArn,
"workflowName" => workflowName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_id_mapping_workflow(
idMappingTechniques,
inputSourceConfig,
roleArn,
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/idmappingworkflows",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"idMappingTechniques" => idMappingTechniques,
"inputSourceConfig" => inputSourceConfig,
"roleArn" => roleArn,
"workflowName" => workflowName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_id_namespace(id_namespace_name, type)
create_id_namespace(id_namespace_name, type, params::Dict{String,<:Any})
Creates an ID namespace object which will help customers provide metadata explaining their
dataset and how to use it. Each ID namespace must have a unique name. To modify an existing
ID namespace, use the UpdateIdNamespace API.
# Arguments
- `id_namespace_name`: The name of the ID namespace.
- `type`: The type of ID namespace. There are two types: SOURCE and TARGET. The SOURCE
contains configurations for sourceId data that will be processed in an ID mapping workflow.
The TARGET contains a configuration of targetId to which all sourceIds will resolve to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the ID namespace.
- `"idMappingWorkflowProperties"`: Determines the properties of IdMappingWorflow where this
IdNamespace can be used as a Source or a Target.
- `"inputSourceConfig"`: A list of InputSource objects, which have the fields
InputSourceARN and SchemaName.
- `"roleArn"`: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes
this role to access the resources defined in this IdNamespace on your behalf as part of the
workflow run.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_id_namespace(
idNamespaceName, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"POST",
"/idnamespaces",
Dict{String,Any}("idNamespaceName" => idNamespaceName, "type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_id_namespace(
idNamespaceName,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/idnamespaces",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("idNamespaceName" => idNamespaceName, "type" => type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_matching_workflow(input_source_config, output_source_config, resolution_techniques, role_arn, workflow_name)
create_matching_workflow(input_source_config, output_source_config, resolution_techniques, role_arn, workflow_name, params::Dict{String,<:Any})
Creates a MatchingWorkflow object which stores the configuration of the data processing job
to be run. It is important to note that there should not be a pre-existing MatchingWorkflow
with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
# Arguments
- `input_source_config`: A list of InputSource objects, which have the fields
InputSourceARN and SchemaName.
- `output_source_config`: A list of OutputSource objects, each of which contains fields
OutputS3Path, ApplyNormalization, and Output.
- `resolution_techniques`: An object which defines the resolutionType and the
ruleBasedProperties.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes
this role to create resources on your behalf as part of workflow execution.
- `workflow_name`: The name of the workflow. There can't be multiple MatchingWorkflows with
the same name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the workflow.
- `"incrementalRunConfig"`: An object which defines an incremental run type and has only
incrementalRunType as a field.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_matching_workflow(
inputSourceConfig,
outputSourceConfig,
resolutionTechniques,
roleArn,
workflowName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/matchingworkflows",
Dict{String,Any}(
"inputSourceConfig" => inputSourceConfig,
"outputSourceConfig" => outputSourceConfig,
"resolutionTechniques" => resolutionTechniques,
"roleArn" => roleArn,
"workflowName" => workflowName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_matching_workflow(
inputSourceConfig,
outputSourceConfig,
resolutionTechniques,
roleArn,
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/matchingworkflows",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"inputSourceConfig" => inputSourceConfig,
"outputSourceConfig" => outputSourceConfig,
"resolutionTechniques" => resolutionTechniques,
"roleArn" => roleArn,
"workflowName" => workflowName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_schema_mapping(mapped_input_fields, schema_name)
create_schema_mapping(mapped_input_fields, schema_name, params::Dict{String,<:Any})
Creates a schema mapping, which defines the schema of the input customer records table. The
SchemaMapping also provides Entity Resolution with some metadata about the table, such as
the attribute types of the columns and which columns to match on.
# Arguments
- `mapped_input_fields`: A list of MappedInputFields. Each MappedInputField corresponds to
a column the source data table, and contains column name plus additional information that
Entity Resolution uses for matching.
- `schema_name`: The name of the schema. There can't be multiple SchemaMappings with the
same name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the schema.
- `"tags"`: The tags used to organize, track, or control access for this resource.
"""
function create_schema_mapping(
mappedInputFields, schemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"POST",
"/schemas",
Dict{String,Any}(
"mappedInputFields" => mappedInputFields, "schemaName" => schemaName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_schema_mapping(
mappedInputFields,
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/schemas",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"mappedInputFields" => mappedInputFields, "schemaName" => schemaName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_id_mapping_workflow(workflow_name)
delete_id_mapping_workflow(workflow_name, params::Dict{String,<:Any})
Deletes the IdMappingWorkflow with a given name. This operation will succeed even if a
workflow with the given name does not exist.
# Arguments
- `workflow_name`: The name of the workflow to be deleted.
"""
function delete_id_mapping_workflow(
workflowName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"DELETE",
"/idmappingworkflows/$(workflowName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_id_mapping_workflow(
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"DELETE",
"/idmappingworkflows/$(workflowName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_id_namespace(id_namespace_name)
delete_id_namespace(id_namespace_name, params::Dict{String,<:Any})
Deletes the IdNamespace with a given name.
# Arguments
- `id_namespace_name`: The name of the ID namespace.
"""
function delete_id_namespace(
idNamespaceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"DELETE",
"/idnamespaces/$(idNamespaceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_id_namespace(
idNamespaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"DELETE",
"/idnamespaces/$(idNamespaceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_matching_workflow(workflow_name)
delete_matching_workflow(workflow_name, params::Dict{String,<:Any})
Deletes the MatchingWorkflow with a given name. This operation will succeed even if a
workflow with the given name does not exist.
# Arguments
- `workflow_name`: The name of the workflow to be retrieved.
"""
function delete_matching_workflow(
workflowName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"DELETE",
"/matchingworkflows/$(workflowName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_matching_workflow(
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"DELETE",
"/matchingworkflows/$(workflowName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy_statement(arn, statement_id)
delete_policy_statement(arn, statement_id, params::Dict{String,<:Any})
Deletes the policy statement.
# Arguments
- `arn`: The ARN of the resource for which the policy need to be deleted.
- `statement_id`: A statement identifier that differentiates the statement from others in
the same policy.
"""
function delete_policy_statement(
arn, statementId; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"DELETE",
"/policies/$(arn)/$(statementId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_policy_statement(
arn,
statementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"DELETE",
"/policies/$(arn)/$(statementId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_schema_mapping(schema_name)
delete_schema_mapping(schema_name, params::Dict{String,<:Any})
Deletes the SchemaMapping with a given name. This operation will succeed even if a schema
with the given name does not exist. This operation will fail if there is a MatchingWorkflow
object that references the SchemaMapping in the workflow's InputSourceConfig.
# Arguments
- `schema_name`: The name of the schema to delete.
"""
function delete_schema_mapping(
schemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"DELETE",
"/schemas/$(schemaName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_schema_mapping(
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"DELETE",
"/schemas/$(schemaName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_id_mapping_job(job_id, workflow_name)
get_id_mapping_job(job_id, workflow_name, params::Dict{String,<:Any})
Gets the status, metrics, and errors (if there are any) that are associated with a job.
# Arguments
- `job_id`: The ID of the job.
- `workflow_name`: The name of the workflow.
"""
function get_id_mapping_job(
jobId, workflowName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/idmappingworkflows/$(workflowName)/jobs/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_id_mapping_job(
jobId,
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"GET",
"/idmappingworkflows/$(workflowName)/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_id_mapping_workflow(workflow_name)
get_id_mapping_workflow(workflow_name, params::Dict{String,<:Any})
Returns the IdMappingWorkflow with a given name, if it exists.
# Arguments
- `workflow_name`: The name of the workflow.
"""
function get_id_mapping_workflow(
workflowName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/idmappingworkflows/$(workflowName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_id_mapping_workflow(
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"GET",
"/idmappingworkflows/$(workflowName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_id_namespace(id_namespace_name)
get_id_namespace(id_namespace_name, params::Dict{String,<:Any})
Returns the IdNamespace with a given name, if it exists.
# Arguments
- `id_namespace_name`: The name of the ID namespace.
"""
function get_id_namespace(
idNamespaceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/idnamespaces/$(idNamespaceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_id_namespace(
idNamespaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"GET",
"/idnamespaces/$(idNamespaceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_match_id(record, workflow_name)
get_match_id(record, workflow_name, params::Dict{String,<:Any})
Returns the corresponding Match ID of a customer record if the record has been processed.
# Arguments
- `record`: The record to fetch the Match ID for.
- `workflow_name`: The name of the workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applyNormalization"`: Normalizes the attributes defined in the schema in the input
data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in
the input table is in a format of 1234567890, Entity Resolution will normalize this field
in the output to (123)-456-7890.
"""
function get_match_id(
record, workflowName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"POST",
"/matchingworkflows/$(workflowName)/matches",
Dict{String,Any}("record" => record);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_match_id(
record,
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/matchingworkflows/$(workflowName)/matches",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("record" => record), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_matching_job(job_id, workflow_name)
get_matching_job(job_id, workflow_name, params::Dict{String,<:Any})
Gets the status, metrics, and errors (if there are any) that are associated with a job.
# Arguments
- `job_id`: The ID of the job.
- `workflow_name`: The name of the workflow.
"""
function get_matching_job(
jobId, workflowName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/matchingworkflows/$(workflowName)/jobs/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_matching_job(
jobId,
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"GET",
"/matchingworkflows/$(workflowName)/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_matching_workflow(workflow_name)
get_matching_workflow(workflow_name, params::Dict{String,<:Any})
Returns the MatchingWorkflow with a given name, if it exists.
# Arguments
- `workflow_name`: The name of the workflow.
"""
function get_matching_workflow(
workflowName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/matchingworkflows/$(workflowName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_matching_workflow(
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"GET",
"/matchingworkflows/$(workflowName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy(arn)
get_policy(arn, params::Dict{String,<:Any})
Returns the resource-based policy.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the resource for which the policy need to be
returned.
"""
function get_policy(arn; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"GET", "/policies/$(arn)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_policy(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/policies/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_provider_service(provider_name, provider_service_name)
get_provider_service(provider_name, provider_service_name, params::Dict{String,<:Any})
Returns the ProviderService of a given name.
# Arguments
- `provider_name`: The name of the provider. This name is typically the company name.
- `provider_service_name`: The ARN (Amazon Resource Name) of the product that the provider
service provides.
"""
function get_provider_service(
providerName, providerServiceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/providerservices/$(providerName)/$(providerServiceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_provider_service(
providerName,
providerServiceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"GET",
"/providerservices/$(providerName)/$(providerServiceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_schema_mapping(schema_name)
get_schema_mapping(schema_name, params::Dict{String,<:Any})
Returns the SchemaMapping of a given name.
# Arguments
- `schema_name`: The name of the schema to be retrieved.
"""
function get_schema_mapping(schemaName; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"GET",
"/schemas/$(schemaName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_schema_mapping(
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"GET",
"/schemas/$(schemaName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_id_mapping_jobs(workflow_name)
list_id_mapping_jobs(workflow_name, params::Dict{String,<:Any})
Lists all ID mapping jobs for a given workflow.
# Arguments
- `workflow_name`: The name of the workflow to be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects returned per page.
- `"nextToken"`: The pagination token from the previous API call.
"""
function list_id_mapping_jobs(
workflowName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/idmappingworkflows/$(workflowName)/jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_id_mapping_jobs(
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"GET",
"/idmappingworkflows/$(workflowName)/jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_id_mapping_workflows()
list_id_mapping_workflows(params::Dict{String,<:Any})
Returns a list of all the IdMappingWorkflows that have been created for an 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 returned per page.
- `"nextToken"`: The pagination token from the previous API call.
"""
function list_id_mapping_workflows(; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"GET", "/idmappingworkflows"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_id_mapping_workflows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/idmappingworkflows",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_id_namespaces()
list_id_namespaces(params::Dict{String,<:Any})
Returns a list of all ID namespaces.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of IdNamespace objects returned per page.
- `"nextToken"`: The pagination token from the previous API call.
"""
function list_id_namespaces(; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"GET", "/idnamespaces"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_id_namespaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/idnamespaces",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_matching_jobs(workflow_name)
list_matching_jobs(workflow_name, params::Dict{String,<:Any})
Lists all jobs for a given workflow.
# Arguments
- `workflow_name`: The name of the workflow to be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects returned per page.
- `"nextToken"`: The pagination token from the previous API call.
"""
function list_matching_jobs(workflowName; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"GET",
"/matchingworkflows/$(workflowName)/jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_matching_jobs(
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"GET",
"/matchingworkflows/$(workflowName)/jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_matching_workflows()
list_matching_workflows(params::Dict{String,<:Any})
Returns a list of all the MatchingWorkflows that have been created for an 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 returned per page.
- `"nextToken"`: The pagination token from the previous API call.
"""
function list_matching_workflows(; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"GET", "/matchingworkflows"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_matching_workflows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/matchingworkflows",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_provider_services()
list_provider_services(params::Dict{String,<:Any})
Returns a list of all the ProviderServices that are available in this Amazon Web Services
Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects returned per page.
- `"nextToken"`: The pagination token from the previous API call.
- `"providerName"`: The name of the provider. This name is typically the company name.
"""
function list_provider_services(; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"GET", "/providerservices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_provider_services(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET",
"/providerservices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_schema_mappings()
list_schema_mappings(params::Dict{String,<:Any})
Returns a list of all the SchemaMappings that have been created for an 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 returned per page.
- `"nextToken"`: The pagination token from the previous API call.
"""
function list_schema_mappings(; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"GET", "/schemas"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_schema_mappings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"GET", "/schemas", 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 an Entity Resolution resource. In Entity Resolution,
SchemaMapping, and MatchingWorkflow can be tagged.
# Arguments
- `resource_arn`: The ARN of the resource for which you want to view tags.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"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 entityresolution(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_policy(arn, policy)
put_policy(arn, policy, params::Dict{String,<:Any})
Updates the resource-based policy.
# Arguments
- `arn`: The Amazon Resource Name (ARN) of the resource for which the policy needs to be
updated.
- `policy`: The resource-based policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"token"`: A unique identifier for the current revision of the policy.
"""
function put_policy(arn, policy; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"PUT",
"/policies/$(arn)",
Dict{String,Any}("policy" => policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_policy(
arn,
policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"PUT",
"/policies/$(arn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("policy" => policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_id_mapping_job(workflow_name)
start_id_mapping_job(workflow_name, params::Dict{String,<:Any})
Starts the IdMappingJob of a workflow. The workflow must have previously been created using
the CreateIdMappingWorkflow endpoint.
# Arguments
- `workflow_name`: The name of the ID mapping job to be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"outputSourceConfig"`: A list of OutputSource objects.
"""
function start_id_mapping_job(
workflowName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"POST",
"/idmappingworkflows/$(workflowName)/jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_id_mapping_job(
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/idmappingworkflows/$(workflowName)/jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_matching_job(workflow_name)
start_matching_job(workflow_name, params::Dict{String,<:Any})
Starts the MatchingJob of a workflow. The workflow must have previously been created using
the CreateMatchingWorkflow endpoint.
# Arguments
- `workflow_name`: The name of the matching job to be retrieved.
"""
function start_matching_job(workflowName; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"POST",
"/matchingworkflows/$(workflowName)/jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_matching_job(
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"POST",
"/matchingworkflows/$(workflowName)/jobs",
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 Entity Resolution 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. In Entity Resolution, SchemaMapping and MatchingWorkflow can be tagged.
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, 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 resource for which you want to view tags.
- `tags`: The tags used to organize, track, or control access for this resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return entityresolution(
"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 entityresolution(
"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 Entity Resolution resource. In Entity
Resolution, SchemaMapping, and MatchingWorkflow can be tagged.
# Arguments
- `resource_arn`: The ARN of the resource for which you want to untag.
- `tag_keys`: The list of tag keys to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"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 entityresolution(
"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_id_mapping_workflow(id_mapping_techniques, input_source_config, role_arn, workflow_name)
update_id_mapping_workflow(id_mapping_techniques, input_source_config, role_arn, workflow_name, params::Dict{String,<:Any})
Updates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow,
except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow
must already exist for the method to succeed.
# Arguments
- `id_mapping_techniques`: An object which defines the idMappingType and the
providerProperties.
- `input_source_config`: A list of InputSource objects, which have the fields
InputSourceARN and SchemaName.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes
this role to access Amazon Web Services resources on your behalf.
- `workflow_name`: The name of the workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the workflow.
- `"outputSourceConfig"`: A list of OutputSource objects, each of which contains fields
OutputS3Path and KMSArn.
"""
function update_id_mapping_workflow(
idMappingTechniques,
inputSourceConfig,
roleArn,
workflowName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"PUT",
"/idmappingworkflows/$(workflowName)",
Dict{String,Any}(
"idMappingTechniques" => idMappingTechniques,
"inputSourceConfig" => inputSourceConfig,
"roleArn" => roleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_id_mapping_workflow(
idMappingTechniques,
inputSourceConfig,
roleArn,
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"PUT",
"/idmappingworkflows/$(workflowName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"idMappingTechniques" => idMappingTechniques,
"inputSourceConfig" => inputSourceConfig,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_id_namespace(id_namespace_name)
update_id_namespace(id_namespace_name, params::Dict{String,<:Any})
Updates an existing ID namespace.
# Arguments
- `id_namespace_name`: The name of the ID namespace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the ID namespace.
- `"idMappingWorkflowProperties"`: Determines the properties of IdMappingWorkflow where
this IdNamespace can be used as a Source or a Target.
- `"inputSourceConfig"`: A list of InputSource objects, which have the fields
InputSourceARN and SchemaName.
- `"roleArn"`: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes
this role to access the resources defined in this IdNamespace on your behalf as part of a
workflow run.
"""
function update_id_namespace(
idNamespaceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"PUT",
"/idnamespaces/$(idNamespaceName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_id_namespace(
idNamespaceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"PUT",
"/idnamespaces/$(idNamespaceName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_matching_workflow(input_source_config, output_source_config, resolution_techniques, role_arn, workflow_name)
update_matching_workflow(input_source_config, output_source_config, resolution_techniques, role_arn, workflow_name, params::Dict{String,<:Any})
Updates an existing MatchingWorkflow. This method is identical to CreateMatchingWorkflow,
except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must
already exist for the method to succeed.
# Arguments
- `input_source_config`: A list of InputSource objects, which have the fields
InputSourceARN and SchemaName.
- `output_source_config`: A list of OutputSource objects, each of which contains fields
OutputS3Path, ApplyNormalization, and Output.
- `resolution_techniques`: An object which defines the resolutionType and the
ruleBasedProperties.
- `role_arn`: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes
this role to create resources on your behalf as part of workflow execution.
- `workflow_name`: The name of the workflow to be retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the workflow.
- `"incrementalRunConfig"`: An object which defines an incremental run type and has only
incrementalRunType as a field.
"""
function update_matching_workflow(
inputSourceConfig,
outputSourceConfig,
resolutionTechniques,
roleArn,
workflowName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"PUT",
"/matchingworkflows/$(workflowName)",
Dict{String,Any}(
"inputSourceConfig" => inputSourceConfig,
"outputSourceConfig" => outputSourceConfig,
"resolutionTechniques" => resolutionTechniques,
"roleArn" => roleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_matching_workflow(
inputSourceConfig,
outputSourceConfig,
resolutionTechniques,
roleArn,
workflowName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"PUT",
"/matchingworkflows/$(workflowName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"inputSourceConfig" => inputSourceConfig,
"outputSourceConfig" => outputSourceConfig,
"resolutionTechniques" => resolutionTechniques,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_schema_mapping(mapped_input_fields, schema_name)
update_schema_mapping(mapped_input_fields, schema_name, params::Dict{String,<:Any})
Updates a schema mapping. A schema is immutable if it is being used by a workflow.
Therefore, you can't update a schema mapping if it's associated with a workflow.
# Arguments
- `mapped_input_fields`: A list of MappedInputFields. Each MappedInputField corresponds to
a column the source data table, and contains column name plus additional information that
Entity Resolution uses for matching.
- `schema_name`: The name of the schema. There can't be multiple SchemaMappings with the
same name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the schema.
"""
function update_schema_mapping(
mappedInputFields, schemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return entityresolution(
"PUT",
"/schemas/$(schemaName)",
Dict{String,Any}("mappedInputFields" => mappedInputFields);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_schema_mapping(
mappedInputFields,
schemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return entityresolution(
"PUT",
"/schemas/$(schemaName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("mappedInputFields" => mappedInputFields), 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 | 91964 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: eventbridge
using AWS.Compat
using AWS.UUIDs
"""
activate_event_source(name)
activate_event_source(name, params::Dict{String,<:Any})
Activates a partner event source that has been deactivated. Once activated, your matching
event bus will start receiving events from the event source.
# Arguments
- `name`: The name of the partner event source to activate.
"""
function activate_event_source(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"ActivateEventSource",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function activate_event_source(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ActivateEventSource",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_replay(replay_name)
cancel_replay(replay_name, params::Dict{String,<:Any})
Cancels the specified replay.
# Arguments
- `replay_name`: The name of the replay to cancel.
"""
function cancel_replay(ReplayName; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"CancelReplay",
Dict{String,Any}("ReplayName" => ReplayName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_replay(
ReplayName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"CancelReplay",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ReplayName" => ReplayName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_api_destination(connection_arn, http_method, invocation_endpoint, name)
create_api_destination(connection_arn, http_method, invocation_endpoint, name, params::Dict{String,<:Any})
Creates an API destination, which is an HTTP invocation endpoint configured as a target for
events. API destinations do not support private destinations, such as interface VPC
endpoints. For more information, see API destinations in the EventBridge User Guide.
# Arguments
- `connection_arn`: The ARN of the connection to use for the API destination. The
destination endpoint must support the authorization type specified for the connection.
- `http_method`: The method to use for the request to the HTTP invocation endpoint.
- `invocation_endpoint`: The URL to the HTTP invocation endpoint for the API destination.
- `name`: The name for the API destination to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the API destination to create.
- `"InvocationRateLimitPerSecond"`: The maximum number of requests per second to send to
the HTTP invocation endpoint.
"""
function create_api_destination(
ConnectionArn,
HttpMethod,
InvocationEndpoint,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"CreateApiDestination",
Dict{String,Any}(
"ConnectionArn" => ConnectionArn,
"HttpMethod" => HttpMethod,
"InvocationEndpoint" => InvocationEndpoint,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_api_destination(
ConnectionArn,
HttpMethod,
InvocationEndpoint,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"CreateApiDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConnectionArn" => ConnectionArn,
"HttpMethod" => HttpMethod,
"InvocationEndpoint" => InvocationEndpoint,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_archive(archive_name, event_source_arn)
create_archive(archive_name, event_source_arn, params::Dict{String,<:Any})
Creates an archive of events with the specified settings. When you create an archive,
incoming events might not immediately start being sent to the archive. Allow a short period
of time for changes to take effect. If you do not specify a pattern to filter events sent
to the archive, all events are sent to the archive except replayed events. Replayed events
are not sent to an archive. Archives and schema discovery are not supported for event
buses encrypted using a customer managed key. EventBridge returns an error if: You call
CreateArchive on an event bus set to use a customer managed key for encryption. You call
CreateDiscoverer on an event bus set to use a customer managed key for encryption. You
call UpdatedEventBus to set a customer managed key on an event bus with an archives or
schema discovery enabled. To enable archives or schema discovery on an event bus, choose
to use an Amazon Web Services owned key. For more information, see Data encryption in
EventBridge in the Amazon EventBridge User Guide.
# Arguments
- `archive_name`: The name for the archive to create.
- `event_source_arn`: The ARN of the event bus that sends events to the archive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the archive.
- `"EventPattern"`: An event pattern to use to filter events sent to the archive.
- `"RetentionDays"`: The number of days to retain events for. Default value is 0. If set to
0, events are retained indefinitely
"""
function create_archive(
ArchiveName, EventSourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"CreateArchive",
Dict{String,Any}("ArchiveName" => ArchiveName, "EventSourceArn" => EventSourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_archive(
ArchiveName,
EventSourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"CreateArchive",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ArchiveName" => ArchiveName, "EventSourceArn" => EventSourceArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connection(auth_parameters, authorization_type, name)
create_connection(auth_parameters, authorization_type, name, params::Dict{String,<:Any})
Creates a connection. A connection defines the authorization type and credentials to use
for authorization with an API destination HTTP endpoint.
# Arguments
- `auth_parameters`: A CreateConnectionAuthRequestParameters object that contains the
authorization parameters to use to authorize with the endpoint.
- `authorization_type`: The type of authorization to use for the connection. OAUTH tokens
are refreshed when a 401 or 407 response is returned.
- `name`: The name for the connection to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the connection to create.
"""
function create_connection(
AuthParameters,
AuthorizationType,
Name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"CreateConnection",
Dict{String,Any}(
"AuthParameters" => AuthParameters,
"AuthorizationType" => AuthorizationType,
"Name" => Name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connection(
AuthParameters,
AuthorizationType,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"CreateConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthParameters" => AuthParameters,
"AuthorizationType" => AuthorizationType,
"Name" => Name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_endpoint(event_buses, name, routing_config)
create_endpoint(event_buses, name, routing_config, params::Dict{String,<:Any})
Creates a global endpoint. Global endpoints improve your application's availability by
making it regional-fault tolerant. To do this, you define a primary and secondary Region
with event buses in each Region. You also create a Amazon Route 53 health check that will
tell EventBridge to route events to the secondary Region when an \"unhealthy\" state is
encountered and events will be routed back to the primary Region when the health check
reports a \"healthy\" state.
# Arguments
- `event_buses`: Define the event buses used. The names of the event buses must be
identical in each Region.
- `name`: The name of the global endpoint. For example,
\"Name\":\"us-east-2-custom_bus_A-endpoint\".
- `routing_config`: Configure the routing policy, including the health check and secondary
Region..
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the global endpoint.
- `"ReplicationConfig"`: Enable or disable event replication. The default state is ENABLED
which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event
replication enabled, set the state to DISABLED.
- `"RoleArn"`: The ARN of the role used for replication.
"""
function create_endpoint(
EventBuses, Name, RoutingConfig; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"CreateEndpoint",
Dict{String,Any}(
"EventBuses" => EventBuses, "Name" => Name, "RoutingConfig" => RoutingConfig
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_endpoint(
EventBuses,
Name,
RoutingConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"CreateEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EventBuses" => EventBuses,
"Name" => Name,
"RoutingConfig" => RoutingConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_event_bus(name)
create_event_bus(name, params::Dict{String,<:Any})
Creates a new event bus within your account. This can be a custom event bus which you can
use to receive events from your custom applications and services, or it can be a partner
event bus which can be matched to a partner event source.
# Arguments
- `name`: The name of the new event bus. Custom event bus names can't contain the /
character, but you can use the / character in partner event bus names. In addition, for
partner event buses, the name must exactly match the name of the partner event source that
this event bus is matched to. You can't use the name default for a custom event bus, as
this name is already used for your account's default event bus.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeadLetterConfig"`:
- `"Description"`: The event bus description.
- `"EventSourceName"`: If you are creating a partner event bus, this specifies the partner
event source that the new event bus will be matched with.
- `"KmsKeyIdentifier"`: The identifier of the KMS customer managed key for EventBridge to
use, if you choose to use a customer managed key to encrypt events on this event bus. The
identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web
Services owned key to encrypt events on the event bus. For more information, see Managing
keys in the Key Management Service Developer Guide. Archives and schema discovery are not
supported for event buses encrypted using a customer managed key. EventBridge returns an
error if: You call CreateArchive on an event bus set to use a customer managed key for
encryption. You call CreateDiscoverer on an event bus set to use a customer managed key
for encryption. You call UpdatedEventBus to set a customer managed key on an event bus
with an archives or schema discovery enabled. To enable archives or schema discovery on
an event bus, choose to use an Amazon Web Services owned key. For more information, see
Data encryption in EventBridge in the Amazon EventBridge User Guide.
- `"Tags"`: Tags to associate with the event bus.
"""
function create_event_bus(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"CreateEventBus",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_event_bus(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"CreateEventBus",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_partner_event_source(account, name)
create_partner_event_source(account, name, params::Dict{String,<:Any})
Called by an SaaS partner to create a partner event source. This operation is not used by
Amazon Web Services customers. Each partner event source can be used by one Amazon Web
Services account to create a matching partner event bus in that Amazon Web Services
account. A SaaS partner must create one partner event source for each Amazon Web Services
account that wants to receive those event types. A partner event source creates events
based on resources within the SaaS partner's service or application. An Amazon Web Services
account that creates a partner event bus that matches the partner event source can use that
event bus to receive events from the partner, and then process them using Amazon Web
Services Events rules and targets. Partner event source names follow this format:
partner_name/event_namespace/event_name partner_name is determined during partner
registration, and identifies the partner to Amazon Web Services customers.
event_namespace is determined by the partner, and is a way for the partner to categorize
their events. event_name is determined by the partner, and should uniquely identify an
event-generating resource within the partner system. The event_name must be unique across
all Amazon Web Services customers. This is because the event source is a shared resource
between the partner and customer accounts, and each partner event source unique in the
partner account. The combination of event_namespace and event_name should help Amazon Web
Services customers decide whether to create an event bus to receive these events.
# Arguments
- `account`: The Amazon Web Services account ID that is permitted to create a matching
partner event bus for this partner event source.
- `name`: The name of the partner event source. This name must be unique and must be in the
format partner_name/event_namespace/event_name . The Amazon Web Services account that
wants to use this partner event source must create a partner event bus with a name that
matches the name of the partner event source.
"""
function create_partner_event_source(
Account, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"CreatePartnerEventSource",
Dict{String,Any}("Account" => Account, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_partner_event_source(
Account,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"CreatePartnerEventSource",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Account" => Account, "Name" => Name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deactivate_event_source(name)
deactivate_event_source(name, params::Dict{String,<:Any})
You can use this operation to temporarily stop receiving events from the specified partner
event source. The matching event bus is not deleted. When you deactivate a partner event
source, the source goes into PENDING state. If it remains in PENDING state for more than
two weeks, it is deleted. To activate a deactivated partner event source, use
ActivateEventSource.
# Arguments
- `name`: The name of the partner event source to deactivate.
"""
function deactivate_event_source(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DeactivateEventSource",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deactivate_event_source(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DeactivateEventSource",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deauthorize_connection(name)
deauthorize_connection(name, params::Dict{String,<:Any})
Removes all authorization parameters from the connection. This lets you remove the secret
from the connection so you can reuse it without having to create a new connection.
# Arguments
- `name`: The name of the connection to remove authorization from.
"""
function deauthorize_connection(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DeauthorizeConnection",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deauthorize_connection(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DeauthorizeConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_api_destination(name)
delete_api_destination(name, params::Dict{String,<:Any})
Deletes the specified API destination.
# Arguments
- `name`: The name of the destination to delete.
"""
function delete_api_destination(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DeleteApiDestination",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_api_destination(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DeleteApiDestination",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_archive(archive_name)
delete_archive(archive_name, params::Dict{String,<:Any})
Deletes the specified archive.
# Arguments
- `archive_name`: The name of the archive to delete.
"""
function delete_archive(ArchiveName; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DeleteArchive",
Dict{String,Any}("ArchiveName" => ArchiveName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_archive(
ArchiveName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"DeleteArchive",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ArchiveName" => ArchiveName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connection(name)
delete_connection(name, params::Dict{String,<:Any})
Deletes a connection.
# Arguments
- `name`: The name of the connection to delete.
"""
function delete_connection(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DeleteConnection",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connection(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DeleteConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_endpoint(name)
delete_endpoint(name, params::Dict{String,<:Any})
Delete an existing global endpoint. For more information about global endpoints, see Making
applications Regional-fault tolerant with global endpoints and event replication in the
Amazon EventBridge User Guide .
# Arguments
- `name`: The name of the endpoint you want to delete. For example,
\"Name\":\"us-east-2-custom_bus_A-endpoint\"..
"""
function delete_endpoint(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DeleteEndpoint",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_endpoint(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DeleteEndpoint",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_bus(name)
delete_event_bus(name, params::Dict{String,<:Any})
Deletes the specified custom event bus or partner event bus. All rules associated with this
event bus need to be deleted. You can't delete your account's default event bus.
# Arguments
- `name`: The name of the event bus to delete.
"""
function delete_event_bus(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DeleteEventBus",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_bus(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DeleteEventBus",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_partner_event_source(account, name)
delete_partner_event_source(account, name, params::Dict{String,<:Any})
This operation is used by SaaS partners to delete a partner event source. This operation is
not used by Amazon Web Services customers. When you delete an event source, the status of
the corresponding partner event bus in the Amazon Web Services customer account becomes
DELETED.
# Arguments
- `account`: The Amazon Web Services account ID of the Amazon Web Services customer that
the event source was created for.
- `name`: The name of the event source to delete.
"""
function delete_partner_event_source(
Account, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DeletePartnerEventSource",
Dict{String,Any}("Account" => Account, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_partner_event_source(
Account,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"DeletePartnerEventSource",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Account" => Account, "Name" => Name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule(name)
delete_rule(name, params::Dict{String,<:Any})
Deletes the specified rule. Before you can delete the rule, you must remove all targets,
using RemoveTargets. When you delete a rule, incoming events might continue to match to the
deleted rule. Allow a short period of time for changes to take effect. If you call delete
rule multiple times for the same rule, all calls will succeed. When you call delete rule
for a non-existent custom eventbus, ResourceNotFoundException is returned. Managed rules
are rules created and managed by another Amazon Web Services service on your behalf. These
rules are created by those other Amazon Web Services services to support functionality in
those services. You can delete these rules using the Force option, but you should do so
only if you are sure the other service is not still using that rule.
# Arguments
- `name`: The name of the rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventBusName"`: The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
- `"Force"`: If this is a managed rule, created by an Amazon Web Services service on your
behalf, you must specify Force as True to delete the rule. This parameter is ignored for
rules that are not managed rules. You can check whether a rule is a managed rule by using
DescribeRule or ListRules and checking the ManagedBy field of the response.
"""
function delete_rule(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DeleteRule",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DeleteRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_api_destination(name)
describe_api_destination(name, params::Dict{String,<:Any})
Retrieves details about an API destination.
# Arguments
- `name`: The name of the API destination to retrieve.
"""
function describe_api_destination(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DescribeApiDestination",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_api_destination(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DescribeApiDestination",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_archive(archive_name)
describe_archive(archive_name, params::Dict{String,<:Any})
Retrieves details about an archive.
# Arguments
- `archive_name`: The name of the archive to retrieve.
"""
function describe_archive(ArchiveName; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DescribeArchive",
Dict{String,Any}("ArchiveName" => ArchiveName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_archive(
ArchiveName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"DescribeArchive",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ArchiveName" => ArchiveName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_connection(name)
describe_connection(name, params::Dict{String,<:Any})
Retrieves details about a connection.
# Arguments
- `name`: The name of the connection to retrieve.
"""
function describe_connection(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DescribeConnection",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_connection(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DescribeConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoint(name)
describe_endpoint(name, params::Dict{String,<:Any})
Get the information about an existing global endpoint. For more information about global
endpoints, see Making applications Regional-fault tolerant with global endpoints and event
replication in the Amazon EventBridge User Guide .
# Arguments
- `name`: The name of the endpoint you want to get information about. For example,
\"Name\":\"us-east-2-custom_bus_A-endpoint\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HomeRegion"`: The primary Region of the endpoint you want to get information about. For
example \"HomeRegion\": \"us-east-1\".
"""
function describe_endpoint(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DescribeEndpoint",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_endpoint(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DescribeEndpoint",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_bus()
describe_event_bus(params::Dict{String,<:Any})
Displays details about an event bus in your account. This can include the external Amazon
Web Services accounts that are permitted to write events to your default event bus, and the
associated policy. For custom event buses and partner event buses, it displays the name,
ARN, policy, state, and creation time. To enable your account to receive events from other
accounts on its default event bus, use PutPermission. For more information about partner
event buses, see CreateEventBus.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name or ARN of the event bus to show details for. If you omit this, the
default event bus is displayed.
"""
function describe_event_bus(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DescribeEventBus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_event_bus(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DescribeEventBus", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_event_source(name)
describe_event_source(name, params::Dict{String,<:Any})
This operation lists details about a partner event source that is shared with your account.
# Arguments
- `name`: The name of the partner event source to display the details of.
"""
function describe_event_source(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DescribeEventSource",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_event_source(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DescribeEventSource",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_partner_event_source(name)
describe_partner_event_source(name, params::Dict{String,<:Any})
An SaaS partner can use this operation to list details about a partner event source that
they have created. Amazon Web Services customers do not use this operation. Instead, Amazon
Web Services customers can use DescribeEventSource to see details about a partner event
source that is shared with them.
# Arguments
- `name`: The name of the event source to display.
"""
function describe_partner_event_source(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DescribePartnerEventSource",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_partner_event_source(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DescribePartnerEventSource",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_replay(replay_name)
describe_replay(replay_name, params::Dict{String,<:Any})
Retrieves details about a replay. Use DescribeReplay to determine the progress of a running
replay. A replay processes events to replay based on the time in the event, and replays
them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an
EventEndTime that covers a 20 minute time range, the events are replayed from the first
minute of that 20 minute range first. Then the events from the second minute are replayed.
You can use DescribeReplay to determine the progress of a replay. The value returned for
EventLastReplayedTime indicates the time within the specified time range associated with
the last event replayed.
# Arguments
- `replay_name`: The name of the replay to retrieve.
"""
function describe_replay(ReplayName; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DescribeReplay",
Dict{String,Any}("ReplayName" => ReplayName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_replay(
ReplayName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"DescribeReplay",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ReplayName" => ReplayName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_rule(name)
describe_rule(name, params::Dict{String,<:Any})
Describes the specified rule. DescribeRule does not list the targets of a rule. To see the
targets associated with a rule, use ListTargetsByRule.
# Arguments
- `name`: The name of the rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventBusName"`: The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
"""
function describe_rule(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DescribeRule",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_rule(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DescribeRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_rule(name)
disable_rule(name, params::Dict{String,<:Any})
Disables the specified rule. A disabled rule won't match any events, and won't self-trigger
if it has a schedule expression. When you disable a rule, incoming events might continue to
match to the disabled rule. Allow a short period of time for changes to take effect.
# Arguments
- `name`: The name of the rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventBusName"`: The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
"""
function disable_rule(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"DisableRule",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_rule(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"DisableRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_rule(name)
enable_rule(name, params::Dict{String,<:Any})
Enables the specified rule. If the rule does not exist, the operation fails. When you
enable a rule, incoming events might not immediately start matching to a newly enabled
rule. Allow a short period of time for changes to take effect.
# Arguments
- `name`: The name of the rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventBusName"`: The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
"""
function enable_rule(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"EnableRule",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_rule(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"EnableRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_api_destinations()
list_api_destinations(params::Dict{String,<:Any})
Retrieves a list of API destination in the account in the current Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionArn"`: The ARN of the connection specified for the API destination.
- `"Limit"`: The maximum number of API destinations to include in the response.
- `"NamePrefix"`: A name prefix to filter results returned. Only API destinations with a
name that starts with the prefix are returned.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_api_destinations(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"ListApiDestinations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_api_destinations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListApiDestinations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_archives()
list_archives(params::Dict{String,<:Any})
Lists your archives. You can either list all the archives or you can provide a prefix to
match to the archive names. Filter parameters are exclusive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventSourceArn"`: The ARN of the event source associated with the archive.
- `"Limit"`: The maximum number of results to return.
- `"NamePrefix"`: A name prefix to filter the archives returned. Only archives with name
that match the prefix are returned.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
- `"State"`: The state of the archive.
"""
function list_archives(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"ListArchives"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_archives(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListArchives", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_connections()
list_connections(params::Dict{String,<:Any})
Retrieves a list of connections from the account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionState"`: The state of the connection.
- `"Limit"`: The maximum number of connections to return.
- `"NamePrefix"`: A name prefix to filter results returned. Only connections with a name
that starts with the prefix are returned.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_connections(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"ListConnections"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListConnections", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_endpoints()
list_endpoints(params::Dict{String,<:Any})
List the global endpoints associated with this account. For more information about global
endpoints, see Making applications Regional-fault tolerant with global endpoints and event
replication in the Amazon EventBridge User Guide .
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"HomeRegion"`: The primary Region of the endpoints associated with this account. For
example \"HomeRegion\": \"us-east-1\".
- `"MaxResults"`: The maximum number of results returned by the call.
- `"NamePrefix"`: A value that will return a subset of the endpoints associated with this
account. For example, \"NamePrefix\": \"ABC\" will return all endpoints with \"ABC\" in the
name.
- `"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. Keep all other arguments unchanged. Each
pagination token expires after 24 hours. Using an expired pagination token will return an
HTTP 400 InvalidToken error.
"""
function list_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"ListEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListEndpoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_event_buses()
list_event_buses(params::Dict{String,<:Any})
Lists all the event buses in your account, including the default event bus, custom event
buses, and partner event buses.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifying this limits the number of results returned by this operation. The
operation also returns a NextToken which you can use in a subsequent operation to retrieve
the next set of results.
- `"NamePrefix"`: Specifying this limits the results to only those event buses with names
that start with the specified prefix.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_event_buses(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"ListEventBuses"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_event_buses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListEventBuses", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_event_sources()
list_event_sources(params::Dict{String,<:Any})
You can use this to see all the partner event sources that have been shared with your
Amazon Web Services account. For more information about partner event sources, see
CreateEventBus.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifying this limits the number of results returned by this operation. The
operation also returns a NextToken which you can use in a subsequent operation to retrieve
the next set of results.
- `"NamePrefix"`: Specifying this limits the results to only those partner event sources
with names that start with the specified prefix.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_event_sources(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"ListEventSources"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_event_sources(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListEventSources", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_partner_event_source_accounts(event_source_name)
list_partner_event_source_accounts(event_source_name, params::Dict{String,<:Any})
An SaaS partner can use this operation to display the Amazon Web Services account ID that a
particular partner event source name is associated with. This operation is not used by
Amazon Web Services customers.
# Arguments
- `event_source_name`: The name of the partner event source to display account information
about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: Specifying this limits the number of results returned by this operation. The
operation also returns a NextToken which you can use in a subsequent operation to retrieve
the next set of results.
- `"NextToken"`: The token returned by a previous call to this operation. Specifying this
retrieves the next set of results.
"""
function list_partner_event_source_accounts(
EventSourceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListPartnerEventSourceAccounts",
Dict{String,Any}("EventSourceName" => EventSourceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_partner_event_source_accounts(
EventSourceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"ListPartnerEventSourceAccounts",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EventSourceName" => EventSourceName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_partner_event_sources(name_prefix)
list_partner_event_sources(name_prefix, params::Dict{String,<:Any})
An SaaS partner can use this operation to list all the partner event source names that they
have created. This operation is not used by Amazon Web Services customers.
# Arguments
- `name_prefix`: If you specify this, the results are limited to only those partner event
sources that start with the string you specify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: pecifying this limits the number of results returned by this operation. The
operation also returns a NextToken which you can use in a subsequent operation to retrieve
the next set of results.
- `"NextToken"`: The token returned by a previous call to this operation. Specifying this
retrieves the next set of results.
"""
function list_partner_event_sources(
NamePrefix; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListPartnerEventSources",
Dict{String,Any}("NamePrefix" => NamePrefix);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_partner_event_sources(
NamePrefix,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"ListPartnerEventSources",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("NamePrefix" => NamePrefix), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_replays()
list_replays(params::Dict{String,<:Any})
Lists your replays. You can either list all the replays or you can provide a prefix to
match to the replay names. Filter parameters are exclusive.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventSourceArn"`: The ARN of the archive from which the events are replayed.
- `"Limit"`: The maximum number of replays to retrieve.
- `"NamePrefix"`: A name prefix to filter the replays returned. Only replays with name that
match the prefix are returned.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
- `"State"`: The state of the replay.
"""
function list_replays(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"ListReplays"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_replays(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListReplays", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_rule_names_by_target(target_arn)
list_rule_names_by_target(target_arn, params::Dict{String,<:Any})
Lists the rules for the specified target. You can see which of the rules in Amazon
EventBridge can invoke a specific target in your account. The maximum number of results per
page for requests is 100.
# Arguments
- `target_arn`: The Amazon Resource Name (ARN) of the target resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventBusName"`: The name or ARN of the event bus to list rules for. If you omit this,
the default event bus is used.
- `"Limit"`: The maximum number of results to return.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_rule_names_by_target(
TargetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListRuleNamesByTarget",
Dict{String,Any}("TargetArn" => TargetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_rule_names_by_target(
TargetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"ListRuleNamesByTarget",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TargetArn" => TargetArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_rules()
list_rules(params::Dict{String,<:Any})
Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a
prefix to match to the rule names. The maximum number of results per page for requests is
100. ListRules does not list the targets of a rule. To see the targets associated with a
rule, use ListTargetsByRule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventBusName"`: The name or ARN of the event bus to list the rules for. If you omit
this, the default event bus is used.
- `"Limit"`: The maximum number of results to return.
- `"NamePrefix"`: The prefix matching the rule name.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge("ListRules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListRules", 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 an EventBridge resource. In EventBridge, rules and event
buses can be tagged.
# Arguments
- `resource_arn`: The ARN of the EventBridge resource for which you want to view tags.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"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 eventbridge(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_targets_by_rule(rule)
list_targets_by_rule(rule, params::Dict{String,<:Any})
Lists the targets assigned to the specified rule. The maximum number of results per page
for requests is 100.
# Arguments
- `rule`: The name of the rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventBusName"`: The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
- `"Limit"`: The maximum number of results to return.
- `"NextToken"`: The token returned by a previous call to retrieve the next set of results.
"""
function list_targets_by_rule(Rule; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"ListTargetsByRule",
Dict{String,Any}("Rule" => Rule);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_targets_by_rule(
Rule, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"ListTargetsByRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Rule" => Rule), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_events(entries)
put_events(entries, params::Dict{String,<:Any})
Sends custom events to Amazon EventBridge so that they can be matched to rules. The maximum
size for a PutEvents event entry is 256 KB. Entry size is calculated including the event
and any necessary characters and keys of the JSON representation of the event. To learn
more, see Calculating PutEvents event entry size in the Amazon EventBridge User Guide
PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the
constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of
9,223,372,036,854,775,807. PutEvents will only process nested JSON up to 1100 levels deep.
# Arguments
- `entries`: The entry that defines an event in your system. You can specify several
parameters for the entry such as the source and type of the event, resources associated
with the event, and so on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndpointId"`: The URL subdomain of the endpoint. For example, if the URL for Endpoint
is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo. When
using Java, you must include auth-crt on the class path.
"""
function put_events(Entries; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"PutEvents",
Dict{String,Any}("Entries" => Entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_events(
Entries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"PutEvents",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Entries" => Entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_partner_events(entries)
put_partner_events(entries, params::Dict{String,<:Any})
This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web
Services customers do not use this operation. For information on calculating event batch
size, see Calculating EventBridge PutEvents event entry size in the EventBridge User Guide.
# Arguments
- `entries`: The list of events to write to the event bus.
"""
function put_partner_events(Entries; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"PutPartnerEvents",
Dict{String,Any}("Entries" => Entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_partner_events(
Entries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"PutPartnerEvents",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Entries" => Entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_permission()
put_permission(params::Dict{String,<:Any})
Running PutPermission permits the specified Amazon Web Services account or Amazon Web
Services organization to put events to the specified event bus. Amazon EventBridge
(CloudWatch Events) rules in your account are triggered by these events arriving to an
event bus in your account. For another account to send events to your account, that
external account must have an EventBridge rule with your account's event bus as a target.
To enable multiple Amazon Web Services accounts to put events to your event bus, run
PutPermission once for each of these accounts. Or, if all the accounts are members of the
same Amazon Web Services organization, you can run PutPermission once specifying Principal
as \"*\" and specifying the Amazon Web Services organization ID in Condition, to grant
permissions to all accounts in that organization. If you grant permissions using an
organization, then accounts in that organization must specify a RoleArn with proper
permissions when they use PutTarget to add your account's event bus as a target. For more
information, see Sending and Receiving Events Between Amazon Web Services Accounts in the
Amazon EventBridge User Guide. The permission policy on the event bus cannot exceed 10 KB
in size.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Action"`: The action that you are enabling the other account to perform.
- `"Condition"`: This parameter enables you to limit the permission to accounts that
fulfill a certain condition, such as being a member of a certain Amazon Web Services
organization. For more information about Amazon Web Services Organizations, see What Is
Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide. If
you specify Condition with an Amazon Web Services organization ID, and specify \"*\" as the
value for Principal, you grant permission to all the accounts in the named organization.
The Condition is a JSON string which must contain Type, Key, and Value fields.
- `"EventBusName"`: The name of the event bus associated with the rule. If you omit this,
the default event bus is used.
- `"Policy"`: A JSON string that describes the permission policy statement. You can include
a Policy parameter in the request instead of using the StatementId, Action, Principal, or
Condition parameters.
- `"Principal"`: The 12-digit Amazon Web Services account ID that you are permitting to put
events to your default event bus. Specify \"*\" to permit any account to put events to your
default event bus. If you specify \"*\" without specifying Condition, avoid creating rules
that may match undesirable events. To create more secure rules, make sure that the event
pattern for each rule contains an account field with a specific account ID from which to
receive events. Rules with an account field do not match any events sent from other
accounts.
- `"StatementId"`: An identifier string for the external account that you are granting
permissions to. If you later want to revoke the permission for this external account,
specify this StatementId when you run RemovePermission. Each StatementId must be unique.
"""
function put_permission(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"PutPermission"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function put_permission(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"PutPermission", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_rule(name)
put_rule(name, params::Dict{String,<:Any})
Creates or updates the specified rule. Rules are enabled by default, or based on value of
the state. You can disable a rule using DisableRule. A single rule watches for events from
a single event bus. Events generated by Amazon Web Services services go to your account's
default event bus. Events generated by SaaS partner services or applications go to the
matching partner event bus. If you have custom applications or services, you can specify
whether their events go to your default event bus or a custom event bus that you have
created. For more information, see CreateEventBus. If you are updating an existing rule,
the rule is replaced with what you specify in this PutRule command. If you omit arguments
in PutRule, the old values for those arguments are not kept. Instead, they are replaced
with null values. When you create or update a rule, incoming events might not immediately
start matching to new or updated rules. Allow a short period of time for changes to take
effect. A rule must contain at least an EventPattern or ScheduleExpression. Rules with
EventPatterns are triggered when a matching event is observed. Rules with
ScheduleExpressions self-trigger based on the given schedule. A rule can have both an
EventPattern and a ScheduleExpression, in which case the rule triggers on matching events
as well as on a schedule. When you initially create a rule, you can optionally assign one
or more tags to the rule. 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 rules with certain tag values. To use the PutRule operation and assign tags, you must
have both the events:PutRule and events:TagResource permissions. If you are updating an
existing rule, any tags you specify in the PutRule operation are ignored. To update the
tags of an existing rule, use TagResource and UntagResource. Most services in Amazon Web
Services treat : or / as the same character in Amazon Resource Names (ARNs). However,
EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN
characters when creating event patterns so that they match the ARN syntax in the event you
want to match. In EventBridge, it is possible to create rules that lead to infinite loops,
where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed
on an S3 bucket, and trigger software to change them to the desired state. If the rule is
not written carefully, the subsequent change to the ACLs fires the rule again, creating an
infinite loop. To prevent this, write the rules so that the triggered actions do not
re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a
bad state, instead of after any change. An infinite loop can quickly cause higher than
expected charges. We recommend that you use budgeting, which alerts you when charges exceed
your specified limit. For more information, see Managing Your Costs with Budgets.
# Arguments
- `name`: The name of the rule that you are creating or updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the rule.
- `"EventBusName"`: The name or ARN of the event bus to associate with this rule. If you
omit this, the default event bus is used.
- `"EventPattern"`: The event pattern. For more information, see Amazon EventBridge event
patterns in the Amazon EventBridge User Guide .
- `"RoleArn"`: The Amazon Resource Name (ARN) of the IAM role associated with the rule. If
you're setting an event bus in another account as the target and that account granted
permission to your account through an organization instead of directly by the account ID,
you must specify a RoleArn with proper permissions in the Target structure, instead of here
in this parameter.
- `"ScheduleExpression"`: The scheduling expression. For example, \"cron(0 20 * * ? *)\" or
\"rate(5 minutes)\".
- `"State"`: The state of the rule. Valid values include: DISABLED: The rule is
disabled. EventBridge does not match any events against the rule. ENABLED: The rule is
enabled. EventBridge matches events against the rule, except for Amazon Web Services
management events delivered through CloudTrail.
ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events,
including Amazon Web Services management events delivered through CloudTrail. Management
events provide visibility into management operations that are performed on resources in
your Amazon Web Services account. These are also known as control plane operations. For
more information, see Logging management events in the CloudTrail User Guide, and Filtering
management events from Amazon Web Services services in the Amazon EventBridge User Guide .
This value is only valid for rules on the default event bus or custom event buses. It does
not apply to partner event buses.
- `"Tags"`: The list of key-value pairs to associate with the rule.
"""
function put_rule(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"PutRule",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_rule(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"PutRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_targets(rule, targets)
put_targets(rule, targets, params::Dict{String,<:Any})
Adds the specified targets to the specified rule, or updates the targets if they are
already associated with the rule. Targets are the resources that are invoked when a rule is
triggered. The maximum number of entries per request is 10. Each rule can have up to five
(5) targets associated with it at one time. For a list of services you can configure as
targets for events, see EventBridge targets in the Amazon EventBridge User Guide .
Creating rules with built-in targets is supported only in the Amazon Web Services
Management Console. The built-in targets are: Amazon EBS CreateSnapshot API call
Amazon EC2 RebootInstances API call Amazon EC2 StopInstances API call Amazon EC2
TerminateInstances API call For some target types, PutTargets provides target-specific
parameters. If the target is a Kinesis data stream, you can optionally specify which shard
the event goes to by using the KinesisParameters argument. To invoke a command on multiple
EC2 instances with one rule, you can use the RunCommandParameters field. To be able to make
API calls against the resources that you own, Amazon EventBridge needs the appropriate
permissions: For Lambda and Amazon SNS resources, EventBridge relies on resource-based
policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines and API
Gateway APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in
PutTargets. For more information, see Authentication and Access Control in the Amazon
EventBridge User Guide . If another Amazon Web Services account is in the same region and
has granted you permission (using PutPermission), you can send events to that account. Set
that account's event bus as a target of the rules in your account. To send the matched
events to the other account, specify that account's event bus as the Arn value when you run
PutTargets. If your account sends events to another account, your account is charged for
each sent event. Each event sent to another account is charged as a custom event. The
account receiving the event is not charged. For more information, see Amazon EventBridge
Pricing. Input, InputPath, and InputTransformer are not available with PutTarget if the
target is an event bus of a different Amazon Web Services account. If you are setting the
event bus of another account as the target, and that account granted permission to your
account through an organization instead of directly by the account ID, then you must
specify a RoleArn with proper permissions in the Target structure. For more information,
see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon
EventBridge User Guide. If you have an IAM role on a cross-account event bus target, a
PutTargets call without a role on the same target (same Id and Arn) will not remove the
role. For more information about enabling cross-account events, see PutPermission. Input,
InputPath, and InputTransformer are mutually exclusive and optional parameters of a target.
When a rule is triggered due to a matched event: If none of the following arguments are
specified for a target, then the entire event is passed to the target in JSON format
(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from
the event is passed to the target). If Input is specified in the form of valid JSON, then
the matched event is overridden with this constant. If InputPath is specified in the form
of JSONPath (for example, .detail), then only the part of the event specified in the path
is passed to the target (for example, only the detail part of the event is passed). If
InputTransformer is specified, then one or more specified JSONPaths are extracted from the
event and used as values in a template that you specify as the input to the target. When
you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket
notation. When you add targets to a rule and the associated rule triggers soon after, new
or updated targets might not be immediately invoked. Allow a short period of time for
changes to take effect. This action can partially fail if too many requests are made at the
same time. If that happens, FailedEntryCount is non-zero in the response and each entry in
FailedEntries provides the ID of the failed target and the error code.
# Arguments
- `rule`: The name of the rule.
- `targets`: The targets to update or add to the rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventBusName"`: The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
"""
function put_targets(Rule, Targets; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"PutTargets",
Dict{String,Any}("Rule" => Rule, "Targets" => Targets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_targets(
Rule,
Targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"PutTargets",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Rule" => Rule, "Targets" => Targets), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_permission()
remove_permission(params::Dict{String,<:Any})
Revokes the permission of another Amazon Web Services account to be able to put events to
the specified event bus. Specify the account to revoke by the StatementId value that you
associated with the account when you granted it permission with PutPermission. You can find
the StatementId by using DescribeEventBus.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventBusName"`: The name of the event bus to revoke permissions for. If you omit this,
the default event bus is used.
- `"RemoveAllPermissions"`: Specifies whether to remove all permissions.
- `"StatementId"`: The statement ID corresponding to the account that is no longer allowed
to put events to the default event bus.
"""
function remove_permission(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"RemovePermission"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function remove_permission(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"RemovePermission", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
remove_targets(ids, rule)
remove_targets(ids, rule, params::Dict{String,<:Any})
Removes the specified targets from the specified rule. When the rule is triggered, those
targets are no longer be invoked. A successful execution of RemoveTargets doesn't
guarantee all targets are removed from the rule, it means that the target(s) listed in the
request are removed. When you remove a target, when the associated rule triggers, removed
targets might continue to be invoked. Allow a short period of time for changes to take
effect. This action can partially fail if too many requests are made at the same time. If
that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries
provides the ID of the failed target and the error code. The maximum number of entries per
request is 10.
# Arguments
- `ids`: The IDs of the targets to remove from the rule.
- `rule`: The name of the rule.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EventBusName"`: The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
- `"Force"`: If this is a managed rule, created by an Amazon Web Services service on your
behalf, you must specify Force as True to remove targets. This parameter is ignored for
rules that are not managed rules. You can check whether a rule is a managed rule by using
DescribeRule or ListRules and checking the ManagedBy field of the response.
"""
function remove_targets(Ids, Rule; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"RemoveTargets",
Dict{String,Any}("Ids" => Ids, "Rule" => Rule);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_targets(
Ids,
Rule,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"RemoveTargets",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Ids" => Ids, "Rule" => Rule), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_replay(destination, event_end_time, event_source_arn, event_start_time, replay_name)
start_replay(destination, event_end_time, event_source_arn, event_start_time, replay_name, params::Dict{String,<:Any})
Starts the specified replay. Events are not necessarily replayed in the exact same order
that they were added to the archive. A replay processes events to replay based on the time
in the event, and replays them using 1 minute intervals. If you specify an EventStartTime
and an EventEndTime that covers a 20 minute time range, the events are replayed from the
first minute of that 20 minute range first. Then the events from the second minute are
replayed. You can use DescribeReplay to determine the progress of a replay. The value
returned for EventLastReplayedTime indicates the time within the specified time range
associated with the last event replayed.
# Arguments
- `destination`: A ReplayDestination object that includes details about the destination for
the replay.
- `event_end_time`: A time stamp for the time to stop replaying events. Only events that
occurred between the EventStartTime and EventEndTime are replayed.
- `event_source_arn`: The ARN of the archive to replay events from.
- `event_start_time`: A time stamp for the time to start replaying events. Only events that
occurred between the EventStartTime and EventEndTime are replayed.
- `replay_name`: The name of the replay to start.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the replay to start.
"""
function start_replay(
Destination,
EventEndTime,
EventSourceArn,
EventStartTime,
ReplayName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"StartReplay",
Dict{String,Any}(
"Destination" => Destination,
"EventEndTime" => EventEndTime,
"EventSourceArn" => EventSourceArn,
"EventStartTime" => EventStartTime,
"ReplayName" => ReplayName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_replay(
Destination,
EventEndTime,
EventSourceArn,
EventStartTime,
ReplayName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"StartReplay",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Destination" => Destination,
"EventEndTime" => EventEndTime,
"EventSourceArn" => EventSourceArn,
"EventStartTime" => EventStartTime,
"ReplayName" => ReplayName,
),
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 EventBridge 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. In EventBridge, rules and event buses can be tagged. 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, 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. You can associate as
many as 50 tags with a resource.
# Arguments
- `resource_arn`: The ARN of the EventBridge resource that you're adding tags to.
- `tags`: The list of key-value pairs to associate with the resource.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"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 eventbridge(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceARN" => ResourceARN, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_event_pattern(event, event_pattern)
test_event_pattern(event, event_pattern, params::Dict{String,<:Any})
Tests whether the specified event pattern matches the provided event. Most services in
Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).
However, EventBridge uses an exact match in event patterns and rules. Be sure to use the
correct ARN characters when creating event patterns so that they match the ARN syntax in
the event you want to match.
# Arguments
- `event`: The event, in JSON format, to test against the event pattern. The JSON must
follow the format specified in Amazon Web Services Events, and the following fields are
mandatory: id account source time region resources detail-type
- `event_pattern`: The event pattern. For more information, see Events and Event Patterns
in the Amazon EventBridge User Guide .
"""
function test_event_pattern(
Event, EventPattern; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"TestEventPattern",
Dict{String,Any}("Event" => Event, "EventPattern" => EventPattern);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_event_pattern(
Event,
EventPattern,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"TestEventPattern",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Event" => Event, "EventPattern" => EventPattern),
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 EventBridge resource. In Amazon EventBridge
(CloudWatch Events), rules and event buses can be tagged.
# Arguments
- `resource_arn`: The ARN of the EventBridge resource from which you are removing tags.
- `tag_keys`: The list of tag keys to remove from the resource.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"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 eventbridge(
"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_api_destination(name)
update_api_destination(name, params::Dict{String,<:Any})
Updates an API destination.
# Arguments
- `name`: The name of the API destination to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionArn"`: The ARN of the connection to use for the API destination.
- `"Description"`: The name of the API destination to update.
- `"HttpMethod"`: The method to use for the API destination.
- `"InvocationEndpoint"`: The URL to the endpoint to use for the API destination.
- `"InvocationRateLimitPerSecond"`: The maximum number of invocations per second to send to
the API destination.
"""
function update_api_destination(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"UpdateApiDestination",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_api_destination(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"UpdateApiDestination",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_archive(archive_name)
update_archive(archive_name, params::Dict{String,<:Any})
Updates the specified archive.
# Arguments
- `archive_name`: The name of the archive to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The description for the archive.
- `"EventPattern"`: The event pattern to use to filter events sent to the archive.
- `"RetentionDays"`: The number of days to retain events in the archive.
"""
function update_archive(ArchiveName; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"UpdateArchive",
Dict{String,Any}("ArchiveName" => ArchiveName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_archive(
ArchiveName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return eventbridge(
"UpdateArchive",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ArchiveName" => ArchiveName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_connection(name)
update_connection(name, params::Dict{String,<:Any})
Updates settings for a connection.
# Arguments
- `name`: The name of the connection to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthParameters"`: The authorization parameters to use for the connection.
- `"AuthorizationType"`: The type of authorization to use for the connection.
- `"Description"`: A description for the connection.
"""
function update_connection(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"UpdateConnection",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connection(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"UpdateConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_endpoint(name)
update_endpoint(name, params::Dict{String,<:Any})
Update an existing endpoint. For more information about global endpoints, see Making
applications Regional-fault tolerant with global endpoints and event replication in the
Amazon EventBridge User Guide .
# Arguments
- `name`: The name of the endpoint you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description for the endpoint.
- `"EventBuses"`: Define event buses used for replication.
- `"ReplicationConfig"`: Whether event replication was enabled or disabled by this request.
- `"RoleArn"`: The ARN of the role used by event replication for this request.
- `"RoutingConfig"`: Configure the routing policy, including the health check and secondary
Region.
"""
function update_endpoint(Name; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"UpdateEndpoint",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_endpoint(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"UpdateEndpoint",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_event_bus()
update_event_bus(params::Dict{String,<:Any})
Updates the specified event bus.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeadLetterConfig"`:
- `"Description"`: The event bus description.
- `"KmsKeyIdentifier"`: The identifier of the KMS customer managed key for EventBridge to
use, if you choose to use a customer managed key to encrypt events on this event bus. The
identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web
Services owned key to encrypt events on the event bus. For more information, see Managing
keys in the Key Management Service Developer Guide. Archives and schema discovery are not
supported for event buses encrypted using a customer managed key. EventBridge returns an
error if: You call CreateArchive on an event bus set to use a customer managed key for
encryption. You call CreateDiscoverer on an event bus set to use a customer managed key
for encryption. You call UpdatedEventBus to set a customer managed key on an event bus
with an archives or schema discovery enabled. To enable archives or schema discovery on
an event bus, choose to use an Amazon Web Services owned key. For more information, see
Data encryption in EventBridge in the Amazon EventBridge User Guide.
- `"Name"`: The name of the event bus.
"""
function update_event_bus(; aws_config::AbstractAWSConfig=global_aws_config())
return eventbridge(
"UpdateEventBus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_event_bus(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return eventbridge(
"UpdateEventBus", 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 | 63968 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: evidently
using AWS.Compat
using AWS.UUIDs
"""
batch_evaluate_feature(project, requests)
batch_evaluate_feature(project, requests, params::Dict{String,<:Any})
This operation assigns feature variation to user sessions. For each user session, you pass
in an entityID that represents the user. Evidently then checks the evaluation rules and
assigns the variation. The first rules that are evaluated are the override rules. If the
user's entityID matches an override rule, the user is served the variation specified by
that rule. Next, if there is a launch of the feature, the user might be assigned to a
variation in the launch. The chance of this depends on the percentage of users that are
allocated to that launch. If the user is enrolled in the launch, the variation they are
served depends on the allocation of the various feature variations used for the launch. If
the user is not assigned to a launch, and there is an ongoing experiment for this feature,
the user might be assigned to a variation in the experiment. The chance of this depends on
the percentage of users that are allocated to that experiment. If the user is enrolled in
the experiment, the variation they are served depends on the allocation of the various
feature variations used for the experiment. If the user is not assigned to a launch or
experiment, they are served the default variation.
# Arguments
- `project`: The name or ARN of the project that contains the feature being evaluated.
- `requests`: An array of structures, where each structure assigns a feature variation to
one user session.
"""
function batch_evaluate_feature(
project, requests; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"POST",
"/projects/$(project)/evaluations",
Dict{String,Any}("requests" => requests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_evaluate_feature(
project,
requests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/evaluations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("requests" => requests), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_experiment(metric_goals, name, project, treatments)
create_experiment(metric_goals, name, project, treatments, params::Dict{String,<:Any})
Creates an Evidently experiment. Before you create an experiment, you must create the
feature to use for the experiment. An experiment helps you make feature design decisions
based on evidence and data. An experiment can test as many as five variations at once.
Evidently collects experiment data and analyzes it by statistical methods, and provides
clear recommendations about which variations perform better. You can optionally specify a
segment to have the experiment consider only certain audience types in the experiment, such
as using only user sessions from a certain location or who use a certain internet browser.
Don't use this operation to update an existing experiment. Instead, use UpdateExperiment.
# Arguments
- `metric_goals`: An array of structures that defines the metrics used for the experiment,
and whether a higher or lower value for each metric is the goal.
- `name`: A name for the new experiment.
- `project`: The name or ARN of the project that you want to create the new experiment in.
- `treatments`: An array of structures that describe the configuration of each feature
variation used in the experiment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: An optional description of the experiment.
- `"onlineAbConfig"`: A structure that contains the configuration of which variation to use
as the \"control\" version. tThe \"control\" version is used for comparison with other
variations. This structure also specifies how much experiment traffic is allocated to each
variation.
- `"randomizationSalt"`: When Evidently assigns a particular user session to an experiment,
it must use a randomization ID to determine which variation the user session is served.
This randomization ID is a combination of the entity ID and randomizationSalt. If you omit
randomizationSalt, Evidently uses the experiment name as the randomizationSalt.
- `"samplingRate"`: The portion of the available audience that you want to allocate to this
experiment, in thousandths of a percent. The available audience is the total audience minus
the audience that you have allocated to overrides or current launches of this feature. This
is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of
the available audience.
- `"segment"`: Specifies an audience segment to use in the experiment. When a segment is
used in an experiment, only user sessions that match the segment pattern are used in the
experiment.
- `"tags"`: Assigns one or more tags (key-value pairs) to the experiment. 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 associate as many as 50 tags with an experiment. For more
information, see Tagging Amazon Web Services resources.
"""
function create_experiment(
metricGoals,
name,
project,
treatments;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/experiments",
Dict{String,Any}(
"metricGoals" => metricGoals, "name" => name, "treatments" => treatments
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_experiment(
metricGoals,
name,
project,
treatments,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/experiments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"metricGoals" => metricGoals, "name" => name, "treatments" => treatments
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_feature(name, project, variations)
create_feature(name, project, variations, params::Dict{String,<:Any})
Creates an Evidently feature that you want to launch or test. You can define up to five
variations of a feature, and use these variations in your launches and experiments. A
feature must be created in a project. For information about creating a project, see
CreateProject. Don't use this operation to update an existing feature. Instead, use
UpdateFeature.
# Arguments
- `name`: The name for the new feature.
- `project`: The name or ARN of the project that is to contain the new feature.
- `variations`: An array of structures that contain the configuration of the feature's
different variations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"defaultVariation"`: The name of the variation to use as the default variation. The
default variation is served to users who are not allocated to any ongoing launches or
experiments of this feature. This variation must also be listed in the variations
structure. If you omit defaultVariation, the first variation listed in the variations
structure is used as the default variation.
- `"description"`: An optional description of the feature.
- `"entityOverrides"`: Specify users that should always be served a specific variation of a
feature. Each user is specified by a key-value pair . For each key, specify a user by
entering their user ID, account ID, or some other identifier. For the value, specify the
name of the variation that they are to be served. This parameter is limited to 2500
overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.
- `"evaluationStrategy"`: Specify ALL_RULES to activate the traffic allocation specified by
any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default
variation to all users instead.
- `"tags"`: Assigns one or more tags (key-value pairs) to the feature. 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 associate as many as 50 tags with a feature. For more
information, see Tagging Amazon Web Services resources.
"""
function create_feature(
name, project, variations; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"POST",
"/projects/$(project)/features",
Dict{String,Any}("name" => name, "variations" => variations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_feature(
name,
project,
variations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/features",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "variations" => variations), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_launch(groups, name, project)
create_launch(groups, name, project, params::Dict{String,<:Any})
Creates a launch of a given feature. Before you create a launch, you must create the
feature to use for the launch. You can use a launch to safely validate new features by
serving them to a specified percentage of your users while you roll out the feature. You
can monitor the performance of the new feature to help you decide when to ramp up traffic
to more users. This helps you reduce risk and identify unintended consequences before you
fully launch the feature. Don't use this operation to update an existing launch. Instead,
use UpdateLaunch.
# Arguments
- `groups`: An array of structures that contains the feature and variations that are to be
used for the launch.
- `name`: The name for the new launch.
- `project`: The name or ARN of the project that you want to create the launch in.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: An optional description for the launch.
- `"metricMonitors"`: An array of structures that define the metrics that will be used to
monitor the launch performance.
- `"randomizationSalt"`: When Evidently assigns a particular user session to a launch, it
must use a randomization ID to determine which variation the user session is served. This
randomization ID is a combination of the entity ID and randomizationSalt. If you omit
randomizationSalt, Evidently uses the launch name as the randomizationSalt.
- `"scheduledSplitsConfig"`: An array of structures that define the traffic allocation
percentages among the feature variations during each step of the launch.
- `"tags"`: Assigns one or more tags (key-value pairs) to the launch. 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 associate as many as 50 tags with a launch. For more
information, see Tagging Amazon Web Services resources.
"""
function create_launch(
groups, name, project; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"POST",
"/projects/$(project)/launches",
Dict{String,Any}("groups" => groups, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_launch(
groups,
name,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/launches",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("groups" => groups, "name" => name), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_project(name)
create_project(name, params::Dict{String,<:Any})
Creates a project, which is the logical object in Evidently that can contain features,
launches, and experiments. Use projects to group similar features together. To update an
existing project, use UpdateProject.
# Arguments
- `name`: The name for the project.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appConfigResource"`: Use this parameter if the project will use client-side evaluation
powered by AppConfig. Client-side evaluation allows your application to assign variations
to user sessions locally instead of by calling the EvaluateFeature operation. This
mitigates the latency and availability risks that come with an API call. For more
information, see Client-side evaluation - powered by AppConfig. This parameter is a
structure that contains information about the AppConfig application and environment that
will be used as for client-side evaluation. To create a project that uses client-side
evaluation, you must have the evidently:ExportProjectAsConfiguration permission.
- `"dataDelivery"`: A structure that contains information about where Evidently is to store
evaluation events for longer term storage, if you choose to do so. If you choose not to
store these events, Evidently deletes them after using them to produce metrics and other
experiment results that you can view.
- `"description"`: An optional description of the project.
- `"tags"`: Assigns one or more tags (key-value pairs) to the project. 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 associate as many as 50 tags with a project. For more
information, see Tagging Amazon Web Services resources.
"""
function create_project(name; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"POST",
"/projects",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"POST",
"/projects",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_segment(name, pattern)
create_segment(name, pattern, params::Dict{String,<:Any})
Use this operation to define a segment of your audience. A segment is a portion of your
audience that share one or more characteristics. Examples could be Chrome browser users,
users in Europe, or Firefox browser users in Europe who also fit other criteria that your
application collects, such as age. Using a segment in an experiment limits that experiment
to evaluate only the users who match the segment criteria. Using one or more segments in a
launch allows you to define different traffic splits for the different audience segments.
For more information about segment pattern syntax, see Segment rule pattern syntax. The
pattern that you define for a segment is matched against the value of evaluationContext,
which is passed into Evidently in the EvaluateFeature operation, when Evidently assigns a
feature variation to a user.
# Arguments
- `name`: A name for the segment.
- `pattern`: The pattern to use for the segment. For more information about pattern syntax,
see Segment rule pattern syntax.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: An optional description for this segment.
- `"tags"`: Assigns one or more tags (key-value pairs) to the segment. 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 associate as many as 50 tags with a segment. For more
information, see Tagging Amazon Web Services resources.
"""
function create_segment(name, pattern; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"POST",
"/segments",
Dict{String,Any}("name" => name, "pattern" => pattern);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_segment(
name,
pattern,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/segments",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("name" => name, "pattern" => pattern), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_experiment(experiment, project)
delete_experiment(experiment, project, params::Dict{String,<:Any})
Deletes an Evidently experiment. The feature used for the experiment is not deleted. To
stop an experiment without deleting it, use StopExperiment.
# Arguments
- `experiment`: The name of the experiment to delete.
- `project`: The name or ARN of the project that contains the experiment to delete.
"""
function delete_experiment(
experiment, project; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"DELETE",
"/projects/$(project)/experiments/$(experiment)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_experiment(
experiment,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"DELETE",
"/projects/$(project)/experiments/$(experiment)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_feature(feature, project)
delete_feature(feature, project, params::Dict{String,<:Any})
Deletes an Evidently feature.
# Arguments
- `feature`: The name of the feature to delete.
- `project`: The name or ARN of the project that contains the feature to delete.
"""
function delete_feature(feature, project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"DELETE",
"/projects/$(project)/features/$(feature)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_feature(
feature,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"DELETE",
"/projects/$(project)/features/$(feature)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_launch(launch, project)
delete_launch(launch, project, params::Dict{String,<:Any})
Deletes an Evidently launch. The feature used for the launch is not deleted. To stop a
launch without deleting it, use StopLaunch.
# Arguments
- `launch`: The name of the launch to delete.
- `project`: The name or ARN of the project that contains the launch to delete.
"""
function delete_launch(launch, project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"DELETE",
"/projects/$(project)/launches/$(launch)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_launch(
launch,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"DELETE",
"/projects/$(project)/launches/$(launch)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project(project)
delete_project(project, params::Dict{String,<:Any})
Deletes an Evidently project. Before you can delete a project, you must delete all the
features that the project contains. To delete a feature, use DeleteFeature.
# Arguments
- `project`: The name or ARN of the project to delete.
"""
function delete_project(project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"DELETE",
"/projects/$(project)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project(
project, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"DELETE",
"/projects/$(project)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_segment(segment)
delete_segment(segment, params::Dict{String,<:Any})
Deletes a segment. You can't delete a segment that is being used in a launch or experiment,
even if that launch or experiment is not currently running.
# Arguments
- `segment`: Specifies the segment to delete.
"""
function delete_segment(segment; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"DELETE",
"/segments/$(segment)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_segment(
segment, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"DELETE",
"/segments/$(segment)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
evaluate_feature(entity_id, feature, project)
evaluate_feature(entity_id, feature, project, params::Dict{String,<:Any})
This operation assigns a feature variation to one given user session. You pass in an
entityID that represents the user. Evidently then checks the evaluation rules and assigns
the variation. The first rules that are evaluated are the override rules. If the user's
entityID matches an override rule, the user is served the variation specified by that rule.
If there is a current launch with this feature that uses segment overrides, and if the user
session's evaluationContext matches a segment rule defined in a segment override, the
configuration in the segment overrides is used. For more information about segments, see
CreateSegment and Use segments to focus your audience. If there is a launch with no segment
overrides, the user might be assigned to a variation in the launch. The chance of this
depends on the percentage of users that are allocated to that launch. If the user is
enrolled in the launch, the variation they are served depends on the allocation of the
various feature variations used for the launch. If the user is not assigned to a launch,
and there is an ongoing experiment for this feature, the user might be assigned to a
variation in the experiment. The chance of this depends on the percentage of users that are
allocated to that experiment. If the experiment uses a segment, then only user sessions
with evaluationContext values that match the segment rule are used in the experiment. If
the user is enrolled in the experiment, the variation they are served depends on the
allocation of the various feature variations used for the experiment. If the user is not
assigned to a launch or experiment, they are served the default variation.
# Arguments
- `entity_id`: An internal ID that represents a unique user of the application. This
entityID is checked against any override rules assigned for this feature.
- `feature`: The name of the feature being evaluated.
- `project`: The name or ARN of the project that contains this feature.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"evaluationContext"`: A JSON object of attributes that you can optionally pass in as
part of the evaluation event sent to Evidently from the user session. Evidently can use
this value to match user sessions with defined audience segments. For more information, see
Use segments to focus your audience. If you include this parameter, the value must be a
JSON object. A JSON array is not supported.
"""
function evaluate_feature(
entityId, feature, project; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"POST",
"/projects/$(project)/evaluations/$(feature)",
Dict{String,Any}("entityId" => entityId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function evaluate_feature(
entityId,
feature,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/evaluations/$(feature)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("entityId" => entityId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_experiment(experiment, project)
get_experiment(experiment, project, params::Dict{String,<:Any})
Returns the details about one experiment. You must already know the experiment name. To
retrieve a list of experiments in your account, use ListExperiments.
# Arguments
- `experiment`: The name of the experiment that you want to see the details of.
- `project`: The name or ARN of the project that contains the experiment.
"""
function get_experiment(
experiment, project; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"GET",
"/projects/$(project)/experiments/$(experiment)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_experiment(
experiment,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"GET",
"/projects/$(project)/experiments/$(experiment)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_experiment_results(experiment, metric_names, project, treatment_names)
get_experiment_results(experiment, metric_names, project, treatment_names, params::Dict{String,<:Any})
Retrieves the results of a running or completed experiment. No results are available until
there have been 100 events for each variation and at least 10 minutes have passed since the
start of the experiment. To increase the statistical power, Evidently performs an
additional offline p-value analysis at the end of the experiment. Offline p-value analysis
can detect statistical significance in some cases where the anytime p-values used during
the experiment do not find statistical significance. Experiment results are available up to
63 days after the start of the experiment. They are not available after that because of
CloudWatch data retention policies.
# Arguments
- `experiment`: The name of the experiment to retrieve the results of.
- `metric_names`: The names of the experiment metrics that you want to see the results of.
- `project`: The name or ARN of the project that contains the experiment that you want to
see the results of.
- `treatment_names`: The names of the experiment treatments that you want to see the
results for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"baseStat"`: The statistic used to calculate experiment results. Currently the only
valid value is mean, which uses the mean of the collected values as the statistic.
- `"endTime"`: The date and time that the experiment ended, if it is completed. This must
be no longer than 30 days after the experiment start time.
- `"period"`: In seconds, the amount of time to aggregate results together.
- `"reportNames"`: The names of the report types that you want to see. Currently,
BayesianInference is the only valid value.
- `"resultStats"`: The statistics that you want to see in the returned results. PValue
specifies to use p-values for the results. A p-value is used in hypothesis testing to
measure how often you are willing to make a mistake in rejecting the null hypothesis. A
general practice is to reject the null hypothesis and declare that the results are
statistically significant when the p-value is less than 0.05. ConfidenceInterval
specifies a confidence interval for the results. The confidence interval represents the
range of values for the chosen metric that is likely to contain the true difference between
the baseStat of a variation and the baseline. Evidently returns the 95% confidence
interval. TreatmentEffect is the difference in the statistic specified by the baseStat
parameter between each variation and the default variation. BaseStat returns the
statistical values collected for the metric for each variation. The statistic uses the same
statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns
the mean of the values collected for each variation.
- `"startTime"`: The date and time that the experiment started.
"""
function get_experiment_results(
experiment,
metricNames,
project,
treatmentNames;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/experiments/$(experiment)/results",
Dict{String,Any}("metricNames" => metricNames, "treatmentNames" => treatmentNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_experiment_results(
experiment,
metricNames,
project,
treatmentNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/experiments/$(experiment)/results",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"metricNames" => metricNames, "treatmentNames" => treatmentNames
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_feature(feature, project)
get_feature(feature, project, params::Dict{String,<:Any})
Returns the details about one feature. You must already know the feature name. To retrieve
a list of features in your account, use ListFeatures.
# Arguments
- `feature`: The name of the feature that you want to retrieve information for.
- `project`: The name or ARN of the project that contains the feature.
"""
function get_feature(feature, project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"GET",
"/projects/$(project)/features/$(feature)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_feature(
feature,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"GET",
"/projects/$(project)/features/$(feature)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_launch(launch, project)
get_launch(launch, project, params::Dict{String,<:Any})
Returns the details about one launch. You must already know the launch name. To retrieve a
list of launches in your account, use ListLaunches.
# Arguments
- `launch`: The name of the launch that you want to see the details of.
- `project`: The name or ARN of the project that contains the launch.
"""
function get_launch(launch, project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"GET",
"/projects/$(project)/launches/$(launch)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_launch(
launch,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"GET",
"/projects/$(project)/launches/$(launch)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_project(project)
get_project(project, params::Dict{String,<:Any})
Returns the details about one launch. You must already know the project name. To retrieve a
list of projects in your account, use ListProjects.
# Arguments
- `project`: The name or ARN of the project that you want to see the details of.
"""
function get_project(project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"GET",
"/projects/$(project)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_project(
project, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"GET",
"/projects/$(project)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_segment(segment)
get_segment(segment, params::Dict{String,<:Any})
Returns information about the specified segment. Specify the segment you want to view by
specifying its ARN.
# Arguments
- `segment`: The ARN of the segment to return information for.
"""
function get_segment(segment; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"GET",
"/segments/$(segment)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_segment(
segment, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"GET",
"/segments/$(segment)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_experiments(project)
list_experiments(project, params::Dict{String,<:Any})
Returns configuration details about all the experiments in the specified project.
# Arguments
- `project`: The name or ARN of the project to return the experiment list from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to include in the response.
- `"nextToken"`: The token to use when requesting the next set of results. You received
this token from a previous ListExperiments operation.
- `"status"`: Use this optional parameter to limit the returned results to only the
experiments with the status that you specify here.
"""
function list_experiments(project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"GET",
"/projects/$(project)/experiments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_experiments(
project, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"GET",
"/projects/$(project)/experiments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_features(project)
list_features(project, params::Dict{String,<:Any})
Returns configuration details about all the features in the specified project.
# Arguments
- `project`: The name or ARN of the project to return the feature list from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to include in the response.
- `"nextToken"`: The token to use when requesting the next set of results. You received
this token from a previous ListFeatures operation.
"""
function list_features(project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"GET",
"/projects/$(project)/features";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_features(
project, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"GET",
"/projects/$(project)/features",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_launches(project)
list_launches(project, params::Dict{String,<:Any})
Returns configuration details about all the launches in the specified project.
# Arguments
- `project`: The name or ARN of the project to return the launch list from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to include in the response.
- `"nextToken"`: The token to use when requesting the next set of results. You received
this token from a previous ListLaunches operation.
- `"status"`: Use this optional parameter to limit the returned results to only the
launches with the status that you specify here.
"""
function list_launches(project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"GET",
"/projects/$(project)/launches";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_launches(
project, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"GET",
"/projects/$(project)/launches",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_projects()
list_projects(params::Dict{String,<:Any})
Returns configuration details about all the projects in the current Region in your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to include in the response.
- `"nextToken"`: The token to use when requesting the next set of results. You received
this token from a previous ListProjects operation.
"""
function list_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"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 evidently(
"GET", "/projects", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_segment_references(segment, type)
list_segment_references(segment, type, params::Dict{String,<:Any})
Use this operation to find which experiments or launches are using a specified segment.
# Arguments
- `segment`: The ARN of the segment that you want to view information for.
- `type`: Specifies whether to return information about launches or experiments that use
this segment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to include in the response. If you omit
this, the default of 50 is used.
- `"nextToken"`: The token to use when requesting the next set of results. You received
this token from a previous ListSegmentReferences operation.
"""
function list_segment_references(
segment, type; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"GET",
"/segments/$(segment)/references",
Dict{String,Any}("type" => type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_segment_references(
segment,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"GET",
"/segments/$(segment)/references",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("type" => type), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_segments()
list_segments(params::Dict{String,<:Any})
Returns a list of audience segments that you have created in your account 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 include in the response. If you omit
this, the default of 50 is used.
- `"nextToken"`: The token to use when requesting the next set of results. You received
this token from a previous ListSegments operation.
"""
function list_segments(; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"GET", "/segments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_segments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"GET", "/segments", 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 an Evidently resource.
# Arguments
- `resource_arn`: The ARN of the resource that you want to see the tags of.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"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 evidently(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_project_events(events, project)
put_project_events(events, project, params::Dict{String,<:Any})
Sends performance events to Evidently. These events can be used to evaluate a launch or an
experiment.
# Arguments
- `events`: An array of event structures that contain the performance data that is being
sent to Evidently.
- `project`: The name or ARN of the project to write the events to.
"""
function put_project_events(
events, project; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"POST",
"/events/projects/$(project)",
Dict{String,Any}("events" => events);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_project_events(
events,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/events/projects/$(project)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("events" => events), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_experiment(analysis_complete_time, experiment, project)
start_experiment(analysis_complete_time, experiment, project, params::Dict{String,<:Any})
Starts an existing experiment. To create an experiment, use CreateExperiment.
# Arguments
- `analysis_complete_time`: The date and time to end the experiment. This must be no more
than 30 days after the experiment starts.
- `experiment`: The name of the experiment to start.
- `project`: The name or ARN of the project that contains the experiment to start.
"""
function start_experiment(
analysisCompleteTime,
experiment,
project;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/experiments/$(experiment)/start",
Dict{String,Any}("analysisCompleteTime" => analysisCompleteTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_experiment(
analysisCompleteTime,
experiment,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/experiments/$(experiment)/start",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("analysisCompleteTime" => analysisCompleteTime),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_launch(launch, project)
start_launch(launch, project, params::Dict{String,<:Any})
Starts an existing launch. To create a launch, use CreateLaunch.
# Arguments
- `launch`: The name of the launch to start.
- `project`: The name or ARN of the project that contains the launch to start.
"""
function start_launch(launch, project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"POST",
"/projects/$(project)/launches/$(launch)/start";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_launch(
launch,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/launches/$(launch)/start",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_experiment(experiment, project)
stop_experiment(experiment, project, params::Dict{String,<:Any})
Stops an experiment that is currently running. If you stop an experiment, you can't resume
it or restart it.
# Arguments
- `experiment`: The name of the experiment to stop.
- `project`: The name or ARN of the project that contains the experiment to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"desiredState"`: Specify whether the experiment is to be considered COMPLETED or
CANCELLED after it stops.
- `"reason"`: A string that describes why you are stopping the experiment.
"""
function stop_experiment(
experiment, project; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"POST",
"/projects/$(project)/experiments/$(experiment)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_experiment(
experiment,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/experiments/$(experiment)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_launch(launch, project)
stop_launch(launch, project, params::Dict{String,<:Any})
Stops a launch that is currently running. After you stop a launch, you will not be able to
resume it or restart it. Also, it will not be evaluated as a rule for traffic allocation,
and the traffic that was allocated to the launch will instead be available to the feature's
experiment, if there is one. Otherwise, all traffic will be served the default variation
after the launch is stopped.
# Arguments
- `launch`: The name of the launch to stop.
- `project`: The name or ARN of the project that contains the launch that you want to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"desiredState"`: Specify whether to consider the launch as COMPLETED or CANCELLED after
it stops.
- `"reason"`: A string that describes why you are stopping the launch.
"""
function stop_launch(launch, project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"POST",
"/projects/$(project)/launches/$(launch)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_launch(
launch,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/projects/$(project)/launches/$(launch)/cancel",
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 CloudWatch Evidently resource.
Projects, features, launches, and experiments 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 resource, 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
resource, 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. For more information, see Tagging Amazon
Web Services resources.
# Arguments
- `resource_arn`: The ARN of the CloudWatch Evidently resource that you're adding tags to.
- `tags`: The list of key-value pairs to associate with the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"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 evidently(
"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_segment_pattern(pattern, payload)
test_segment_pattern(pattern, payload, params::Dict{String,<:Any})
Use this operation to test a rules pattern that you plan to use to create an audience
segment. For more information about segments, see CreateSegment.
# Arguments
- `pattern`: The pattern to test.
- `payload`: A sample evaluationContext JSON block to test against the specified pattern.
"""
function test_segment_pattern(
pattern, payload; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"POST",
"/test-segment-pattern",
Dict{String,Any}("pattern" => pattern, "payload" => payload);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_segment_pattern(
pattern,
payload,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"POST",
"/test-segment-pattern",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("pattern" => pattern, "payload" => payload), 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 CloudWatch Evidently 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 evidently(
"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 evidently(
"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_experiment(experiment, project)
update_experiment(experiment, project, params::Dict{String,<:Any})
Updates an Evidently experiment. Don't use this operation to update an experiment's tag.
Instead, use TagResource.
# Arguments
- `experiment`: The name of the experiment to update.
- `project`: The name or ARN of the project that contains the experiment that you want to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: An optional description of the experiment.
- `"metricGoals"`: An array of structures that defines the metrics used for the experiment,
and whether a higher or lower value for each metric is the goal.
- `"onlineAbConfig"`: A structure that contains the configuration of which variation o use
as the \"control\" version. The \"control\" version is used for comparison with other
variations. This structure also specifies how much experiment traffic is allocated to each
variation.
- `"randomizationSalt"`: When Evidently assigns a particular user session to an experiment,
it must use a randomization ID to determine which variation the user session is served.
This randomization ID is a combination of the entity ID and randomizationSalt. If you omit
randomizationSalt, Evidently uses the experiment name as the randomizationSalt.
- `"removeSegment"`: Removes a segment from being used in an experiment. You can't use this
parameter if the experiment is currently running.
- `"samplingRate"`: The portion of the available audience that you want to allocate to this
experiment, in thousandths of a percent. The available audience is the total audience minus
the audience that you have allocated to overrides or current launches of this feature. This
is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of
the available audience.
- `"segment"`: Adds an audience segment to an experiment. When a segment is used in an
experiment, only user sessions that match the segment pattern are used in the experiment.
You can't use this parameter if the experiment is currently running.
- `"treatments"`: An array of structures that define the variations being tested in the
experiment.
"""
function update_experiment(
experiment, project; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"PATCH",
"/projects/$(project)/experiments/$(experiment)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_experiment(
experiment,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"PATCH",
"/projects/$(project)/experiments/$(experiment)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_feature(feature, project)
update_feature(feature, project, params::Dict{String,<:Any})
Updates an existing feature. You can't use this operation to update the tags of an existing
feature. Instead, use TagResource.
# Arguments
- `feature`: The name of the feature to be updated.
- `project`: The name or ARN of the project that contains the feature to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"addOrUpdateVariations"`: To update variation configurations for this feature, or add
new ones, specify this structure. In this array, include any variations that you want to
add or update. If the array includes a variation name that already exists for this feature,
it is updated. If it includes a new variation name, it is added as a new variation.
- `"defaultVariation"`: The name of the variation to use as the default variation. The
default variation is served to users who are not allocated to any ongoing launches or
experiments of this feature.
- `"description"`: An optional description of the feature.
- `"entityOverrides"`: Specified users that should always be served a specific variation of
a feature. Each user is specified by a key-value pair . For each key, specify a user by
entering their user ID, account ID, or some other identifier. For the value, specify the
name of the variation that they are to be served. This parameter is limited to 2500
overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.
- `"evaluationStrategy"`: Specify ALL_RULES to activate the traffic allocation specified by
any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default
variation to all users instead.
- `"removeVariations"`: Removes a variation from the feature. If the variation you specify
doesn't exist, then this makes no change and does not report an error. This operation fails
if you try to remove a variation that is part of an ongoing launch or experiment.
"""
function update_feature(feature, project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"PATCH",
"/projects/$(project)/features/$(feature)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_feature(
feature,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"PATCH",
"/projects/$(project)/features/$(feature)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_launch(launch, project)
update_launch(launch, project, params::Dict{String,<:Any})
Updates a launch of a given feature. Don't use this operation to update the tags of an
existing launch. Instead, use TagResource.
# Arguments
- `launch`: The name of the launch that is to be updated.
- `project`: The name or ARN of the project that contains the launch that you want to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: An optional description for the launch.
- `"groups"`: An array of structures that contains the feature and variations that are to
be used for the launch.
- `"metricMonitors"`: An array of structures that define the metrics that will be used to
monitor the launch performance.
- `"randomizationSalt"`: When Evidently assigns a particular user session to a launch, it
must use a randomization ID to determine which variation the user session is served. This
randomization ID is a combination of the entity ID and randomizationSalt. If you omit
randomizationSalt, Evidently uses the launch name as the randomizationSalt.
- `"scheduledSplitsConfig"`: An array of structures that define the traffic allocation
percentages among the feature variations during each step of the launch.
"""
function update_launch(launch, project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"PATCH",
"/projects/$(project)/launches/$(launch)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_launch(
launch,
project,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return evidently(
"PATCH",
"/projects/$(project)/launches/$(launch)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_project(project)
update_project(project, params::Dict{String,<:Any})
Updates the description of an existing project. To create a new project, use CreateProject.
Don't use this operation to update the data storage options of a project. Instead, use
UpdateProjectDataDelivery. Don't use this operation to update the tags of a project.
Instead, use TagResource.
# Arguments
- `project`: The name or ARN of the project to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"appConfigResource"`: Use this parameter if the project will use client-side evaluation
powered by AppConfig. Client-side evaluation allows your application to assign variations
to user sessions locally instead of by calling the EvaluateFeature operation. This
mitigates the latency and availability risks that come with an API call. allows you to This
parameter is a structure that contains information about the AppConfig application that
will be used for client-side evaluation.
- `"description"`: An optional description of the project.
"""
function update_project(project; aws_config::AbstractAWSConfig=global_aws_config())
return evidently(
"PATCH",
"/projects/$(project)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_project(
project, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"PATCH",
"/projects/$(project)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_project_data_delivery(project)
update_project_data_delivery(project, params::Dict{String,<:Any})
Updates the data storage options for this project. If you store evaluation events, you an
keep them and analyze them on your own. If you choose not to store evaluation events,
Evidently deletes them after using them to produce metrics and other experiment results
that you can view. You can't specify both cloudWatchLogs and s3Destination in the same
operation.
# Arguments
- `project`: The name or ARN of the project that you want to modify the data storage
options for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cloudWatchLogs"`: A structure containing the CloudWatch Logs log group where you want
to store evaluation events.
- `"s3Destination"`: A structure containing the S3 bucket name and bucket prefix where you
want to store evaluation events.
"""
function update_project_data_delivery(
project; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"PATCH",
"/projects/$(project)/data-delivery";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_project_data_delivery(
project, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return evidently(
"PATCH",
"/projects/$(project)/data-delivery",
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 | 81827 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: finspace
using AWS.Compat
using AWS.UUIDs
"""
create_environment(name)
create_environment(name, params::Dict{String,<:Any})
Create a new FinSpace environment.
# Arguments
- `name`: The name of the FinSpace environment to be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataBundles"`: The list of Amazon Resource Names (ARN) of the data bundles to install.
Currently supported data bundle ARNs:
arn:aws:finspace:{Region}::data-bundle/capital-markets-sample - Contains sample Capital
Markets datasets, categories and controlled vocabularies.
arn:aws:finspace:{Region}::data-bundle/taq (default) - Contains trades and quotes data in
addition to sample Capital Markets data.
- `"description"`: The description of the FinSpace environment to be created.
- `"federationMode"`: Authentication mode for the environment. FEDERATED - Users access
FinSpace through Single Sign On (SSO) via your Identity provider. LOCAL - Users access
FinSpace via email and password managed within the FinSpace environment.
- `"federationParameters"`: Configuration information when authentication mode is FEDERATED.
- `"kmsKeyId"`: The KMS key id to encrypt your data in the FinSpace environment.
- `"superuserParameters"`: Configuration information for the superuser.
- `"tags"`: Add tags to your FinSpace environment.
"""
function create_environment(name; aws_config::AbstractAWSConfig=global_aws_config())
return finspace(
"POST",
"/environment",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_environment(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"POST",
"/environment",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_kx_changeset(change_requests, client_token, database_name, environment_id)
create_kx_changeset(change_requests, client_token, database_name, environment_id, params::Dict{String,<:Any})
Creates a changeset for a kdb database. A changeset allows you to add and delete existing
files by using an ordered list of change requests.
# Arguments
- `change_requests`: A list of change request objects that are run in order. A change
request object consists of changeType , s3Path, and dbPath. A changeType can have the
following values: PUT – Adds or updates files in a database. DELETE – Deletes
files in a database. All the change requests require a mandatory dbPath attribute that
defines the path within the database directory. All database paths must start with a
leading / and end with a trailing /. The s3Path attribute defines the s3 source file path
and is required for a PUT change type. The s3path must end with a trailing / if it is a
directory and must end without a trailing / if it is a file. Here are few examples of how
you can use the change request object: This request adds a single sym file at database
root location. { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\",
\"dbPath\":\"/\"} This request adds files in the given s3Path under the 2020.01.02
partition of the database. { \"changeType\": \"PUT\",
\"s3Path\":\"s3://bucket/db/2020.01.02/\", \"dbPath\":\"/2020.01.02/\"} This request
adds files in the given s3Path under the taq table partition of the database. [ {
\"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",
\"dbPath\":\"/2020.01.02/taq/\"}] This request deletes the 2020.01.02 partition of the
database. [{ \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.02/\"} ] The DELETE
request allows you to delete the existing files under the 2020.01.02 partition of the
database, and the PUT request adds a new taq table under it. [ {\"changeType\":
\"DELETE\", \"dbPath\":\"/2020.01.02/\"}, {\"changeType\": \"PUT\",
\"s3Path\":\"s3://bucket/db/2020.01.02/taq/\", \"dbPath\":\"/2020.01.02/taq/\"}]
- `client_token`: A token that ensures idempotency. This token expires in 10 minutes.
- `database_name`: The name of the kdb database.
- `environment_id`: A unique identifier of the kdb environment.
"""
function create_kx_changeset(
changeRequests,
clientToken,
databaseName,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/databases/$(databaseName)/changesets",
Dict{String,Any}("changeRequests" => changeRequests, "clientToken" => clientToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_kx_changeset(
changeRequests,
clientToken,
databaseName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/databases/$(databaseName)/changesets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"changeRequests" => changeRequests, "clientToken" => clientToken
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_kx_cluster(az_mode, cluster_name, cluster_type, environment_id, release_label, vpc_configuration)
create_kx_cluster(az_mode, cluster_name, cluster_type, environment_id, release_label, vpc_configuration, params::Dict{String,<:Any})
Creates a new kdb cluster.
# Arguments
- `az_mode`: The number of availability zones you want to assign per cluster. This can be
one of the following SINGLE – Assigns one availability zone per cluster. MULTI –
Assigns all the availability zones per cluster.
- `cluster_name`: A unique name for the cluster that you want to create.
- `cluster_type`: Specifies the type of KDB database that is being created. The following
types are available: HDB – A Historical Database. The data is only accessible with
read-only permissions from one of the FinSpace managed kdb databases mounted to the
cluster. RDB – A Realtime Database. This type of database captures all the data from a
ticker plant and stores it in memory until the end of day, after which it writes all of its
data to a disk and reloads the HDB. This cluster type requires local storage for temporary
storage of data during the savedown process. If you specify this field in your request, you
must provide the savedownStorageConfiguration parameter. GATEWAY – A gateway cluster
allows you to access data across processes in kdb systems. It allows you to create your own
routing logic using the initialization scripts and custom code. This type of cluster does
not require a writable local storage. GP – A general purpose cluster allows you to
quickly iterate on code during development by granting greater access to system commands
and enabling a fast reload of custom code. This cluster type can optionally mount databases
including cache and savedown storage. For this cluster type, the node count is fixed at 1.
It does not support autoscaling and supports only SINGLE AZ mode. Tickerplant – A
tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It
can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can
persist messages to log, which is readable by any RDB environment. It supports only
single-node that is only one kdb process.
- `environment_id`: A unique identifier for the kdb environment.
- `release_label`: The version of FinSpace managed kdb to run.
- `vpc_configuration`: Configuration details about the network where the Privatelink
endpoint of the cluster resides.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoScalingConfiguration"`: The configuration based on which FinSpace will scale in or
scale out nodes in your cluster.
- `"availabilityZoneId"`: The availability zone identifiers for the requested regions.
- `"cacheStorageConfigurations"`: The configurations for a read only cache storage
associated with a cluster. This cache will be stored as an FSx Lustre that reads from the
S3 store.
- `"capacityConfiguration"`: A structure for the metadata of a cluster. It includes
information like the CPUs needed, memory of instances, and number of instances.
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"clusterDescription"`: A description of the cluster.
- `"code"`: The details of the custom code that you want to use inside a cluster when
analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the
relative path from where the custom code is loaded into the cluster.
- `"commandLineArguments"`: Defines the key-value pairs to make them available inside the
cluster.
- `"databases"`: A list of databases that will be available for querying.
- `"executionRole"`: An IAM role that defines a set of permissions associated with a
cluster. These permissions are assumed when a cluster attempts to access another cluster.
- `"initializationScript"`: Specifies a Q program that will be run at launch of a cluster.
It is a relative path within .zip file that contains the custom code, which will be loaded
on the cluster. It must include the file name itself. For example, somedir/init.q.
- `"savedownStorageConfiguration"`: The size and type of the temporary storage that is used
to hold data during the savedown process. This parameter is required when you choose
clusterType as RDB. All the data written to this storage space is lost when the cluster
node is restarted.
- `"scalingGroupConfiguration"`: The structure that stores the configuration details of a
scaling group.
- `"tags"`: A list of key-value pairs to label the cluster. You can add up to 50 tags to a
cluster.
- `"tickerplantLogConfiguration"`: A configuration to store Tickerplant logs. It consists
of a list of volumes that will be mounted to your cluster. For the cluster type
Tickerplant, the location of the TP volume on the cluster will be available by using the
global variable .aws.tp_log_path.
"""
function create_kx_cluster(
azMode,
clusterName,
clusterType,
environmentId,
releaseLabel,
vpcConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/clusters",
Dict{String,Any}(
"azMode" => azMode,
"clusterName" => clusterName,
"clusterType" => clusterType,
"releaseLabel" => releaseLabel,
"vpcConfiguration" => vpcConfiguration,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_kx_cluster(
azMode,
clusterName,
clusterType,
environmentId,
releaseLabel,
vpcConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/clusters",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"azMode" => azMode,
"clusterName" => clusterName,
"clusterType" => clusterType,
"releaseLabel" => releaseLabel,
"vpcConfiguration" => vpcConfiguration,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_kx_database(client_token, database_name, environment_id)
create_kx_database(client_token, database_name, environment_id, params::Dict{String,<:Any})
Creates a new kdb database in the environment.
# Arguments
- `client_token`: A token that ensures idempotency. This token expires in 10 minutes.
- `database_name`: The name of the kdb database.
- `environment_id`: A unique identifier for the kdb environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the database.
- `"tags"`: A list of key-value pairs to label the kdb database. You can add up to 50 tags
to your kdb database
"""
function create_kx_database(
clientToken,
databaseName,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/databases",
Dict{String,Any}("clientToken" => clientToken, "databaseName" => databaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_kx_database(
clientToken,
databaseName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/databases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken, "databaseName" => databaseName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_kx_dataview(az_mode, client_token, database_name, dataview_name, environment_id)
create_kx_dataview(az_mode, client_token, database_name, dataview_name, environment_id, params::Dict{String,<:Any})
Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed
cache, ready for mounting on kdb clusters. Dataviews are only available for clusters
running on a scaling group. They are not supported on dedicated clusters.
# Arguments
- `az_mode`: The number of availability zones you want to assign per volume. Currently,
FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
- `client_token`: A token that ensures idempotency. This token expires in 10 minutes.
- `database_name`: The name of the database where you want to create a dataview.
- `dataview_name`: A unique identifier for the dataview.
- `environment_id`: A unique identifier for the kdb environment, where you want to create
the dataview.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoUpdate"`: The option to specify whether you want to apply all the future additions
and corrections automatically to the dataview, when you ingest new changesets. The default
value is false.
- `"availabilityZoneId"`: The identifier of the availability zones.
- `"changesetId"`: A unique identifier of the changeset that you want to use to ingest
data.
- `"description"`: A description of the dataview.
- `"readWrite"`: The option to specify whether you want to make the dataview writable to
perform database maintenance. The following are some considerations related to writable
dataviews.

 You cannot create partial writable dataviews. When you create
writeable dataviews you must provide the entire database path. You cannot perform updates
on a writeable dataview. Hence, autoUpdate must be set as False if readWrite is True for a
dataview. You must also use a unique volume for creating a writeable dataview. So, if you
choose a volume that is already in use by another dataview, the dataview creation fails.
Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot
update the readWrite parameter later.
- `"segmentConfigurations"`: The configuration that contains the database path of the data
that you want to place on each selected volume. Each segment must have a unique database
path for each volume. If you do not explicitly specify any database path for a volume, they
are accessible from the cluster through the default S3/object store segment.
- `"tags"`: A list of key-value pairs to label the dataview. You can add up to 50 tags to
a dataview.
"""
function create_kx_dataview(
azMode,
clientToken,
databaseName,
dataviewName,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/databases/$(databaseName)/dataviews",
Dict{String,Any}(
"azMode" => azMode, "clientToken" => clientToken, "dataviewName" => dataviewName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_kx_dataview(
azMode,
clientToken,
databaseName,
dataviewName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/databases/$(databaseName)/dataviews",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"azMode" => azMode,
"clientToken" => clientToken,
"dataviewName" => dataviewName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_kx_environment(kms_key_id, name)
create_kx_environment(kms_key_id, name, params::Dict{String,<:Any})
Creates a managed kdb environment for the account.
# Arguments
- `kms_key_id`: The KMS key ID to encrypt your data in the FinSpace environment.
- `name`: The name of the kdb environment that you want to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"description"`: A description for the kdb environment.
- `"tags"`: A list of key-value pairs to label the kdb environment. You can add up to 50
tags to your kdb environment.
"""
function create_kx_environment(
kmsKeyId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"POST",
"/kx/environments",
Dict{String,Any}(
"kmsKeyId" => kmsKeyId, "name" => name, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_kx_environment(
kmsKeyId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"kmsKeyId" => kmsKeyId, "name" => name, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_kx_scaling_group(availability_zone_id, client_token, environment_id, host_type, scaling_group_name)
create_kx_scaling_group(availability_zone_id, client_token, environment_id, host_type, scaling_group_name, params::Dict{String,<:Any})
Creates a new scaling group.
# Arguments
- `availability_zone_id`: The identifier of the availability zones.
- `client_token`: A token that ensures idempotency. This token expires in 10 minutes.
- `environment_id`: A unique identifier for the kdb environment, where you want to create
the scaling group.
- `host_type`: The memory and CPU capabilities of the scaling group host on which FinSpace
Managed kdb clusters will be placed. You can add one of the following values:
kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
- `scaling_group_name`: A unique identifier for the kdb scaling group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A list of key-value pairs to label the scaling group. You can add up to 50
tags to a scaling group.
"""
function create_kx_scaling_group(
availabilityZoneId,
clientToken,
environmentId,
hostType,
scalingGroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/scalingGroups",
Dict{String,Any}(
"availabilityZoneId" => availabilityZoneId,
"clientToken" => clientToken,
"hostType" => hostType,
"scalingGroupName" => scalingGroupName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_kx_scaling_group(
availabilityZoneId,
clientToken,
environmentId,
hostType,
scalingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/scalingGroups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"availabilityZoneId" => availabilityZoneId,
"clientToken" => clientToken,
"hostType" => hostType,
"scalingGroupName" => scalingGroupName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_kx_user(environment_id, iam_role, user_name)
create_kx_user(environment_id, iam_role, user_name, params::Dict{String,<:Any})
Creates a user in FinSpace kdb environment with an associated IAM role.
# Arguments
- `environment_id`: A unique identifier for the kdb environment where you want to create a
user.
- `iam_role`: The IAM role ARN that will be associated with the user.
- `user_name`: A unique identifier for the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"tags"`: A list of key-value pairs to label the user. You can add up to 50 tags to a
user.
"""
function create_kx_user(
environmentId, iamRole, userName; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/users",
Dict{String,Any}(
"iamRole" => iamRole, "userName" => userName, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_kx_user(
environmentId,
iamRole,
userName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/users",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"iamRole" => iamRole,
"userName" => userName,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_kx_volume(availability_zone_ids, az_mode, environment_id, volume_name, volume_type)
create_kx_volume(availability_zone_ids, az_mode, environment_id, volume_name, volume_type, params::Dict{String,<:Any})
Creates a new volume with a specific amount of throughput and storage capacity.
# Arguments
- `availability_zone_ids`: The identifier of the availability zones.
- `az_mode`: The number of availability zones you want to assign per volume. Currently,
FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
- `environment_id`: A unique identifier for the kdb environment, whose clusters can attach
to the volume.
- `volume_name`: A unique identifier for the volume.
- `volume_type`: The type of file system volume. Currently, FinSpace only supports NAS_1
volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"description"`: A description of the volume.
- `"nas1Configuration"`: Specifies the configuration for the Network attached storage
(NAS_1) file system volume. This parameter is required when you choose volumeType as NAS_1.
- `"tags"`: A list of key-value pairs to label the volume. You can add up to 50 tags to a
volume.
"""
function create_kx_volume(
availabilityZoneIds,
azMode,
environmentId,
volumeName,
volumeType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/kxvolumes",
Dict{String,Any}(
"availabilityZoneIds" => availabilityZoneIds,
"azMode" => azMode,
"volumeName" => volumeName,
"volumeType" => volumeType,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_kx_volume(
availabilityZoneIds,
azMode,
environmentId,
volumeName,
volumeType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"POST",
"/kx/environments/$(environmentId)/kxvolumes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"availabilityZoneIds" => availabilityZoneIds,
"azMode" => azMode,
"volumeName" => volumeName,
"volumeType" => volumeType,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_environment(environment_id)
delete_environment(environment_id, params::Dict{String,<:Any})
Delete an FinSpace environment.
# Arguments
- `environment_id`: The identifier for the FinSpace environment.
"""
function delete_environment(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"DELETE",
"/environment/$(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 finspace(
"DELETE",
"/environment/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_kx_cluster(cluster_name, environment_id)
delete_kx_cluster(cluster_name, environment_id, params::Dict{String,<:Any})
Deletes a kdb cluster.
# Arguments
- `cluster_name`: The name of the cluster that you want to delete.
- `environment_id`: A unique identifier for the kdb environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function delete_kx_cluster(
clusterName, environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/clusters/$(clusterName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_kx_cluster(
clusterName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/clusters/$(clusterName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_kx_cluster_node(cluster_name, environment_id, node_id)
delete_kx_cluster_node(cluster_name, environment_id, node_id, params::Dict{String,<:Any})
Deletes the specified nodes from a cluster.
# Arguments
- `cluster_name`: The name of the cluster, for which you want to delete the nodes.
- `environment_id`: A unique identifier for the kdb environment.
- `node_id`: A unique identifier for the node that you want to delete.
"""
function delete_kx_cluster_node(
clusterName, environmentId, nodeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/clusters/$(clusterName)/nodes/$(nodeId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_kx_cluster_node(
clusterName,
environmentId,
nodeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/clusters/$(clusterName)/nodes/$(nodeId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_kx_database(client_token, database_name, environment_id)
delete_kx_database(client_token, database_name, environment_id, params::Dict{String,<:Any})
Deletes the specified database and all of its associated data. This action is irreversible.
You must copy any data out of the database before deleting it if the data is to be retained.
# Arguments
- `client_token`: A token that ensures idempotency. This token expires in 10 minutes.
- `database_name`: The name of the kdb database that you want to delete.
- `environment_id`: A unique identifier for the kdb environment.
"""
function delete_kx_database(
clientToken,
databaseName,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/databases/$(databaseName)",
Dict{String,Any}("clientToken" => clientToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_kx_database(
clientToken,
databaseName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/databases/$(databaseName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => clientToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_kx_dataview(client_token, database_name, dataview_name, environment_id)
delete_kx_dataview(client_token, database_name, dataview_name, environment_id, params::Dict{String,<:Any})
Deletes the specified dataview. Before deleting a dataview, make sure that it is not in
use by any cluster.
# Arguments
- `client_token`: A token that ensures idempotency. This token expires in 10 minutes.
- `database_name`: The name of the database whose dataview you want to delete.
- `dataview_name`: The name of the dataview that you want to delete.
- `environment_id`: A unique identifier for the kdb environment, from where you want to
delete the dataview.
"""
function delete_kx_dataview(
clientToken,
databaseName,
dataviewName,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/databases/$(databaseName)/dataviews/$(dataviewName)",
Dict{String,Any}("clientToken" => clientToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_kx_dataview(
clientToken,
databaseName,
dataviewName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/databases/$(databaseName)/dataviews/$(dataviewName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => clientToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_kx_environment(environment_id)
delete_kx_environment(environment_id, params::Dict{String,<:Any})
Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will
remove all the associated data and any services running in it.
# Arguments
- `environment_id`: A unique identifier for the kdb environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function delete_kx_environment(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_kx_environment(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_kx_scaling_group(environment_id, scaling_group_name)
delete_kx_scaling_group(environment_id, scaling_group_name, params::Dict{String,<:Any})
Deletes the specified scaling group. This action is irreversible. You cannot delete a
scaling group until all the clusters running on it have been deleted.
# Arguments
- `environment_id`: A unique identifier for the kdb environment, from where you want to
delete the dataview.
- `scaling_group_name`: A unique identifier for the kdb scaling group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function delete_kx_scaling_group(
environmentId, scalingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/scalingGroups/$(scalingGroupName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_kx_scaling_group(
environmentId,
scalingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/scalingGroups/$(scalingGroupName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_kx_user(environment_id, user_name)
delete_kx_user(environment_id, user_name, params::Dict{String,<:Any})
Deletes a user in the specified kdb environment.
# Arguments
- `environment_id`: A unique identifier for the kdb environment.
- `user_name`: A unique identifier for the user that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function delete_kx_user(
environmentId, userName; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/users/$(userName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_kx_user(
environmentId,
userName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/users/$(userName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_kx_volume(environment_id, volume_name)
delete_kx_volume(environment_id, volume_name, params::Dict{String,<:Any})
Deletes a volume. You can only delete a volume if it's not attached to a cluster or a
dataview. When a volume is deleted, any data on the volume is lost. This action is
irreversible.
# Arguments
- `environment_id`: A unique identifier for the kdb environment, whose clusters can attach
to the volume.
- `volume_name`: The name of the volume that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function delete_kx_volume(
environmentId, volumeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/kxvolumes/$(volumeName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_kx_volume(
environmentId,
volumeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"DELETE",
"/kx/environments/$(environmentId)/kxvolumes/$(volumeName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_environment(environment_id)
get_environment(environment_id, params::Dict{String,<:Any})
Returns the FinSpace environment object.
# Arguments
- `environment_id`: The identifier of the FinSpace environment.
"""
function get_environment(environmentId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace(
"GET",
"/environment/$(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 finspace(
"GET",
"/environment/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_kx_changeset(changeset_id, database_name, environment_id)
get_kx_changeset(changeset_id, database_name, environment_id, params::Dict{String,<:Any})
Returns information about a kdb changeset.
# Arguments
- `changeset_id`: A unique identifier of the changeset for which you want to retrieve data.
- `database_name`: The name of the kdb database.
- `environment_id`: A unique identifier for the kdb environment.
"""
function get_kx_changeset(
changesetId,
databaseName,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases/$(databaseName)/changesets/$(changesetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_kx_changeset(
changesetId,
databaseName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases/$(databaseName)/changesets/$(changesetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_kx_cluster(cluster_name, environment_id)
get_kx_cluster(cluster_name, environment_id, params::Dict{String,<:Any})
Retrieves information about a kdb cluster.
# Arguments
- `cluster_name`: The name of the cluster that you want to retrieve.
- `environment_id`: A unique identifier for the kdb environment.
"""
function get_kx_cluster(
clusterName, environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/clusters/$(clusterName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_kx_cluster(
clusterName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/clusters/$(clusterName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_kx_connection_string(cluster_name, environment_id, user_arn)
get_kx_connection_string(cluster_name, environment_id, user_arn, params::Dict{String,<:Any})
Retrieves a connection string for a user to connect to a kdb cluster. You must call this
API using the same role that you have defined while creating a user.
# Arguments
- `cluster_name`: A name of the kdb cluster.
- `environment_id`: A unique identifier for the kdb environment.
- `user_arn`: The Amazon Resource Name (ARN) that identifies the user. For more
information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User
Guide.
"""
function get_kx_connection_string(
clusterName, environmentId, userArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/connectionString",
Dict{String,Any}("clusterName" => clusterName, "userArn" => userArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_kx_connection_string(
clusterName,
environmentId,
userArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/connectionString",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("clusterName" => clusterName, "userArn" => userArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_kx_database(database_name, environment_id)
get_kx_database(database_name, environment_id, params::Dict{String,<:Any})
Returns database information for the specified environment ID.
# Arguments
- `database_name`: The name of the kdb database.
- `environment_id`: A unique identifier for the kdb environment.
"""
function get_kx_database(
databaseName, environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases/$(databaseName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_kx_database(
databaseName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases/$(databaseName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_kx_dataview(database_name, dataview_name, environment_id)
get_kx_dataview(database_name, dataview_name, environment_id, params::Dict{String,<:Any})
Retrieves details of the dataview.
# Arguments
- `database_name`: The name of the database where you created the dataview.
- `dataview_name`: A unique identifier for the dataview.
- `environment_id`: A unique identifier for the kdb environment, from where you want to
retrieve the dataview details.
"""
function get_kx_dataview(
databaseName,
dataviewName,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases/$(databaseName)/dataviews/$(dataviewName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_kx_dataview(
databaseName,
dataviewName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases/$(databaseName)/dataviews/$(dataviewName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_kx_environment(environment_id)
get_kx_environment(environment_id, params::Dict{String,<:Any})
Retrieves all the information for the specified kdb environment.
# Arguments
- `environment_id`: A unique identifier for the kdb environment.
"""
function get_kx_environment(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_kx_environment(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_kx_scaling_group(environment_id, scaling_group_name)
get_kx_scaling_group(environment_id, scaling_group_name, params::Dict{String,<:Any})
Retrieves details of a scaling group.
# Arguments
- `environment_id`: A unique identifier for the kdb environment.
- `scaling_group_name`: A unique identifier for the kdb scaling group.
"""
function get_kx_scaling_group(
environmentId, scalingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/scalingGroups/$(scalingGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_kx_scaling_group(
environmentId,
scalingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/scalingGroups/$(scalingGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_kx_user(environment_id, user_name)
get_kx_user(environment_id, user_name, params::Dict{String,<:Any})
Retrieves information about the specified kdb user.
# Arguments
- `environment_id`: A unique identifier for the kdb environment.
- `user_name`: A unique identifier for the user.
"""
function get_kx_user(
environmentId, userName; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/users/$(userName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_kx_user(
environmentId,
userName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/users/$(userName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_kx_volume(environment_id, volume_name)
get_kx_volume(environment_id, volume_name, params::Dict{String,<:Any})
Retrieves the information about the volume.
# Arguments
- `environment_id`: A unique identifier for the kdb environment, whose clusters can attach
to the volume.
- `volume_name`: A unique identifier for the volume.
"""
function get_kx_volume(
environmentId, volumeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/kxvolumes/$(volumeName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_kx_volume(
environmentId,
volumeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/kxvolumes/$(volumeName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_environments()
list_environments(params::Dict{String,<:Any})
A list of all of your FinSpace environments.
# 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 this request.
- `"nextToken"`: A token generated by FinSpace that specifies where to continue pagination
if a previous request was truncated. To get the next set of pages, pass in the
nextTokennextToken value from the response object of the previous page call.
"""
function list_environments(; aws_config::AbstractAWSConfig=global_aws_config())
return finspace(
"GET", "/environment"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_environments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/environment",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_kx_changesets(database_name, environment_id)
list_kx_changesets(database_name, environment_id, params::Dict{String,<:Any})
Returns a list of all the changesets for a database.
# Arguments
- `database_name`: The name of the kdb database.
- `environment_id`: A unique identifier for the kdb 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 in this request.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_kx_changesets(
databaseName, environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases/$(databaseName)/changesets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_kx_changesets(
databaseName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases/$(databaseName)/changesets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_kx_cluster_nodes(cluster_name, environment_id)
list_kx_cluster_nodes(cluster_name, environment_id, params::Dict{String,<:Any})
Lists all the nodes in a kdb cluster.
# Arguments
- `cluster_name`: A unique name for the cluster.
- `environment_id`: A unique identifier for the kdb 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 in this request.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_kx_cluster_nodes(
clusterName, environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/clusters/$(clusterName)/nodes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_kx_cluster_nodes(
clusterName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/clusters/$(clusterName)/nodes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_kx_clusters(environment_id)
list_kx_clusters(environment_id, params::Dict{String,<:Any})
Returns a list of clusters.
# Arguments
- `environment_id`: A unique identifier for the kdb environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clusterType"`: Specifies the type of KDB database that is being created. The following
types are available: HDB – A Historical Database. The data is only accessible with
read-only permissions from one of the FinSpace managed kdb databases mounted to the
cluster. RDB – A Realtime Database. This type of database captures all the data from a
ticker plant and stores it in memory until the end of day, after which it writes all of its
data to a disk and reloads the HDB. This cluster type requires local storage for temporary
storage of data during the savedown process. If you specify this field in your request, you
must provide the savedownStorageConfiguration parameter. GATEWAY – A gateway cluster
allows you to access data across processes in kdb systems. It allows you to create your own
routing logic using the initialization scripts and custom code. This type of cluster does
not require a writable local storage. GP – A general purpose cluster allows you to
quickly iterate on code during development by granting greater access to system commands
and enabling a fast reload of custom code. This cluster type can optionally mount databases
including cache and savedown storage. For this cluster type, the node count is fixed at 1.
It does not support autoscaling and supports only SINGLE AZ mode. Tickerplant – A
tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It
can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can
persist messages to log, which is readable by any RDB environment. It supports only
single-node that is only one kdb process.
- `"maxResults"`: The maximum number of results to return in this request.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_kx_clusters(environmentId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace(
"GET",
"/kx/environments/$(environmentId)/clusters";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_kx_clusters(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/clusters",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_kx_databases(environment_id)
list_kx_databases(environment_id, params::Dict{String,<:Any})
Returns a list of all the databases in the kdb environment.
# Arguments
- `environment_id`: A unique identifier for the kdb 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 in this request.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_kx_databases(environmentId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_kx_databases(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_kx_dataviews(database_name, environment_id)
list_kx_dataviews(database_name, environment_id, params::Dict{String,<:Any})
Returns a list of all the dataviews in the database.
# Arguments
- `database_name`: The name of the database where the dataviews were created.
- `environment_id`: A unique identifier for the kdb environment, for which you want to
retrieve a list of dataviews.
# 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 this request.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_kx_dataviews(
databaseName, environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases/$(databaseName)/dataviews";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_kx_dataviews(
databaseName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/databases/$(databaseName)/dataviews",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_kx_environments()
list_kx_environments(params::Dict{String,<:Any})
Returns a list of kdb environments created in an 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 in this request.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_kx_environments(; aws_config::AbstractAWSConfig=global_aws_config())
return finspace(
"GET", "/kx/environments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_kx_environments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_kx_scaling_groups(environment_id)
list_kx_scaling_groups(environment_id, params::Dict{String,<:Any})
Returns a list of scaling groups in a kdb environment.
# Arguments
- `environment_id`: A unique identifier for the kdb environment, for which you want to
retrieve a list of scaling groups.
# 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 this request.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_kx_scaling_groups(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/scalingGroups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_kx_scaling_groups(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/scalingGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_kx_users(environment_id)
list_kx_users(environment_id, params::Dict{String,<:Any})
Lists all the users in a kdb environment.
# Arguments
- `environment_id`: A unique identifier for the kdb 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 in this request.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_kx_users(environmentId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace(
"GET",
"/kx/environments/$(environmentId)/users";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_kx_users(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/users",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_kx_volumes(environment_id)
list_kx_volumes(environment_id, params::Dict{String,<:Any})
Lists all the volumes in a kdb environment.
# Arguments
- `environment_id`: A unique identifier for the kdb environment, whose clusters can attach
to the volume.
# 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 this request.
- `"nextToken"`: A token that indicates where a results page should begin.
- `"volumeType"`: The type of file system volume. Currently, FinSpace only supports NAS_1
volume type.
"""
function list_kx_volumes(environmentId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace(
"GET",
"/kx/environments/$(environmentId)/kxvolumes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_kx_volumes(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"GET",
"/kx/environments/$(environmentId)/kxvolumes",
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 all tags for a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"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 finspace(
"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 metadata tags to a FinSpace resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the resource.
- `tags`: One or more tags to be assigned to the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return finspace(
"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 finspace(
"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 metadata tags from a FinSpace resource.
# Arguments
- `resource_arn`: A FinSpace resource from which you want to remove a tag or tags. The
value for this parameter is an Amazon Resource Name (ARN).
- `tag_keys`: The tag keys (names) of one or more tags to be removed.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"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 finspace(
"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(environment_id)
update_environment(environment_id, params::Dict{String,<:Any})
Update your FinSpace environment.
# Arguments
- `environment_id`: The identifier of the FinSpace environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the environment.
- `"federationMode"`: Authentication mode for the environment. FEDERATED - Users access
FinSpace through Single Sign On (SSO) via your Identity provider. LOCAL - Users access
FinSpace via email and password managed within the FinSpace environment.
- `"federationParameters"`:
- `"name"`: The name of the environment.
"""
function update_environment(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"PUT",
"/environment/$(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 finspace(
"PUT",
"/environment/$(environmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_kx_cluster_code_configuration(cluster_name, code, environment_id)
update_kx_cluster_code_configuration(cluster_name, code, environment_id, params::Dict{String,<:Any})
Allows you to update code configuration on a running cluster. By using this API you can
update the code, the initialization script path, and the command line arguments for a
specific cluster. The configuration that you want to update will override any existing
configurations on the cluster.
# Arguments
- `cluster_name`: The name of the cluster.
- `code`:
- `environment_id`: A unique identifier of the kdb environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"commandLineArguments"`: Specifies the key-value pairs to make them available inside the
cluster. You cannot update this parameter for a NO_RESTART deployment.
- `"deploymentConfiguration"`: The configuration that allows you to choose how you want to
update the code on a cluster.
- `"initializationScript"`: Specifies a Q program that will be run at launch of a cluster.
It is a relative path within .zip file that contains the custom code, which will be loaded
on the cluster. It must include the file name itself. For example, somedir/init.q. You
cannot update this parameter for a NO_RESTART deployment.
"""
function update_kx_cluster_code_configuration(
clusterName, code, environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/clusters/$(clusterName)/configuration/code",
Dict{String,Any}("code" => code, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_kx_cluster_code_configuration(
clusterName,
code,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/clusters/$(clusterName)/configuration/code",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("code" => code, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_kx_cluster_databases(cluster_name, databases, environment_id)
update_kx_cluster_databases(cluster_name, databases, environment_id, params::Dict{String,<:Any})
Updates the databases mounted on a kdb cluster, which includes the changesetId and all the
dbPaths to be cached. This API does not allow you to change a database name or add a
database if you created a cluster without one. Using this API you can point a cluster to a
different changeset and modify a list of partitions being cached.
# Arguments
- `cluster_name`: A unique name for the cluster that you want to modify.
- `databases`: The structure of databases mounted on the cluster.
- `environment_id`: The unique identifier of a kdb environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"deploymentConfiguration"`: The configuration that allows you to choose how you want to
update the databases on a cluster.
"""
function update_kx_cluster_databases(
clusterName, databases, environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/clusters/$(clusterName)/configuration/databases",
Dict{String,Any}("databases" => databases, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_kx_cluster_databases(
clusterName,
databases,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/clusters/$(clusterName)/configuration/databases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"databases" => databases, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_kx_database(client_token, database_name, environment_id)
update_kx_database(client_token, database_name, environment_id, params::Dict{String,<:Any})
Updates information for the given kdb database.
# Arguments
- `client_token`: A token that ensures idempotency. This token expires in 10 minutes.
- `database_name`: The name of the kdb database.
- `environment_id`: A unique identifier for the kdb environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the database.
"""
function update_kx_database(
clientToken,
databaseName,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/databases/$(databaseName)",
Dict{String,Any}("clientToken" => clientToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_kx_database(
clientToken,
databaseName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/databases/$(databaseName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => clientToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_kx_dataview(client_token, database_name, dataview_name, environment_id)
update_kx_dataview(client_token, database_name, dataview_name, environment_id, params::Dict{String,<:Any})
Updates the specified dataview. The dataviews get automatically updated when any new
changesets are ingested. Each update of the dataview creates a new version, including
changeset details and cache configurations
# Arguments
- `client_token`: A token that ensures idempotency. This token expires in 10 minutes.
- `database_name`: The name of the database.
- `dataview_name`: The name of the dataview that you want to update.
- `environment_id`: A unique identifier for the kdb environment, where you want to update
the dataview.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"changesetId"`: A unique identifier for the changeset.
- `"description"`: The description for a dataview.
- `"segmentConfigurations"`: The configuration that contains the database path of the data
that you want to place on each selected volume. Each segment must have a unique database
path for each volume. If you do not explicitly specify any database path for a volume, they
are accessible from the cluster through the default S3/object store segment.
"""
function update_kx_dataview(
clientToken,
databaseName,
dataviewName,
environmentId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/databases/$(databaseName)/dataviews/$(dataviewName)",
Dict{String,Any}("clientToken" => clientToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_kx_dataview(
clientToken,
databaseName,
dataviewName,
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/databases/$(databaseName)/dataviews/$(dataviewName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => clientToken), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_kx_environment(environment_id)
update_kx_environment(environment_id, params::Dict{String,<:Any})
Updates information for the given kdb environment.
# Arguments
- `environment_id`: A unique identifier for the kdb environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"description"`: A description of the kdb environment.
- `"name"`: The name of the kdb environment.
"""
function update_kx_environment(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_kx_environment(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_kx_environment_network(environment_id)
update_kx_environment_network(environment_id, params::Dict{String,<:Any})
Updates environment network to connect to your internal network by using a transit gateway.
This API supports request to create a transit gateway attachment from FinSpace VPC to your
transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request
to update a network, you cannot change it again. Network update might require termination
of any clusters that are running in the existing network.
# Arguments
- `environment_id`: A unique identifier for the kdb environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"customDNSConfiguration"`: A list of DNS server name and server IP. This is used to set
up Route-53 outbound resolvers.
- `"transitGatewayConfiguration"`: Specifies the transit gateway and network configuration
to connect the kdb environment to an internal network.
"""
function update_kx_environment_network(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/network",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_kx_environment_network(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/network",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_kx_user(environment_id, iam_role, user_name)
update_kx_user(environment_id, iam_role, user_name, params::Dict{String,<:Any})
Updates the user details. You can only update the IAM role associated with a user.
# Arguments
- `environment_id`: A unique identifier for the kdb environment.
- `iam_role`: The IAM role ARN that is associated with the user.
- `user_name`: A unique identifier for the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function update_kx_user(
environmentId, iamRole, userName; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/users/$(userName)",
Dict{String,Any}("iamRole" => iamRole, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_kx_user(
environmentId,
iamRole,
userName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"PUT",
"/kx/environments/$(environmentId)/users/$(userName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("iamRole" => iamRole, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_kx_volume(environment_id, volume_name)
update_kx_volume(environment_id, volume_name, params::Dict{String,<:Any})
Updates the throughput or capacity of a volume. During the update process, the filesystem
might be unavailable for a few minutes. You can retry any operations after the update is
complete.
# Arguments
- `environment_id`: A unique identifier for the kdb environment where you created the
storage volume.
- `volume_name`: A unique identifier for the volume.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"description"`: A description of the volume.
- `"nas1Configuration"`: Specifies the configuration for the Network attached storage
(NAS_1) file system volume.
"""
function update_kx_volume(
environmentId, volumeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace(
"PATCH",
"/kx/environments/$(environmentId)/kxvolumes/$(volumeName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_kx_volume(
environmentId,
volumeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace(
"PATCH",
"/kx/environments/$(environmentId)/kxvolumes/$(volumeName)",
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 | 48347 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: finspace_data
using AWS.Compat
using AWS.UUIDs
"""
associate_user_to_permission_group(permission_group_id, user_id)
associate_user_to_permission_group(permission_group_id, user_id, params::Dict{String,<:Any})
Adds a user to a permission group to grant permissions for actions a user can perform in
FinSpace.
# Arguments
- `permission_group_id`: The unique identifier for the permission group.
- `user_id`: The unique identifier for the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function associate_user_to_permission_group(
permissionGroupId, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"POST",
"/permission-group/$(permissionGroupId)/users/$(userId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_user_to_permission_group(
permissionGroupId,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"POST",
"/permission-group/$(permissionGroupId)/users/$(userId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_changeset(change_type, dataset_id, format_params, source_params)
create_changeset(change_type, dataset_id, format_params, source_params, params::Dict{String,<:Any})
Creates a new Changeset in a FinSpace Dataset.
# Arguments
- `change_type`: The option to indicate how a Changeset will be applied to a Dataset.
REPLACE – Changeset will be considered as a replacement to all prior loaded Changesets.
APPEND – Changeset will be considered as an addition to the end of all prior loaded
Changesets. MODIFY – Changeset is considered as a replacement to a specific prior
ingested Changeset.
- `dataset_id`: The unique identifier for the FinSpace Dataset where the Changeset will be
created.
- `format_params`: Options that define the structure of the source file(s) including the
format type (formatType), header row (withHeader), data separation character (separator)
and the type of compression (compression). formatType is a required attribute and can
have the following values: PARQUET – Parquet source file format. CSV – CSV
source file format. JSON – JSON source file format. XML – XML source file format.
Here is an example of how you could specify the formatParams: \"formatParams\": {
\"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\",
\"compression\":\"None\" } Note that if you only provide formatType as CSV, the rest of
the attributes will automatically default to CSV values as following: { \"withHeader\":
\"true\", \"separator\": \",\" } For more information about supported file formats, see
Supported Data Types and File Formats in the FinSpace User Guide.
- `source_params`: Options that define the location of the data being ingested
(s3SourcePath) and the source of the changeset (sourceType). Both s3SourcePath and
sourceType are required attributes. Here is an example of how you could specify the
sourceParams: \"sourceParams\": { \"s3SourcePath\":
\"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/inge
stion/equity.csv\", \"sourceType\": \"S3\" } The S3 path that you specify must allow the
FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket.
For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API
section.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function create_changeset(
changeType,
datasetId,
formatParams,
sourceParams;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"POST",
"/datasets/$(datasetId)/changesetsv2",
Dict{String,Any}(
"changeType" => changeType,
"formatParams" => formatParams,
"sourceParams" => sourceParams,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_changeset(
changeType,
datasetId,
formatParams,
sourceParams,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"POST",
"/datasets/$(datasetId)/changesetsv2",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"changeType" => changeType,
"formatParams" => formatParams,
"sourceParams" => sourceParams,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_view(dataset_id, destination_type_params)
create_data_view(dataset_id, destination_type_params, params::Dict{String,<:Any})
Creates a Dataview for a Dataset.
# Arguments
- `dataset_id`: The unique Dataset identifier that is used to create a Dataview.
- `destination_type_params`: Options that define the destination type for the Dataview.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"asOfTimestamp"`: Beginning time to use for the Dataview. The value is determined as
epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM
UTC is specified as 1635768000000.
- `"autoUpdate"`: Flag to indicate Dataview should be updated automatically.
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"partitionColumns"`: Ordered set of column names used to partition data.
- `"sortColumns"`: Columns to be used for sorting the data.
"""
function create_data_view(
datasetId, destinationTypeParams; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"POST",
"/datasets/$(datasetId)/dataviewsv2",
Dict{String,Any}(
"destinationTypeParams" => destinationTypeParams,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_view(
datasetId,
destinationTypeParams,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"POST",
"/datasets/$(datasetId)/dataviewsv2",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destinationTypeParams" => destinationTypeParams,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset(dataset_title, kind, permission_group_params)
create_dataset(dataset_title, kind, permission_group_params, params::Dict{String,<:Any})
Creates a new FinSpace Dataset.
# Arguments
- `dataset_title`: Display title for a FinSpace Dataset.
- `kind`: The format in which Dataset data is structured. TABULAR – Data is structured
in a tabular format. NON_TABULAR – Data is structured in a non-tabular format.
- `permission_group_params`: Permission group parameters for Dataset permissions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alias"`: The unique resource identifier for a Dataset.
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"datasetDescription"`: Description of a Dataset.
- `"ownerInfo"`: Contact information for a Dataset owner.
- `"schemaDefinition"`: Definition for a schema on a tabular Dataset.
"""
function create_dataset(
datasetTitle,
kind,
permissionGroupParams;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"POST",
"/datasetsv2",
Dict{String,Any}(
"datasetTitle" => datasetTitle,
"kind" => kind,
"permissionGroupParams" => permissionGroupParams,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset(
datasetTitle,
kind,
permissionGroupParams,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"POST",
"/datasetsv2",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"datasetTitle" => datasetTitle,
"kind" => kind,
"permissionGroupParams" => permissionGroupParams,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_permission_group(application_permissions, name)
create_permission_group(application_permissions, name, params::Dict{String,<:Any})
Creates a group of permissions for various actions that a user can perform in FinSpace.
# Arguments
- `application_permissions`: The option to indicate FinSpace application permissions that
are granted to a specific group. When assigning application permissions, be aware that the
permission ManageUsersAndGroups allows users to grant themselves or others access to any
functionality in their FinSpace environment's application. It should only be granted to
trusted users. CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups. This is a
privileged permission that allows users to grant themselves or others access to any
functionality in the application. It should only be granted to trusted users.
ManageAttributeSets – Group members can manage attribute sets. ViewAuditData – Group
members can view audit data. AccessNotebooks – Group members will have access to
FinSpace notebooks. GetTemporaryCredentials – Group members can get temporary API
credentials.
- `name`: The name of the permission group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"description"`: A brief description for the permission group.
"""
function create_permission_group(
applicationPermissions, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"POST",
"/permission-group",
Dict{String,Any}(
"applicationPermissions" => applicationPermissions,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_permission_group(
applicationPermissions,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"POST",
"/permission-group",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"applicationPermissions" => applicationPermissions,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(email_address, type)
create_user(email_address, type, params::Dict{String,<:Any})
Creates a new user in FinSpace.
# Arguments
- `email_address`: The email address of the user that you want to register. The email
address serves as a uniquer identifier for each user and cannot be changed after it's
created.
- `type`: The option to indicate the type of user. Use one of the following options to
specify this parameter: SUPER_USER – A user with permission to all the functionality
and data in FinSpace. APP_USER – A user with specific permissions in FinSpace. The
users are assigned permissions by adding them to a permission group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"apiAccess"`: The option to indicate whether the user can use the
GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access
other FinSpace Data API operations. ENABLED – The user has permissions to use the
APIs. DISABLED – The user does not have permissions to use any APIs.
- `"apiAccessPrincipalArn"`: The ARN identifier of an AWS user or role that is allowed to
call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific
FinSpace user. This must be an IAM role within your FinSpace account.
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"firstName"`: The first name of the user that you want to register.
- `"lastName"`: The last name of the user that you want to register.
"""
function create_user(emailAddress, type; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"POST",
"/user",
Dict{String,Any}(
"emailAddress" => emailAddress, "type" => type, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
emailAddress,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"POST",
"/user",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"emailAddress" => emailAddress,
"type" => type,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset(dataset_id)
delete_dataset(dataset_id, params::Dict{String,<:Any})
Deletes a FinSpace Dataset.
# Arguments
- `dataset_id`: The unique identifier of the Dataset to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function delete_dataset(datasetId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"DELETE",
"/datasetsv2/$(datasetId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dataset(
datasetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"DELETE",
"/datasetsv2/$(datasetId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_permission_group(permission_group_id)
delete_permission_group(permission_group_id, params::Dict{String,<:Any})
Deletes a permission group. This action is irreversible.
# Arguments
- `permission_group_id`: The unique identifier for the permission group that you want to
delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function delete_permission_group(
permissionGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"DELETE",
"/permission-group/$(permissionGroupId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_permission_group(
permissionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"DELETE",
"/permission-group/$(permissionGroupId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_user(user_id)
disable_user(user_id, params::Dict{String,<:Any})
Denies access to the FinSpace web application and API for the specified user.
# Arguments
- `user_id`: The unique identifier for the user that you want to deactivate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function disable_user(userId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"POST",
"/user/$(userId)/disable",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_user(
userId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"POST",
"/user/$(userId)/disable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_user_from_permission_group(permission_group_id, user_id)
disassociate_user_from_permission_group(permission_group_id, user_id, params::Dict{String,<:Any})
Removes a user from a permission group.
# Arguments
- `permission_group_id`: The unique identifier for the permission group.
- `user_id`: The unique identifier for the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function disassociate_user_from_permission_group(
permissionGroupId, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"DELETE",
"/permission-group/$(permissionGroupId)/users/$(userId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_user_from_permission_group(
permissionGroupId,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"DELETE",
"/permission-group/$(permissionGroupId)/users/$(userId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_user(user_id)
enable_user(user_id, params::Dict{String,<:Any})
Allows the specified user to access the FinSpace web application and API.
# Arguments
- `user_id`: The unique identifier for the user that you want to activate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function enable_user(userId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"POST",
"/user/$(userId)/enable",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_user(
userId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"POST",
"/user/$(userId)/enable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_changeset(changeset_id, dataset_id)
get_changeset(changeset_id, dataset_id, params::Dict{String,<:Any})
Get information about a Changeset.
# Arguments
- `changeset_id`: The unique identifier of the Changeset for which to get data.
- `dataset_id`: The unique identifier for the FinSpace Dataset where the Changeset is
created.
"""
function get_changeset(
changesetId, datasetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"GET",
"/datasets/$(datasetId)/changesetsv2/$(changesetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_changeset(
changesetId,
datasetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/datasets/$(datasetId)/changesetsv2/$(changesetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_view(dataset_id, dataview_id)
get_data_view(dataset_id, dataview_id, params::Dict{String,<:Any})
Gets information about a Dataview.
# Arguments
- `dataset_id`: The unique identifier for the Dataset used in the Dataview.
- `dataview_id`: The unique identifier for the Dataview.
"""
function get_data_view(
datasetId, dataviewId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"GET",
"/datasets/$(datasetId)/dataviewsv2/$(dataviewId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_view(
datasetId,
dataviewId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/datasets/$(datasetId)/dataviewsv2/$(dataviewId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dataset(dataset_id)
get_dataset(dataset_id, params::Dict{String,<:Any})
Returns information about a Dataset.
# Arguments
- `dataset_id`: The unique identifier for a Dataset.
"""
function get_dataset(datasetId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"GET",
"/datasetsv2/$(datasetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dataset(
datasetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/datasetsv2/$(datasetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_external_data_view_access_details(dataset_id, dataview_id)
get_external_data_view_access_details(dataset_id, dataview_id, params::Dict{String,<:Any})
Returns the credentials to access the external Dataview from an S3 location. To call this
API: You must retrieve the programmatic credentials. You must be a member of a FinSpace
user group, where the dataset that you want to access has Read Dataset Data permissions.
# Arguments
- `dataset_id`: The unique identifier for the Dataset.
- `dataview_id`: The unique identifier for the Dataview that you want to access.
"""
function get_external_data_view_access_details(
datasetId, dataviewId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"POST",
"/datasets/$(datasetId)/dataviewsv2/$(dataviewId)/external-access-details";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_external_data_view_access_details(
datasetId,
dataviewId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"POST",
"/datasets/$(datasetId)/dataviewsv2/$(dataviewId)/external-access-details",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_permission_group(permission_group_id)
get_permission_group(permission_group_id, params::Dict{String,<:Any})
Retrieves the details of a specific permission group.
# Arguments
- `permission_group_id`: The unique identifier for the permission group.
"""
function get_permission_group(
permissionGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"GET",
"/permission-group/$(permissionGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_permission_group(
permissionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/permission-group/$(permissionGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_programmatic_access_credentials(environment_id)
get_programmatic_access_credentials(environment_id, params::Dict{String,<:Any})
Request programmatic credentials to use with FinSpace SDK. For more information, see Step
2. Access credentials programmatically using IAM access key id and secret access key.
# Arguments
- `environment_id`: The FinSpace environment identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"durationInMinutes"`: The time duration in which the credentials remain valid.
"""
function get_programmatic_access_credentials(
environmentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"GET",
"/credentials/programmatic",
Dict{String,Any}("environmentId" => environmentId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_programmatic_access_credentials(
environmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/credentials/programmatic",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("environmentId" => environmentId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user(user_id)
get_user(user_id, params::Dict{String,<:Any})
Retrieves details for a specific user.
# Arguments
- `user_id`: The unique identifier of the user to get data for.
"""
function get_user(userId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"GET", "/user/$(userId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_user(
userId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"GET",
"/user/$(userId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_working_location()
get_working_location(params::Dict{String,<:Any})
A temporary Amazon S3 location, where you can copy your files from a source location to
stage or use as a scratch space in FinSpace notebook.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locationType"`: Specify the type of the working location. SAGEMAKER – Use the
Amazon S3 location as a temporary location to store data content when working with FinSpace
Notebooks that run on SageMaker studio. INGESTION – Use the Amazon S3 location as a
staging location to copy your data content and then use the location with the Changeset
creation operation.
"""
function get_working_location(; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"POST", "/workingLocationV1"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_working_location(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"POST",
"/workingLocationV1",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_changesets(dataset_id)
list_changesets(dataset_id, params::Dict{String,<:Any})
Lists the FinSpace Changesets for a Dataset.
# Arguments
- `dataset_id`: The unique identifier for the FinSpace Dataset to which the Changeset
belongs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results per page.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_changesets(datasetId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"GET",
"/datasets/$(datasetId)/changesetsv2";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_changesets(
datasetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/datasets/$(datasetId)/changesetsv2",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_views(dataset_id)
list_data_views(dataset_id, params::Dict{String,<:Any})
Lists all available Dataviews for a Dataset.
# Arguments
- `dataset_id`: The unique identifier of the Dataset for which to retrieve Dataviews.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results per page.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_data_views(datasetId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"GET",
"/datasets/$(datasetId)/dataviewsv2";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_views(
datasetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/datasets/$(datasetId)/dataviewsv2",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_datasets()
list_datasets(params::Dict{String,<:Any})
Lists all of the active Datasets that a user has access to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results per page.
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_datasets(; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"GET", "/datasetsv2"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_datasets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"GET", "/datasetsv2", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_permission_groups(max_results)
list_permission_groups(max_results, params::Dict{String,<:Any})
Lists all available permission groups in FinSpace.
# Arguments
- `max_results`: The maximum number of results per page.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_permission_groups(
maxResults; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"GET",
"/permission-group",
Dict{String,Any}("maxResults" => maxResults);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_permission_groups(
maxResults,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/permission-group",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("maxResults" => maxResults), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_permission_groups_by_user(max_results, user_id)
list_permission_groups_by_user(max_results, user_id, params::Dict{String,<:Any})
Lists all the permission groups that are associated with a specific user.
# Arguments
- `max_results`: The maximum number of results per page.
- `user_id`: The unique identifier for the user.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_permission_groups_by_user(
maxResults, userId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"GET",
"/user/$(userId)/permission-groups",
Dict{String,Any}("maxResults" => maxResults);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_permission_groups_by_user(
maxResults,
userId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/user/$(userId)/permission-groups",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("maxResults" => maxResults), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users(max_results)
list_users(max_results, params::Dict{String,<:Any})
Lists all available users in FinSpace.
# Arguments
- `max_results`: The maximum number of results per page.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_users(maxResults; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"GET",
"/user",
Dict{String,Any}("maxResults" => maxResults);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_users(
maxResults,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/user",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("maxResults" => maxResults), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users_by_permission_group(max_results, permission_group_id)
list_users_by_permission_group(max_results, permission_group_id, params::Dict{String,<:Any})
Lists details of all the users in a specific permission group.
# Arguments
- `max_results`: The maximum number of results per page.
- `permission_group_id`: The unique identifier for the permission group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token that indicates where a results page should begin.
"""
function list_users_by_permission_group(
maxResults, permissionGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"GET",
"/permission-group/$(permissionGroupId)/users",
Dict{String,Any}("maxResults" => maxResults);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_users_by_permission_group(
maxResults,
permissionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"GET",
"/permission-group/$(permissionGroupId)/users",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("maxResults" => maxResults), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_user_password(user_id)
reset_user_password(user_id, params::Dict{String,<:Any})
Resets the password for a specified user ID and generates a temporary one. Only a superuser
can reset password for other users. Resetting the password immediately invalidates the
previous password associated with the user.
# Arguments
- `user_id`: The unique identifier of the user that a temporary password is requested for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function reset_user_password(userId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"POST",
"/user/$(userId)/password",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_user_password(
userId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"POST",
"/user/$(userId)/password",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_changeset(changeset_id, dataset_id, format_params, source_params)
update_changeset(changeset_id, dataset_id, format_params, source_params, params::Dict{String,<:Any})
Updates a FinSpace Changeset.
# Arguments
- `changeset_id`: The unique identifier for the Changeset to update.
- `dataset_id`: The unique identifier for the FinSpace Dataset in which the Changeset is
created.
- `format_params`: Options that define the structure of the source file(s) including the
format type (formatType), header row (withHeader), data separation character (separator)
and the type of compression (compression). formatType is a required attribute and can
have the following values: PARQUET – Parquet source file format. CSV – CSV
source file format. JSON – JSON source file format. XML – XML source file format.
Here is an example of how you could specify the formatParams: \"formatParams\": {
\"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\",
\"compression\":\"None\" } Note that if you only provide formatType as CSV, the rest of
the attributes will automatically default to CSV values as following: { \"withHeader\":
\"true\", \"separator\": \",\" } For more information about supported file formats, see
Supported Data Types and File Formats in the FinSpace User Guide.
- `source_params`: Options that define the location of the data being ingested
(s3SourcePath) and the source of the changeset (sourceType). Both s3SourcePath and
sourceType are required attributes. Here is an example of how you could specify the
sourceParams: \"sourceParams\": { \"s3SourcePath\":
\"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/inge
stion/equity.csv\", \"sourceType\": \"S3\" } The S3 path that you specify must allow the
FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket.
For more information, see Loading data from an Amazon S3 Bucket using the FinSpace
APIsection.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
"""
function update_changeset(
changesetId,
datasetId,
formatParams,
sourceParams;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"PUT",
"/datasets/$(datasetId)/changesetsv2/$(changesetId)",
Dict{String,Any}(
"formatParams" => formatParams,
"sourceParams" => sourceParams,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_changeset(
changesetId,
datasetId,
formatParams,
sourceParams,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"PUT",
"/datasets/$(datasetId)/changesetsv2/$(changesetId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"formatParams" => formatParams,
"sourceParams" => sourceParams,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dataset(dataset_id, dataset_title, kind)
update_dataset(dataset_id, dataset_title, kind, params::Dict{String,<:Any})
Updates a FinSpace Dataset.
# Arguments
- `dataset_id`: The unique identifier for the Dataset to update.
- `dataset_title`: A display title for the Dataset.
- `kind`: The format in which the Dataset data is structured. TABULAR – Data is
structured in a tabular format. NON_TABULAR – Data is structured in a non-tabular
format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alias"`: The unique resource identifier for a Dataset.
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"datasetDescription"`: A description for the Dataset.
- `"schemaDefinition"`: Definition for a schema on a tabular Dataset.
"""
function update_dataset(
datasetId, datasetTitle, kind; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"PUT",
"/datasetsv2/$(datasetId)",
Dict{String,Any}(
"datasetTitle" => datasetTitle, "kind" => kind, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dataset(
datasetId,
datasetTitle,
kind,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"PUT",
"/datasetsv2/$(datasetId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"datasetTitle" => datasetTitle,
"kind" => kind,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_permission_group(permission_group_id)
update_permission_group(permission_group_id, params::Dict{String,<:Any})
Modifies the details of a permission group. You cannot modify a permissionGroupID.
# Arguments
- `permission_group_id`: The unique identifier for the permission group to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"applicationPermissions"`: The permissions that are granted to a specific group for
accessing the FinSpace application. When assigning application permissions, be aware that
the permission ManageUsersAndGroups allows users to grant themselves or others access to
any functionality in their FinSpace environment's application. It should only be granted to
trusted users. CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups. This is a
privileged permission that allows users to grant themselves or others access to any
functionality in the application. It should only be granted to trusted users.
ManageAttributeSets – Group members can manage attribute sets. ViewAuditData – Group
members can view audit data. AccessNotebooks – Group members will have access to
FinSpace notebooks. GetTemporaryCredentials – Group members can get temporary API
credentials.
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"description"`: A brief description for the permission group.
- `"name"`: The name of the permission group.
"""
function update_permission_group(
permissionGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"PUT",
"/permission-group/$(permissionGroupId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_permission_group(
permissionGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return finspace_data(
"PUT",
"/permission-group/$(permissionGroupId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user(user_id)
update_user(user_id, params::Dict{String,<:Any})
Modifies the details of the specified user. You cannot update the userId for a user.
# Arguments
- `user_id`: The unique identifier for the user that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"apiAccess"`: The option to indicate whether the user can use the
GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access
other FinSpace Data API operations. ENABLED – The user has permissions to use the
APIs. DISABLED – The user does not have permissions to use any APIs.
- `"apiAccessPrincipalArn"`: The ARN identifier of an AWS user or role that is allowed to
call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific
FinSpace user. This must be an IAM role within your FinSpace account.
- `"clientToken"`: A token that ensures idempotency. This token expires in 10 minutes.
- `"firstName"`: The first name of the user.
- `"lastName"`: The last name of the user.
- `"type"`: The option to indicate the type of user. SUPER_USER– A user with
permission to all the functionality and data in FinSpace. APP_USER – A user with
specific permissions in FinSpace. The users are assigned permissions by adding them to a
permission group.
"""
function update_user(userId; aws_config::AbstractAWSConfig=global_aws_config())
return finspace_data(
"PUT",
"/user/$(userId)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user(
userId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return finspace_data(
"PUT",
"/user/$(userId)",
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 | 40016 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: firehose
using AWS.Compat
using AWS.UUIDs
"""
create_delivery_stream(delivery_stream_name)
create_delivery_stream(delivery_stream_name, params::Dict{String,<:Any})
Creates a Firehose delivery stream. By default, you can create up to 50 delivery streams
per Amazon Web Services Region. This is an asynchronous operation that immediately returns.
The initial status of the delivery stream is CREATING. After the delivery stream is
created, its status is ACTIVE and it now accepts data. If the delivery stream creation
fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery
stream that is not in the ACTIVE state cause an exception. To check the state of a delivery
stream, use DescribeDeliveryStream. If the status of a delivery stream is CREATING_FAILED,
this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However,
you can invoke the DeleteDeliveryStream operation to delete it. A Firehose delivery stream
can be configured to receive records directly from providers using PutRecord or
PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To
specify a Kinesis data stream as input, set the DeliveryStreamType parameter to
KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role
ARN in the KinesisStreamSourceConfiguration parameter. To create a delivery stream with
server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in
your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn
on SSE for an existing delivery stream that doesn't have SSE enabled. A delivery stream is
configured with a single destination, such as Amazon Simple Storage Service (Amazon S3),
Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any
custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service
providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic.
You must specify only one of the following destination configuration parameters:
ExtendedS3DestinationConfiguration, S3DestinationConfiguration,
ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or
SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also
provide the following optional values: BufferingHints, EncryptionConfiguration, and
CompressionFormat. By default, if no BufferingHints value is provided, Firehose buffers
data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is
a hint, so there are some cases where the service cannot adhere to these conditions
strictly. For example, record boundaries might be such that the size is a little over or
under the configured buffering size. By default, no encryption is performed. We strongly
recommend that you enable encryption to ensure secure data storage in Amazon S3. A few
notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an
S3 bucket as intermediate location. Firehose first delivers data to Amazon S3 and then uses
COPY syntax to load data into an Amazon Redshift table. This is specified in the
RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats
SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration
because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support
these compression formats. We strongly recommend that you use the user name and password
you provide exclusively with Firehose, and that the permissions for the account are
restricted for Amazon Redshift INSERT permissions. Firehose assumes the IAM role that is
configured as part of the destination. The role should allow the Firehose principal to
assume the role, and the role should have permissions that allow the service to deliver the
data. For more information, see Grant Firehose Access to an Amazon S3 Destination in the
Amazon Firehose Developer Guide.
# Arguments
- `delivery_stream_name`: The name of the delivery stream. This name must be unique per
Amazon Web Services account in the same Amazon Web Services Region. If the delivery streams
are in different accounts or different Regions, you can have multiple delivery streams with
the same name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AmazonOpenSearchServerlessDestinationConfiguration"`: The destination in the Serverless
offering for Amazon OpenSearch Service. You can specify only one destination.
- `"AmazonopensearchserviceDestinationConfiguration"`: The destination in Amazon OpenSearch
Service. You can specify only one destination.
- `"DeliveryStreamEncryptionConfigurationInput"`: Used to specify the type and Amazon
Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
- `"DeliveryStreamType"`: The delivery stream type. This parameter can be one of the
following values: DirectPut: Provider applications access the delivery stream directly.
KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.
- `"ElasticsearchDestinationConfiguration"`: The destination in Amazon ES. You can specify
only one destination.
- `"ExtendedS3DestinationConfiguration"`: The destination in Amazon S3. You can specify
only one destination.
- `"HttpEndpointDestinationConfiguration"`: Enables configuring Kinesis Firehose to deliver
data to any HTTP endpoint destination. You can specify only one destination.
- `"KinesisStreamSourceConfiguration"`: When a Kinesis data stream is used as the source
for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data
stream Amazon Resource Name (ARN) and the role ARN for the source stream.
- `"MSKSourceConfiguration"`:
- `"RedshiftDestinationConfiguration"`: The destination in Amazon Redshift. You can specify
only one destination.
- `"S3DestinationConfiguration"`: [Deprecated] The destination in Amazon S3. You can
specify only one destination.
- `"SnowflakeDestinationConfiguration"`: Configure Snowflake destination
- `"SplunkDestinationConfiguration"`: The destination in Splunk. You can specify only one
destination.
- `"Tags"`: A set of tags to assign to the delivery stream. A tag is a key-value pair that
you can define and assign to Amazon Web Services resources. Tags are metadata. For example,
you can add friendly names and descriptions or other types of information that can help you
distinguish the delivery stream. For more information about tags, see Using Cost Allocation
Tags in the Amazon Web Services Billing and Cost Management User Guide. You can specify up
to 50 tags when creating a delivery stream. If you specify tags in the CreateDeliveryStream
action, Amazon Data Firehose performs an additional authorization on the
firehose:TagDeliveryStream action to verify if users have permissions to create tags. If
you do not provide this permission, requests to create new Firehose delivery streams with
IAM resource tags will fail with an AccessDeniedException such as following.
AccessDeniedException User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform:
firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with
an explicit deny in an identity-based policy. For an example IAM policy, see Tag example.
"""
function create_delivery_stream(
DeliveryStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"CreateDeliveryStream",
Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_delivery_stream(
DeliveryStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"CreateDeliveryStream",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_delivery_stream(delivery_stream_name)
delete_delivery_stream(delivery_stream_name, params::Dict{String,<:Any})
Deletes a delivery stream and its data. You can delete a delivery stream only if it is in
one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You
can't delete a delivery stream that is in the CREATING state. To check the state of a
delivery stream, use DescribeDeliveryStream. DeleteDeliveryStream is an asynchronous API.
When an API request to DeleteDeliveryStream succeeds, the delivery stream is marked for
deletion, and it goes into the DELETING state.While the delivery stream is in the DELETING
state, the service might continue to accept records, but it doesn't make any guarantees
with respect to delivering the data. Therefore, as a best practice, first stop any
applications that are sending records before you delete a delivery stream. Removal of a
delivery stream that is in the DELETING state is a low priority operation for the service.
A stream may remain in the DELETING state for several minutes. Therefore, as a best
practice, applications should not wait for streams in the DELETING state to be removed.
# Arguments
- `delivery_stream_name`: The name of the delivery stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowForceDelete"`: Set this to true if you want to delete the delivery stream even if
Firehose is unable to retire the grant for the CMK. Firehose might be unable to retire the
grant due to a customer error, such as when the CMK or the grant are in an invalid state.
If you force deletion, you can then use the RevokeGrant operation to revoke the grant you
gave to Firehose. If a failure to retire the grant happens due to an Amazon Web Services
KMS issue, Firehose keeps retrying the delete operation. The default value is false.
"""
function delete_delivery_stream(
DeliveryStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"DeleteDeliveryStream",
Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_delivery_stream(
DeliveryStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"DeleteDeliveryStream",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_delivery_stream(delivery_stream_name)
describe_delivery_stream(delivery_stream_name, params::Dict{String,<:Any})
Describes the specified delivery stream and its status. For example, after your delivery
stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE
and therefore ready for data to be sent to it. If the status of a delivery stream is
CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream
again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. If
the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream
again but with DeleteDeliveryStreamInputAllowForceDelete set to true.
# Arguments
- `delivery_stream_name`: The name of the delivery stream.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ExclusiveStartDestinationId"`: The ID of the destination to start returning the
destination information. Firehose supports one destination per delivery stream.
- `"Limit"`: The limit on the number of destinations to return. You can have one
destination per delivery stream.
"""
function describe_delivery_stream(
DeliveryStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"DescribeDeliveryStream",
Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_delivery_stream(
DeliveryStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"DescribeDeliveryStream",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_delivery_streams()
list_delivery_streams(params::Dict{String,<:Any})
Lists your delivery streams in alphabetical order of their names. The number of delivery
streams might be too large to return using a single call to ListDeliveryStreams. You can
limit the number of delivery streams returned, using the Limit parameter. To determine
whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams
in the output. If there are more delivery streams to list, you can request them by calling
this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name
of the last delivery stream returned in the last call.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeliveryStreamType"`: The delivery stream type. This can be one of the following
values: DirectPut: Provider applications access the delivery stream directly.
KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source. This
parameter is optional. If this parameter is omitted, delivery streams of all types are
returned.
- `"ExclusiveStartDeliveryStreamName"`: The list of delivery streams returned by this call
to ListDeliveryStreams will start with the delivery stream whose name comes alphabetically
immediately after the name you specify in ExclusiveStartDeliveryStreamName.
- `"Limit"`: The maximum number of delivery streams to list. The default value is 10.
"""
function list_delivery_streams(; aws_config::AbstractAWSConfig=global_aws_config())
return firehose(
"ListDeliveryStreams"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_delivery_streams(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"ListDeliveryStreams",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_delivery_stream(delivery_stream_name)
list_tags_for_delivery_stream(delivery_stream_name, params::Dict{String,<:Any})
Lists the tags for the specified delivery stream. This operation has a limit of five
transactions per second per account.
# Arguments
- `delivery_stream_name`: The name of the delivery stream whose tags you want to list.
# 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
you set this parameter, ListTagsForDeliveryStream 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 delivery stream, HasMoreTags is set to true in the response. To
list additional tags, set ExclusiveStartTagKey to the last key in the response.
"""
function list_tags_for_delivery_stream(
DeliveryStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"ListTagsForDeliveryStream",
Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_delivery_stream(
DeliveryStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"ListTagsForDeliveryStream",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_record(delivery_stream_name, record)
put_record(delivery_stream_name, record, params::Dict{String,<:Any})
Writes a single data record into an Amazon Firehose delivery stream. To write multiple data
records into a delivery stream, use PutRecordBatch. Applications using these operations are
referred to as producers. By default, each delivery stream can take in up to 2,000
transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord
and PutRecordBatch, the limits are an aggregate across these two operations for each
delivery stream. For more information about limits and how to request an increase, see
Amazon Firehose Limits. Firehose accumulates and publishes a particular metric for a
customer account in one minute intervals. It is possible that the bursts of incoming
bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the
actual spikes in the traffic might not be fully visible in the customer's 1 minute
CloudWatch metrics. You must specify the name of the delivery stream and the data record
when using PutRecord. The data record consists of a data blob that can be up to 1,000 KiB
in size, and any kind of data. For example, it can be a segment from a log file, geographic
location data, website clickstream data, and so on. Firehose buffers records before
delivering them to the destination. To disambiguate the data blobs at the destination, a
common solution is to use delimiters in the data, such as a newline (n) or some other
character unique within the data. This allows the consumer application to parse individual
data items when reading the data from the destination. The PutRecord operation returns a
RecordId, which is a unique string assigned to each record. Producer applications can use
this ID for purposes such as auditability and investigation. If the PutRecord operation
throws a ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times.
If the exception persists, it is possible that the throughput limits have been exceeded for
the delivery stream. Re-invoking the Put API operations (for example, PutRecord and
PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer
time out before retrying Put API operations. Data records sent to Firehose are stored for
24 hours from the time they are added to a delivery stream as it tries to send the records
to the destination. If the destination is unreachable for more than 24 hours, the data is
no longer available. Don't concatenate two or more base64 strings to form the data fields
of your records. Instead, concatenate the raw data, then perform base64 encoding.
# Arguments
- `delivery_stream_name`: The name of the delivery stream.
- `record`: The record.
"""
function put_record(
DeliveryStreamName, Record; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"PutRecord",
Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName, "Record" => Record);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_record(
DeliveryStreamName,
Record,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"PutRecord",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeliveryStreamName" => DeliveryStreamName, "Record" => Record
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_record_batch(delivery_stream_name, records)
put_record_batch(delivery_stream_name, records, params::Dict{String,<:Any})
Writes multiple data records into a delivery stream in a single call, which can achieve
higher throughput per producer than when writing single records. To write single data
records into a delivery stream, use PutRecord. Applications using these operations are
referred to as producers. Firehose accumulates and publishes a particular metric for a
customer account in one minute intervals. It is possible that the bursts of incoming
bytes/records ingested to a delivery stream last only for a few seconds. Due to this, the
actual spikes in the traffic might not be fully visible in the customer's 1 minute
CloudWatch metrics. For information about service quota, see Amazon Firehose Quota. Each
PutRecordBatch request supports up to 500 records. Each record in the request can be as
large as 1,000 KB (before base64 encoding), up to a limit of 4 MB for the entire request.
These limits cannot be changed. You must specify the name of the delivery stream and the
data record when using PutRecord. The data record consists of a data blob that can be up to
1,000 KB in size, and any kind of data. For example, it could be a segment from a log file,
geographic location data, website clickstream data, and so on. Firehose buffers records
before delivering them to the destination. To disambiguate the data blobs at the
destination, a common solution is to use delimiters in the data, such as a newline (n) or
some other character unique within the data. This allows the consumer application to parse
individual data items when reading the data from the destination. The PutRecordBatch
response includes a count of failed records, FailedPutCount, and an array of responses,
RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may
be greater than 0, indicating that there are records for which the operation didn't
succeed. Each entry in the RequestResponses array provides additional information about the
processed record. It directly correlates with a record in the request array using the same
ordering, from the top to the bottom. The response array always includes the same number of
records as the request array. RequestResponses includes both successfully and
unsuccessfully processed records. Firehose tries to process all records in each
PutRecordBatch request. A single record failure does not stop the processing of subsequent
records. A successfully processed record includes a RecordId value, which is unique for
the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values.
ErrorCode reflects the type of error, and is one of the following values:
ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed
information about the error. If there is an internal server error or a timeout, the write
might have completed or it might have failed. If FailedPutCount is greater than 0, retry
the request, resending only those records that might have failed processing. This minimizes
the possible duplicate records and also reduces the total bytes sent (and corresponding
charges). We recommend that you handle any duplicates at the destination. If PutRecordBatch
throws ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times.
If the exception persists, it is possible that the throughput limits have been exceeded for
the delivery stream. Re-invoking the Put API operations (for example, PutRecord and
PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer
time out before retrying Put API operations. Data records sent to Firehose are stored for
24 hours from the time they are added to a delivery stream as it attempts to send the
records to the destination. If the destination is unreachable for more than 24 hours, the
data is no longer available. Don't concatenate two or more base64 strings to form the data
fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
# Arguments
- `delivery_stream_name`: The name of the delivery stream.
- `records`: One or more records.
"""
function put_record_batch(
DeliveryStreamName, Records; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"PutRecordBatch",
Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName, "Records" => Records);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_record_batch(
DeliveryStreamName,
Records,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"PutRecordBatch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeliveryStreamName" => DeliveryStreamName, "Records" => Records
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_delivery_stream_encryption(delivery_stream_name)
start_delivery_stream_encryption(delivery_stream_name, params::Dict{String,<:Any})
Enables server-side encryption (SSE) for the delivery stream. This operation is
asynchronous. It returns immediately. When you invoke it, Firehose first sets the
encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of
a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the
operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read
and write data to your delivery stream while the encryption status is ENABLING, but the
data is not encrypted. It can take up to 5 seconds after the encryption status changes to
ENABLED before all records written to the delivery stream are encrypted. To find out
whether a record or a batch of records was encrypted, check the response elements
PutRecordOutputEncrypted and PutRecordBatchOutputEncrypted, respectively. To check the
encryption status of a delivery stream, use DescribeDeliveryStream. Even if encryption is
currently enabled for a delivery stream, you can still invoke this operation on it to
change the ARN of the CMK or both its type and ARN. If you invoke this method to change the
CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Firehose schedules the grant it had
on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Firehose
creates a grant that enables it to use the new CMK to encrypt and decrypt data and to
manage the grant. For the KMS grant creation to be successful, the Firehose API operations
StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session
credentials that are more than 6 hours old. If a delivery stream already has encryption
enabled and then you invoke this operation to change the ARN of the CMK or both its type
and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK
failed. In this case, encryption remains enabled with the old CMK. If the encryption status
of your delivery stream is ENABLING_FAILED, you can invoke this operation again with a
valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the
permission for Firehose to invoke KMS encrypt and decrypt operations. You can enable SSE
for a delivery stream only if it's a delivery stream that uses DirectPut as its source.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a
combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the
limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption
12 times for the same delivery stream in a 24-hour period.
# Arguments
- `delivery_stream_name`: The name of the delivery stream for which you want to enable
server-side encryption (SSE).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeliveryStreamEncryptionConfigurationInput"`: Used to specify the type and Amazon
Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
"""
function start_delivery_stream_encryption(
DeliveryStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"StartDeliveryStreamEncryption",
Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_delivery_stream_encryption(
DeliveryStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"StartDeliveryStreamEncryption",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_delivery_stream_encryption(delivery_stream_name)
stop_delivery_stream_encryption(delivery_stream_name, params::Dict{String,<:Any})
Disables server-side encryption (SSE) for the delivery stream. This operation is
asynchronous. It returns immediately. When you invoke it, Firehose first sets the
encryption status of the stream to DISABLING, and then to DISABLED. You can continue to
read and write data to your stream while its status is DISABLING. It can take up to 5
seconds after the encryption status changes to DISABLED before all records written to the
delivery stream are no longer subject to encryption. To find out whether a record or a
batch of records was encrypted, check the response elements PutRecordOutputEncrypted and
PutRecordBatchOutputEncrypted, respectively. To check the encryption state of a delivery
stream, use DescribeDeliveryStream. If SSE is enabled using a customer managed CMK and
then you invoke StopDeliveryStreamEncryption, Firehose schedules the related KMS grant for
retirement and then retires it after it ensures that it is finished delivering records to
the destination. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption
operations have a combined limit of 25 calls per delivery stream per 24 hours. For example,
you reach the limit if you call StartDeliveryStreamEncryption 13 times and
StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
# Arguments
- `delivery_stream_name`: The name of the delivery stream for which you want to disable
server-side encryption (SSE).
"""
function stop_delivery_stream_encryption(
DeliveryStreamName; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"StopDeliveryStreamEncryption",
Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_delivery_stream_encryption(
DeliveryStreamName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"StopDeliveryStreamEncryption",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_delivery_stream(delivery_stream_name, tags)
tag_delivery_stream(delivery_stream_name, tags, params::Dict{String,<:Any})
Adds or updates tags for the specified delivery stream. A tag is a key-value pair 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. Tags are
metadata. For example, you can add friendly names and descriptions or other types of
information that can help you distinguish the delivery stream. For more information about
tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management
User Guide. Each delivery stream can have up to 50 tags. This operation has a limit of
five transactions per second per account.
# Arguments
- `delivery_stream_name`: The name of the delivery stream to which you want to add the tags.
- `tags`: A set of key-value pairs to use to create the tags.
"""
function tag_delivery_stream(
DeliveryStreamName, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"TagDeliveryStream",
Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_delivery_stream(
DeliveryStreamName,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"TagDeliveryStream",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeliveryStreamName" => DeliveryStreamName, "Tags" => Tags
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_delivery_stream(delivery_stream_name, tag_keys)
untag_delivery_stream(delivery_stream_name, tag_keys, params::Dict{String,<:Any})
Removes tags from the specified delivery stream. Removed tags are deleted, and you can't
recover them after this operation successfully completes. If you specify a tag that doesn't
exist, the operation ignores it. This operation has a limit of five transactions per second
per account.
# Arguments
- `delivery_stream_name`: The name of the delivery stream.
- `tag_keys`: A list of tag keys. Each corresponding tag is removed from the delivery
stream.
"""
function untag_delivery_stream(
DeliveryStreamName, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return firehose(
"UntagDeliveryStream",
Dict{String,Any}("DeliveryStreamName" => DeliveryStreamName, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_delivery_stream(
DeliveryStreamName,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"UntagDeliveryStream",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DeliveryStreamName" => DeliveryStreamName, "TagKeys" => TagKeys
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_destination(current_delivery_stream_version_id, delivery_stream_name, destination_id)
update_destination(current_delivery_stream_version_id, delivery_stream_name, destination_id, params::Dict{String,<:Any})
Updates the specified destination of the specified delivery stream. Use this operation to
change the destination type (for example, to replace the Amazon S3 destination with Amazon
Redshift) or change the parameters associated with a destination (for example, to change
the bucket name of the Amazon S3 destination). The update might not occur immediately. The
target delivery stream remains active while the configurations are updated, so data writes
to the delivery stream can continue during this process. The updated configurations are
usually effective within a few minutes. Switching between Amazon OpenSearch Service and
other services is not supported. For an Amazon OpenSearch Service destination, you can only
update to another Amazon OpenSearch Service destination. If the destination type is the
same, Firehose merges the configuration parameters specified with the destination
configuration that already exists on the delivery stream. If any of the parameters are not
specified in the call, the existing values are retained. For example, in the Amazon S3
destination, if EncryptionConfiguration is not specified, then the existing
EncryptionConfiguration is maintained on the destination. If the destination type is not
the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose
does not merge any parameters. In this case, all parameters must be specified. Firehose
uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This
is a required field, and the service updates the configuration only if the existing
configuration has a version ID that matches. After the update is applied successfully, the
version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new
version ID to set CurrentDeliveryStreamVersionId in the next call.
# Arguments
- `current_delivery_stream_version_id`: Obtain this value from the VersionId result of
DeliveryStreamDescription. This value is required, and helps the service perform
conditional operations. For example, if there is an interleaving update and this value is
null, then the update destination fails. After the update is successful, the VersionId
value is updated. The service then performs a merge of the old configuration with the new
configuration.
- `delivery_stream_name`: The name of the delivery stream.
- `destination_id`: The ID of the destination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AmazonOpenSearchServerlessDestinationUpdate"`: Describes an update for a destination in
the Serverless offering for Amazon OpenSearch Service.
- `"AmazonopensearchserviceDestinationUpdate"`: Describes an update for a destination in
Amazon OpenSearch Service.
- `"ElasticsearchDestinationUpdate"`: Describes an update for a destination in Amazon ES.
- `"ExtendedS3DestinationUpdate"`: Describes an update for a destination in Amazon S3.
- `"HttpEndpointDestinationUpdate"`: Describes an update to the specified HTTP endpoint
destination.
- `"RedshiftDestinationUpdate"`: Describes an update for a destination in Amazon Redshift.
- `"S3DestinationUpdate"`: [Deprecated] Describes an update for a destination in Amazon S3.
- `"SnowflakeDestinationUpdate"`: Update to the Snowflake destination configuration
settings.
- `"SplunkDestinationUpdate"`: Describes an update for a destination in Splunk.
"""
function update_destination(
CurrentDeliveryStreamVersionId,
DeliveryStreamName,
DestinationId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"UpdateDestination",
Dict{String,Any}(
"CurrentDeliveryStreamVersionId" => CurrentDeliveryStreamVersionId,
"DeliveryStreamName" => DeliveryStreamName,
"DestinationId" => DestinationId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_destination(
CurrentDeliveryStreamVersionId,
DeliveryStreamName,
DestinationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return firehose(
"UpdateDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CurrentDeliveryStreamVersionId" => CurrentDeliveryStreamVersionId,
"DeliveryStreamName" => DeliveryStreamName,
"DestinationId" => DestinationId,
),
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 | 26576 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: fis
using AWS.Compat
using AWS.UUIDs
"""
create_experiment_template(actions, client_token, description, role_arn, stop_conditions)
create_experiment_template(actions, client_token, description, role_arn, stop_conditions, params::Dict{String,<:Any})
Creates an experiment template. An experiment template includes the following components:
Targets: A target can be a specific resource in your Amazon Web Services environment, or
one or more resources that match criteria that you specify, for example, resources that
have specific tags. Actions: The actions to carry out on the target. You can specify
multiple actions, the duration of each action, and when to start each action during an
experiment. Stop conditions: If a stop condition is triggered while an experiment is
running, the experiment is automatically stopped. You can define a stop condition as a
CloudWatch alarm. For more information, see experiment templates in the Fault Injection
Service User Guide.
# Arguments
- `actions`: The actions for the experiment.
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `description`: A description for the experiment template.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role that grants the FIS service
permission to perform service actions on your behalf.
- `stop_conditions`: The stop conditions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"experimentOptions"`: The experiment options for the experiment template.
- `"logConfiguration"`: The configuration for experiment logging.
- `"tags"`: The tags to apply to the experiment template.
- `"targets"`: The targets for the experiment.
"""
function create_experiment_template(
actions,
clientToken,
description,
roleArn,
stopConditions;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fis(
"POST",
"/experimentTemplates",
Dict{String,Any}(
"actions" => actions,
"clientToken" => clientToken,
"description" => description,
"roleArn" => roleArn,
"stopConditions" => stopConditions,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_experiment_template(
actions,
clientToken,
description,
roleArn,
stopConditions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fis(
"POST",
"/experimentTemplates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actions" => actions,
"clientToken" => clientToken,
"description" => description,
"roleArn" => roleArn,
"stopConditions" => stopConditions,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_target_account_configuration(account_id, id, role_arn)
create_target_account_configuration(account_id, id, role_arn, params::Dict{String,<:Any})
Creates a target account configuration for the experiment template. A target account
configuration is required when accountTargeting of experimentOptions is set to
multi-account. For more information, see experiment options in the Fault Injection Service
User Guide.
# Arguments
- `account_id`: The Amazon Web Services account ID of the target account.
- `id`: The experiment template ID.
- `role_arn`: The Amazon Resource Name (ARN) of an IAM role for the target account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `"description"`: The description of the target account.
"""
function create_target_account_configuration(
accountId, id, roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"POST",
"/experimentTemplates/$(id)/targetAccountConfigurations/$(accountId)",
Dict{String,Any}("roleArn" => roleArn, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_target_account_configuration(
accountId,
id,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fis(
"POST",
"/experimentTemplates/$(id)/targetAccountConfigurations/$(accountId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("roleArn" => roleArn, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_experiment_template(id)
delete_experiment_template(id, params::Dict{String,<:Any})
Deletes the specified experiment template.
# Arguments
- `id`: The ID of the experiment template.
"""
function delete_experiment_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"DELETE",
"/experimentTemplates/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_experiment_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"DELETE",
"/experimentTemplates/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_target_account_configuration(account_id, id)
delete_target_account_configuration(account_id, id, params::Dict{String,<:Any})
Deletes the specified target account configuration of the experiment template.
# Arguments
- `account_id`: The Amazon Web Services account ID of the target account.
- `id`: The ID of the experiment template.
"""
function delete_target_account_configuration(
accountId, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"DELETE",
"/experimentTemplates/$(id)/targetAccountConfigurations/$(accountId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_target_account_configuration(
accountId,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fis(
"DELETE",
"/experimentTemplates/$(id)/targetAccountConfigurations/$(accountId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_action(id)
get_action(id, params::Dict{String,<:Any})
Gets information about the specified FIS action.
# Arguments
- `id`: The ID of the action.
"""
function get_action(id; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"GET", "/actions/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_action(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/actions/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_experiment(id)
get_experiment(id, params::Dict{String,<:Any})
Gets information about the specified experiment.
# Arguments
- `id`: The ID of the experiment.
"""
function get_experiment(id; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"GET", "/experiments/$(id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_experiment(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experiments/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_experiment_target_account_configuration(account_id, id)
get_experiment_target_account_configuration(account_id, id, params::Dict{String,<:Any})
Gets information about the specified target account configuration of the experiment.
# Arguments
- `account_id`: The Amazon Web Services account ID of the target account.
- `id`: The ID of the experiment.
"""
function get_experiment_target_account_configuration(
accountId, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experiments/$(id)/targetAccountConfigurations/$(accountId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_experiment_target_account_configuration(
accountId,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fis(
"GET",
"/experiments/$(id)/targetAccountConfigurations/$(accountId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_experiment_template(id)
get_experiment_template(id, params::Dict{String,<:Any})
Gets information about the specified experiment template.
# Arguments
- `id`: The ID of the experiment template.
"""
function get_experiment_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"GET",
"/experimentTemplates/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_experiment_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experimentTemplates/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_target_account_configuration(account_id, id)
get_target_account_configuration(account_id, id, params::Dict{String,<:Any})
Gets information about the specified target account configuration of the experiment
template.
# Arguments
- `account_id`: The Amazon Web Services account ID of the target account.
- `id`: The ID of the experiment template.
"""
function get_target_account_configuration(
accountId, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experimentTemplates/$(id)/targetAccountConfigurations/$(accountId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_target_account_configuration(
accountId,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fis(
"GET",
"/experimentTemplates/$(id)/targetAccountConfigurations/$(accountId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_target_resource_type(resource_type)
get_target_resource_type(resource_type, params::Dict{String,<:Any})
Gets information about the specified resource type.
# Arguments
- `resource_type`: The resource type.
"""
function get_target_resource_type(
resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/targetResourceTypes/$(resourceType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_target_resource_type(
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fis(
"GET",
"/targetResourceTypes/$(resourceType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_actions()
list_actions(params::Dict{String,<:Any})
Lists the available FIS actions.
# 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_actions(; aws_config::AbstractAWSConfig=global_aws_config())
return fis("GET", "/actions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_actions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET", "/actions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_experiment_resolved_targets(id)
list_experiment_resolved_targets(id, params::Dict{String,<:Any})
Lists the resolved targets information of the specified experiment.
# Arguments
- `id`: The ID of the experiment.
# 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.
- `"targetName"`: The name of the target.
"""
function list_experiment_resolved_targets(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experiments/$(id)/resolvedTargets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_experiment_resolved_targets(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experiments/$(id)/resolvedTargets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_experiment_target_account_configurations(id)
list_experiment_target_account_configurations(id, params::Dict{String,<:Any})
Lists the target account configurations of the specified experiment.
# Arguments
- `id`: The ID of the experiment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: The token for the next page of results.
"""
function list_experiment_target_account_configurations(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experiments/$(id)/targetAccountConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_experiment_target_account_configurations(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experiments/$(id)/targetAccountConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_experiment_templates()
list_experiment_templates(params::Dict{String,<:Any})
Lists your experiment templates.
# 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_experiment_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"GET",
"/experimentTemplates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_experiment_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experimentTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_experiments()
list_experiments(params::Dict{String,<:Any})
Lists your experiments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"experimentTemplateId"`: The ID of the experiment template.
- `"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_experiments(; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"GET", "/experiments"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_experiments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experiments",
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 fis(
"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 fis(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_target_account_configurations(id)
list_target_account_configurations(id, params::Dict{String,<:Any})
Lists the target account configurations of the specified experiment template.
# Arguments
- `id`: The ID of the experiment template.
# 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_target_account_configurations(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experimentTemplates/$(id)/targetAccountConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_target_account_configurations(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/experimentTemplates/$(id)/targetAccountConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_target_resource_types()
list_target_resource_types(params::Dict{String,<:Any})
Lists the target resource types.
# 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_target_resource_types(; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"GET",
"/targetResourceTypes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_target_resource_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"GET",
"/targetResourceTypes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_experiment(client_token, experiment_template_id)
start_experiment(client_token, experiment_template_id, params::Dict{String,<:Any})
Starts running an experiment from the specified experiment template.
# Arguments
- `client_token`: Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
- `experiment_template_id`: The ID of the experiment template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"experimentOptions"`: The experiment options for running the experiment.
- `"tags"`: The tags to apply to the experiment.
"""
function start_experiment(
clientToken, experimentTemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"POST",
"/experiments",
Dict{String,Any}(
"clientToken" => clientToken, "experimentTemplateId" => experimentTemplateId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_experiment(
clientToken,
experimentTemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fis(
"POST",
"/experiments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"experimentTemplateId" => experimentTemplateId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_experiment(id)
stop_experiment(id, params::Dict{String,<:Any})
Stops the specified experiment.
# Arguments
- `id`: The ID of the experiment.
"""
function stop_experiment(id; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"DELETE",
"/experiments/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_experiment(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"DELETE",
"/experiments/$(id)",
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 the specified tags to the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource.
- `tags`: The tags for the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"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 fis(
"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)
untag_resource(resource_arn, params::Dict{String,<:Any})
Removes the specified tags from the specified 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:
- `"tagKeys"`: The tag keys to remove.
"""
function untag_resource(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"DELETE",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fis(
"DELETE",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_experiment_template(id)
update_experiment_template(id, params::Dict{String,<:Any})
Updates the specified experiment template.
# Arguments
- `id`: The ID of the experiment template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"actions"`: The actions for the experiment.
- `"description"`: A description for the template.
- `"experimentOptions"`: The experiment options for the experiment template.
- `"logConfiguration"`: The configuration for experiment logging.
- `"roleArn"`: The Amazon Resource Name (ARN) of an IAM role that grants the FIS service
permission to perform service actions on your behalf.
- `"stopConditions"`: The stop conditions for the experiment.
- `"targets"`: The targets for the experiment.
"""
function update_experiment_template(id; aws_config::AbstractAWSConfig=global_aws_config())
return fis(
"PATCH",
"/experimentTemplates/$(id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_experiment_template(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"PATCH",
"/experimentTemplates/$(id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_target_account_configuration(account_id, id)
update_target_account_configuration(account_id, id, params::Dict{String,<:Any})
Updates the target account configuration for the specified experiment template.
# Arguments
- `account_id`: The Amazon Web Services account ID of the target account.
- `id`: The ID of the experiment template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the target account.
- `"roleArn"`: The Amazon Resource Name (ARN) of an IAM role for the target account.
"""
function update_target_account_configuration(
accountId, id; aws_config::AbstractAWSConfig=global_aws_config()
)
return fis(
"PATCH",
"/experimentTemplates/$(id)/targetAccountConfigurations/$(accountId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_target_account_configuration(
accountId,
id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fis(
"PATCH",
"/experimentTemplates/$(id)/targetAccountConfigurations/$(accountId)",
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 | 61842 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: fms
using AWS.Compat
using AWS.UUIDs
"""
associate_admin_account(admin_account)
associate_admin_account(admin_account, params::Dict{String,<:Any})
Sets a Firewall Manager default administrator account. The Firewall Manager default
administrator account can manage third-party firewalls and has full administrative scope
that allows administration of all policy types, accounts, organizational units, and
Regions. This account must be a member account of the organization in Organizations whose
resources you want to protect. For information about working with Firewall Manager
administrator accounts, see Managing Firewall Manager administrators in the Firewall
Manager Developer Guide.
# Arguments
- `admin_account`: The Amazon Web Services account ID to associate with Firewall Manager as
the Firewall Manager default administrator account. This account must be a member account
of the organization in Organizations whose resources you want to protect. For more
information about Organizations, see Managing the Amazon Web Services Accounts in Your
Organization.
"""
function associate_admin_account(
AdminAccount; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"AssociateAdminAccount",
Dict{String,Any}("AdminAccount" => AdminAccount);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_admin_account(
AdminAccount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"AssociateAdminAccount",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AdminAccount" => AdminAccount), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_third_party_firewall(third_party_firewall)
associate_third_party_firewall(third_party_firewall, params::Dict{String,<:Any})
Sets the Firewall Manager policy administrator as a tenant administrator of a third-party
firewall service. A tenant is an instance of the third-party firewall service that's
associated with your Amazon Web Services customer account.
# Arguments
- `third_party_firewall`: The name of the third-party firewall vendor.
"""
function associate_third_party_firewall(
ThirdPartyFirewall; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"AssociateThirdPartyFirewall",
Dict{String,Any}("ThirdPartyFirewall" => ThirdPartyFirewall);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_third_party_firewall(
ThirdPartyFirewall,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"AssociateThirdPartyFirewall",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ThirdPartyFirewall" => ThirdPartyFirewall), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_associate_resource(items, resource_set_identifier)
batch_associate_resource(items, resource_set_identifier, params::Dict{String,<:Any})
Associate resources to a Firewall Manager resource set.
# Arguments
- `items`: The uniform resource identifiers (URIs) of resources that should be associated
to the resource set. The URIs must be Amazon Resource Names (ARNs).
- `resource_set_identifier`: A unique identifier for the resource set, used in a request to
refer to the resource set.
"""
function batch_associate_resource(
Items, ResourceSetIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"BatchAssociateResource",
Dict{String,Any}(
"Items" => Items, "ResourceSetIdentifier" => ResourceSetIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_associate_resource(
Items,
ResourceSetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"BatchAssociateResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Items" => Items, "ResourceSetIdentifier" => ResourceSetIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_disassociate_resource(items, resource_set_identifier)
batch_disassociate_resource(items, resource_set_identifier, params::Dict{String,<:Any})
Disassociates resources from a Firewall Manager resource set.
# Arguments
- `items`: The uniform resource identifiers (URI) of resources that should be disassociated
from the resource set. The URIs must be Amazon Resource Names (ARNs).
- `resource_set_identifier`: A unique identifier for the resource set, used in a request to
refer to the resource set.
"""
function batch_disassociate_resource(
Items, ResourceSetIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"BatchDisassociateResource",
Dict{String,Any}(
"Items" => Items, "ResourceSetIdentifier" => ResourceSetIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_disassociate_resource(
Items,
ResourceSetIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"BatchDisassociateResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Items" => Items, "ResourceSetIdentifier" => ResourceSetIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_apps_list(list_id)
delete_apps_list(list_id, params::Dict{String,<:Any})
Permanently deletes an Firewall Manager applications list.
# Arguments
- `list_id`: The ID of the applications list that you want to delete. You can retrieve this
ID from PutAppsList, ListAppsLists, and GetAppsList.
"""
function delete_apps_list(ListId; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"DeleteAppsList",
Dict{String,Any}("ListId" => ListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_apps_list(
ListId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"DeleteAppsList",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ListId" => ListId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_notification_channel()
delete_notification_channel(params::Dict{String,<:Any})
Deletes an Firewall Manager association with the IAM role and the Amazon Simple
Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
"""
function delete_notification_channel(; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"DeleteNotificationChannel"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function delete_notification_channel(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"DeleteNotificationChannel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy(policy_id)
delete_policy(policy_id, params::Dict{String,<:Any})
Permanently deletes an Firewall Manager policy.
# Arguments
- `policy_id`: The ID of the policy that you want to delete. You can retrieve this ID from
PutPolicy and ListPolicies.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteAllPolicyResources"`: If True, the request performs cleanup according to the
policy type. For WAF and Shield Advanced policies, the cleanup does the following:
Deletes rule groups created by Firewall Manager Removes web ACLs from in-scope resources
Deletes web ACLs that contain no rules or rule groups For security group policies, the
cleanup does the following for each security group in the policy: Disassociates the
security group from in-scope resources Deletes the security group if it was created
through Firewall Manager and if it's no longer associated with any resources through
another policy For security group common policies, even if set to False, Firewall
Manager deletes all security groups created by Firewall Manager that aren't associated with
any other resources through another policy. After the cleanup, in-scope resources are no
longer protected by web ACLs in this policy. Protection of out-of-scope resources remains
unchanged. Scope is determined by tags that you create and accounts that you associate with
the policy. When creating the policy, if you specify that only resources in specific
accounts or with specific tags are in scope of the policy, those accounts and resources are
handled by the policy. All others are out of scope. If you don't specify tags or accounts,
all resources are in scope.
"""
function delete_policy(PolicyId; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"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 fms(
"DeletePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyId" => PolicyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_protocols_list(list_id)
delete_protocols_list(list_id, params::Dict{String,<:Any})
Permanently deletes an Firewall Manager protocols list.
# Arguments
- `list_id`: The ID of the protocols list that you want to delete. You can retrieve this ID
from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.
"""
function delete_protocols_list(ListId; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"DeleteProtocolsList",
Dict{String,Any}("ListId" => ListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_protocols_list(
ListId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"DeleteProtocolsList",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ListId" => ListId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_set(identifier)
delete_resource_set(identifier, params::Dict{String,<:Any})
Deletes the specified ResourceSet.
# Arguments
- `identifier`: A unique identifier for the resource set, used in a request to refer to the
resource set.
"""
function delete_resource_set(Identifier; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"DeleteResourceSet",
Dict{String,Any}("Identifier" => Identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_set(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"DeleteResourceSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identifier" => Identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_admin_account()
disassociate_admin_account(params::Dict{String,<:Any})
Disassociates an Firewall Manager administrator account. To set a different account as an
Firewall Manager administrator, submit a PutAdminAccount request. To set an account as a
default administrator account, you must submit an AssociateAdminAccount request.
Disassociation of the default administrator account follows the first in, last out
principle. If you are the default administrator, all Firewall Manager administrators within
the organization must first disassociate their accounts before you can disassociate your
account.
"""
function disassociate_admin_account(; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"DisassociateAdminAccount"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function disassociate_admin_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"DisassociateAdminAccount",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_third_party_firewall(third_party_firewall)
disassociate_third_party_firewall(third_party_firewall, params::Dict{String,<:Any})
Disassociates a Firewall Manager policy administrator from a third-party firewall tenant.
When you call DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all
of the firewalls that are associated with the account.
# Arguments
- `third_party_firewall`: The name of the third-party firewall vendor.
"""
function disassociate_third_party_firewall(
ThirdPartyFirewall; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"DisassociateThirdPartyFirewall",
Dict{String,Any}("ThirdPartyFirewall" => ThirdPartyFirewall);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_third_party_firewall(
ThirdPartyFirewall,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"DisassociateThirdPartyFirewall",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ThirdPartyFirewall" => ThirdPartyFirewall), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_admin_account()
get_admin_account(params::Dict{String,<:Any})
Returns the Organizations account that is associated with Firewall Manager as the Firewall
Manager default administrator.
"""
function get_admin_account(; aws_config::AbstractAWSConfig=global_aws_config())
return fms("GetAdminAccount"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_admin_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"GetAdminAccount", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_admin_scope(admin_account)
get_admin_scope(admin_account, params::Dict{String,<:Any})
Returns information about the specified account's administrative scope. The administrative
scope defines the resources that an Firewall Manager administrator can manage.
# Arguments
- `admin_account`: The administrator account that you want to get the details for.
"""
function get_admin_scope(AdminAccount; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"GetAdminScope",
Dict{String,Any}("AdminAccount" => AdminAccount);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_admin_scope(
AdminAccount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"GetAdminScope",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AdminAccount" => AdminAccount), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_apps_list(list_id)
get_apps_list(list_id, params::Dict{String,<:Any})
Returns information about the specified Firewall Manager applications list.
# Arguments
- `list_id`: The ID of the Firewall Manager applications list that you want the details for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultList"`: Specifies whether the list to retrieve is a default list owned by
Firewall Manager.
"""
function get_apps_list(ListId; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"GetAppsList",
Dict{String,Any}("ListId" => ListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_apps_list(
ListId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"GetAppsList",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ListId" => ListId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compliance_detail(member_account, policy_id)
get_compliance_detail(member_account, policy_id, params::Dict{String,<:Any})
Returns detailed compliance information about the specified member account. Details include
resources that are in and out of compliance with the specified policy. The reasons for
resources being considered compliant depend on the Firewall Manager policy type.
# Arguments
- `member_account`: The Amazon Web Services account that owns the resources that you want
to get the details for.
- `policy_id`: The ID of the policy that you want to get the details for. PolicyId is
returned by PutPolicy and by ListPolicies.
"""
function get_compliance_detail(
MemberAccount, PolicyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"GetComplianceDetail",
Dict{String,Any}("MemberAccount" => MemberAccount, "PolicyId" => PolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_compliance_detail(
MemberAccount,
PolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"GetComplianceDetail",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MemberAccount" => MemberAccount, "PolicyId" => PolicyId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_notification_channel()
get_notification_channel(params::Dict{String,<:Any})
Information about the Amazon Simple Notification Service (SNS) topic that is used to record
Firewall Manager SNS logs.
"""
function get_notification_channel(; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"GetNotificationChannel"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_notification_channel(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"GetNotificationChannel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy(policy_id)
get_policy(policy_id, params::Dict{String,<:Any})
Returns information about the specified Firewall Manager policy.
# Arguments
- `policy_id`: The ID of the Firewall Manager policy that you want the details for.
"""
function get_policy(PolicyId; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"GetPolicy",
Dict{String,Any}("PolicyId" => PolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_policy(
PolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"GetPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyId" => PolicyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_protection_status(policy_id)
get_protection_status(policy_id, params::Dict{String,<:Any})
If you created a Shield Advanced policy, returns policy-level attack summary information in
the event of a potential DDoS attack. Other policy types are currently unsupported.
# Arguments
- `policy_id`: The ID of the policy for which you want to get the attack information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndTime"`: The end of the time period to query for the attacks. This is a timestamp
type. The request syntax listing indicates a number type because the default used by
Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.
- `"MaxResults"`: Specifies the number of objects that you want Firewall Manager to return
for this request. If you have more objects than the number that you specify for MaxResults,
the response includes a NextToken value that you can use to get another batch of objects.
- `"MemberAccountId"`: The Amazon Web Services account that is in scope of the policy that
you want to get the details for.
- `"NextToken"`: If you specify a value for MaxResults and you have more objects than the
number that you specify for MaxResults, Firewall Manager returns a NextToken value in the
response, which you can use to retrieve another group of objects. For the second and
subsequent GetProtectionStatus requests, specify the value of NextToken from the previous
response to get information about another batch of objects.
- `"StartTime"`: The start of the time period to query for the attacks. This is a timestamp
type. The request syntax listing indicates a number type because the default used by
Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.
"""
function get_protection_status(PolicyId; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"GetProtectionStatus",
Dict{String,Any}("PolicyId" => PolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_protection_status(
PolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"GetProtectionStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyId" => PolicyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_protocols_list(list_id)
get_protocols_list(list_id, params::Dict{String,<:Any})
Returns information about the specified Firewall Manager protocols list.
# Arguments
- `list_id`: The ID of the Firewall Manager protocols list that you want the details for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultList"`: Specifies whether the list to retrieve is a default list owned by
Firewall Manager.
"""
function get_protocols_list(ListId; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"GetProtocolsList",
Dict{String,Any}("ListId" => ListId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_protocols_list(
ListId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"GetProtocolsList",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("ListId" => ListId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_set(identifier)
get_resource_set(identifier, params::Dict{String,<:Any})
Gets information about a specific resource set.
# Arguments
- `identifier`: A unique identifier for the resource set, used in a request to refer to the
resource set.
"""
function get_resource_set(Identifier; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"GetResourceSet",
Dict{String,Any}("Identifier" => Identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_set(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"GetResourceSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identifier" => Identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_third_party_firewall_association_status(third_party_firewall)
get_third_party_firewall_association_status(third_party_firewall, params::Dict{String,<:Any})
The onboarding status of a Firewall Manager admin account to third-party firewall vendor
tenant.
# Arguments
- `third_party_firewall`: The name of the third-party firewall vendor.
"""
function get_third_party_firewall_association_status(
ThirdPartyFirewall; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"GetThirdPartyFirewallAssociationStatus",
Dict{String,Any}("ThirdPartyFirewall" => ThirdPartyFirewall);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_third_party_firewall_association_status(
ThirdPartyFirewall,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"GetThirdPartyFirewallAssociationStatus",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ThirdPartyFirewall" => ThirdPartyFirewall), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_violation_details(member_account, policy_id, resource_id, resource_type)
get_violation_details(member_account, policy_id, resource_id, resource_type, params::Dict{String,<:Any})
Retrieves violations for a resource based on the specified Firewall Manager policy and
Amazon Web Services account.
# Arguments
- `member_account`: The Amazon Web Services account ID that you want the details for.
- `policy_id`: The ID of the Firewall Manager policy that you want the details for. You can
get violation details for the following policy types: DNS Firewall Imported Network
Firewall Network Firewall Security group content audit Network ACL Third-party
firewall
- `resource_id`: The ID of the resource that has violations.
- `resource_type`: The resource type. This is in the format shown in the Amazon Web
Services Resource Types Reference. Supported resource types are: AWS::EC2::Instance,
AWS::EC2::NetworkInterface, AWS::EC2::SecurityGroup, AWS::NetworkFirewall::FirewallPolicy,
and AWS::EC2::Subnet.
"""
function get_violation_details(
MemberAccount,
PolicyId,
ResourceId,
ResourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"GetViolationDetails",
Dict{String,Any}(
"MemberAccount" => MemberAccount,
"PolicyId" => PolicyId,
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_violation_details(
MemberAccount,
PolicyId,
ResourceId,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"GetViolationDetails",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MemberAccount" => MemberAccount,
"PolicyId" => PolicyId,
"ResourceId" => ResourceId,
"ResourceType" => ResourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_admin_accounts_for_organization()
list_admin_accounts_for_organization(params::Dict{String,<:Any})
Returns a AdminAccounts object that lists the Firewall Manager administrators within the
organization that are onboarded to Firewall Manager by AssociateAdminAccount. This
operation can be called only from the organization's management 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 Firewall Manager to return
for this request. If more objects are available, in the response, Firewall Manager 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,
Firewall Manager 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_admin_accounts_for_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"ListAdminAccountsForOrganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_admin_accounts_for_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"ListAdminAccountsForOrganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_admins_managing_account()
list_admins_managing_account(params::Dict{String,<:Any})
Lists the accounts that are managing the specified Organizations member account. This is
useful for any member account so that they can view the accounts who are managing their
account. This operation only returns the managing administrators that have the requested
account within their AdminScope.
# 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 Firewall Manager to return
for this request. If more objects are available, in the response, Firewall Manager 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,
Firewall Manager 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_admins_managing_account(; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"ListAdminsManagingAccount"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_admins_managing_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"ListAdminsManagingAccount",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_apps_lists(max_results)
list_apps_lists(max_results, params::Dict{String,<:Any})
Returns an array of AppsListDataSummary objects.
# Arguments
- `max_results`: The maximum number of objects that you want Firewall Manager to return for
this request. If more objects are available, in the response, Firewall Manager provides a
NextToken value that you can use in a subsequent call to get the next batch of objects. If
you don't specify this, Firewall Manager returns all available objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultLists"`: Specifies whether the lists to retrieve are default lists owned by
Firewall Manager.
- `"NextToken"`: If you specify a value for MaxResults in your list request, and you have
more objects than the maximum, Firewall Manager returns this token in the response. For all
but the first request, you provide the token returned by the prior request in the request
parameters, to retrieve the next batch of objects.
"""
function list_apps_lists(MaxResults; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"ListAppsLists",
Dict{String,Any}("MaxResults" => MaxResults);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_apps_lists(
MaxResults,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"ListAppsLists",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MaxResults" => MaxResults), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_compliance_status(policy_id)
list_compliance_status(policy_id, params::Dict{String,<:Any})
Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a
summary of which member accounts are protected by the specified policy.
# Arguments
- `policy_id`: The ID of the Firewall Manager policy that you want the details for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the number of PolicyComplianceStatus objects that you want
Firewall Manager to return for this request. If you have more PolicyComplianceStatus
objects than the number that you specify for MaxResults, the response includes a NextToken
value that you can use to get another batch of PolicyComplianceStatus objects.
- `"NextToken"`: If you specify a value for MaxResults and you have more
PolicyComplianceStatus objects than the number that you specify for MaxResults, Firewall
Manager returns a NextToken value in the response that allows you to list another group of
PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus
requests, specify the value of NextToken from the previous response to get information
about another batch of PolicyComplianceStatus objects.
"""
function list_compliance_status(PolicyId; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"ListComplianceStatus",
Dict{String,Any}("PolicyId" => PolicyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_compliance_status(
PolicyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"ListComplianceStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyId" => PolicyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_discovered_resources(member_account_ids, resource_type)
list_discovered_resources(member_account_ids, resource_type, params::Dict{String,<:Any})
Returns an array of resources in the organization's accounts that are available to be
associated with a resource set.
# Arguments
- `member_account_ids`: The Amazon Web Services account IDs to discover resources in. Only
one account is supported per request. The account must be a member of your organization.
- `resource_type`: The type of resources to discover.
# 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 Firewall Manager to return
for this request. If more objects are available, in the response, Firewall Manager 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,
Firewall Manager 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_discovered_resources(
MemberAccountIds, ResourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"ListDiscoveredResources",
Dict{String,Any}(
"MemberAccountIds" => MemberAccountIds, "ResourceType" => ResourceType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_discovered_resources(
MemberAccountIds,
ResourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"ListDiscoveredResources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MemberAccountIds" => MemberAccountIds, "ResourceType" => ResourceType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_member_accounts()
list_member_accounts(params::Dict{String,<:Any})
Returns a MemberAccounts object that lists the member accounts in the administrator's
Amazon Web Services organization. Either an Firewall Manager administrator or the
organization's management account can make this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the number of member account IDs that you want Firewall Manager
to return for this request. If you have more IDs than the number that you specify for
MaxResults, the response includes a NextToken value that you can use to get another batch
of member account IDs.
- `"NextToken"`: If you specify a value for MaxResults and you have more account IDs than
the number that you specify for MaxResults, Firewall Manager returns a NextToken value in
the response that allows you to list another group of IDs. For the second and subsequent
ListMemberAccountsRequest requests, specify the value of NextToken from the previous
response to get information about another batch of member account IDs.
"""
function list_member_accounts(; aws_config::AbstractAWSConfig=global_aws_config())
return fms("ListMemberAccounts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_member_accounts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"ListMemberAccounts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_policies()
list_policies(params::Dict{String,<:Any})
Returns an array of PolicySummary objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Specifies the number of PolicySummary objects that you want Firewall
Manager to return for this request. If you have more PolicySummary objects than the number
that you specify for MaxResults, the response includes a NextToken value that you can use
to get another batch of PolicySummary objects.
- `"NextToken"`: If you specify a value for MaxResults and you have more PolicySummary
objects than the number that you specify for MaxResults, Firewall Manager returns a
NextToken value in the response that allows you to list another group of PolicySummary
objects. For the second and subsequent ListPolicies requests, specify the value of
NextToken from the previous response to get information about another batch of
PolicySummary objects.
"""
function list_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return fms("ListPolicies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"ListPolicies", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_protocols_lists(max_results)
list_protocols_lists(max_results, params::Dict{String,<:Any})
Returns an array of ProtocolsListDataSummary objects.
# Arguments
- `max_results`: The maximum number of objects that you want Firewall Manager to return for
this request. If more objects are available, in the response, Firewall Manager provides a
NextToken value that you can use in a subsequent call to get the next batch of objects. If
you don't specify this, Firewall Manager returns all available objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultLists"`: Specifies whether the lists to retrieve are default lists owned by
Firewall Manager.
- `"NextToken"`: If you specify a value for MaxResults in your list request, and you have
more objects than the maximum, Firewall Manager returns this token in the response. For all
but the first request, you provide the token returned by the prior request in the request
parameters, to retrieve the next batch of objects.
"""
function list_protocols_lists(MaxResults; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"ListProtocolsLists",
Dict{String,Any}("MaxResults" => MaxResults);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_protocols_lists(
MaxResults,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"ListProtocolsLists",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MaxResults" => MaxResults), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_set_resources(identifier)
list_resource_set_resources(identifier, params::Dict{String,<:Any})
Returns an array of resources that are currently associated to a resource set.
# Arguments
- `identifier`: A unique identifier for the resource set, used in a request to refer to the
resource set.
# 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 Firewall Manager to return
for this request. If more objects are available, in the response, Firewall Manager 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,
Firewall Manager 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_resource_set_resources(
Identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"ListResourceSetResources",
Dict{String,Any}("Identifier" => Identifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resource_set_resources(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"ListResourceSetResources",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Identifier" => Identifier), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_sets()
list_resource_sets(params::Dict{String,<:Any})
Returns an array of ResourceSetSummary objects.
# 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 Firewall Manager to return
for this request. If more objects are available, in the response, Firewall Manager 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,
Firewall Manager 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_resource_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return fms("ListResourceSets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_resource_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"ListResourceSets", 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 the specified Amazon Web Services resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to return tags for. The
Firewall Manager resources that support tagging are policies, applications lists, and
protocols lists.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"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 fms(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_third_party_firewall_firewall_policies(max_results, third_party_firewall)
list_third_party_firewall_firewall_policies(max_results, third_party_firewall, params::Dict{String,<:Any})
Retrieves a list of all of the third-party firewall policies that are associated with the
third-party firewall administrator's account.
# Arguments
- `max_results`: The maximum number of third-party firewall policies that you want Firewall
Manager to return. If the specified third-party firewall vendor is associated with more
than MaxResults firewall policies, the response includes a NextToken element. NextToken
contains an encrypted token that identifies the first third-party firewall policies that
Firewall Manager will return if you submit another request.
- `third_party_firewall`: The name of the third-party firewall vendor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NextToken"`: If the previous response included a NextToken element, the specified
third-party firewall vendor is associated with more third-party firewall policies. To get
more third-party firewall policies, submit another
ListThirdPartyFirewallFirewallPoliciesRequest request. For the value of NextToken, specify
the value of NextToken from the previous response. If the previous response didn't include
a NextToken element, there are no more third-party firewall policies to get.
"""
function list_third_party_firewall_firewall_policies(
MaxResults, ThirdPartyFirewall; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"ListThirdPartyFirewallFirewallPolicies",
Dict{String,Any}(
"MaxResults" => MaxResults, "ThirdPartyFirewall" => ThirdPartyFirewall
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_third_party_firewall_firewall_policies(
MaxResults,
ThirdPartyFirewall,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"ListThirdPartyFirewallFirewallPolicies",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MaxResults" => MaxResults, "ThirdPartyFirewall" => ThirdPartyFirewall
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_admin_account(admin_account)
put_admin_account(admin_account, params::Dict{String,<:Any})
Creates or updates an Firewall Manager administrator account. The account must be a member
of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. Only
the organization's management account can create an Firewall Manager administrator account.
When you create an Firewall Manager administrator account, the service checks to see if the
account is already a delegated administrator within Organizations. If the account isn't a
delegated administrator, Firewall Manager calls Organizations to delegate the account
within Organizations. For more information about administrator accounts within
Organizations, see Managing the Amazon Web Services Accounts in Your Organization.
# Arguments
- `admin_account`: The Amazon Web Services account ID to add as an Firewall Manager
administrator account. The account must be a member of the organization that was onboarded
to Firewall Manager by AssociateAdminAccount. For more information about Organizations, see
Managing the Amazon Web Services Accounts in Your Organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdminScope"`: Configures the resources that the specified Firewall Manager
administrator can manage. As a best practice, set the administrative scope according to the
principles of least privilege. Only grant the administrator the specific resources or
permissions that they need to perform the duties of their role.
"""
function put_admin_account(AdminAccount; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"PutAdminAccount",
Dict{String,Any}("AdminAccount" => AdminAccount);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_admin_account(
AdminAccount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"PutAdminAccount",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AdminAccount" => AdminAccount), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_apps_list(apps_list)
put_apps_list(apps_list, params::Dict{String,<:Any})
Creates an Firewall Manager applications list.
# Arguments
- `apps_list`: The details of the Firewall Manager applications list to be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagList"`: The tags associated with the resource.
"""
function put_apps_list(AppsList; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"PutAppsList",
Dict{String,Any}("AppsList" => AppsList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_apps_list(
AppsList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"PutAppsList",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AppsList" => AppsList), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_notification_channel(sns_role_name, sns_topic_arn)
put_notification_channel(sns_role_name, sns_topic_arn, params::Dict{String,<:Any})
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall
Manager uses to record SNS logs. To perform this action outside of the console, you must
first configure the SNS topic's access policy to allow the SnsRoleName to publish SNS logs.
If the SnsRoleName provided is a role other than the AWSServiceRoleForFMS service-linked
role, this role must have a trust relationship configured to allow the Firewall Manager
service principal fms.amazonaws.com to assume this role. For information about configuring
an SNS access policy, see Service roles for Firewall Manager in the Firewall Manager
Developer Guide.
# Arguments
- `sns_role_name`: The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to
record Firewall Manager activity.
- `sns_topic_arn`: The Amazon Resource Name (ARN) of the SNS topic that collects
notifications from Firewall Manager.
"""
function put_notification_channel(
SnsRoleName, SnsTopicArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"PutNotificationChannel",
Dict{String,Any}("SnsRoleName" => SnsRoleName, "SnsTopicArn" => SnsTopicArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_notification_channel(
SnsRoleName,
SnsTopicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"PutNotificationChannel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SnsRoleName" => SnsRoleName, "SnsTopicArn" => SnsTopicArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_policy(policy)
put_policy(policy, params::Dict{String,<:Any})
Creates an Firewall Manager policy. A Firewall Manager policy is specific to the individual
policy type. If you want to enforce multiple policy types across accounts, you can create
multiple policies. You can create more than one policy for each type. If you add a new
account to an organization that you created with Organizations, Firewall Manager
automatically applies the policy to the resources in that account that are within scope of
the policy. Firewall Manager provides the following types of policies: WAF policy -
This policy applies WAF web ACL protections to specified accounts and resources. Shield
Advanced policy - This policy applies Shield Advanced protection to specified accounts and
resources. Security Groups policy - This type of policy gives you control over security
groups that are in use throughout your organization in Organizations and lets you enforce a
baseline set of rules across your organization. Network ACL policy - This type of
policy gives you control over the network ACLs that are in use throughout your organization
in Organizations and lets you enforce a baseline set of first and last network ACL rules
across your organization. Network Firewall policy - This policy applies Network
Firewall protection to your organization's VPCs. DNS Firewall policy - This policy
applies Amazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
Third-party firewall policy - This policy applies third-party firewall protections.
Third-party firewalls are available by subscription through the Amazon Web Services
Marketplace console at Amazon Web Services Marketplace. Palo Alto Networks Cloud NGFW
policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW)
protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
Fortigate CNF policy - This policy applies Fortigate Cloud Native Firewall (CNF)
protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and
secures cloud infrastructures with industry-leading advanced threat prevention, smart web
application firewalls (WAF), and API protection.
# Arguments
- `policy`: The details of the Firewall Manager policy to be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagList"`: The tags to add to the Amazon Web Services resource.
"""
function put_policy(Policy; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"PutPolicy",
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 fms(
"PutPolicy",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Policy" => Policy), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_protocols_list(protocols_list)
put_protocols_list(protocols_list, params::Dict{String,<:Any})
Creates an Firewall Manager protocols list.
# Arguments
- `protocols_list`: The details of the Firewall Manager protocols list to be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagList"`: The tags associated with the resource.
"""
function put_protocols_list(
ProtocolsList; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"PutProtocolsList",
Dict{String,Any}("ProtocolsList" => ProtocolsList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_protocols_list(
ProtocolsList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"PutProtocolsList",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ProtocolsList" => ProtocolsList), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_set(resource_set)
put_resource_set(resource_set, params::Dict{String,<:Any})
Creates the resource set. An Firewall Manager resource set defines the resources to import
into an Firewall Manager policy from another Amazon Web Services service.
# Arguments
- `resource_set`: Details about the resource set to be created or updated.>
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagList"`: Retrieves the tags associated with the specified resource set. 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.
"""
function put_resource_set(ResourceSet; aws_config::AbstractAWSConfig=global_aws_config())
return fms(
"PutResourceSet",
Dict{String,Any}("ResourceSet" => ResourceSet);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_set(
ResourceSet,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"PutResourceSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceSet" => ResourceSet), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tag_list)
tag_resource(resource_arn, tag_list, params::Dict{String,<:Any})
Adds one or more tags to an Amazon Web Services resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to return tags for. The
Firewall Manager resources that support tagging are policies, applications lists, and
protocols lists.
- `tag_list`: The tags to add to the resource.
"""
function tag_resource(
ResourceArn, TagList; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagList" => TagList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
TagList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fms(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagList" => TagList),
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 Web Services resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource to return tags for. The
Firewall Manager resources that support tagging are policies, applications lists, and
protocols lists.
- `tag_keys`: The keys of the tags to remove from the resource.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return fms(
"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 fms(
"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 | 140096 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: forecast
using AWS.Compat
using AWS.UUIDs
"""
create_auto_predictor(predictor_name)
create_auto_predictor(predictor_name, params::Dict{String,<:Any})
Creates an Amazon Forecast predictor. Amazon Forecast creates predictors with
AutoPredictor, which involves applying the optimal combination of algorithms to each time
series in your datasets. You can use CreateAutoPredictor to create new predictors or
upgrade/retrain existing predictors. Creating new predictors The following parameters are
required when creating a new predictor: PredictorName - A unique name for the predictor.
DatasetGroupArn - The ARN of the dataset group used to train the predictor.
ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc).
ForecastHorizon - The number of time-steps that the model predicts. The forecast horizon is
also called the prediction length. When creating a new predictor, do not specify a value
for ReferencePredictorArn. Upgrading and retraining predictors The following parameters
are required when retraining or upgrading a predictor: PredictorName - A unique name for
the predictor. ReferencePredictorArn - The ARN of the predictor to retrain or upgrade.
When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn
and PredictorName.
# Arguments
- `predictor_name`: A unique name for the predictor
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataConfig"`: The data configuration for your dataset group and any additional datasets.
- `"EncryptionConfig"`:
- `"ExplainPredictor"`: Create an Explainability resource for the predictor.
- `"ForecastDimensions"`: An array of dimension (field) names that specify how to group the
generated forecast. For example, if you are generating forecasts for item sales across all
your stores, and your dataset contains a store_id field, you would specify store_id as a
dimension to group sales forecasts for each store.
- `"ForecastFrequency"`: The frequency of predictions in a forecast. Valid intervals are an
integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For
example, \"1D\" indicates every day and \"15min\" indicates every 15 minutes. You cannot
specify a value that would overlap with the next larger frequency. That means, for example,
you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The
valid values for each frequency are the following: Minute - 1-59 Hour - 1-23 Day -
1-6 Week - 1-4 Month - 1-11 Year - 1 Thus, if you want every other week forecasts,
specify \"2W\". Or, if you want quarterly forecasts, you specify \"3M\". The frequency must
be greater than or equal to the TARGET_TIME_SERIES dataset frequency. When a
RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the
RELATED_TIME_SERIES dataset frequency.
- `"ForecastHorizon"`: The number of time-steps that the model predicts. The forecast
horizon is also called the prediction length. The maximum forecast horizon is the lesser of
500 time-steps or 1/4 of the TARGET_TIME_SERIES dataset length. If you are retraining an
existing AutoPredictor, then the maximum forecast horizon is the lesser of 500 time-steps
or 1/3 of the TARGET_TIME_SERIES dataset length. If you are upgrading to an AutoPredictor
or retraining an existing AutoPredictor, you cannot update the forecast horizon parameter.
You can meet this requirement by providing longer time-series in the dataset.
- `"ForecastTypes"`: The forecast types used to train a predictor. You can specify up to
five forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of
0.01 or higher. You can also specify the mean forecast with mean.
- `"MonitorConfig"`: The configuration details for predictor monitoring. Provide a name for
the monitor resource to enable predictor monitoring. Predictor monitoring allows you to see
how your predictor's performance changes over time. For more information, see Predictor
Monitoring.
- `"OptimizationMetric"`: The accuracy metric used to optimize the predictor.
- `"ReferencePredictorArn"`: The ARN of the predictor to retrain or upgrade. This parameter
is only used when retraining or upgrading a predictor. When creating a new predictor, do
not specify a value for this parameter. When upgrading or retraining a predictor, only
specify values for the ReferencePredictorArn and PredictorName. The value for PredictorName
must be a unique predictor name.
- `"Tags"`: Optional metadata to help you categorize and organize your predictors. Each tag
consists of a key and an optional value, both of which you define. Tag keys and values are
case sensitive. The following restrictions apply to tags: For each resource, each tag key
must be unique and each tag key must have one value. Maximum number of tags per resource:
50. Maximum key length: 128 Unicode characters in UTF-8. Maximum value length: 256
Unicode characters in UTF-8. Accepted characters: all letters and numbers, spaces
representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other
services and resources, the character restrictions of those services also apply. Key
prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have
this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers
it to be a user tag and will count against the limit of 50 tags. Tags with only the key
prefix of aws do not count against your tags per resource limit. You cannot edit or delete
tag keys with this prefix.
- `"TimeAlignmentBoundary"`: The time boundary Forecast uses to align and aggregate any
data that doesn't align with your forecast frequency. Provide the unit of time and the time
boundary as a key value pair. For more information on specifying a time boundary, see
Specifying a Time Boundary. If you don't provide a time boundary, Forecast uses a set of
Default Time Boundaries.
"""
function create_auto_predictor(
PredictorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"CreateAutoPredictor",
Dict{String,Any}("PredictorName" => PredictorName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_auto_predictor(
PredictorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateAutoPredictor",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PredictorName" => PredictorName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset(dataset_name, dataset_type, domain, schema)
create_dataset(dataset_name, dataset_type, domain, schema, params::Dict{String,<:Any})
Creates an Amazon Forecast dataset. The information about the dataset that you provide
helps Forecast understand how to consume the data for model training. This includes the
following: DataFrequency - How frequently your historical time-series data is
collected. Domain and DatasetType - Each dataset has an associated dataset domain
and a type within the domain. Amazon Forecast provides a list of predefined domains and
types within each domain. For each unique dataset domain and type within the domain, Amazon
Forecast requires your data to include a minimum set of predefined fields. Schema - A
schema specifies the fields in the dataset, including the field name and data type. After
creating a dataset, you import your training data into it and add the dataset to a dataset
group. You use the dataset group to create a predictor. For more information, see Importing
datasets. To get a list of all your datasets, use the ListDatasets operation. For example
Forecast datasets, see the Amazon Forecast Sample GitHub repository. The Status of a
dataset must be ACTIVE before you can import training data. Use the DescribeDataset
operation to get the status.
# Arguments
- `dataset_name`: A name for the dataset.
- `dataset_type`: The dataset type. Valid values depend on the chosen Domain.
- `domain`: The domain associated with the dataset. When you add a dataset to a dataset
group, this value and the value specified for the Domain parameter of the
CreateDatasetGroup operation must match. The Domain and DatasetType that you choose
determine the fields that must be present in the training data that you import to the
dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the
DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present
in your data. For more information, see Importing datasets.
- `schema`: The schema for the dataset. The schema attributes and their order must match
the fields in your data. The dataset Domain and DatasetType that you choose determine the
minimum required fields in your training data. For information about the required fields
for a specific dataset domain and type, see Dataset Domains and Dataset Types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataFrequency"`: The frequency of data collection. This parameter is required for
RELATED_TIME_SERIES datasets. Valid intervals are an integer followed by Y (Year), M
(Month), W (Week), D (Day), H (Hour), and min (Minute). For example, \"1D\" indicates every
day and \"15min\" indicates every 15 minutes. You cannot specify a value that would overlap
with the next larger frequency. That means, for example, you cannot specify a frequency of
60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are
the following: Minute - 1-59 Hour - 1-23 Day - 1-6 Week - 1-4 Month - 1-11 Year
- 1 Thus, if you want every other week forecasts, specify \"2W\". Or, if you want
quarterly forecasts, you specify \"3M\".
- `"EncryptionConfig"`: An Key Management Service (KMS) key and the Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the key.
- `"Tags"`: The optional metadata that you apply to the dataset to help you categorize and
organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags: Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8. Maximum value length - 256
Unicode characters in UTF-8. If your tagging schema is used across multiple services and
resources, remember that other services may have restrictions on allowed characters.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and
the following characters: + - = . _ : / @. Tag keys and values are case sensitive. Do
not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as
it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this
prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does
not, then Forecast considers it to be a user tag and will count against the limit of 50
tags. Tags with only the key prefix of aws do not count against your tags per resource
limit.
"""
function create_dataset(
DatasetName,
DatasetType,
Domain,
Schema;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateDataset",
Dict{String,Any}(
"DatasetName" => DatasetName,
"DatasetType" => DatasetType,
"Domain" => Domain,
"Schema" => Schema,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset(
DatasetName,
DatasetType,
Domain,
Schema,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateDataset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatasetName" => DatasetName,
"DatasetType" => DatasetType,
"Domain" => Domain,
"Schema" => Schema,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset_group(dataset_group_name, domain)
create_dataset_group(dataset_group_name, domain, params::Dict{String,<:Any})
Creates a dataset group, which holds a collection of related datasets. You can add datasets
to the dataset group when you create the dataset group, or later by using the
UpdateDatasetGroup operation. After creating a dataset group and adding datasets, you use
the dataset group when you create a predictor. For more information, see Dataset groups. To
get a list of all your datasets groups, use the ListDatasetGroups operation. The Status of
a dataset group must be ACTIVE before you can use the dataset group to create a predictor.
To get the status, use the DescribeDatasetGroup operation.
# Arguments
- `dataset_group_name`: A name for the dataset group.
- `domain`: The domain associated with the dataset group. When you add a dataset to a
dataset group, this value and the value specified for the Domain parameter of the
CreateDataset operation must match. The Domain and DatasetType that you choose determine
the fields that must be present in training data that you import to a dataset. For example,
if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast
requires that item_id, timestamp, and demand fields are present in your data. For more
information, see Dataset groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DatasetArns"`: An array of Amazon Resource Names (ARNs) of the datasets that you want
to include in the dataset group.
- `"Tags"`: The optional metadata that you apply to the dataset group to help you
categorize and organize them. Each tag consists of a key and an optional value, both of
which you define. The following basic restrictions apply to tags: Maximum number of tags
per resource - 50. For each resource, each tag key must be unique, and each tag key can
have only one value. Maximum key length - 128 Unicode characters in UTF-8. Maximum
value length - 256 Unicode characters in UTF-8. If your tagging schema is used across
multiple services and resources, remember that other services may have restrictions on
allowed characters. Generally allowed characters are: letters, numbers, and spaces
representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and
values are case sensitive. Do not use aws:, AWS:, or any upper or lowercase combination
of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit
or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as
its prefix but the key does not, then Forecast considers it to be a user tag and will count
against the limit of 50 tags. Tags with only the key prefix of aws do not count against
your tags per resource limit.
"""
function create_dataset_group(
DatasetGroupName, Domain; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"CreateDatasetGroup",
Dict{String,Any}("DatasetGroupName" => DatasetGroupName, "Domain" => Domain);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset_group(
DatasetGroupName,
Domain,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateDatasetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatasetGroupName" => DatasetGroupName, "Domain" => Domain
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset_import_job(data_source, dataset_arn, dataset_import_job_name)
create_dataset_import_job(data_source, dataset_arn, dataset_import_job_name, params::Dict{String,<:Any})
Imports your training data to an Amazon Forecast dataset. You provide the location of your
training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon
Resource Name (ARN) of the dataset that you want to import the data to. You must specify a
DataSource object that includes an Identity and Access Management (IAM) role that Amazon
Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and
processes it in an internal Amazon Web Services system. For more information, see Set up
permissions. The training data must be in CSV or Parquet format. The delimiter must be a
comma (,). You can specify the path to a specific file, the S3 bucket, or to a folder in
the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit
of 10,000 files. Because dataset imports are not aggregated, your most recent dataset
import is the one that is used when training a predictor or generating a forecast. Make
sure that your most recent dataset import contains all of the data you want to model off
of, and not just the new data collected since the previous import. To get a list of all
your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs
operation.
# Arguments
- `data_source`: The location of the training data to import and an Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the data. The training data
must be stored in an Amazon S3 bucket. If encryption is used, DataSource must include an
Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to
access the key. The KMS key and IAM role must match those specified in the EncryptionConfig
parameter of the CreateDataset operation.
- `dataset_arn`: The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you
want to import data to.
- `dataset_import_job_name`: The name for the dataset import job. We recommend including
the current timestamp in the name, for example, 20190721DatasetImport. This can help you
avoid getting a ResourceAlreadyExistsException exception.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Format"`: The format of the imported data, CSV or PARQUET. The default value is CSV.
- `"GeolocationFormat"`: The format of the geolocation attribute. The geolocation attribute
can be formatted in one of two ways: LAT_LONG - the latitude and longitude in decimal
format (Example: 47.61_-122.33). CC_POSTALCODE (US Only) - the country code (US),
followed by the 5-digit ZIP code (Example: US_98121).
- `"ImportMode"`: Specifies whether the dataset import job is a FULL or INCREMENTAL import.
A FULL dataset import replaces all of the existing data with the newly imported data. An
INCREMENTAL import appends the imported data to the existing data.
- `"Tags"`: The optional metadata that you apply to the dataset import job to help you
categorize and organize them. Each tag consists of a key and an optional value, both of
which you define. The following basic restrictions apply to tags: Maximum number of tags
per resource - 50. For each resource, each tag key must be unique, and each tag key can
have only one value. Maximum key length - 128 Unicode characters in UTF-8. Maximum
value length - 256 Unicode characters in UTF-8. If your tagging schema is used across
multiple services and resources, remember that other services may have restrictions on
allowed characters. Generally allowed characters are: letters, numbers, and spaces
representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and
values are case sensitive. Do not use aws:, AWS:, or any upper or lowercase combination
of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit
or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as
its prefix but the key does not, then Forecast considers it to be a user tag and will count
against the limit of 50 tags. Tags with only the key prefix of aws do not count against
your tags per resource limit.
- `"TimeZone"`: A single time zone for every item in your dataset. This option is ideal for
datasets with all timestamps within a single time zone, or if all timestamps are normalized
to a single time zone. Refer to the Joda-Time API for a complete list of valid time zone
names.
- `"TimestampFormat"`: The format of timestamps in the dataset. The format that you specify
depends on the DataFrequency specified when the dataset was created. The following formats
are supported \"yyyy-MM-dd\" For the following data frequencies: Y, M, W, and D
\"yyyy-MM-dd HH:mm:ss\" For the following data frequencies: H, 30min, 15min, and 1min; and
optionally, for: Y, M, W, and D If the format isn't specified, Amazon Forecast expects
the format to be \"yyyy-MM-dd HH:mm:ss\".
- `"UseGeolocationForTimeZone"`: Automatically derive time zone information from the
geolocation attribute. This option is ideal for datasets that contain timestamps in
multiple time zones and those timestamps are expressed in local time.
"""
function create_dataset_import_job(
DataSource,
DatasetArn,
DatasetImportJobName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateDatasetImportJob",
Dict{String,Any}(
"DataSource" => DataSource,
"DatasetArn" => DatasetArn,
"DatasetImportJobName" => DatasetImportJobName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset_import_job(
DataSource,
DatasetArn,
DatasetImportJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateDatasetImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataSource" => DataSource,
"DatasetArn" => DatasetArn,
"DatasetImportJobName" => DatasetImportJobName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_explainability(explainability_config, explainability_name, resource_arn)
create_explainability(explainability_config, explainability_name, resource_arn, params::Dict{String,<:Any})
Explainability is only available for Forecasts and Predictors generated from an
AutoPredictor (CreateAutoPredictor) Creates an Amazon Forecast Explainability.
Explainability helps you better understand how the attributes in your datasets impact
forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative
impact of each attribute and determine whether they increase or decrease forecast values.
To enable Forecast Explainability, your predictor must include at least one of the
following: related time series, item metadata, or additional datasets like Holidays and the
Weather Index. CreateExplainability accepts either a Predictor ARN or Forecast ARN. To
receive aggregated Impact scores for all time series and time points in your datasets,
provide a Predictor ARN. To receive Impact scores for specific time series and time points,
provide a Forecast ARN. CreateExplainability with a Predictor ARN You can only have one
Explainability resource per predictor. If you already enabled ExplainPredictor in
CreateAutoPredictor, that predictor already has an Explainability resource. The following
parameters are required when providing a Predictor ARN: ExplainabilityName - A unique
name for the Explainability. ResourceArn - The Arn of the predictor.
TimePointGranularity - Must be set to “ALL”. TimeSeriesGranularity - Must be set to
“ALL”. Do not specify a value for the following parameters: DataSource - Only
valid when TimeSeriesGranularity is “SPECIFIC”. Schema - Only valid when
TimeSeriesGranularity is “SPECIFIC”. StartDateTime - Only valid when
TimePointGranularity is “SPECIFIC”. EndDateTime - Only valid when
TimePointGranularity is “SPECIFIC”. CreateExplainability with a Forecast ARN You
can specify a maximum of 50 time series and 500 time points. The following parameters are
required when providing a Predictor ARN: ExplainabilityName - A unique name for the
Explainability. ResourceArn - The Arn of the forecast. TimePointGranularity - Either
“ALL” or “SPECIFIC”. TimeSeriesGranularity - Either “ALL” or “SPECIFIC”.
If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:
DataSource - The S3 location of the CSV file specifying your time series. Schema - The
Schema defines the attributes and attribute types listed in the Data Source. If you set
TimePointGranularity to “SPECIFIC”, you must also provide the following:
StartDateTime - The first timestamp in the range of time points. EndDateTime - The last
timestamp in the range of time points.
# Arguments
- `explainability_config`: The configuration settings that define the granularity of time
series and time points for the Explainability.
- `explainability_name`: A unique name for the Explainability.
- `resource_arn`: The Amazon Resource Name (ARN) of the Predictor or Forecast used to
create the Explainability.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DataSource"`:
- `"EnableVisualization"`: Create an Explainability visualization that is viewable within
the Amazon Web Services console.
- `"EndDateTime"`: If TimePointGranularity is set to SPECIFIC, define the last time point
for the Explainability. Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
2015-01-01T20:00:00)
- `"Schema"`:
- `"StartDateTime"`: If TimePointGranularity is set to SPECIFIC, define the first point for
the Explainability. Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
2015-01-01T20:00:00)
- `"Tags"`: Optional metadata to help you categorize and organize your resources. Each tag
consists of a key and an optional value, both of which you define. Tag keys and values are
case sensitive. The following restrictions apply to tags: For each resource, each tag key
must be unique and each tag key must have one value. Maximum number of tags per resource:
50. Maximum key length: 128 Unicode characters in UTF-8. Maximum value length: 256
Unicode characters in UTF-8. Accepted characters: all letters and numbers, spaces
representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other
services and resources, the character restrictions of those services also apply. Key
prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have
this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers
it to be a user tag and will count against the limit of 50 tags. Tags with only the key
prefix of aws do not count against your tags per resource limit. You cannot edit or delete
tag keys with this prefix.
"""
function create_explainability(
ExplainabilityConfig,
ExplainabilityName,
ResourceArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateExplainability",
Dict{String,Any}(
"ExplainabilityConfig" => ExplainabilityConfig,
"ExplainabilityName" => ExplainabilityName,
"ResourceArn" => ResourceArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_explainability(
ExplainabilityConfig,
ExplainabilityName,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateExplainability",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExplainabilityConfig" => ExplainabilityConfig,
"ExplainabilityName" => ExplainabilityName,
"ResourceArn" => ResourceArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_explainability_export(destination, explainability_arn, explainability_export_name)
create_explainability_export(destination, explainability_arn, explainability_export_name, params::Dict{String,<:Any})
Exports an Explainability resource created by the CreateExplainability operation. Exported
files are exported to an Amazon Simple Storage Service (Amazon S3) bucket. You must specify
a DataDestination object that includes an Amazon S3 bucket and an Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For
more information, see aws-forecast-iam-roles. The Status of the export job must be ACTIVE
before you can access the export in your Amazon S3 bucket. To get the status, use the
DescribeExplainabilityExport operation.
# Arguments
- `destination`:
- `explainability_arn`: The Amazon Resource Name (ARN) of the Explainability to export.
- `explainability_export_name`: A unique name for the Explainability export.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Format"`: The format of the exported data, CSV or PARQUET.
- `"Tags"`: Optional metadata to help you categorize and organize your resources. Each tag
consists of a key and an optional value, both of which you define. Tag keys and values are
case sensitive. The following restrictions apply to tags: For each resource, each tag key
must be unique and each tag key must have one value. Maximum number of tags per resource:
50. Maximum key length: 128 Unicode characters in UTF-8. Maximum value length: 256
Unicode characters in UTF-8. Accepted characters: all letters and numbers, spaces
representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other
services and resources, the character restrictions of those services also apply. Key
prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have
this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers
it to be a user tag and will count against the limit of 50 tags. Tags with only the key
prefix of aws do not count against your tags per resource limit. You cannot edit or delete
tag keys with this prefix.
"""
function create_explainability_export(
Destination,
ExplainabilityArn,
ExplainabilityExportName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateExplainabilityExport",
Dict{String,Any}(
"Destination" => Destination,
"ExplainabilityArn" => ExplainabilityArn,
"ExplainabilityExportName" => ExplainabilityExportName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_explainability_export(
Destination,
ExplainabilityArn,
ExplainabilityExportName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateExplainabilityExport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Destination" => Destination,
"ExplainabilityArn" => ExplainabilityArn,
"ExplainabilityExportName" => ExplainabilityExportName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_forecast(forecast_name, predictor_arn)
create_forecast(forecast_name, predictor_arn, params::Dict{String,<:Any})
Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train
the predictor. This is known as inference. To retrieve the forecast for a single item at
low latency, use the operation. To export the complete forecast into your Amazon Simple
Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation. The range of
the forecast is determined by the ForecastHorizon value, which you specify in the
CreatePredictor request. When you query a forecast, you can request a specific date range
within the forecast. To get a list of all your forecasts, use the ListForecasts operation.
The forecasts generated by Amazon Forecast are in the same time zone as the dataset that
was used to create the predictor. For more information, see howitworks-forecast. The
Status of the forecast must be ACTIVE before you can query or export the forecast. Use the
DescribeForecast operation to get the status. By default, a forecast includes predictions
for every item (item_id) in the dataset group that was used to train the predictor.
However, you can use the TimeSeriesSelector object to generate a forecast on a subset of
time series. Forecast creation is skipped for any time series that you specify that are not
in the input dataset. The forecast export file will not contain these time series or their
forecasted values.
# Arguments
- `forecast_name`: A name for the forecast.
- `predictor_arn`: The Amazon Resource Name (ARN) of the predictor to use to generate the
forecast.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ForecastTypes"`: The quantiles at which probabilistic forecasts are generated. You can
currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99
(increments of .01 only) and mean. The mean forecast is different from the median (0.50)
when the distribution is not symmetric (for example, Beta and Negative Binomial). The
default quantiles are the quantiles you specified during predictor creation. If you didn't
specify quantiles, the default values are [\"0.1\", \"0.5\", \"0.9\"].
- `"Tags"`: The optional metadata that you apply to the forecast to help you categorize and
organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags: Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8. Maximum value length - 256
Unicode characters in UTF-8. If your tagging schema is used across multiple services and
resources, remember that other services may have restrictions on allowed characters.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and
the following characters: + - = . _ : / @. Tag keys and values are case sensitive. Do
not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as
it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this
prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does
not, then Forecast considers it to be a user tag and will count against the limit of 50
tags. Tags with only the key prefix of aws do not count against your tags per resource
limit.
- `"TimeSeriesSelector"`: Defines the set of time series that are used to create the
forecasts in a TimeSeriesIdentifiers object. The TimeSeriesIdentifiers object needs the
following information: DataSource Format Schema
"""
function create_forecast(
ForecastName, PredictorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"CreateForecast",
Dict{String,Any}("ForecastName" => ForecastName, "PredictorArn" => PredictorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_forecast(
ForecastName,
PredictorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateForecast",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ForecastName" => ForecastName, "PredictorArn" => PredictorArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_forecast_export_job(destination, forecast_arn, forecast_export_job_name)
create_forecast_export_job(destination, forecast_arn, forecast_export_job_name, params::Dict{String,<:Any})
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage
Service (Amazon S3) bucket. The forecast file name will match the following conventions:
<ForecastExportJobName>_<ExportTimestamp>_<PartNumber> where the
<ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ). You
must specify a DataDestination object that includes an Identity and Access Management (IAM)
role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information,
see aws-forecast-iam-roles. For more information, see howitworks-forecast. To get a list of
all your forecast export jobs, use the ListForecastExportJobs operation. The Status of the
forecast export job must be ACTIVE before you can access the forecast in your Amazon S3
bucket. To get the status, use the DescribeForecastExportJob operation.
# Arguments
- `destination`: The location where you want to save the forecast and an Identity and
Access Management (IAM) role that Amazon Forecast can assume to access the location. The
forecast must be exported to an Amazon S3 bucket. If encryption is used, Destination must
include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast
permission to access the key.
- `forecast_arn`: The Amazon Resource Name (ARN) of the forecast that you want to export.
- `forecast_export_job_name`: The name for the forecast export job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Format"`: The format of the exported data, CSV or PARQUET. The default value is CSV.
- `"Tags"`: The optional metadata that you apply to the forecast export job to help you
categorize and organize them. Each tag consists of a key and an optional value, both of
which you define. The following basic restrictions apply to tags: Maximum number of tags
per resource - 50. For each resource, each tag key must be unique, and each tag key can
have only one value. Maximum key length - 128 Unicode characters in UTF-8. Maximum
value length - 256 Unicode characters in UTF-8. If your tagging schema is used across
multiple services and resources, remember that other services may have restrictions on
allowed characters. Generally allowed characters are: letters, numbers, and spaces
representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and
values are case sensitive. Do not use aws:, AWS:, or any upper or lowercase combination
of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit
or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as
its prefix but the key does not, then Forecast considers it to be a user tag and will count
against the limit of 50 tags. Tags with only the key prefix of aws do not count against
your tags per resource limit.
"""
function create_forecast_export_job(
Destination,
ForecastArn,
ForecastExportJobName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateForecastExportJob",
Dict{String,Any}(
"Destination" => Destination,
"ForecastArn" => ForecastArn,
"ForecastExportJobName" => ForecastExportJobName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_forecast_export_job(
Destination,
ForecastArn,
ForecastExportJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateForecastExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Destination" => Destination,
"ForecastArn" => ForecastArn,
"ForecastExportJobName" => ForecastExportJobName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_monitor(monitor_name, resource_arn)
create_monitor(monitor_name, resource_arn, params::Dict{String,<:Any})
Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring
allows you to see how your predictor's performance changes over time. For more information,
see Predictor Monitoring.
# Arguments
- `monitor_name`: The name of the monitor resource.
- `resource_arn`: The Amazon Resource Name (ARN) of the predictor to monitor.
# 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 monitor resource.
"""
function create_monitor(
MonitorName, ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"CreateMonitor",
Dict{String,Any}("MonitorName" => MonitorName, "ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_monitor(
MonitorName,
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateMonitor",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"MonitorName" => MonitorName, "ResourceArn" => ResourceArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_predictor(featurization_config, forecast_horizon, input_data_config, predictor_name)
create_predictor(featurization_config, forecast_horizon, input_data_config, predictor_name, params::Dict{String,<:Any})
This operation creates a legacy predictor that does not include all the predictor
functionalities provided by Amazon Forecast. To create a predictor that is compatible with
all aspects of Forecast, use CreateAutoPredictor. Creates an Amazon Forecast predictor. In
the request, provide a dataset group and either specify an algorithm or let Amazon Forecast
choose an algorithm for you using AutoML. If you specify an algorithm, you also can
override algorithm-specific hyperparameters. Amazon Forecast uses the algorithm to train a
predictor using the latest version of the datasets in the specified dataset group. You can
then generate a forecast using the CreateForecast operation. To see the evaluation
metrics, use the GetAccuracyMetrics operation. You can specify a featurization
configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to
improve model training. For more information, see FeaturizationConfig. For
RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified
when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets
don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp
format. For more information, see howitworks-datasets-groups. By default, predictors are
trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose
custom forecast types to train and evaluate your predictor by setting the ForecastTypes.
AutoML If you want Amazon Forecast to evaluate each algorithm and choose the one that
minimizes the objective function, set PerformAutoML to true. The objective function is
defined as the mean of the weighted losses over the forecast types. By default, these are
the p10, p50, and p90 quantile losses. For more information, see EvaluationResult. When
AutoML is enabled, the following properties are disallowed: AlgorithmArn HPOConfig
PerformHPO TrainingParameters To get a list of all of your predictors, use the
ListPredictors operation. Before you can use the predictor to create a forecast, the
Status of the predictor must be ACTIVE, signifying that training has completed. To get the
status, use the DescribePredictor operation.
# Arguments
- `featurization_config`: The featurization configuration.
- `forecast_horizon`: Specifies the number of time-steps that the model is trained to
predict. The forecast horizon is also called the prediction length. For example, if you
configure a dataset for daily data collection (using the DataFrequency parameter of the
CreateDataset operation) and set the forecast horizon to 10, the model returns predictions
for 10 days. The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the
TARGET_TIME_SERIES dataset length.
- `input_data_config`: Describes the dataset group that contains the data to use to train
the predictor.
- `predictor_name`: A name for the predictor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AlgorithmArn"`: The Amazon Resource Name (ARN) of the algorithm to use for model
training. Required if PerformAutoML is not set to true. Supported algorithms:
arn:aws:forecast:::algorithm/ARIMA arn:aws:forecast:::algorithm/CNN-QR
arn:aws:forecast:::algorithm/Deep_AR_Plus arn:aws:forecast:::algorithm/ETS
arn:aws:forecast:::algorithm/NPTS arn:aws:forecast:::algorithm/Prophet
- `"AutoMLOverrideStrategy"`: The LatencyOptimized AutoML override strategy is only
available in private beta. Contact Amazon Web Services Support or your account manager to
learn more about access privileges. Used to overide the default AutoML strategy, which is
to optimize predictor accuracy. To apply an AutoML strategy that minimizes training time,
use LatencyOptimized. This parameter is only valid for predictors trained using AutoML.
- `"EncryptionConfig"`: An Key Management Service (KMS) key and the Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the key.
- `"EvaluationParameters"`: Used to override the default evaluation parameters of the
specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into
training data and testing data. The evaluation parameters define how to perform the split
and the number of iterations.
- `"ForecastTypes"`: Specifies the forecast types used to train a predictor. You can
specify up to five forecast types. Forecast types can be quantiles from 0.01 to 0.99, by
increments of 0.01 or higher. You can also specify the mean forecast with mean. The
default value is [\"0.10\", \"0.50\", \"0.9\"].
- `"HPOConfig"`: Provides hyperparameter override values for the algorithm. If you don't
provide this parameter, Amazon Forecast uses default values. The individual algorithms
specify which hyperparameters support hyperparameter optimization (HPO). For more
information, see aws-forecast-choosing-recipes. If you included the HPOConfig object, you
must set PerformHPO to true.
- `"OptimizationMetric"`: The accuracy metric used to optimize the predictor.
- `"PerformAutoML"`: Whether to perform AutoML. When Amazon Forecast performs AutoML, it
evaluates the algorithms it provides and chooses the best algorithm and configuration for
your training dataset. The default value is false. In this case, you are required to
specify an algorithm. Set PerformAutoML to true to have Amazon Forecast perform AutoML.
This is a good option if you aren't sure which algorithm is suitable for your training
data. In this case, PerformHPO must be false.
- `"PerformHPO"`: Whether to perform hyperparameter optimization (HPO). HPO finds optimal
hyperparameter values for your training data. The process of performing HPO is known as
running a hyperparameter tuning job. The default value is false. In this case, Amazon
Forecast uses default hyperparameter values from the chosen algorithm. To override the
default values, set PerformHPO to true and, optionally, supply the
HyperParameterTuningJobConfig object. The tuning job specifies a metric to optimize, which
hyperparameters participate in tuning, and the valid range for each tunable hyperparameter.
In this case, you are required to specify an algorithm and PerformAutoML must be false. The
following algorithms support HPO: DeepAR+ CNN-QR
- `"Tags"`: The optional metadata that you apply to the predictor to help you categorize
and organize them. Each tag consists of a key and an optional value, both of which you
define. The following basic restrictions apply to tags: Maximum number of tags per
resource - 50. For each resource, each tag key must be unique, and each tag key can have
only one value. Maximum key length - 128 Unicode characters in UTF-8. Maximum value
length - 256 Unicode characters in UTF-8. If your tagging schema is used across multiple
services and resources, remember that other services may have restrictions on allowed
characters. Generally allowed characters are: letters, numbers, and spaces representable in
UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case
sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a
prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete
tag keys with this prefix. Values can have this prefix. If a tag value has aws as its
prefix but the key does not, then Forecast considers it to be a user tag and will count
against the limit of 50 tags. Tags with only the key prefix of aws do not count against
your tags per resource limit.
- `"TrainingParameters"`: The hyperparameters to override for model training. The
hyperparameters that you can override are listed in the individual algorithms. For the list
of supported algorithms, see aws-forecast-choosing-recipes.
"""
function create_predictor(
FeaturizationConfig,
ForecastHorizon,
InputDataConfig,
PredictorName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreatePredictor",
Dict{String,Any}(
"FeaturizationConfig" => FeaturizationConfig,
"ForecastHorizon" => ForecastHorizon,
"InputDataConfig" => InputDataConfig,
"PredictorName" => PredictorName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_predictor(
FeaturizationConfig,
ForecastHorizon,
InputDataConfig,
PredictorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreatePredictor",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FeaturizationConfig" => FeaturizationConfig,
"ForecastHorizon" => ForecastHorizon,
"InputDataConfig" => InputDataConfig,
"PredictorName" => PredictorName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_predictor_backtest_export_job(destination, predictor_arn, predictor_backtest_export_job_name)
create_predictor_backtest_export_job(destination, predictor_arn, predictor_backtest_export_job_name, params::Dict{String,<:Any})
Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or
CreatePredictor operations. Two folders containing CSV or Parquet files are exported to
your specified S3 bucket. The export file names will match the following conventions:
<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv The
<ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ). You
must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and
Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
bucket. For more information, see aws-forecast-iam-roles. The Status of the export job
must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the
status, use the DescribePredictorBacktestExportJob operation.
# Arguments
- `destination`:
- `predictor_arn`: The Amazon Resource Name (ARN) of the predictor that you want to export.
- `predictor_backtest_export_job_name`: The name for the backtest export job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Format"`: The format of the exported data, CSV or PARQUET. The default value is CSV.
- `"Tags"`: Optional metadata to help you categorize and organize your backtests. Each tag
consists of a key and an optional value, both of which you define. Tag keys and values are
case sensitive. The following restrictions apply to tags: For each resource, each tag key
must be unique and each tag key must have one value. Maximum number of tags per resource:
50. Maximum key length: 128 Unicode characters in UTF-8. Maximum value length: 256
Unicode characters in UTF-8. Accepted characters: all letters and numbers, spaces
representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other
services and resources, the character restrictions of those services also apply. Key
prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have
this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers
it to be a user tag and will count against the limit of 50 tags. Tags with only the key
prefix of aws do not count against your tags per resource limit. You cannot edit or delete
tag keys with this prefix.
"""
function create_predictor_backtest_export_job(
Destination,
PredictorArn,
PredictorBacktestExportJobName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreatePredictorBacktestExportJob",
Dict{String,Any}(
"Destination" => Destination,
"PredictorArn" => PredictorArn,
"PredictorBacktestExportJobName" => PredictorBacktestExportJobName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_predictor_backtest_export_job(
Destination,
PredictorArn,
PredictorBacktestExportJobName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreatePredictorBacktestExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Destination" => Destination,
"PredictorArn" => PredictorArn,
"PredictorBacktestExportJobName" => PredictorBacktestExportJobName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_what_if_analysis(forecast_arn, what_if_analysis_name)
create_what_if_analysis(forecast_arn, what_if_analysis_name, params::Dict{String,<:Any})
What-if analysis is a scenario modeling technique where you make a hypothetical change to a
time series and compare the forecasts generated by these changes against the baseline,
unchanged time series. It is important to remember that the purpose of a what-if analysis
is to understand how a forecast can change given different modifications to the baseline
time series. For example, imagine you are a clothing retailer who is considering an end of
season sale to clear space for new styles. After creating a baseline forecast, you can use
a what-if analysis to investigate how different sales tactics might affect your goals. You
could create a scenario where everything is given a 25% markdown, and another where
everything is given a fixed dollar markdown. You could create a scenario where the sale
lasts for one week and another where the sale lasts for one month. With a what-if analysis,
you can compare many different scenarios against each other. Note that a what-if analysis
is meant to display what the forecasting model has learned and how it will behave in the
scenarios that you are evaluating. Do not blindly use the results of the what-if analysis
to make business decisions. For instance, forecasts might not be accurate for novel
scenarios where there is no reference available to determine whether a forecast is good.
The TimeSeriesSelector object defines the items that you want in the what-if analysis.
# Arguments
- `forecast_arn`: The Amazon Resource Name (ARN) of the baseline forecast.
- `what_if_analysis_name`: The name of the what-if analysis. Each name must be unique.
# 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 what if forecast.
- `"TimeSeriesSelector"`: Defines the set of time series that are used in the what-if
analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the
time series in this object. The TimeSeriesIdentifiers object needs the following
information: DataSource Format Schema
"""
function create_what_if_analysis(
ForecastArn, WhatIfAnalysisName; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"CreateWhatIfAnalysis",
Dict{String,Any}(
"ForecastArn" => ForecastArn, "WhatIfAnalysisName" => WhatIfAnalysisName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_what_if_analysis(
ForecastArn,
WhatIfAnalysisName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateWhatIfAnalysis",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ForecastArn" => ForecastArn, "WhatIfAnalysisName" => WhatIfAnalysisName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_what_if_forecast(what_if_analysis_arn, what_if_forecast_name)
create_what_if_forecast(what_if_analysis_arn, what_if_forecast_name, params::Dict{String,<:Any})
A what-if forecast is a forecast that is created from a modified version of the baseline
forecast. Each what-if forecast incorporates either a replacement dataset or a set of
transformations to the original dataset.
# Arguments
- `what_if_analysis_arn`: The Amazon Resource Name (ARN) of the what-if analysis.
- `what_if_forecast_name`: The name of the what-if forecast. Names must be unique within
each what-if analysis.
# 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 what if forecast.
- `"TimeSeriesReplacementsDataSource"`: The replacement time series dataset, which contains
the rows that you want to change in the related time series dataset. A replacement time
series does not need to contain all rows that are in the baseline related time series.
Include only the rows (measure-dimension combinations) that you want to include in the
what-if forecast. This dataset is merged with the original time series to create a
transformed dataset that is used for the what-if analysis. This dataset should contain the
items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp
column, and at least one of the related time series columns. This file should not contain
duplicate timestamps for the same time series. Timestamps and item_ids not included in this
dataset are not included in the what-if analysis.
- `"TimeSeriesTransformations"`: The transformations that are applied to the baseline time
series. Each transformation contains an action and a set of conditions. An action is
applied only when all conditions are met. If no conditions are provided, the action is
applied to all items.
"""
function create_what_if_forecast(
WhatIfAnalysisArn, WhatIfForecastName; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"CreateWhatIfForecast",
Dict{String,Any}(
"WhatIfAnalysisArn" => WhatIfAnalysisArn,
"WhatIfForecastName" => WhatIfForecastName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_what_if_forecast(
WhatIfAnalysisArn,
WhatIfForecastName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateWhatIfForecast",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"WhatIfAnalysisArn" => WhatIfAnalysisArn,
"WhatIfForecastName" => WhatIfForecastName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_what_if_forecast_export(destination, what_if_forecast_arns, what_if_forecast_export_name)
create_what_if_forecast_export(destination, what_if_forecast_arns, what_if_forecast_export_name, params::Dict{String,<:Any})
Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple
Storage Service (Amazon S3) bucket. The forecast file name will match the following
conventions: ≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Identity and Access Management
(IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more
information, see aws-forecast-iam-roles. For more information, see howitworks-forecast. To
get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports
operation. The Status of the forecast export job must be ACTIVE before you can access the
forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport
operation.
# Arguments
- `destination`: The location where you want to save the forecast and an Identity and
Access Management (IAM) role that Amazon Forecast can assume to access the location. The
forecast must be exported to an Amazon S3 bucket. If encryption is used, Destination must
include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast
permission to access the key.
- `what_if_forecast_arns`: The list of what-if forecast Amazon Resource Names (ARNs) to
export.
- `what_if_forecast_export_name`: The name of the what-if forecast to export.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Format"`: The format of the exported data, CSV or PARQUET.
- `"Tags"`: A list of tags to apply to the what if forecast.
"""
function create_what_if_forecast_export(
Destination,
WhatIfForecastArns,
WhatIfForecastExportName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateWhatIfForecastExport",
Dict{String,Any}(
"Destination" => Destination,
"WhatIfForecastArns" => WhatIfForecastArns,
"WhatIfForecastExportName" => WhatIfForecastExportName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_what_if_forecast_export(
Destination,
WhatIfForecastArns,
WhatIfForecastExportName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"CreateWhatIfForecastExport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Destination" => Destination,
"WhatIfForecastArns" => WhatIfForecastArns,
"WhatIfForecastExportName" => WhatIfForecastExportName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset(dataset_arn)
delete_dataset(dataset_arn, params::Dict{String,<:Any})
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You
can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status
use the DescribeDataset operation. Forecast does not automatically update any dataset
groups that contain the deleted dataset. In order to update the dataset group, use the
UpdateDatasetGroup operation, omitting the deleted dataset's ARN.
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) of the dataset to delete.
"""
function delete_dataset(DatasetArn; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"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 forecast(
"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 created using the CreateDatasetGroup operation. You can only delete
dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the
status, use the DescribeDatasetGroup operation. This operation deletes only the dataset
group, not the datasets in the group.
# Arguments
- `dataset_group_arn`: The Amazon Resource Name (ARN) of the dataset group to delete.
"""
function delete_dataset_group(
DatasetGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"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 forecast(
"DeleteDatasetGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DatasetGroupArn" => DatasetGroupArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset_import_job(dataset_import_job_arn)
delete_dataset_import_job(dataset_import_job_arn, params::Dict{String,<:Any})
Deletes a dataset import job created using the CreateDatasetImportJob operation. You can
delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the
status, use the DescribeDatasetImportJob operation.
# Arguments
- `dataset_import_job_arn`: The Amazon Resource Name (ARN) of the dataset import job to
delete.
"""
function delete_dataset_import_job(
DatasetImportJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DeleteDatasetImportJob",
Dict{String,Any}("DatasetImportJobArn" => DatasetImportJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dataset_import_job(
DatasetImportJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeleteDatasetImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatasetImportJobArn" => DatasetImportJobArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_explainability(explainability_arn)
delete_explainability(explainability_arn, params::Dict{String,<:Any})
Deletes an Explainability resource. You can delete only predictor that have a status of
ACTIVE or CREATE_FAILED. To get the status, use the DescribeExplainability operation.
# Arguments
- `explainability_arn`: The Amazon Resource Name (ARN) of the Explainability resource to
delete.
"""
function delete_explainability(
ExplainabilityArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DeleteExplainability",
Dict{String,Any}("ExplainabilityArn" => ExplainabilityArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_explainability(
ExplainabilityArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeleteExplainability",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ExplainabilityArn" => ExplainabilityArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_explainability_export(explainability_export_arn)
delete_explainability_export(explainability_export_arn, params::Dict{String,<:Any})
Deletes an Explainability export.
# Arguments
- `explainability_export_arn`: The Amazon Resource Name (ARN) of the Explainability export
to delete.
"""
function delete_explainability_export(
ExplainabilityExportArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DeleteExplainabilityExport",
Dict{String,Any}("ExplainabilityExportArn" => ExplainabilityExportArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_explainability_export(
ExplainabilityExportArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeleteExplainabilityExport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ExplainabilityExportArn" => ExplainabilityExportArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_forecast(forecast_arn)
delete_forecast(forecast_arn, params::Dict{String,<:Any})
Deletes a forecast created using the CreateForecast operation. You can delete only
forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the
DescribeForecast operation. You can't delete a forecast while it is being exported. After a
forecast is deleted, you can no longer query the forecast.
# Arguments
- `forecast_arn`: The Amazon Resource Name (ARN) of the forecast to delete.
"""
function delete_forecast(ForecastArn; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"DeleteForecast",
Dict{String,Any}("ForecastArn" => ForecastArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_forecast(
ForecastArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeleteForecast",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ForecastArn" => ForecastArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_forecast_export_job(forecast_export_job_arn)
delete_forecast_export_job(forecast_export_job_arn, params::Dict{String,<:Any})
Deletes a forecast export job created using the CreateForecastExportJob operation. You can
delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status,
use the DescribeForecastExportJob operation.
# Arguments
- `forecast_export_job_arn`: The Amazon Resource Name (ARN) of the forecast export job to
delete.
"""
function delete_forecast_export_job(
ForecastExportJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DeleteForecastExportJob",
Dict{String,Any}("ForecastExportJobArn" => ForecastExportJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_forecast_export_job(
ForecastExportJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeleteForecastExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ForecastExportJobArn" => ForecastExportJobArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_monitor(monitor_arn)
delete_monitor(monitor_arn, params::Dict{String,<:Any})
Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE,
ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.
# Arguments
- `monitor_arn`: The Amazon Resource Name (ARN) of the monitor resource to delete.
"""
function delete_monitor(MonitorArn; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"DeleteMonitor",
Dict{String,Any}("MonitorArn" => MonitorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_monitor(
MonitorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeleteMonitor",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MonitorArn" => MonitorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_predictor(predictor_arn)
delete_predictor(predictor_arn, params::Dict{String,<:Any})
Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You
can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status,
use the DescribePredictor operation.
# Arguments
- `predictor_arn`: The Amazon Resource Name (ARN) of the predictor to delete.
"""
function delete_predictor(PredictorArn; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"DeletePredictor",
Dict{String,Any}("PredictorArn" => PredictorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_predictor(
PredictorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeletePredictor",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PredictorArn" => PredictorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_predictor_backtest_export_job(predictor_backtest_export_job_arn)
delete_predictor_backtest_export_job(predictor_backtest_export_job_arn, params::Dict{String,<:Any})
Deletes a predictor backtest export job.
# Arguments
- `predictor_backtest_export_job_arn`: The Amazon Resource Name (ARN) of the predictor
backtest export job to delete.
"""
function delete_predictor_backtest_export_job(
PredictorBacktestExportJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DeletePredictorBacktestExportJob",
Dict{String,Any}("PredictorBacktestExportJobArn" => PredictorBacktestExportJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_predictor_backtest_export_job(
PredictorBacktestExportJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeletePredictorBacktestExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PredictorBacktestExportJobArn" => PredictorBacktestExportJobArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_tree(resource_arn)
delete_resource_tree(resource_arn, params::Dict{String,<:Any})
Deletes an entire resource tree. This operation will delete the parent resource and its
child resources. Child resources are resources that were created from another resource. For
example, when a forecast is generated from a predictor, the forecast is the child resource
and the predictor is the parent resource. Amazon Forecast resources possess the following
parent-child resource hierarchies: Dataset: dataset import jobs Dataset Group:
predictors, predictor backtest export jobs, forecasts, forecast export jobs Predictor:
predictor backtest export jobs, forecasts, forecast export jobs Forecast: forecast
export jobs DeleteResourceTree will only delete Amazon Forecast resources, and will not
delete datasets or exported files stored in Amazon S3.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the parent resource to delete. All
child resources of the parent resource will also be deleted.
"""
function delete_resource_tree(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DeleteResourceTree",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_tree(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeleteResourceTree",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_what_if_analysis(what_if_analysis_arn)
delete_what_if_analysis(what_if_analysis_arn, params::Dict{String,<:Any})
Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete
only what-if analyses that have a status of ACTIVE or CREATE_FAILED. To get the status, use
the DescribeWhatIfAnalysis operation. You can't delete a what-if analysis while any of its
forecasts are being exported.
# Arguments
- `what_if_analysis_arn`: The Amazon Resource Name (ARN) of the what-if analysis that you
want to delete.
"""
function delete_what_if_analysis(
WhatIfAnalysisArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DeleteWhatIfAnalysis",
Dict{String,Any}("WhatIfAnalysisArn" => WhatIfAnalysisArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_what_if_analysis(
WhatIfAnalysisArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeleteWhatIfAnalysis",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WhatIfAnalysisArn" => WhatIfAnalysisArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_what_if_forecast(what_if_forecast_arn)
delete_what_if_forecast(what_if_forecast_arn, params::Dict{String,<:Any})
Deletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete
only what-if forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status,
use the DescribeWhatIfForecast operation. You can't delete a what-if forecast while it is
being exported. After a what-if forecast is deleted, you can no longer query the what-if
analysis.
# Arguments
- `what_if_forecast_arn`: The Amazon Resource Name (ARN) of the what-if forecast that you
want to delete.
"""
function delete_what_if_forecast(
WhatIfForecastArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DeleteWhatIfForecast",
Dict{String,Any}("WhatIfForecastArn" => WhatIfForecastArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_what_if_forecast(
WhatIfForecastArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeleteWhatIfForecast",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WhatIfForecastArn" => WhatIfForecastArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_what_if_forecast_export(what_if_forecast_export_arn)
delete_what_if_forecast_export(what_if_forecast_export_arn, params::Dict{String,<:Any})
Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation.
You can delete only what-if forecast exports that have a status of ACTIVE or CREATE_FAILED.
To get the status, use the DescribeWhatIfForecastExport operation.
# Arguments
- `what_if_forecast_export_arn`: The Amazon Resource Name (ARN) of the what-if forecast
export that you want to delete.
"""
function delete_what_if_forecast_export(
WhatIfForecastExportArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DeleteWhatIfForecastExport",
Dict{String,Any}("WhatIfForecastExportArn" => WhatIfForecastExportArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_what_if_forecast_export(
WhatIfForecastExportArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DeleteWhatIfForecastExport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WhatIfForecastExportArn" => WhatIfForecastExportArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_auto_predictor(predictor_arn)
describe_auto_predictor(predictor_arn, params::Dict{String,<:Any})
Describes a predictor created using the CreateAutoPredictor operation.
# Arguments
- `predictor_arn`: The Amazon Resource Name (ARN) of the predictor.
"""
function describe_auto_predictor(
PredictorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DescribeAutoPredictor",
Dict{String,Any}("PredictorArn" => PredictorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_auto_predictor(
PredictorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribeAutoPredictor",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PredictorArn" => PredictorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset(dataset_arn)
describe_dataset(dataset_arn, params::Dict{String,<:Any})
Describes an Amazon Forecast dataset created using the CreateDataset operation. In addition
to listing the parameters specified in the CreateDataset request, this operation includes
the following dataset properties: CreationTime LastModificationTime Status
# Arguments
- `dataset_arn`: The Amazon Resource Name (ARN) of the dataset.
"""
function describe_dataset(DatasetArn; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"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 forecast(
"DescribeDataset",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatasetArn" => DatasetArn), 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 a dataset group created using the CreateDatasetGroup operation. In addition to
listing the parameters provided in the CreateDatasetGroup request, this operation includes
the following properties: DatasetArns - The datasets belonging to the group.
CreationTime LastModificationTime Status
# Arguments
- `dataset_group_arn`: The Amazon Resource Name (ARN) of the dataset group.
"""
function describe_dataset_group(
DatasetGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"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 forecast(
"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 a dataset import job created using the CreateDatasetImportJob operation. In
addition to listing the parameters provided in the CreateDatasetImportJob request, this
operation includes the following properties: CreationTime LastModificationTime
DataSize FieldStatistics Status Message - If an error occurred, information
about the error.
# Arguments
- `dataset_import_job_arn`: The Amazon Resource Name (ARN) of the dataset import job.
"""
function describe_dataset_import_job(
DatasetImportJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"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 forecast(
"DescribeDatasetImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatasetImportJobArn" => DatasetImportJobArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_explainability(explainability_arn)
describe_explainability(explainability_arn, params::Dict{String,<:Any})
Describes an Explainability resource created using the CreateExplainability operation.
# Arguments
- `explainability_arn`: The Amazon Resource Name (ARN) of the Explaianability to describe.
"""
function describe_explainability(
ExplainabilityArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DescribeExplainability",
Dict{String,Any}("ExplainabilityArn" => ExplainabilityArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_explainability(
ExplainabilityArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribeExplainability",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ExplainabilityArn" => ExplainabilityArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_explainability_export(explainability_export_arn)
describe_explainability_export(explainability_export_arn, params::Dict{String,<:Any})
Describes an Explainability export created using the CreateExplainabilityExport operation.
# Arguments
- `explainability_export_arn`: The Amazon Resource Name (ARN) of the Explainability export.
"""
function describe_explainability_export(
ExplainabilityExportArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DescribeExplainabilityExport",
Dict{String,Any}("ExplainabilityExportArn" => ExplainabilityExportArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_explainability_export(
ExplainabilityExportArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribeExplainabilityExport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ExplainabilityExportArn" => ExplainabilityExportArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_forecast(forecast_arn)
describe_forecast(forecast_arn, params::Dict{String,<:Any})
Describes a forecast created using the CreateForecast operation. In addition to listing the
properties provided in the CreateForecast request, this operation lists the following
properties: DatasetGroupArn - The dataset group that provided the training data.
CreationTime LastModificationTime Status Message - If an error occurred,
information about the error.
# Arguments
- `forecast_arn`: The Amazon Resource Name (ARN) of the forecast.
"""
function describe_forecast(ForecastArn; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"DescribeForecast",
Dict{String,Any}("ForecastArn" => ForecastArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_forecast(
ForecastArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribeForecast",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ForecastArn" => ForecastArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_forecast_export_job(forecast_export_job_arn)
describe_forecast_export_job(forecast_export_job_arn, params::Dict{String,<:Any})
Describes a forecast export job created using the CreateForecastExportJob operation. In
addition to listing the properties provided by the user in the CreateForecastExportJob
request, this operation lists the following properties: CreationTime
LastModificationTime Status Message - If an error occurred, information about the
error.
# Arguments
- `forecast_export_job_arn`: The Amazon Resource Name (ARN) of the forecast export job.
"""
function describe_forecast_export_job(
ForecastExportJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DescribeForecastExportJob",
Dict{String,Any}("ForecastExportJobArn" => ForecastExportJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_forecast_export_job(
ForecastExportJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribeForecastExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ForecastExportJobArn" => ForecastExportJobArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_monitor(monitor_arn)
describe_monitor(monitor_arn, params::Dict{String,<:Any})
Describes a monitor resource. In addition to listing the properties provided in the
CreateMonitor request, this operation lists the following properties: Baseline
CreationTime LastEvaluationTime LastEvaluationState LastModificationTime
Message Status
# Arguments
- `monitor_arn`: The Amazon Resource Name (ARN) of the monitor resource to describe.
"""
function describe_monitor(MonitorArn; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"DescribeMonitor",
Dict{String,Any}("MonitorArn" => MonitorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_monitor(
MonitorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribeMonitor",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MonitorArn" => MonitorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_predictor(predictor_arn)
describe_predictor(predictor_arn, params::Dict{String,<:Any})
This operation is only valid for legacy predictors created with CreatePredictor. If you
are not using a legacy predictor, use DescribeAutoPredictor. Describes a predictor created
using the CreatePredictor operation. In addition to listing the properties provided in the
CreatePredictor request, this operation lists the following properties:
DatasetImportJobArns - The dataset import jobs used to import training data.
AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.
CreationTime LastModificationTime Status Message - If an error occurred,
information about the error.
# Arguments
- `predictor_arn`: The Amazon Resource Name (ARN) of the predictor that you want
information about.
"""
function describe_predictor(PredictorArn; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"DescribePredictor",
Dict{String,Any}("PredictorArn" => PredictorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_predictor(
PredictorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribePredictor",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PredictorArn" => PredictorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_predictor_backtest_export_job(predictor_backtest_export_job_arn)
describe_predictor_backtest_export_job(predictor_backtest_export_job_arn, params::Dict{String,<:Any})
Describes a predictor backtest export job created using the
CreatePredictorBacktestExportJob operation. In addition to listing the properties provided
by the user in the CreatePredictorBacktestExportJob request, this operation lists the
following properties: CreationTime LastModificationTime Status Message (if
an error occurred)
# Arguments
- `predictor_backtest_export_job_arn`: The Amazon Resource Name (ARN) of the predictor
backtest export job.
"""
function describe_predictor_backtest_export_job(
PredictorBacktestExportJobArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DescribePredictorBacktestExportJob",
Dict{String,Any}("PredictorBacktestExportJobArn" => PredictorBacktestExportJobArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_predictor_backtest_export_job(
PredictorBacktestExportJobArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribePredictorBacktestExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PredictorBacktestExportJobArn" => PredictorBacktestExportJobArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_what_if_analysis(what_if_analysis_arn)
describe_what_if_analysis(what_if_analysis_arn, params::Dict{String,<:Any})
Describes the what-if analysis created using the CreateWhatIfAnalysis operation. In
addition to listing the properties provided in the CreateWhatIfAnalysis request, this
operation lists the following properties: CreationTime LastModificationTime
Message - If an error occurred, information about the error. Status
# Arguments
- `what_if_analysis_arn`: The Amazon Resource Name (ARN) of the what-if analysis that you
are interested in.
"""
function describe_what_if_analysis(
WhatIfAnalysisArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DescribeWhatIfAnalysis",
Dict{String,Any}("WhatIfAnalysisArn" => WhatIfAnalysisArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_what_if_analysis(
WhatIfAnalysisArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribeWhatIfAnalysis",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WhatIfAnalysisArn" => WhatIfAnalysisArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_what_if_forecast(what_if_forecast_arn)
describe_what_if_forecast(what_if_forecast_arn, params::Dict{String,<:Any})
Describes the what-if forecast created using the CreateWhatIfForecast operation. In
addition to listing the properties provided in the CreateWhatIfForecast request, this
operation lists the following properties: CreationTime LastModificationTime
Message - If an error occurred, information about the error. Status
# Arguments
- `what_if_forecast_arn`: The Amazon Resource Name (ARN) of the what-if forecast that you
are interested in.
"""
function describe_what_if_forecast(
WhatIfForecastArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DescribeWhatIfForecast",
Dict{String,Any}("WhatIfForecastArn" => WhatIfForecastArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_what_if_forecast(
WhatIfForecastArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribeWhatIfForecast",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WhatIfForecastArn" => WhatIfForecastArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_what_if_forecast_export(what_if_forecast_export_arn)
describe_what_if_forecast_export(what_if_forecast_export_arn, params::Dict{String,<:Any})
Describes the what-if forecast export created using the CreateWhatIfForecastExport
operation. In addition to listing the properties provided in the CreateWhatIfForecastExport
request, this operation lists the following properties: CreationTime
LastModificationTime Message - If an error occurred, information about the error.
Status
# Arguments
- `what_if_forecast_export_arn`: The Amazon Resource Name (ARN) of the what-if forecast
export that you are interested in.
"""
function describe_what_if_forecast_export(
WhatIfForecastExportArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"DescribeWhatIfForecastExport",
Dict{String,Any}("WhatIfForecastExportArn" => WhatIfForecastExportArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_what_if_forecast_export(
WhatIfForecastExportArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"DescribeWhatIfForecastExport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("WhatIfForecastExportArn" => WhatIfForecastExportArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_accuracy_metrics(predictor_arn)
get_accuracy_metrics(predictor_arn, params::Dict{String,<:Any})
Provides metrics on the accuracy of the models that were trained by the CreatePredictor
operation. Use metrics to see how well the model performed and to decide whether to use the
predictor to generate a forecast. For more information, see Predictor Metrics. This
operation generates metrics for each backtest window that was evaluated. The number of
backtest windows (NumberOfBacktestWindows) is specified using the EvaluationParameters
object, which is optionally included in the CreatePredictor request. If
NumberOfBacktestWindows isn't specified, the number defaults to one. The parameters of the
filling method determine which items contribute to the metrics. If you want all items to
contribute, specify zero. If you want only those items that have complete data in the range
being evaluated to contribute, specify nan. For more information, see FeaturizationMethod.
Before you can get accuracy metrics, the Status of the predictor must be ACTIVE, signifying
that training has completed. To get the status, use the DescribePredictor operation.
# Arguments
- `predictor_arn`: The Amazon Resource Name (ARN) of the predictor to get metrics for.
"""
function get_accuracy_metrics(
PredictorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"GetAccuracyMetrics",
Dict{String,Any}("PredictorArn" => PredictorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_accuracy_metrics(
PredictorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"GetAccuracyMetrics",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PredictorArn" => PredictorArn), 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 created using the CreateDatasetGroup operation. For each
dataset group, this operation returns a summary of its properties, including its Amazon
Resource Name (ARN). You can retrieve the complete set of properties by using the dataset
group ARN with the DescribeDatasetGroup operation.
# 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"`: 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_dataset_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"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 forecast(
"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 created using the CreateDatasetImportJob operation.
For each import job, this operation returns a summary of its properties, including its
Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an
array of Filter objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, you provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the datasets that match the statement from the list, respectively. The match
statement consists of a key and a value. Filter properties Condition - The condition
to apply. Valid values are IS and IS_NOT. To include the datasets that match the statement,
specify IS. To exclude matching datasets, specify IS_NOT. Key - The name of the
parameter to filter on. Valid values are DatasetArn and Status. Value - The value to
match. For example, to list all dataset import jobs whose status is ACTIVE, you specify
the following filter: \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\",
\"Value\": \"ACTIVE\" } ]
- `"MaxResults"`: The number of items to return in the response.
- `"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_dataset_import_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"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 forecast(
"ListDatasetImportJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_datasets()
list_datasets(params::Dict{String,<:Any})
Returns a list of datasets created using the CreateDataset operation. For each dataset, a
summary of its properties, including its Amazon Resource Name (ARN), is returned. To
retrieve the complete set of properties, use the ARN with the DescribeDataset operation.
# 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"`: 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_datasets(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast("ListDatasets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_datasets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListDatasets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_explainabilities()
list_explainabilities(params::Dict{String,<:Any})
Returns a list of Explainability resources created using the CreateExplainability
operation. This operation returns a summary for each Explainability. You can filter the
list using an array of Filter objects. To retrieve the complete set of properties for a
particular Explainability resource, use the ARN with the DescribeExplainability operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the resources that match the statement from the list. The match statement consists
of a key and a value. Filter properties Condition - The condition to apply. Valid
values are IS and IS_NOT. Key - The name of the parameter to filter on. Valid values are
ResourceArn and Status. Value - The value to match.
- `"MaxResults"`: The number of items returned in the response.
- `"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_explainabilities(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"ListExplainabilities"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_explainabilities(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListExplainabilities",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_explainability_exports()
list_explainability_exports(params::Dict{String,<:Any})
Returns a list of Explainability exports created using the CreateExplainabilityExport
operation. This operation returns a summary for each Explainability export. You can filter
the list using an array of Filter objects. To retrieve the complete set of properties for a
particular Explainability export, use the ARN with the DescribeExplainability operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude resources that match the statement from the list. The match statement consists of a
key and a value. Filter properties Condition - The condition to apply. Valid values
are IS and IS_NOT. Key - The name of the parameter to filter on. Valid values are
ResourceArn and Status. Value - The value to match.
- `"MaxResults"`: The number of items to return in the response.
- `"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_explainability_exports(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"ListExplainabilityExports"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_explainability_exports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListExplainabilityExports",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_forecast_export_jobs()
list_forecast_export_jobs(params::Dict{String,<:Any})
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
For each forecast export job, this operation returns a summary of its properties, including
its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN
with the DescribeForecastExportJob operation. You can filter the list using an array of
Filter objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, you provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the forecast export jobs that match the statement from the list, respectively. The
match statement consists of a key and a value. Filter properties Condition - The
condition to apply. Valid values are IS and IS_NOT. To include the forecast export jobs
that match the statement, specify IS. To exclude matching forecast export jobs, specify
IS_NOT. Key - The name of the parameter to filter on. Valid values are ForecastArn and
Status. Value - The value to match. For example, to list all jobs that export a
forecast named electricityforecast, specify the following filter: \"Filters\": [ {
\"Condition\": \"IS\", \"Key\": \"ForecastArn\", \"Value\":
\"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast\" } ]
- `"MaxResults"`: The number of items to return in the response.
- `"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_forecast_export_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"ListForecastExportJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_forecast_export_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListForecastExportJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_forecasts()
list_forecasts(params::Dict{String,<:Any})
Returns a list of forecasts created using the CreateForecast operation. For each forecast,
this operation returns a summary of its properties, including its Amazon Resource Name
(ARN). To retrieve the complete set of properties, specify the ARN with the
DescribeForecast operation. You can filter the list using an array of Filter objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, you provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the forecasts that match the statement from the list, respectively. The match
statement consists of a key and a value. Filter properties Condition - The condition
to apply. Valid values are IS and IS_NOT. To include the forecasts that match the
statement, specify IS. To exclude matching forecasts, specify IS_NOT. Key - The name of
the parameter to filter on. Valid values are DatasetGroupArn, PredictorArn, and Status.
Value - The value to match. For example, to list all forecasts whose status is not
ACTIVE, you would specify: \"Filters\": [ { \"Condition\": \"IS_NOT\", \"Key\":
\"Status\", \"Value\": \"ACTIVE\" } ]
- `"MaxResults"`: The number of items to return in the response.
- `"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_forecasts(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast("ListForecasts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_forecasts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListForecasts", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_monitor_evaluations(monitor_arn)
list_monitor_evaluations(monitor_arn, params::Dict{String,<:Any})
Returns a list of the monitoring evaluation results and predictor events collected by the
monitor resource during different windows of time. For information about monitoring see
predictor-monitoring. For more information about retrieving monitoring results see Viewing
Monitoring Results.
# Arguments
- `monitor_arn`: The Amazon Resource Name (ARN) of the monitor resource to get results from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the resources that match the statement from the list. The match statement consists
of a key and a value. Filter properties Condition - The condition to apply. Valid
values are IS and IS_NOT. Key - The name of the parameter to filter on. The only valid
value is EvaluationState. Value - The value to match. Valid values are only SUCCESS or
FAILURE. For example, to list only successful monitor evaluations, you would specify:
\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"EvaluationState\", \"Value\":
\"SUCCESS\" } ]
- `"MaxResults"`: The maximum number of monitoring 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_monitor_evaluations(
MonitorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListMonitorEvaluations",
Dict{String,Any}("MonitorArn" => MonitorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_monitor_evaluations(
MonitorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"ListMonitorEvaluations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("MonitorArn" => MonitorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_monitors()
list_monitors(params::Dict{String,<:Any})
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor
operation. For each monitor resource, this operation returns of a summary of its
properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of
properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor
operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the resources that match the statement from the list. The match statement consists
of a key and a value. Filter properties Condition - The condition to apply. Valid
values are IS and IS_NOT. Key - The name of the parameter to filter on. The only valid
value is Status. Value - The value to match. For example, to list all monitors who's
status is ACTIVE, you would specify: \"Filters\": [ { \"Condition\": \"IS\", \"Key\":
\"Status\", \"Value\": \"ACTIVE\" } ]
- `"MaxResults"`: The maximum number of monitors to include in the response.
- `"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_monitors(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast("ListMonitors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_monitors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListMonitors", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_predictor_backtest_export_jobs()
list_predictor_backtest_export_jobs(params::Dict{String,<:Any})
Returns a list of predictor backtest export jobs created using the
CreatePredictorBacktestExportJob operation. This operation returns a summary for each
backtest export job. You can filter the list using an array of Filter objects. To retrieve
the complete set of properties for a particular backtest export job, use the ARN with the
DescribePredictorBacktestExportJob operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the predictor backtest export jobs that match the statement from the list. The
match statement consists of a key and a value. Filter properties Condition - The
condition to apply. Valid values are IS and IS_NOT. To include the predictor backtest
export jobs that match the statement, specify IS. To exclude matching predictor backtest
export jobs, specify IS_NOT. Key - The name of the parameter to filter on. Valid values
are PredictorArn and Status. Value - The value to match.
- `"MaxResults"`: The number of items to return in the response.
- `"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_predictor_backtest_export_jobs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListPredictorBacktestExportJobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_predictor_backtest_export_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListPredictorBacktestExportJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_predictors()
list_predictors(params::Dict{String,<:Any})
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor
operations. For each predictor, this operation returns a summary of its properties,
including its Amazon Resource Name (ARN). You can retrieve the complete set of properties
by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You can
filter the list using an array of Filter objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, you provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the predictors that match the statement from the list, respectively. The match
statement consists of a key and a value. Filter properties Condition - The condition
to apply. Valid values are IS and IS_NOT. To include the predictors that match the
statement, specify IS. To exclude matching predictors, specify IS_NOT. Key - The name of
the parameter to filter on. Valid values are DatasetGroupArn and Status. Value - The
value to match. For example, to list all predictors whose status is ACTIVE, you would
specify: \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\":
\"ACTIVE\" } ]
- `"MaxResults"`: The number of items to return in the response.
- `"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_predictors(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"ListPredictors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_predictors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListPredictors", 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 Forecast resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"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 forecast(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_what_if_analyses()
list_what_if_analyses(params::Dict{String,<:Any})
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For
each what-if analysis, this operation returns a summary of its properties, including its
Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
what-if analysis ARN with the DescribeWhatIfAnalysis operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, you provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the what-if analysis jobs that match the statement from the list, respectively. The
match statement consists of a key and a value. Filter properties Condition - The
condition to apply. Valid values are IS and IS_NOT. To include the what-if analysis jobs
that match the statement, specify IS. To exclude matching what-if analysis jobs, specify
IS_NOT. Key - The name of the parameter to filter on. Valid values are WhatIfAnalysisArn
and Status. Value - The value to match. For example, to list all jobs that export a
forecast named electricityWhatIf, specify the following filter: \"Filters\": [ {
\"Condition\": \"IS\", \"Key\": \"WhatIfAnalysisArn\", \"Value\":
\"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf\" } ]
- `"MaxResults"`: The number of items to return in the response.
- `"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_what_if_analyses(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"ListWhatIfAnalyses"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_what_if_analyses(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListWhatIfAnalyses", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_what_if_forecast_exports()
list_what_if_forecast_exports(params::Dict{String,<:Any})
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport
operation. For each what-if forecast export, this operation returns a summary of its
properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of
properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport
operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, you provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the what-if forecast export jobs that match the statement from the list,
respectively. The match statement consists of a key and a value. Filter properties
Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecast
export jobs that match the statement, specify IS. To exclude matching forecast export jobs,
specify IS_NOT. Key - The name of the parameter to filter on. Valid values are
WhatIfForecastExportArn and Status. Value - The value to match. For example, to list
all jobs that export a forecast named electricityWIFExport, specify the following filter:
\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"WhatIfForecastExportArn\", \"Value\":
\"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport\" } ]
- `"MaxResults"`: The number of items to return in the response.
- `"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_what_if_forecast_exports(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"ListWhatIfForecastExports"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_what_if_forecast_exports(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListWhatIfForecastExports",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_what_if_forecasts()
list_what_if_forecasts(params::Dict{String,<:Any})
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For
each what-if forecast, this operation returns a summary of its properties, including its
Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
what-if forecast ARN with the DescribeWhatIfForecast operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: An array of filters. For each filter, you provide a condition and a match
statement. The condition is either IS or IS_NOT, which specifies whether to include or
exclude the what-if forecast export jobs that match the statement from the list,
respectively. The match statement consists of a key and a value. Filter properties
Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecast
export jobs that match the statement, specify IS. To exclude matching forecast export jobs,
specify IS_NOT. Key - The name of the parameter to filter on. Valid values are
WhatIfForecastArn and Status. Value - The value to match. For example, to list all
jobs that export a forecast named electricityWhatIfForecast, specify the following filter:
\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"WhatIfForecastArn\", \"Value\":
\"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast\" } ]
- `"MaxResults"`: The number of items to return in the response.
- `"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_what_if_forecasts(; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"ListWhatIfForecasts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_what_if_forecasts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"ListWhatIfForecasts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resume_resource(resource_arn)
resume_resource(resource_arn, params::Dict{String,<:Any})
Resumes a stopped monitor resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the monitor resource to resume.
"""
function resume_resource(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"ResumeResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resume_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"ResumeResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_resource(resource_arn)
stop_resource(resource_arn, params::Dict{String,<:Any})
Stops a resource. The resource undergoes the following states: CREATE_STOPPING and
CREATE_STOPPED. You cannot resume a resource once it has been stopped. This operation can
be applied to the following resources (and their corresponding child resources): Dataset
Import Job Predictor Job Forecast Job Forecast Export Job Predictor Backtest Export
Job Explainability Job Explainability Export Job
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource to stop. The
supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn,
ForecastArn, ForecastExportJobArn, ExplainabilityArn, and ExplainabilityExportArn.
"""
function stop_resource(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"StopResource",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_resource(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"StopResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("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})
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 also deleted.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags.
- `tags`: The tags to add to the resource. A tag is an array of key-value pairs. The
following basic restrictions apply to tags: Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8. Maximum value length - 256 Unicode
characters in UTF-8. If your tagging schema is used across multiple services and
resources, remember that other services may have restrictions on allowed characters.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and
the following characters: + - = . _ : / @. Tag keys and values are case sensitive. Do
not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as
it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this
prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does
not, then Forecast considers it to be a user tag and will count against the limit of 50
tags. Tags with only the key prefix of aws do not count against your tags per resource
limit.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return forecast(
"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 forecast(
"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 the specified tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags.
- `tag_keys`: The keys of the tags to be removed.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"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 forecast(
"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_dataset_group(dataset_arns, dataset_group_arn)
update_dataset_group(dataset_arns, dataset_group_arn, params::Dict{String,<:Any})
Replaces the datasets in a dataset group with the specified datasets. The Status of the
dataset group must be ACTIVE before you can use the dataset group to create a predictor.
Use the DescribeDatasetGroup operation to get the status.
# Arguments
- `dataset_arns`: An array of the Amazon Resource Names (ARNs) of the datasets to add to
the dataset group.
- `dataset_group_arn`: The ARN of the dataset group.
"""
function update_dataset_group(
DatasetArns, DatasetGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecast(
"UpdateDatasetGroup",
Dict{String,Any}(
"DatasetArns" => DatasetArns, "DatasetGroupArn" => DatasetGroupArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dataset_group(
DatasetArns,
DatasetGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecast(
"UpdateDatasetGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatasetArns" => DatasetArns, "DatasetGroupArn" => DatasetGroupArn
),
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 | 4835 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: forecastquery
using AWS.Compat
using AWS.UUIDs
"""
query_forecast(filters, forecast_arn)
query_forecast(filters, forecast_arn, params::Dict{String,<:Any})
Retrieves a forecast for a single item, filtered by the supplied criteria. The criteria is
a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target
field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as
part of the FeaturizationConfig object. By default, QueryForecast returns the complete date
range for the filtered forecast. You can request a specific date range. To get the full
forecast, use the CreateForecastExportJob operation. The forecasts generated by Amazon
Forecast are in the same timezone as the dataset that was used to create the predictor.
# Arguments
- `filters`: The filtering criteria to apply when retrieving the forecast. For example, to
get the forecast for client_21 in the electricity usage dataset, specify the following:
{\"item_id\" : \"client_21\"} To get the full forecast, use the CreateForecastExportJob
operation.
- `forecast_arn`: The Amazon Resource Name (ARN) of the forecast to query.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndDate"`: The end date for the forecast. Specify the date using this format:
yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.
- `"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.
- `"StartDate"`: The start date for the forecast. Specify the date using this format:
yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.
"""
function query_forecast(
Filters, ForecastArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecastquery(
"QueryForecast",
Dict{String,Any}("Filters" => Filters, "ForecastArn" => ForecastArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function query_forecast(
Filters,
ForecastArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecastquery(
"QueryForecast",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Filters" => Filters, "ForecastArn" => ForecastArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
query_what_if_forecast(filters, what_if_forecast_arn)
query_what_if_forecast(filters, what_if_forecast_arn, params::Dict{String,<:Any})
Retrieves a what-if forecast.
# Arguments
- `filters`: The filtering criteria to apply when retrieving the forecast. For example, to
get the forecast for client_21 in the electricity usage dataset, specify the following:
{\"item_id\" : \"client_21\"} To get the full what-if forecast, use the
CreateForecastExportJob operation.
- `what_if_forecast_arn`: The Amazon Resource Name (ARN) of the what-if forecast to query.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndDate"`: The end date for the what-if forecast. Specify the date using this format:
yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.
- `"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.
- `"StartDate"`: The start date for the what-if forecast. Specify the date using this
format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.
"""
function query_what_if_forecast(
Filters, WhatIfForecastArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return forecastquery(
"QueryWhatIfForecast",
Dict{String,Any}("Filters" => Filters, "WhatIfForecastArn" => WhatIfForecastArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function query_what_if_forecast(
Filters,
WhatIfForecastArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return forecastquery(
"QueryWhatIfForecast",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Filters" => Filters, "WhatIfForecastArn" => WhatIfForecastArn
),
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 | 105943 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: frauddetector
using AWS.Compat
using AWS.UUIDs
"""
batch_create_variable(variable_entries)
batch_create_variable(variable_entries, params::Dict{String,<:Any})
Creates a batch of variables.
# Arguments
- `variable_entries`: The list of variables for the batch create variable request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A collection of key and value pairs.
"""
function batch_create_variable(
variableEntries; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"BatchCreateVariable",
Dict{String,Any}("variableEntries" => variableEntries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_create_variable(
variableEntries,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"BatchCreateVariable",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("variableEntries" => variableEntries), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_variable(names)
batch_get_variable(names, params::Dict{String,<:Any})
Gets a batch of variables.
# Arguments
- `names`: The list of variable names to get.
"""
function batch_get_variable(names; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"BatchGetVariable",
Dict{String,Any}("names" => names);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_variable(
names, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"BatchGetVariable",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("names" => names), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_batch_import_job(job_id)
cancel_batch_import_job(job_id, params::Dict{String,<:Any})
Cancels an in-progress batch import job.
# Arguments
- `job_id`: The ID of an in-progress batch import job to cancel. Amazon Fraud Detector
will throw an error if the batch import job is in FAILED, CANCELED, or COMPLETED state.
"""
function cancel_batch_import_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"CancelBatchImportJob",
Dict{String,Any}("jobId" => jobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_batch_import_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"CancelBatchImportJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("jobId" => jobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_batch_prediction_job(job_id)
cancel_batch_prediction_job(job_id, params::Dict{String,<:Any})
Cancels the specified batch prediction job.
# Arguments
- `job_id`: The ID of the batch prediction job to cancel.
"""
function cancel_batch_prediction_job(
jobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"CancelBatchPredictionJob",
Dict{String,Any}("jobId" => jobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_batch_prediction_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"CancelBatchPredictionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("jobId" => jobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_batch_import_job(event_type_name, iam_role_arn, input_path, job_id, output_path)
create_batch_import_job(event_type_name, iam_role_arn, input_path, job_id, output_path, params::Dict{String,<:Any})
Creates a batch import job.
# Arguments
- `event_type_name`: The name of the event type.
- `iam_role_arn`: The ARN of the IAM role created for Amazon S3 bucket that holds your data
file. The IAM role must have read permissions to your input S3 bucket and write permissions
to your output S3 bucket. For more information about bucket permissions, see User policy
examples in the Amazon S3 User Guide.
- `input_path`: The URI that points to the Amazon S3 location of your data file.
- `job_id`: The ID of the batch import job. The ID cannot be of a past job, unless the job
exists in CREATE_FAILED state.
- `output_path`: The URI that points to the Amazon S3 location for storing your results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A collection of key-value pairs associated with this request.
"""
function create_batch_import_job(
eventTypeName,
iamRoleArn,
inputPath,
jobId,
outputPath;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateBatchImportJob",
Dict{String,Any}(
"eventTypeName" => eventTypeName,
"iamRoleArn" => iamRoleArn,
"inputPath" => inputPath,
"jobId" => jobId,
"outputPath" => outputPath,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_batch_import_job(
eventTypeName,
iamRoleArn,
inputPath,
jobId,
outputPath,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateBatchImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"eventTypeName" => eventTypeName,
"iamRoleArn" => iamRoleArn,
"inputPath" => inputPath,
"jobId" => jobId,
"outputPath" => outputPath,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_batch_prediction_job(detector_name, event_type_name, iam_role_arn, input_path, job_id, output_path)
create_batch_prediction_job(detector_name, event_type_name, iam_role_arn, input_path, job_id, output_path, params::Dict{String,<:Any})
Creates a batch prediction job.
# Arguments
- `detector_name`: The name of the detector.
- `event_type_name`: The name of the event type.
- `iam_role_arn`: The ARN of the IAM role to use for this job request. The IAM Role must
have read permissions to your input S3 bucket and write permissions to your output S3
bucket. For more information about bucket permissions, see User policy examples in the
Amazon S3 User Guide.
- `input_path`: The Amazon S3 location of your training file.
- `job_id`: The ID of the batch prediction job.
- `output_path`: The Amazon S3 location of your output file.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"detectorVersion"`: The detector version.
- `"tags"`: A collection of key and value pairs.
"""
function create_batch_prediction_job(
detectorName,
eventTypeName,
iamRoleArn,
inputPath,
jobId,
outputPath;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateBatchPredictionJob",
Dict{String,Any}(
"detectorName" => detectorName,
"eventTypeName" => eventTypeName,
"iamRoleArn" => iamRoleArn,
"inputPath" => inputPath,
"jobId" => jobId,
"outputPath" => outputPath,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_batch_prediction_job(
detectorName,
eventTypeName,
iamRoleArn,
inputPath,
jobId,
outputPath,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateBatchPredictionJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorName" => detectorName,
"eventTypeName" => eventTypeName,
"iamRoleArn" => iamRoleArn,
"inputPath" => inputPath,
"jobId" => jobId,
"outputPath" => outputPath,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_detector_version(detector_id, rules)
create_detector_version(detector_id, rules, params::Dict{String,<:Any})
Creates a detector version. The detector version starts in a DRAFT status.
# Arguments
- `detector_id`: The ID of the detector under which you want to create a new version.
- `rules`: The rules to include in the detector version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the detector version.
- `"externalModelEndpoints"`: The Amazon Sagemaker model endpoints to include in the
detector version.
- `"modelVersions"`: The model versions to include in the detector version.
- `"ruleExecutionMode"`: The rule execution mode for the rules included in the detector
version. You can define and edit the rule mode at the detector version level, when it is in
draft status. If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules
sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector
then provides the outcomes for that single rule. If you specifiy ALL_MATCHED, Amazon Fraud
Detector evaluates all rules and returns the outcomes for all matched rules. The default
behavior is FIRST_MATCHED.
- `"tags"`: A collection of key and value pairs.
"""
function create_detector_version(
detectorId, rules; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"CreateDetectorVersion",
Dict{String,Any}("detectorId" => detectorId, "rules" => rules);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_detector_version(
detectorId,
rules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateDetectorVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("detectorId" => detectorId, "rules" => rules),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_list(name)
create_list(name, params::Dict{String,<:Any})
Creates a list. List is a set of input data for a variable in your event dataset. You use
the input data in a rule that's associated with your detector. For more information, see
Lists.
# Arguments
- `name`: The name of the list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the list.
- `"elements"`: The names of the elements, if providing. You can also create an empty list
and add elements later using the UpdateList API.
- `"tags"`: A collection of the key and value pairs.
- `"variableType"`: The variable type of the list. You can only assign the variable type
with String data type. For more information, see Variable types.
"""
function create_list(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"CreateList",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_list(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"CreateList",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model(event_type_name, model_id, model_type)
create_model(event_type_name, model_id, model_type, params::Dict{String,<:Any})
Creates a model using the specified model type.
# Arguments
- `event_type_name`: The name of the event type.
- `model_id`: The model ID.
- `model_type`: The model type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The model description.
- `"tags"`: A collection of key and value pairs.
"""
function create_model(
eventTypeName, modelId, modelType; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"CreateModel",
Dict{String,Any}(
"eventTypeName" => eventTypeName, "modelId" => modelId, "modelType" => modelType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model(
eventTypeName,
modelId,
modelType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateModel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"eventTypeName" => eventTypeName,
"modelId" => modelId,
"modelType" => modelType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_model_version(model_id, model_type, training_data_schema, training_data_source)
create_model_version(model_id, model_type, training_data_schema, training_data_source, params::Dict{String,<:Any})
Creates a version of the model using the specified model type and model id.
# Arguments
- `model_id`: The model ID.
- `model_type`: The model type.
- `training_data_schema`: The training data schema.
- `training_data_source`: The training data source location in Amazon S3.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"externalEventsDetail"`: Details of the external events data used for model version
training. Required if trainingDataSource is EXTERNAL_EVENTS.
- `"ingestedEventsDetail"`: Details of the ingested events data used for model version
training. Required if trainingDataSource is INGESTED_EVENTS.
- `"tags"`: A collection of key and value pairs.
"""
function create_model_version(
modelId,
modelType,
trainingDataSchema,
trainingDataSource;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateModelVersion",
Dict{String,Any}(
"modelId" => modelId,
"modelType" => modelType,
"trainingDataSchema" => trainingDataSchema,
"trainingDataSource" => trainingDataSource,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_model_version(
modelId,
modelType,
trainingDataSchema,
trainingDataSource,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateModelVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"modelId" => modelId,
"modelType" => modelType,
"trainingDataSchema" => trainingDataSchema,
"trainingDataSource" => trainingDataSource,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_rule(detector_id, expression, language, outcomes, rule_id)
create_rule(detector_id, expression, language, outcomes, rule_id, params::Dict{String,<:Any})
Creates a rule for use with the specified detector.
# Arguments
- `detector_id`: The detector ID for the rule's parent detector.
- `expression`: The rule expression.
- `language`: The language of the rule.
- `outcomes`: The outcome or outcomes returned when the rule expression matches.
- `rule_id`: The rule ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The rule description.
- `"tags"`: A collection of key and value pairs.
"""
function create_rule(
detectorId,
expression,
language,
outcomes,
ruleId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateRule",
Dict{String,Any}(
"detectorId" => detectorId,
"expression" => expression,
"language" => language,
"outcomes" => outcomes,
"ruleId" => ruleId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_rule(
detectorId,
expression,
language,
outcomes,
ruleId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateRule",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorId" => detectorId,
"expression" => expression,
"language" => language,
"outcomes" => outcomes,
"ruleId" => ruleId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_variable(data_source, data_type, default_value, name)
create_variable(data_source, data_type, default_value, name, params::Dict{String,<:Any})
Creates a variable.
# Arguments
- `data_source`: The source of the data.
- `data_type`: The data type of the variable.
- `default_value`: The default value for the variable when no value is received.
- `name`: The name of the variable.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description.
- `"tags"`: A collection of key and value pairs.
- `"variableType"`: The variable type. For more information see Variable types. Valid
Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY |
BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN |
CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT |
IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY |
SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY |
SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
"""
function create_variable(
dataSource,
dataType,
defaultValue,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateVariable",
Dict{String,Any}(
"dataSource" => dataSource,
"dataType" => dataType,
"defaultValue" => defaultValue,
"name" => name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_variable(
dataSource,
dataType,
defaultValue,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"CreateVariable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"dataSource" => dataSource,
"dataType" => dataType,
"defaultValue" => defaultValue,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_batch_import_job(job_id)
delete_batch_import_job(job_id, params::Dict{String,<:Any})
Deletes the specified batch import job ID record. This action does not delete the data that
was batch imported.
# Arguments
- `job_id`: The ID of the batch import job to delete.
"""
function delete_batch_import_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DeleteBatchImportJob",
Dict{String,Any}("jobId" => jobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_batch_import_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteBatchImportJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("jobId" => jobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_batch_prediction_job(job_id)
delete_batch_prediction_job(job_id, params::Dict{String,<:Any})
Deletes a batch prediction job.
# Arguments
- `job_id`: The ID of the batch prediction job to delete.
"""
function delete_batch_prediction_job(
jobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteBatchPredictionJob",
Dict{String,Any}("jobId" => jobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_batch_prediction_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteBatchPredictionJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("jobId" => jobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_detector(detector_id)
delete_detector(detector_id, params::Dict{String,<:Any})
Deletes the detector. Before deleting a detector, you must first delete all detector
versions and rule versions associated with the detector. When you delete a detector, Amazon
Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon
Fraud Detector.
# Arguments
- `detector_id`: The ID of the detector to delete.
"""
function delete_detector(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DeleteDetector",
Dict{String,Any}("detectorId" => detectorId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_detector(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"DeleteDetector",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("detectorId" => detectorId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_detector_version(detector_id, detector_version_id)
delete_detector_version(detector_id, detector_version_id, params::Dict{String,<:Any})
Deletes the detector version. You cannot delete detector versions that are in ACTIVE
status. When you delete a detector version, Amazon Fraud Detector permanently deletes the
detector and the data is no longer stored in Amazon Fraud Detector.
# Arguments
- `detector_id`: The ID of the parent detector for the detector version to delete.
- `detector_version_id`: The ID of the detector version to delete.
"""
function delete_detector_version(
detectorId, detectorVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteDetectorVersion",
Dict{String,Any}(
"detectorId" => detectorId, "detectorVersionId" => detectorVersionId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_detector_version(
detectorId,
detectorVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"DeleteDetectorVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorId" => detectorId, "detectorVersionId" => detectorVersionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_entity_type(name)
delete_entity_type(name, params::Dict{String,<:Any})
Deletes an entity type. You cannot delete an entity type that is included in an event type.
When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type
and the data is no longer stored in Amazon Fraud Detector.
# Arguments
- `name`: The name of the entity type to delete.
"""
function delete_entity_type(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DeleteEntityType",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_entity_type(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteEntityType",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event(event_id, event_type_name)
delete_event(event_id, event_type_name, params::Dict{String,<:Any})
Deletes the specified event. When you delete an event, Amazon Fraud Detector permanently
deletes that event and the event data is no longer stored in Amazon Fraud Detector. If
deleteAuditHistory is True, event data is available through search for up to 30 seconds
after the delete operation is completed.
# Arguments
- `event_id`: The ID of the event to delete.
- `event_type_name`: The name of the event type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deleteAuditHistory"`: Specifies whether or not to delete any predictions associated
with the event. If set to True,
"""
function delete_event(
eventId, eventTypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteEvent",
Dict{String,Any}("eventId" => eventId, "eventTypeName" => eventTypeName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event(
eventId,
eventTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"DeleteEvent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("eventId" => eventId, "eventTypeName" => eventTypeName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_event_type(name)
delete_event_type(name, params::Dict{String,<:Any})
Deletes an event type. You cannot delete an event type that is used in a detector or a
model. When you delete an event type, Amazon Fraud Detector permanently deletes that event
type and the data is no longer stored in Amazon Fraud Detector.
# Arguments
- `name`: The name of the event type to delete.
"""
function delete_event_type(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DeleteEventType",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_event_type(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteEventType",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_events_by_event_type(event_type_name)
delete_events_by_event_type(event_type_name, params::Dict{String,<:Any})
Deletes all events of a particular event type.
# Arguments
- `event_type_name`: The name of the event type.
"""
function delete_events_by_event_type(
eventTypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteEventsByEventType",
Dict{String,Any}("eventTypeName" => eventTypeName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_events_by_event_type(
eventTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"DeleteEventsByEventType",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("eventTypeName" => eventTypeName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_external_model(model_endpoint)
delete_external_model(model_endpoint, params::Dict{String,<:Any})
Removes a SageMaker model from Amazon Fraud Detector. You can remove an Amazon SageMaker
model if it is not associated with a detector version. Removing a SageMaker model
disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.
# Arguments
- `model_endpoint`: The endpoint of the Amazon Sagemaker model to delete.
"""
function delete_external_model(
modelEndpoint; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteExternalModel",
Dict{String,Any}("modelEndpoint" => modelEndpoint);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_external_model(
modelEndpoint,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"DeleteExternalModel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("modelEndpoint" => modelEndpoint), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_label(name)
delete_label(name, params::Dict{String,<:Any})
Deletes a label. You cannot delete labels that are included in an event type in Amazon
Fraud Detector. You cannot delete a label assigned to an event ID. You must first delete
the relevant event ID. When you delete a label, Amazon Fraud Detector permanently deletes
that label and the data is no longer stored in Amazon Fraud Detector.
# Arguments
- `name`: The name of the label to delete.
"""
function delete_label(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DeleteLabel",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_label(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteLabel",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_list(name)
delete_list(name, params::Dict{String,<:Any})
Deletes the list, provided it is not used in a rule. When you delete a list, Amazon
Fraud Detector permanently deletes that list and the elements in the list.
# Arguments
- `name`: The name of the list to delete.
"""
function delete_list(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DeleteList",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_list(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteList",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model(model_id, model_type)
delete_model(model_id, model_type, params::Dict{String,<:Any})
Deletes a model. You can delete models and model versions in Amazon Fraud Detector,
provided that they are not associated with a detector version. When you delete a model,
Amazon Fraud Detector permanently deletes that model and the data is no longer stored in
Amazon Fraud Detector.
# Arguments
- `model_id`: The model ID of the model to delete.
- `model_type`: The model type of the model to delete.
"""
function delete_model(modelId, modelType; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DeleteModel",
Dict{String,Any}("modelId" => modelId, "modelType" => modelType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model(
modelId,
modelType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"DeleteModel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("modelId" => modelId, "modelType" => modelType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_model_version(model_id, model_type, model_version_number)
delete_model_version(model_id, model_type, model_version_number, params::Dict{String,<:Any})
Deletes a model version. You can delete models and model versions in Amazon Fraud Detector,
provided that they are not associated with a detector version. When you delete a model
version, Amazon Fraud Detector permanently deletes that model version and the data is no
longer stored in Amazon Fraud Detector.
# Arguments
- `model_id`: The model ID of the model version to delete.
- `model_type`: The model type of the model version to delete.
- `model_version_number`: The model version number of the model version to delete.
"""
function delete_model_version(
modelId,
modelType,
modelVersionNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"DeleteModelVersion",
Dict{String,Any}(
"modelId" => modelId,
"modelType" => modelType,
"modelVersionNumber" => modelVersionNumber,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_model_version(
modelId,
modelType,
modelVersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"DeleteModelVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"modelId" => modelId,
"modelType" => modelType,
"modelVersionNumber" => modelVersionNumber,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_outcome(name)
delete_outcome(name, params::Dict{String,<:Any})
Deletes an outcome. You cannot delete an outcome that is used in a rule version. When you
delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is
no longer stored in Amazon Fraud Detector.
# Arguments
- `name`: The name of the outcome to delete.
"""
function delete_outcome(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DeleteOutcome",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_outcome(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteOutcome",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_rule(rule)
delete_rule(rule, params::Dict{String,<:Any})
Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector
version. When you delete a rule, Amazon Fraud Detector permanently deletes that rule and
the data is no longer stored in Amazon Fraud Detector.
# Arguments
- `rule`:
"""
function delete_rule(rule; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DeleteRule",
Dict{String,Any}("rule" => rule);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_rule(
rule, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteRule",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("rule" => rule), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_variable(name)
delete_variable(name, params::Dict{String,<:Any})
Deletes a variable. You can't delete variables that are included in an event type in Amazon
Fraud Detector. Amazon Fraud Detector automatically deletes model output variables and
SageMaker model output variables when you delete the model. You can't delete these
variables manually. When you delete a variable, Amazon Fraud Detector permanently deletes
that variable and the data is no longer stored in Amazon Fraud Detector.
# Arguments
- `name`: The name of the variable to delete.
"""
function delete_variable(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DeleteVariable",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_variable(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DeleteVariable",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_detector(detector_id)
describe_detector(detector_id, params::Dict{String,<:Any})
Gets all versions for a specified detector.
# Arguments
- `detector_id`: The detector 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 for the request.
- `"nextToken"`: The next token from the previous response.
"""
function describe_detector(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DescribeDetector",
Dict{String,Any}("detectorId" => detectorId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_detector(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"DescribeDetector",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("detectorId" => detectorId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_model_versions()
describe_model_versions(params::Dict{String,<:Any})
Gets all of the model versions for the specified model type or for the specified model type
and model ID. You can also get details for a single, specified model 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.
- `"modelId"`: The model ID.
- `"modelType"`: The model type.
- `"modelVersionNumber"`: The model version number.
- `"nextToken"`: The next token from the previous results.
"""
function describe_model_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"DescribeModelVersions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_model_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"DescribeModelVersions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_batch_import_jobs()
get_batch_import_jobs(params::Dict{String,<:Any})
Gets all batch import jobs or a specific job of the specified ID. This is a paginated API.
If you provide a null maxResults, this action retrieves a maximum of 50 records per page.
If you provide a maxResults, the value must be between 1 and 50. To get the next page
results, provide the pagination token from the GetBatchImportJobsResponse as part of your
request. A null pagination token fetches the records from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"jobId"`: The ID of the batch import job to get.
- `"maxResults"`: The maximum number of objects to return for request.
- `"nextToken"`: The next token from the previous request.
"""
function get_batch_import_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetBatchImportJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_batch_import_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetBatchImportJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_batch_prediction_jobs()
get_batch_prediction_jobs(params::Dict{String,<:Any})
Gets all batch prediction jobs or a specific job if you specify a job ID. This is a
paginated API. If you provide a null maxResults, this action retrieves a maximum of 50
records per page. If you provide a maxResults, the value must be between 1 and 50. To get
the next page results, provide the pagination token from the GetBatchPredictionJobsResponse
as part of your request. A null pagination token fetches the records from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"jobId"`: The batch prediction job for which to get the details.
- `"maxResults"`: The maximum number of objects to return for the request.
- `"nextToken"`: The next token from the previous request.
"""
function get_batch_prediction_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetBatchPredictionJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_batch_prediction_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetBatchPredictionJobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_delete_events_by_event_type_status(event_type_name)
get_delete_events_by_event_type_status(event_type_name, params::Dict{String,<:Any})
Retrieves the status of a DeleteEventsByEventType action.
# Arguments
- `event_type_name`: Name of event type for which to get the deletion status.
"""
function get_delete_events_by_event_type_status(
eventTypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetDeleteEventsByEventTypeStatus",
Dict{String,Any}("eventTypeName" => eventTypeName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_delete_events_by_event_type_status(
eventTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"GetDeleteEventsByEventTypeStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("eventTypeName" => eventTypeName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_detector_version(detector_id, detector_version_id)
get_detector_version(detector_id, detector_version_id, params::Dict{String,<:Any})
Gets a particular detector version.
# Arguments
- `detector_id`: The detector ID.
- `detector_version_id`: The detector version ID.
"""
function get_detector_version(
detectorId, detectorVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetDetectorVersion",
Dict{String,Any}(
"detectorId" => detectorId, "detectorVersionId" => detectorVersionId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_detector_version(
detectorId,
detectorVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"GetDetectorVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorId" => detectorId, "detectorVersionId" => detectorVersionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_detectors()
get_detectors(params::Dict{String,<:Any})
Gets all detectors or a single detector if a detectorId is specified. This is a paginated
API. If you provide a null maxResults, this action retrieves a maximum of 10 records per
page. If you provide a maxResults, the value must be between 5 and 10. To get the next page
results, provide the pagination token from the GetDetectorsResponse as part of your
request. A null pagination token fetches the records from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"detectorId"`: The detector ID.
- `"maxResults"`: The maximum number of objects to return for the request.
- `"nextToken"`: The next token for the subsequent request.
"""
function get_detectors(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetDetectors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_detectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetDetectors", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_entity_types()
get_entity_types(params::Dict{String,<:Any})
Gets all entity types or a specific entity type if a name is specified. This is a paginated
API. If you provide a null maxResults, this action retrieves a maximum of 10 records per
page. If you provide a maxResults, the value must be between 5 and 10. To get the next page
results, provide the pagination token from the GetEntityTypesResponse as part of your
request. A null pagination token fetches the records from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return for the request.
- `"name"`: The name.
- `"nextToken"`: The next token for the subsequent request.
"""
function get_entity_types(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetEntityTypes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_entity_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetEntityTypes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_event(event_id, event_type_name)
get_event(event_id, event_type_name, params::Dict{String,<:Any})
Retrieves details of events stored with Amazon Fraud Detector. This action does not
retrieve prediction results.
# Arguments
- `event_id`: The ID of the event to retrieve.
- `event_type_name`: The event type of the event to retrieve.
"""
function get_event(
eventId, eventTypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetEvent",
Dict{String,Any}("eventId" => eventId, "eventTypeName" => eventTypeName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_event(
eventId,
eventTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"GetEvent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("eventId" => eventId, "eventTypeName" => eventTypeName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_event_prediction(detector_id, entities, event_id, event_timestamp, event_type_name, event_variables)
get_event_prediction(detector_id, entities, event_id, event_timestamp, event_type_name, event_variables, params::Dict{String,<:Any})
Evaluates an event against a detector version. If a version ID is not provided, the
detector’s (ACTIVE) version is used.
# Arguments
- `detector_id`: The detector ID.
- `entities`: The entity type (associated with the detector's event type) and specific
entity ID representing who performed the event. If an entity id is not available, use
\"UNKNOWN.\"
- `event_id`: The unique ID used to identify the event.
- `event_timestamp`: Timestamp that defines when the event under evaluation occurred. The
timestamp must be specified using ISO 8601 standard in UTC.
- `event_type_name`: The event type associated with the detector specified for the
prediction.
- `event_variables`: Names of the event type's variables you defined in Amazon Fraud
Detector to represent data elements and their corresponding values for the event you are
sending for evaluation. You must provide at least one eventVariable To ensure most
accurate fraud prediction and to simplify your data preparation, Amazon Fraud Detector will
replace all missing variables or values as follows: For Amazon Fraud Detector trained
models: If a null value is provided explicitly for a variable or if a variable is missing,
model will replace the null value or the missing variable (no variable name in the
eventVariables map) with calculated default mean/medians for numeric variables and with
special values for categorical variables. For imported SageMaker models: If a null value
is provided explicitly for a variable, the model and rules will use “null” as the
value. If a variable is not provided (no variable name in the eventVariables map), model
and rules will use the default value that is provided for the variable.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"detectorVersionId"`: The detector version ID.
- `"externalModelEndpointDataBlobs"`: The Amazon SageMaker model endpoint input data blobs.
"""
function get_event_prediction(
detectorId,
entities,
eventId,
eventTimestamp,
eventTypeName,
eventVariables;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"GetEventPrediction",
Dict{String,Any}(
"detectorId" => detectorId,
"entities" => entities,
"eventId" => eventId,
"eventTimestamp" => eventTimestamp,
"eventTypeName" => eventTypeName,
"eventVariables" => eventVariables,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_event_prediction(
detectorId,
entities,
eventId,
eventTimestamp,
eventTypeName,
eventVariables,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"GetEventPrediction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorId" => detectorId,
"entities" => entities,
"eventId" => eventId,
"eventTimestamp" => eventTimestamp,
"eventTypeName" => eventTypeName,
"eventVariables" => eventVariables,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_event_prediction_metadata(detector_id, detector_version_id, event_id, event_type_name, prediction_timestamp)
get_event_prediction_metadata(detector_id, detector_version_id, event_id, event_type_name, prediction_timestamp, params::Dict{String,<:Any})
Gets details of the past fraud predictions for the specified event ID, event type,
detector ID, and detector version ID that was generated in the specified time period.
# Arguments
- `detector_id`: The detector ID.
- `detector_version_id`: The detector version ID.
- `event_id`: The event ID.
- `event_type_name`: The event type associated with the detector specified for the
prediction.
- `prediction_timestamp`: The timestamp that defines when the prediction was generated.
The timestamp must be specified using ISO 8601 standard in UTC. We recommend calling
ListEventPredictions first, and using the predictionTimestamp value in the response to
provide an accurate prediction timestamp value.
"""
function get_event_prediction_metadata(
detectorId,
detectorVersionId,
eventId,
eventTypeName,
predictionTimestamp;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"GetEventPredictionMetadata",
Dict{String,Any}(
"detectorId" => detectorId,
"detectorVersionId" => detectorVersionId,
"eventId" => eventId,
"eventTypeName" => eventTypeName,
"predictionTimestamp" => predictionTimestamp,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_event_prediction_metadata(
detectorId,
detectorVersionId,
eventId,
eventTypeName,
predictionTimestamp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"GetEventPredictionMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorId" => detectorId,
"detectorVersionId" => detectorVersionId,
"eventId" => eventId,
"eventTypeName" => eventTypeName,
"predictionTimestamp" => predictionTimestamp,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_event_types()
get_event_types(params::Dict{String,<:Any})
Gets all event types or a specific event type if name is provided. This is a paginated API.
If you provide a null maxResults, this action retrieves a maximum of 10 records per page.
If you provide a maxResults, the value must be between 5 and 10. To get the next page
results, provide the pagination token from the GetEventTypesResponse as part of your
request. A null pagination token fetches the records from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return for the request.
- `"name"`: The name.
- `"nextToken"`: The next token for the subsequent request.
"""
function get_event_types(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetEventTypes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_event_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetEventTypes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_external_models()
get_external_models(params::Dict{String,<:Any})
Gets the details for one or more Amazon SageMaker models that have been imported into the
service. This is a paginated API. If you provide a null maxResults, this actions retrieves
a maximum of 10 records per page. If you provide a maxResults, the value must be between 5
and 10. To get the next page results, provide the pagination token from the
GetExternalModelsResult as part of your request. A null pagination token fetches the
records from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return for the request.
- `"modelEndpoint"`: The Amazon SageMaker model endpoint.
- `"nextToken"`: The next page token for the request.
"""
function get_external_models(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetExternalModels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_external_models(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetExternalModels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_kmsencryption_key()
get_kmsencryption_key(params::Dict{String,<:Any})
Gets the encryption key if a KMS key has been specified to be used to encrypt content in
Amazon Fraud Detector.
"""
function get_kmsencryption_key(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetKMSEncryptionKey"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_kmsencryption_key(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetKMSEncryptionKey",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_labels()
get_labels(params::Dict{String,<:Any})
Gets all labels or a specific label if name is provided. This is a paginated API. If you
provide a null maxResults, this action retrieves a maximum of 50 records per page. If you
provide a maxResults, the value must be between 10 and 50. To get the next page results,
provide the pagination token from the GetGetLabelsResponse as part of your request. A null
pagination token fetches the records from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return for the request.
- `"name"`: The name of the label or labels to get.
- `"nextToken"`: The next token for the subsequent request.
"""
function get_labels(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetLabels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_labels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetLabels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_list_elements(name)
get_list_elements(name, params::Dict{String,<:Any})
Gets all the elements in the specified list.
# Arguments
- `name`: The name of the list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return for the request.
- `"nextToken"`: The next token for the subsequent request.
"""
function get_list_elements(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetListElements",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_list_elements(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetListElements",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lists_metadata()
get_lists_metadata(params::Dict{String,<:Any})
Gets the metadata of either all the lists under the account or the specified list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return for the request.
- `"name"`: The name of the list.
- `"nextToken"`: The next token for the subsequent request.
"""
function get_lists_metadata(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetListsMetadata"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_lists_metadata(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetListsMetadata", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_model_version(model_id, model_type, model_version_number)
get_model_version(model_id, model_type, model_version_number, params::Dict{String,<:Any})
Gets the details of the specified model version.
# Arguments
- `model_id`: The model ID.
- `model_type`: The model type.
- `model_version_number`: The model version number.
"""
function get_model_version(
modelId,
modelType,
modelVersionNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"GetModelVersion",
Dict{String,Any}(
"modelId" => modelId,
"modelType" => modelType,
"modelVersionNumber" => modelVersionNumber,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_model_version(
modelId,
modelType,
modelVersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"GetModelVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"modelId" => modelId,
"modelType" => modelType,
"modelVersionNumber" => modelVersionNumber,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_models()
get_models(params::Dict{String,<:Any})
Gets one or more models. Gets all models for the Amazon Web Services account if no model
type and no model id provided. Gets all models for the Amazon Web Services account and
model type, if the model type is specified but model id is not provided. Gets a specific
model if (model type, model id) tuple is specified. This is a paginated API. If you
provide a null maxResults, this action retrieves a maximum of 10 records per page. If you
provide a maxResults, the value must be between 1 and 10. To get the next page results,
provide the pagination token from the response as part of your request. A null pagination
token fetches the records from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return for the request.
- `"modelId"`: The model ID.
- `"modelType"`: The model type.
- `"nextToken"`: The next token for the subsequent request.
"""
function get_models(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetModels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_models(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetModels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_outcomes()
get_outcomes(params::Dict{String,<:Any})
Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this
actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value
must be between 50 and 100. To get the next page results, provide the pagination token from
the GetOutcomesResult as part of your request. A null pagination token fetches the records
from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of objects to return for the request.
- `"name"`: The name of the outcome or outcomes to get.
- `"nextToken"`: The next page token for the request.
"""
function get_outcomes(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetOutcomes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_outcomes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetOutcomes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_rules(detector_id)
get_rules(detector_id, params::Dict{String,<:Any})
Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets
all rules for the detector and the ruleId if present (paginated). Gets a specific rule if
both the ruleId and the ruleVersion are specified. This is a paginated API. Providing null
maxResults results in retrieving maximum of 100 records per page. If you provide maxResults
the value must be between 50 and 100. To get the next page result, a provide a pagination
token from GetRulesResult as part of your request. Null pagination token fetches the
records from the beginning.
# Arguments
- `detector_id`: The detector ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of rules to return for the request.
- `"nextToken"`: The next page token.
- `"ruleId"`: The rule ID.
- `"ruleVersion"`: The rule version.
"""
function get_rules(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetRules",
Dict{String,Any}("detectorId" => detectorId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_rules(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"GetRules",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("detectorId" => detectorId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_variables()
get_variables(params::Dict{String,<:Any})
Gets all of the variables or the specific variable. This is a paginated API. Providing null
maxSizePerPage results in retrieving maximum of 100 records per page. If you provide
maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide
a pagination token from GetVariablesResult as part of your request. Null pagination token
fetches the records from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The max size per page determined for the get variable request.
- `"name"`: The name of the variable.
- `"nextToken"`: The next page token of the get variable request.
"""
function get_variables(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"GetVariables"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_variables(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"GetVariables", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_event_predictions()
list_event_predictions(params::Dict{String,<:Any})
Gets a list of past predictions. The list can be filtered by detector ID, detector version
ID, event ID, event type, or by specifying a time period. If filter is not specified, the
most recent prediction is returned. For example, the following filter lists all past
predictions for xyz event type - { \"eventType\":{ \"value\": \"xyz\" }” } This is a
paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10
records per page. If you provide a maxResults, the value must be between 50 and 100. To get
the next page results, provide the nextToken from the response as part of your request. A
null nextToken fetches the records from the beginning.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"detectorId"`: The detector ID.
- `"detectorVersionId"`: The detector version ID.
- `"eventId"`: The event ID.
- `"eventType"`: The event type associated with the detector.
- `"maxResults"`: The maximum number of predictions to return for the request.
- `"nextToken"`: Identifies the next page of results to return. Use the token to make the
call again to retrieve the next page. Keep all other arguments unchanged. Each pagination
token expires after 24 hours.
- `"predictionTimeRange"`: The time period for when the predictions were generated.
"""
function list_event_predictions(; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"ListEventPredictions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_event_predictions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"ListEventPredictions",
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 the resource. This is a paginated API. To get the next page
results, provide the pagination token from the response as part of your request. A null
pagination token fetches the records from the beginning.
# Arguments
- `resource_arn`: The ARN that specifies the resource whose tags 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 objects to return for the request.
- `"nextToken"`: The next token from the previous results.
"""
function list_tags_for_resource(
resourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"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 frauddetector(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceARN" => resourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_detector(detector_id, event_type_name)
put_detector(detector_id, event_type_name, params::Dict{String,<:Any})
Creates or updates a detector.
# Arguments
- `detector_id`: The detector ID.
- `event_type_name`: The name of the event type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the detector.
- `"tags"`: A collection of key and value pairs.
"""
function put_detector(
detectorId, eventTypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"PutDetector",
Dict{String,Any}("detectorId" => detectorId, "eventTypeName" => eventTypeName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_detector(
detectorId,
eventTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"PutDetector",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorId" => detectorId, "eventTypeName" => eventTypeName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_entity_type(name)
put_entity_type(name, params::Dict{String,<:Any})
Creates or updates an entity type. An entity represents who is performing the event. As
part of a fraud prediction, you pass the entity ID to indicate the specific entity who
performed the event. An entity type classifies the entity. Example classifications include
customer, merchant, or account.
# Arguments
- `name`: The name of the entity type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description.
- `"tags"`: A collection of key and value pairs.
"""
function put_entity_type(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"PutEntityType",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_entity_type(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"PutEntityType",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_event_type(entity_types, event_variables, name)
put_event_type(entity_types, event_variables, name, params::Dict{String,<:Any})
Creates or updates an event type. An event is a business activity that is evaluated for
fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event
type defines the structure for an event sent to Amazon Fraud Detector. This includes the
variables sent as part of the event, the entity performing the event (such as a customer),
and the labels that classify the event. Example event types include online payment
transactions, account registrations, and authentications.
# Arguments
- `entity_types`: The entity type for the event type. Example entity types: customer,
merchant, account.
- `event_variables`: The event type variables.
- `name`: The name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the event type.
- `"eventIngestion"`: Specifies if ingestion is enabled or disabled.
- `"eventOrchestration"`: Enables or disables event orchestration. If enabled, you can send
event predictions to select AWS services for downstream processing of the events.
- `"labels"`: The event type labels.
- `"tags"`: A collection of key and value pairs.
"""
function put_event_type(
entityTypes, eventVariables, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"PutEventType",
Dict{String,Any}(
"entityTypes" => entityTypes, "eventVariables" => eventVariables, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_event_type(
entityTypes,
eventVariables,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"PutEventType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"entityTypes" => entityTypes,
"eventVariables" => eventVariables,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_external_model(input_configuration, invoke_model_endpoint_role_arn, model_endpoint, model_endpoint_status, model_source, output_configuration)
put_external_model(input_configuration, invoke_model_endpoint_role_arn, model_endpoint, model_endpoint_status, model_source, output_configuration, params::Dict{String,<:Any})
Creates or updates an Amazon SageMaker model endpoint. You can also use this action to
update the configuration of the model endpoint, including the IAM role and/or the mapped
variables.
# Arguments
- `input_configuration`: The model endpoint input configuration.
- `invoke_model_endpoint_role_arn`: The IAM role used to invoke the model endpoint.
- `model_endpoint`: The model endpoints name.
- `model_endpoint_status`: The model endpoint’s status in Amazon Fraud Detector.
- `model_source`: The source of the model.
- `output_configuration`: The model endpoint output configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A collection of key and value pairs.
"""
function put_external_model(
inputConfiguration,
invokeModelEndpointRoleArn,
modelEndpoint,
modelEndpointStatus,
modelSource,
outputConfiguration;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"PutExternalModel",
Dict{String,Any}(
"inputConfiguration" => inputConfiguration,
"invokeModelEndpointRoleArn" => invokeModelEndpointRoleArn,
"modelEndpoint" => modelEndpoint,
"modelEndpointStatus" => modelEndpointStatus,
"modelSource" => modelSource,
"outputConfiguration" => outputConfiguration,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_external_model(
inputConfiguration,
invokeModelEndpointRoleArn,
modelEndpoint,
modelEndpointStatus,
modelSource,
outputConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"PutExternalModel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"inputConfiguration" => inputConfiguration,
"invokeModelEndpointRoleArn" => invokeModelEndpointRoleArn,
"modelEndpoint" => modelEndpoint,
"modelEndpointStatus" => modelEndpointStatus,
"modelSource" => modelSource,
"outputConfiguration" => outputConfiguration,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_kmsencryption_key(kms_encryption_key_arn)
put_kmsencryption_key(kms_encryption_key_arn, params::Dict{String,<:Any})
Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
# Arguments
- `kms_encryption_key_arn`: The KMS encryption key ARN. The KMS key must be single-Region
key. Amazon Fraud Detector does not support multi-Region KMS key.
"""
function put_kmsencryption_key(
kmsEncryptionKeyArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"PutKMSEncryptionKey",
Dict{String,Any}("kmsEncryptionKeyArn" => kmsEncryptionKeyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_kmsencryption_key(
kmsEncryptionKeyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"PutKMSEncryptionKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("kmsEncryptionKeyArn" => kmsEncryptionKeyArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_label(name)
put_label(name, params::Dict{String,<:Any})
Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels
are associated with event types and used to train supervised machine learning models in
Amazon Fraud Detector.
# Arguments
- `name`: The label name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The label description.
- `"tags"`: A collection of key and value pairs.
"""
function put_label(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"PutLabel",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_label(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"PutLabel",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_outcome(name)
put_outcome(name, params::Dict{String,<:Any})
Creates or updates an outcome.
# Arguments
- `name`: The name of the outcome.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The outcome description.
- `"tags"`: A collection of key and value pairs.
"""
function put_outcome(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"PutOutcome",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_outcome(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"PutOutcome",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_event(entities, event_id, event_timestamp, event_type_name, event_variables)
send_event(entities, event_id, event_timestamp, event_type_name, event_variables, params::Dict{String,<:Any})
Stores events in Amazon Fraud Detector without generating fraud predictions for those
events. For example, you can use SendEvent to upload a historical dataset, which you can
then later use to train a model.
# Arguments
- `entities`: An array of entities.
- `event_id`: The event ID to upload.
- `event_timestamp`: The timestamp that defines when the event under evaluation occurred.
The timestamp must be specified using ISO 8601 standard in UTC.
- `event_type_name`: The event type name of the event.
- `event_variables`: Names of the event type's variables you defined in Amazon Fraud
Detector to represent data elements and their corresponding values for the event you are
sending for evaluation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assignedLabel"`: The label to associate with the event. Required if specifying
labelTimestamp.
- `"labelTimestamp"`: The timestamp associated with the label. Required if specifying
assignedLabel.
"""
function send_event(
entities,
eventId,
eventTimestamp,
eventTypeName,
eventVariables;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"SendEvent",
Dict{String,Any}(
"entities" => entities,
"eventId" => eventId,
"eventTimestamp" => eventTimestamp,
"eventTypeName" => eventTypeName,
"eventVariables" => eventVariables,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_event(
entities,
eventId,
eventTimestamp,
eventTypeName,
eventVariables,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"SendEvent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"entities" => entities,
"eventId" => eventId,
"eventTimestamp" => eventTimestamp,
"eventTypeName" => eventTypeName,
"eventVariables" => eventVariables,
),
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 tags to a resource.
# Arguments
- `resource_arn`: The resource ARN.
- `tags`: The tags to assign to the resource.
"""
function tag_resource(resourceARN, tags; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"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 frauddetector(
"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 tags from a resource.
# Arguments
- `resource_arn`: The ARN of the resource from which to remove the tag.
- `tag_keys`: The resource ARN.
"""
function untag_resource(
resourceARN, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"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 frauddetector(
"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_detector_version(detector_id, detector_version_id, external_model_endpoints, rules)
update_detector_version(detector_id, detector_version_id, external_model_endpoints, rules, params::Dict{String,<:Any})
Updates a detector version. The detector version attributes that you can update include
models, external model endpoints, rules, rule execution mode, and description. You can only
update a DRAFT detector version.
# Arguments
- `detector_id`: The parent detector ID for the detector version you want to update.
- `detector_version_id`: The detector version ID.
- `external_model_endpoints`: The Amazon SageMaker model endpoints to include in the
detector version.
- `rules`: The rules to include in the detector version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The detector version description.
- `"modelVersions"`: The model versions to include in the detector version.
- `"ruleExecutionMode"`: The rule execution mode to add to the detector. If you specify
FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping
at the first matched rule. Amazon Fraud dectector then provides the outcomes for that
single rule. If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and
returns the outcomes for all matched rules. You can define and edit the rule mode at the
detector version level, when it is in draft status. The default behavior is FIRST_MATCHED.
"""
function update_detector_version(
detectorId,
detectorVersionId,
externalModelEndpoints,
rules;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateDetectorVersion",
Dict{String,Any}(
"detectorId" => detectorId,
"detectorVersionId" => detectorVersionId,
"externalModelEndpoints" => externalModelEndpoints,
"rules" => rules,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_detector_version(
detectorId,
detectorVersionId,
externalModelEndpoints,
rules,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateDetectorVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorId" => detectorId,
"detectorVersionId" => detectorVersionId,
"externalModelEndpoints" => externalModelEndpoints,
"rules" => rules,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_detector_version_metadata(description, detector_id, detector_version_id)
update_detector_version_metadata(description, detector_id, detector_version_id, params::Dict{String,<:Any})
Updates the detector version's description. You can update the metadata for any detector
version (DRAFT, ACTIVE, or INACTIVE).
# Arguments
- `description`: The description.
- `detector_id`: The detector ID.
- `detector_version_id`: The detector version ID.
"""
function update_detector_version_metadata(
description,
detectorId,
detectorVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateDetectorVersionMetadata",
Dict{String,Any}(
"description" => description,
"detectorId" => detectorId,
"detectorVersionId" => detectorVersionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_detector_version_metadata(
description,
detectorId,
detectorVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateDetectorVersionMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"description" => description,
"detectorId" => detectorId,
"detectorVersionId" => detectorVersionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_detector_version_status(detector_id, detector_version_id, status)
update_detector_version_status(detector_id, detector_version_id, status, params::Dict{String,<:Any})
Updates the detector version’s status. You can perform the following promotions or
demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and
INACTIVE to ACTIVE.
# Arguments
- `detector_id`: The detector ID.
- `detector_version_id`: The detector version ID.
- `status`: The new status. The only supported values are ACTIVE and INACTIVE
"""
function update_detector_version_status(
detectorId, detectorVersionId, status; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"UpdateDetectorVersionStatus",
Dict{String,Any}(
"detectorId" => detectorId,
"detectorVersionId" => detectorVersionId,
"status" => status,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_detector_version_status(
detectorId,
detectorVersionId,
status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateDetectorVersionStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorId" => detectorId,
"detectorVersionId" => detectorVersionId,
"status" => status,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_event_label(assigned_label, event_id, event_type_name, label_timestamp)
update_event_label(assigned_label, event_id, event_type_name, label_timestamp, params::Dict{String,<:Any})
Updates the specified event with a new label.
# Arguments
- `assigned_label`: The new label to assign to the event.
- `event_id`: The ID of the event associated with the label to update.
- `event_type_name`: The event type of the event associated with the label to update.
- `label_timestamp`: The timestamp associated with the label. The timestamp must be
specified using ISO 8601 standard in UTC.
"""
function update_event_label(
assignedLabel,
eventId,
eventTypeName,
labelTimestamp;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateEventLabel",
Dict{String,Any}(
"assignedLabel" => assignedLabel,
"eventId" => eventId,
"eventTypeName" => eventTypeName,
"labelTimestamp" => labelTimestamp,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_event_label(
assignedLabel,
eventId,
eventTypeName,
labelTimestamp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateEventLabel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assignedLabel" => assignedLabel,
"eventId" => eventId,
"eventTypeName" => eventTypeName,
"labelTimestamp" => labelTimestamp,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_list(name)
update_list(name, params::Dict{String,<:Any})
Updates a list.
# Arguments
- `name`: The name of the list to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The new description.
- `"elements"`: One or more list elements to add or replace. If you are providing the
elements, make sure to specify the updateMode to use. If you are deleting all elements
from the list, use REPLACE for the updateMode and provide an empty list (0 elements).
- `"updateMode"`: The update mode (type). Use APPEND if you are adding elements to the
list. Use REPLACE if you replacing existing elements in the list. Use REMOVE if you are
removing elements from the list.
- `"variableType"`: The variable type you want to assign to the list. You cannot update
a variable type of a list that already has a variable type assigned to it. You can assign a
variable type to a list only if the list does not already have a variable type.
"""
function update_list(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"UpdateList",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_list(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"UpdateList",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_model(model_id, model_type)
update_model(model_id, model_type, params::Dict{String,<:Any})
Updates model description.
# Arguments
- `model_id`: The model ID.
- `model_type`: The model type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The new model description.
"""
function update_model(modelId, modelType; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"UpdateModel",
Dict{String,Any}("modelId" => modelId, "modelType" => modelType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_model(
modelId,
modelType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateModel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("modelId" => modelId, "modelType" => modelType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_model_version(major_version_number, model_id, model_type)
update_model_version(major_version_number, model_id, model_type, params::Dict{String,<:Any})
Updates a model version. Updating a model version retrains an existing model version using
updated training data and produces a new minor version of the model. You can update the
training data set location and data access role attributes using this action. This action
creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.
# Arguments
- `major_version_number`: The major version number.
- `model_id`: The model ID.
- `model_type`: The model type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"externalEventsDetail"`: The details of the external events data used for training the
model version. Required if trainingDataSource is EXTERNAL_EVENTS.
- `"ingestedEventsDetail"`: The details of the ingested event used for training the model
version. Required if your trainingDataSource is INGESTED_EVENTS.
- `"tags"`: A collection of key and value pairs.
"""
function update_model_version(
majorVersionNumber,
modelId,
modelType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateModelVersion",
Dict{String,Any}(
"majorVersionNumber" => majorVersionNumber,
"modelId" => modelId,
"modelType" => modelType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_model_version(
majorVersionNumber,
modelId,
modelType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateModelVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"majorVersionNumber" => majorVersionNumber,
"modelId" => modelId,
"modelType" => modelType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_model_version_status(model_id, model_type, model_version_number, status)
update_model_version_status(model_id, model_type, model_version_number, status, params::Dict{String,<:Any})
Updates the status of a model version. You can perform the following status updates:
Change the TRAINING_IN_PROGRESS status to TRAINING_CANCELLED. Change the
TRAINING_COMPLETE status to ACTIVE. Change ACTIVE to INACTIVE.
# Arguments
- `model_id`: The model ID of the model version to update.
- `model_type`: The model type.
- `model_version_number`: The model version number.
- `status`: The model version status.
"""
function update_model_version_status(
modelId,
modelType,
modelVersionNumber,
status;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateModelVersionStatus",
Dict{String,Any}(
"modelId" => modelId,
"modelType" => modelType,
"modelVersionNumber" => modelVersionNumber,
"status" => status,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_model_version_status(
modelId,
modelType,
modelVersionNumber,
status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateModelVersionStatus",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"modelId" => modelId,
"modelType" => modelType,
"modelVersionNumber" => modelVersionNumber,
"status" => status,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule_metadata(description, rule)
update_rule_metadata(description, rule, params::Dict{String,<:Any})
Updates a rule's metadata. The description attribute can be updated.
# Arguments
- `description`: The rule description.
- `rule`: The rule to update.
"""
function update_rule_metadata(
description, rule; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"UpdateRuleMetadata",
Dict{String,Any}("description" => description, "rule" => rule);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule_metadata(
description,
rule,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateRuleMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("description" => description, "rule" => rule),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_rule_version(expression, language, outcomes, rule)
update_rule_version(expression, language, outcomes, rule, params::Dict{String,<:Any})
Updates a rule version resulting in a new rule version. Updates a rule version resulting in
a new rule version (version 1, 2, 3 ...).
# Arguments
- `expression`: The rule expression.
- `language`: The language.
- `outcomes`: The outcomes.
- `rule`: The rule to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description.
- `"tags"`: The tags to assign to the rule version.
"""
function update_rule_version(
expression, language, outcomes, rule; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"UpdateRuleVersion",
Dict{String,Any}(
"expression" => expression,
"language" => language,
"outcomes" => outcomes,
"rule" => rule,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_rule_version(
expression,
language,
outcomes,
rule,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return frauddetector(
"UpdateRuleVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"expression" => expression,
"language" => language,
"outcomes" => outcomes,
"rule" => rule,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_variable(name)
update_variable(name, params::Dict{String,<:Any})
Updates a variable.
# Arguments
- `name`: The name of the variable.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"defaultValue"`: The new default value of the variable.
- `"description"`: The new description.
- `"variableType"`: The variable type. For more information see Variable types.
"""
function update_variable(name; aws_config::AbstractAWSConfig=global_aws_config())
return frauddetector(
"UpdateVariable",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_variable(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return frauddetector(
"UpdateVariable",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => 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 | 1231 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: freetier
using AWS.Compat
using AWS.UUIDs
"""
get_free_tier_usage()
get_free_tier_usage(params::Dict{String,<:Any})
Returns a list of all Free Tier usage objects that match your filters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: An expression that specifies the conditions that you want each FreeTierUsage
object to meet.
- `"maxResults"`: The maximum number of results to return in the response. MaxResults means
that there can be up to the specified number of values, but there might be fewer results
based on your filters.
- `"nextToken"`: The pagination token that indicates the next set of results to retrieve.
"""
function get_free_tier_usage(; aws_config::AbstractAWSConfig=global_aws_config())
return freetier(
"GetFreeTierUsage"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_free_tier_usage(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return freetier(
"GetFreeTierUsage", 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 | 112769 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: fsx
using AWS.Compat
using AWS.UUIDs
"""
associate_file_system_aliases(aliases, file_system_id)
associate_file_system_aliases(aliases, file_system_id, params::Dict{String,<:Any})
Use this action to associate one or more Domain Name Server (DNS) aliases with an existing
Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS
aliases associated with it at any one time. If you try to associate a DNS alias that is
already associated with the file system, FSx takes no action on that alias in the request.
For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to
access your file system, including additional steps you must take to be able to access your
file system using a DNS alias. The system response shows the DNS aliases that Amazon FSx is
attempting to associate with the file system. Use the API operation to monitor the status
of the aliases Amazon FSx is associating with the file system.
# Arguments
- `aliases`: An array of one or more DNS alias names to associate with the file system. The
alias name has to comply with the following formatting requirements: Formatted as a
fully-qualified domain name (FQDN), hostname.domain , for example,
accounting.corp.example.com. Can contain alphanumeric characters and the hyphen (-).
Cannot start or end with a hyphen. Can start with a numeric. For DNS alias names,
Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you
specify them: as uppercase letters, lowercase letters, or the corresponding letters in
escape codes.
- `file_system_id`: Specifies the file system with which you want to associate one or more
DNS aliases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
"""
function associate_file_system_aliases(
Aliases, FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"AssociateFileSystemAliases",
Dict{String,Any}(
"Aliases" => Aliases,
"FileSystemId" => FileSystemId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_file_system_aliases(
Aliases,
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"AssociateFileSystemAliases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Aliases" => Aliases,
"FileSystemId" => FileSystemId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_data_repository_task(task_id)
cancel_data_repository_task(task_id, params::Dict{String,<:Any})
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either
the PENDING or EXECUTING state. When you cancel am export task, Amazon FSx does the
following. Any files that FSx has already exported are not reverted. FSx continues to
export any files that are in-flight when the cancel operation is received. FSx does not
export any files that have not yet been exported. For a release task, Amazon FSx will
stop releasing files upon cancellation. Any files that have already been released will
remain in the released state.
# Arguments
- `task_id`: Specifies the data repository task to cancel.
"""
function cancel_data_repository_task(
TaskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"CancelDataRepositoryTask",
Dict{String,Any}("TaskId" => TaskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_data_repository_task(
TaskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"CancelDataRepositoryTask",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("TaskId" => TaskId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_backup(source_backup_id)
copy_backup(source_backup_id, params::Dict{String,<:Any})
Copies an existing backup within the same Amazon Web Services account to another Amazon Web
Services Region (cross-Region copy) or within the same Amazon Web Services Region
(in-Region copy). You can have up to five backup copy requests in progress to a single
destination Region per account. You can use cross-Region backup copies for cross-Region
disaster recovery. You can periodically take backups and copy them to another Region so
that in the event of a disaster in the primary Region, you can restore from backup and
recover availability quickly in the other Region. You can make cross-Region copies only
within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web
Services currently has three partitions: aws (Standard Regions), aws-cn (China Regions),
and aws-us-gov (Amazon Web Services GovCloud [US] Regions). You can also use backup copies
to clone your file dataset to another Region or within the same Region. You can use the
SourceRegion parameter to specify the Amazon Web Services Region from which the backup will
be copied. For example, if you make the call from the us-west-1 Region and want to copy a
backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to
make a cross-Region copy. If you don't specify a Region, the backup copy is created in the
same Region where the request is sent from (in-Region copy). For more information about
creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide,
Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon
FSx for OpenZFS User Guide.
# Arguments
- `source_backup_id`: The ID of the source backup. Specifies the ID of the backup that's
being copied.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"CopyTags"`: A Boolean flag indicating whether tags from the source backup should be
copied to the backup copy. This value defaults to false. If you set CopyTags to true and
the source backup has existing tags, you can use the Tags parameter to create new tags,
provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both
sets of tags are merged. If there are tag conflicts (for example, two tags with the same
key but different values), the tags created with the Tags parameter take precedence.
- `"KmsKeyId"`:
- `"SourceRegion"`: The source Amazon Web Services Region of the backup. Specifies the
Amazon Web Services Region from which the backup is being copied. The source and
destination Regions must be in the same Amazon Web Services partition. If you don't specify
a Region, SourceRegion defaults to the Region where the request is sent from (in-Region
copy).
- `"Tags"`:
"""
function copy_backup(SourceBackupId; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"CopyBackup",
Dict{String,Any}(
"SourceBackupId" => SourceBackupId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_backup(
SourceBackupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CopyBackup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceBackupId" => SourceBackupId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
copy_snapshot_and_update_volume(source_snapshot_arn, volume_id)
copy_snapshot_and_update_volume(source_snapshot_arn, volume_id, params::Dict{String,<:Any})
Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file
system. For more information, see on-demand data replication in the Amazon FSx for OpenZFS
User Guide.
# Arguments
- `source_snapshot_arn`:
- `volume_id`: Specifies the ID of the volume that you are copying the snapshot to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"CopyStrategy"`: Specifies the strategy to use when copying data from a snapshot to the
volume. FULL_COPY - Copies all data from the snapshot to the volume.
INCREMENTAL_COPY - Copies only the snapshot data that's changed since the previous
replication. CLONE isn't a valid copy strategy option for the
CopySnapshotAndUpdateVolume operation.
- `"Options"`: Confirms that you want to delete data on the destination volume that
wasn’t there during the previous snapshot replication. Your replication will fail if you
don’t include an option for a specific type of data and that data is on your destination.
For example, if you don’t include DELETE_INTERMEDIATE_SNAPSHOTS and there are
intermediate snapshots on the destination, you can’t copy the snapshot.
DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots on the destination volume that aren’t
on the source volume. DELETE_CLONED_VOLUMES - Deletes snapshot clones on the destination
volume that aren't on the source volume. DELETE_INTERMEDIATE_DATA - Overwrites snapshots
on the destination volume that don’t match the source snapshot that you’re copying.
"""
function copy_snapshot_and_update_volume(
SourceSnapshotARN, VolumeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"CopySnapshotAndUpdateVolume",
Dict{String,Any}(
"SourceSnapshotARN" => SourceSnapshotARN,
"VolumeId" => VolumeId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function copy_snapshot_and_update_volume(
SourceSnapshotARN,
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CopySnapshotAndUpdateVolume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SourceSnapshotARN" => SourceSnapshotARN,
"VolumeId" => VolumeId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_backup()
create_backup(params::Dict{String,<:Any})
Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx
for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file
system. We recommend creating regular backups so that you can restore a file system or
volume from a backup if an issue arises with the original file system or volume. For Amazon
FSx for Lustre file systems, you can create a backup only for file systems that have the
following configuration: A Persistent deployment type Are not linked to a data
repository For more information about backups, see the following: For Amazon FSx for
Lustre, see Working with FSx for Lustre backups. For Amazon FSx for Windows, see Working
with FSx for Windows backups. For Amazon FSx for NetApp ONTAP, see Working with FSx for
NetApp ONTAP backups. For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS
backups. If a backup with the specified client request token exists and the parameters
match, this operation returns the description of the existing backup. If a backup with the
specified client request token exists and the parameters don't match, this operation
returns IncompatibleParameterError. If a backup with the specified client request token
doesn't exist, CreateBackup does the following: Creates a new Amazon FSx backup with an
assigned ID, and an initial lifecycle state of CREATING. Returns the description of the
backup. By using the idempotent operation, you can retry a CreateBackup operation without
the risk of creating an extra backup. This approach can be useful when an initial call
fails in a way that makes it unclear whether a backup was created. If you use the same
client request token and the initial call created a backup, the operation returns a
successful result because all the parameters are the same. The CreateBackup operation
returns while the backup's lifecycle state is still CREATING. You can check the backup
creation status by calling the DescribeBackups operation, which returns the backup state
along with other information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: (Optional) A string of up to 63 ASCII characters that Amazon FSx
uses to ensure idempotent creation. This string is automatically filled on your behalf when
you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
- `"FileSystemId"`: The ID of the file system to back up.
- `"Tags"`: (Optional) The tags to apply to the backup at backup creation. The key value of
the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups
to true, and you specify one or more tags using the CreateBackup operation, no existing
file system tags are copied from the file system to the backup.
- `"VolumeId"`: (Optional) The ID of the FSx for ONTAP volume to back up.
"""
function create_backup(; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"CreateBackup",
Dict{String,Any}("ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_backup(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"CreateBackup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_repository_association(data_repository_path, file_system_id)
create_data_repository_association(data_repository_path, file_system_id, params::Dict{String,<:Any})
Creates an Amazon FSx for Lustre data repository association (DRA). A data repository
association is a link between a directory on the file system and an Amazon S3 bucket or
prefix. You can have a maximum of 8 data repository associations on a file system. Data
repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems,
excluding scratch_1 deployment type. Each data repository association must have a unique
Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You
can configure a data repository association for automatic import only, for automatic export
only, or for both. To learn more about linking a data repository to your file system, see
Linking your file system to an S3 bucket. CreateDataRepositoryAssociation isn't supported
on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the
CreateFileCache operation.
# Arguments
- `data_repository_path`: The path to the Amazon S3 data repository that will be linked to
the file system. The path can be an S3 bucket or prefix in the format
s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be
imported from or exported to.
- `file_system_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BatchImportMetaDataOnCreate"`: Set to true to run an import data repository task to
import metadata from the data repository to the file system after the data repository
association is created. Default is false.
- `"ClientRequestToken"`:
- `"FileSystemPath"`: A path on the file system that points to a high-level directory (such
as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with
DataRepositoryPath. The leading forward slash in the name is required. Two data repository
associations cannot have overlapping file system paths. For example, if a data repository
is associated with file system path /ns1/, then you cannot link another data repository
with file system path /ns1/ns2. This path specifies where in your file system files will be
exported from or imported to. This file system directory can be linked to only one Amazon
S3 bucket, and no other S3 bucket can be linked to the directory. If you specify only a
forward slash (/) as the file system path, you can link only one data repository to the
file system. You can only specify \"/\" as the file system path for the first data
repository associated with a file system.
- `"ImportedFileChunkSize"`: For files imported from a data repository, this value
determines the stripe count and maximum amount of data per file (in MiB) stored on a single
physical disk. The maximum number of disks that a single file can be striped across is
limited by the total number of disks that make up the file system. The default chunk size
is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a
maximum size of 5 TB.
- `"S3"`: The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre
file system with a data repository association. The configuration defines which file events
(new, changed, or deleted files or directories) are automatically imported from the linked
data repository to the file system or automatically exported from the file system to the
data repository.
- `"Tags"`:
"""
function create_data_repository_association(
DataRepositoryPath, FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"CreateDataRepositoryAssociation",
Dict{String,Any}(
"DataRepositoryPath" => DataRepositoryPath,
"FileSystemId" => FileSystemId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_repository_association(
DataRepositoryPath,
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateDataRepositoryAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataRepositoryPath" => DataRepositoryPath,
"FileSystemId" => FileSystemId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_repository_task(file_system_id, report, type)
create_data_repository_task(file_system_id, report, type, params::Dict{String,<:Any})
Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation
will fail if a data repository is not linked to the FSx file system. You use import and
export data repository tasks to perform bulk operations between your FSx for Lustre file
system and its linked data repositories. An example of a data repository task is exporting
any data and metadata changes, including POSIX metadata, to files, directories, and
symbolic links (symlinks) from your FSx file system to a linked data repository. You use
release data repository tasks to release data from your file system for files that are
exported to S3. The metadata of released files remains on the file system so users or
applications can still access released files by reading the files again, which will restore
data from Amazon S3 to the FSx for Lustre file system. To learn more about data repository
tasks, see Data Repository Tasks. To learn more about linking a data repository to your
file system, see Linking your file system to an S3 bucket.
# Arguments
- `file_system_id`:
- `report`: Defines whether or not Amazon FSx provides a CompletionReport once the task has
completed. A CompletionReport provides a detailed report on the files that Amazon FSx
processed that meet the criteria specified by the Scope parameter. For more information,
see Working with Task Completion Reports.
- `type`: Specifies the type of data repository task to create. EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked data repository.
IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to
your Amazon FSx for Lustre file system. RELEASE_DATA_FROM_FILESYSTEM tasks release files
in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and
that meet your specified release criteria. AUTO_RELEASE_DATA tasks automatically release
files from an Amazon File Cache resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CapacityToRelease"`: Specifies the amount of data to release, in GiB, by an Amazon File
Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.
- `"ClientRequestToken"`:
- `"Paths"`: A list of paths for the data repository task to use when the task is
processed. If a path that you provide isn't valid, the task fails. If you don't provide
paths, the default behavior is to export all files to S3 (for export tasks), import all
files from S3 (for import tasks), or release all exported files that meet the last accessed
time criteria (for release tasks). For export tasks, the list contains paths on the FSx
for Lustre file system from which the files are exported to the Amazon S3 bucket. The
default path is the file system root directory. The paths you provide need to be relative
to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is
a directory or file on the file system you want to export, then the path to provide is
path1. For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX
metadata changes are imported to the FSx for Lustre file system. The path can be an S3
bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional). For
release tasks, the list contains directory or file paths on the FSx for Lustre file system
from which to release exported files. If a directory is specified, files within the
directory are released. If a file path is specified, only that file is released. To release
all exported files in the file system, specify a forward slash (/) as the path. A file
must also meet the last accessed time criteria specified in for the file to be released.
- `"ReleaseConfiguration"`: The configuration that specifies the last accessed time
criteria for files that will be released from an Amazon FSx for Lustre file system.
- `"Tags"`:
"""
function create_data_repository_task(
FileSystemId, Report, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"CreateDataRepositoryTask",
Dict{String,Any}(
"FileSystemId" => FileSystemId,
"Report" => Report,
"Type" => Type,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_repository_task(
FileSystemId,
Report,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateDataRepositoryTask",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileSystemId" => FileSystemId,
"Report" => Report,
"Type" => Type,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_file_cache(file_cache_type, file_cache_type_version, storage_capacity, subnet_ids)
create_file_cache(file_cache_type, file_cache_type_version, storage_capacity, subnet_ids, params::Dict{String,<:Any})
Creates a new Amazon File Cache resource. You can use this operation with a client request
token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache
with the specified client request token exists and the parameters match, CreateFileCache
returns the description of the existing cache. If a cache with the specified client request
token exists and the parameters don't match, this call returns IncompatibleParameterError.
If a file cache with the specified client request token doesn't exist, CreateFileCache does
the following: Creates a new, empty Amazon File Cache resourcewith an assigned ID, and
an initial lifecycle state of CREATING. Returns the description of the cache in JSON
format. The CreateFileCache call returns while the cache's lifecycle state is still
CREATING. You can check the cache creation status by calling the DescribeFileCaches
operation, which returns the cache state along with other information.
# Arguments
- `file_cache_type`: The type of cache that you're creating, which must be LUSTRE.
- `file_cache_type_version`: Sets the Lustre version for the cache that you're creating,
which must be 2.12.
- `storage_capacity`: The storage capacity of the cache in gibibytes (GiB). Valid values
are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
- `subnet_ids`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: An idempotency token for resource creation, in a string of up to
63 ASCII characters. This token is automatically filled on your behalf when you use the
Command Line Interface (CLI) or an Amazon Web Services SDK. By using the idempotent
operation, you can retry a CreateFileCache operation without the risk of creating an extra
cache. This approach can be useful when an initial call fails in a way that makes it
unclear whether a cache was created. Examples are if a transport level timeout occurred, or
your connection was reset. If you use the same client request token and the initial call
created a cache, the client receives success as long as the parameters are the same.
- `"CopyTagsToDataRepositoryAssociations"`: A boolean flag indicating whether tags for the
cache should be copied to data repository associations. This value defaults to false.
- `"DataRepositoryAssociations"`: A list of up to 8 configurations for data repository
associations (DRAs) to be created during the cache creation. The DRAs link the cache to
either an Amazon S3 data repository or a Network File System (NFS) data repository that
supports the NFSv3 protocol. The DRA configurations must meet the following requirements:
All configurations on the list must be of the same data repository type, either all S3 or
all NFS. A cache can't link to different data repository types at the same time. An NFS
DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic
import and automatic export is not supported.
- `"KmsKeyId"`: Specifies the ID of the Key Management Service (KMS) key to use for
encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon
FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key
Management Service API Reference.
- `"LustreConfiguration"`: The configuration for the Amazon File Cache resource being
created.
- `"SecurityGroupIds"`: A list of IDs specifying the security groups to apply to all
network interfaces created for Amazon File Cache access. This list isn't returned in later
requests to describe the cache.
- `"Tags"`:
"""
function create_file_cache(
FileCacheType,
FileCacheTypeVersion,
StorageCapacity,
SubnetIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateFileCache",
Dict{String,Any}(
"FileCacheType" => FileCacheType,
"FileCacheTypeVersion" => FileCacheTypeVersion,
"StorageCapacity" => StorageCapacity,
"SubnetIds" => SubnetIds,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_file_cache(
FileCacheType,
FileCacheTypeVersion,
StorageCapacity,
SubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateFileCache",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileCacheType" => FileCacheType,
"FileCacheTypeVersion" => FileCacheTypeVersion,
"StorageCapacity" => StorageCapacity,
"SubnetIds" => SubnetIds,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_file_system(file_system_type, storage_capacity, subnet_ids)
create_file_system(file_system_type, storage_capacity, subnet_ids, params::Dict{String,<:Any})
Creates a new, empty Amazon FSx file system. You can create the following supported Amazon
FSx file systems using the CreateFileSystem API operation: Amazon FSx for Lustre Amazon
FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server This
operation requires a client request token in the request that Amazon FSx uses to ensure
idempotent creation. This means that calling the operation multiple times with the same
client request token has no effect. By using the idempotent operation, you can retry a
CreateFileSystem operation without the risk of creating an extra file system. This approach
can be useful when an initial call fails in a way that makes it unclear whether a file
system was created. Examples are if a transport level timeout occurred, or your connection
was reset. If you use the same client request token and the initial call created a file
system, the client receives success as long as the parameters are the same. If a file
system with the specified client request token exists and the parameters match,
CreateFileSystem returns the description of the existing file system. If a file system with
the specified client request token exists and the parameters don't match, this call returns
IncompatibleParameterError. If a file system with the specified client request token
doesn't exist, CreateFileSystem does the following: Creates a new, empty Amazon FSx file
system with an assigned ID, and an initial lifecycle state of CREATING. Returns the
description of the file system in JSON format. The CreateFileSystem call returns while
the file system's lifecycle state is still CREATING. You can check the file-system creation
status by calling the DescribeFileSystems operation, which returns the file system state
along with other information.
# Arguments
- `file_system_type`: The type of Amazon FSx file system to create. Valid values are
WINDOWS, LUSTRE, ONTAP, and OPENZFS.
- `storage_capacity`: Sets the storage capacity of the file system that you're creating, in
gibibytes (GiB). FSx for Lustre file systems - The amount of storage capacity that you can
configure depends on the value that you set for StorageType and the Lustre DeploymentType,
as follows: For SCRATCH_2, PERSISTENT_2, and PERSISTENT_1 deployment types using SSD
storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. For
PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file
systems and increments of 1800 GiB for 40 MB/s/TiB file systems. For SCRATCH_1 deployment
type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB. FSx for ONTAP
file systems - The amount of storage capacity that you can configure depends on the value
of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum
is calculated as 524,288 * HAPairs. FSx for OpenZFS file systems - The amount of storage
capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). FSx for
Windows File Server file systems - The amount of storage capacity that you can configure
depends on the value that you set for StorageType as follows: For SSD storage, valid
values are 32 GiB-65,536 GiB (64 TiB). For HDD storage, valid values are 2000 GiB-65,536
GiB (64 TiB).
- `subnet_ids`: Specifies the IDs of the subnets that the file system will be accessible
from. For Windows and ONTAP MULTI_AZ_1 deployment types,provide exactly two subnet IDs, one
for the preferred file server and one for the standby file server. You specify one of these
subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID or
OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ
file system configuration, see Availability and durability: Single-AZ and Multi-AZ file
systems in the Amazon FSx for Windows User Guide and Availability and durability in the
Amazon FSx for ONTAP User Guide. For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre
deployment types, provide exactly one subnet ID. The file server is launched in that
subnet's Availability Zone.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A string of up to 63 ASCII characters that Amazon FSx uses to
ensure idempotent creation. This string is automatically filled on your behalf when you use
the Command Line Interface (CLI) or an Amazon Web Services SDK.
- `"FileSystemTypeVersion"`: For FSx for Lustre file systems, sets the Lustre version for
the file system that you're creating. Valid values are 2.10, 2.12, and 2.15: 2.10 is
supported by the Scratch and Persistent_1 Lustre deployment types. 2.12 is supported by
all Lustre deployment types, except for PERSISTENT_2 with a metadata configuration mode.
2.15 is supported by all Lustre deployment types and is recommended for all new file
systems. Default value is 2.10, except for the following deployments: Default value is
2.12 when DeploymentType is set to PERSISTENT_2 without a metadata configuration mode.
Default value is 2.15 when DeploymentType is set to PERSISTENT_2 with a metadata
configuration mode.
- `"KmsKeyId"`:
- `"LustreConfiguration"`:
- `"OntapConfiguration"`:
- `"OpenZFSConfiguration"`: The OpenZFS configuration for the file system that's being
created.
- `"SecurityGroupIds"`: A list of IDs specifying the security groups to apply to all
network interfaces created for file system access. This list isn't returned in later
requests to describe the file system. You must specify a security group if you are
creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with
you.
- `"StorageType"`: Sets the storage type for the file system that you're creating. Valid
values are SSD and HDD. Set to SSD to use solid state drive storage. SSD is supported on
all Windows, Lustre, ONTAP, and OpenZFS deployment types. Set to HDD to use hard disk
drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system
deployment types, and on PERSISTENT_1 Lustre file system deployment types. Default value
is SSD. For more information, see Storage type options in the FSx for Windows File Server
User Guide and Multiple storage options in the FSx for Lustre User Guide.
- `"Tags"`: The tags to apply to the file system that's being created. The key value of the
Name tag appears in the console as the file system name.
- `"WindowsConfiguration"`: The Microsoft Windows configuration for the file system that's
being created.
"""
function create_file_system(
FileSystemType,
StorageCapacity,
SubnetIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateFileSystem",
Dict{String,Any}(
"FileSystemType" => FileSystemType,
"StorageCapacity" => StorageCapacity,
"SubnetIds" => SubnetIds,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_file_system(
FileSystemType,
StorageCapacity,
SubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateFileSystem",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileSystemType" => FileSystemType,
"StorageCapacity" => StorageCapacity,
"SubnetIds" => SubnetIds,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_file_system_from_backup(backup_id, subnet_ids)
create_file_system_from_backup(backup_id, subnet_ids, params::Dict{String,<:Any})
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for
OpenZFS file system from an existing Amazon FSx backup. If a file system with the specified
client request token exists and the parameters match, this operation returns the
description of the file system. If a file system with the specified client request token
exists but the parameters don't match, this call returns IncompatibleParameterError. If a
file system with the specified client request token doesn't exist, this operation does the
following: Creates a new Amazon FSx file system from backup with an assigned ID, and an
initial lifecycle state of CREATING. Returns the description of the file system.
Parameters like the Active Directory, default share name, automatic backup, and backup
settings default to the parameters of the file system that was backed up, unless
overridden. You can explicitly supply other settings. By using the idempotent operation,
you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file
system. This approach can be useful when an initial call fails in a way that makes it
unclear whether a file system was created. Examples are if a transport level timeout
occurred, or your connection was reset. If you use the same client request token and the
initial call created a file system, the client receives a success message as long as the
parameters are the same. The CreateFileSystemFromBackup call returns while the file
system's lifecycle state is still CREATING. You can check the file-system creation status
by calling the DescribeFileSystems operation, which returns the file system state along
with other information.
# Arguments
- `backup_id`:
- `subnet_ids`: Specifies the IDs of the subnets that the file system will be accessible
from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs,
one for the preferred file server and one for the standby file server. You specify one of
these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID
property. Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file
systems, and OpenZFS file systems provide exactly one subnet ID. The file server is
launched in that subnet's Availability Zone.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A string of up to 63 ASCII characters that Amazon FSx uses to
ensure idempotent creation. This string is automatically filled on your behalf when you use
the Command Line Interface (CLI) or an Amazon Web Services SDK.
- `"FileSystemTypeVersion"`: Sets the version for the Amazon FSx for Lustre file system
that you're creating from a backup. Valid values are 2.10, 2.12, and 2.15. You don't need
to specify FileSystemTypeVersion because it will be applied using the backup's
FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating
from backup, the value must match the backup's FileSystemTypeVersion setting.
- `"KmsKeyId"`:
- `"LustreConfiguration"`:
- `"OpenZFSConfiguration"`: The OpenZFS configuration for the file system that's being
created.
- `"SecurityGroupIds"`: A list of IDs for the security groups that apply to the specified
network interfaces created for file system access. These security groups apply to all
network interfaces. This value isn't returned in later DescribeFileSystem requests.
- `"StorageCapacity"`: Sets the storage capacity of the OpenZFS file system that you're
creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB
(512 TiB). However, the value that you specify must be equal to or greater than the
backup's storage capacity value. If you don't use the StorageCapacity parameter, the
default is the backup's StorageCapacity value. If used to create a file system other than
OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you
provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request.
- `"StorageType"`: Sets the storage type for the Windows or OpenZFS file system that you're
creating from a backup. Valid values are SSD and HDD. Set to SSD to use solid state drive
storage. SSD is supported on all Windows and OpenZFS deployment types. Set to HDD to use
hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows
File Server file system deployment types. The default value is SSD. HDD and SSD
storage types have different minimum storage capacity requirements. A restored file
system's storage capacity is tied to the file system that was backed up. You can create a
file system that uses HDD storage from a backup of a file system that used SSD storage if
the original SSD file system had a storage capacity of at least 2000 GiB.
- `"Tags"`: The tags to be applied to the file system at file system creation. The key
value of the Name tag appears in the console as the file system name.
- `"WindowsConfiguration"`: The configuration for this Microsoft Windows file system.
"""
function create_file_system_from_backup(
BackupId, SubnetIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"CreateFileSystemFromBackup",
Dict{String,Any}(
"BackupId" => BackupId,
"SubnetIds" => SubnetIds,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_file_system_from_backup(
BackupId,
SubnetIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateFileSystemFromBackup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BackupId" => BackupId,
"SubnetIds" => SubnetIds,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_snapshot(name, volume_id)
create_snapshot(name, volume_id, params::Dict{String,<:Any})
Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can
easily undo file changes and compare file versions by restoring the volume to a previous
version. If a snapshot with the specified client request token exists, and the parameters
match, this operation returns the description of the existing snapshot. If a snapshot with
the specified client request token exists, and the parameters don't match, this operation
returns IncompatibleParameterError. If a snapshot with the specified client request token
doesn't exist, CreateSnapshot does the following: Creates a new OpenZFS snapshot with an
assigned ID, and an initial lifecycle state of CREATING. Returns the description of the
snapshot. By using the idempotent operation, you can retry a CreateSnapshot operation
without the risk of creating an extra snapshot. This approach can be useful when an initial
call fails in a way that makes it unclear whether a snapshot was created. If you use the
same client request token and the initial call created a snapshot, the operation returns a
successful result because all the parameters are the same. The CreateSnapshot operation
returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot
creation status by calling the DescribeSnapshots operation, which returns the snapshot
state along with other information.
# Arguments
- `name`: The name of the snapshot.
- `volume_id`: The ID of the volume that you are taking a snapshot of.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"Tags"`:
"""
function create_snapshot(Name, VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"CreateSnapshot",
Dict{String,Any}(
"Name" => Name, "VolumeId" => VolumeId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_snapshot(
Name,
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"VolumeId" => VolumeId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_storage_virtual_machine(file_system_id, name)
create_storage_virtual_machine(file_system_id, name, params::Dict{String,<:Any})
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
# Arguments
- `file_system_id`:
- `name`: The name of the SVM.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActiveDirectoryConfiguration"`: Describes the self-managed Microsoft Active Directory
to which you want to join the SVM. Joining an Active Directory provides user authentication
and access control for SMB clients, including Microsoft Windows and macOS clients accessing
the file system.
- `"ClientRequestToken"`:
- `"RootVolumeSecurityStyle"`: The security style of the root volume of the SVM. Specify
one of the following values: UNIX if the file system is managed by a UNIX administrator,
the majority of users are NFS clients, and an application accessing the data uses a UNIX
user as the service account. NTFS if the file system is managed by a Microsoft Windows
administrator, the majority of users are SMB clients, and an application accessing the data
uses a Microsoft Windows user as the service account. MIXED This is an advanced setting.
For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User
Guide.
- `"SvmAdminPassword"`: The password to use when managing the SVM using the NetApp ONTAP
CLI or REST API. If you do not specify a password, you can still use the file system's
fsxadmin user to manage the SVM.
- `"Tags"`:
"""
function create_storage_virtual_machine(
FileSystemId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"CreateStorageVirtualMachine",
Dict{String,Any}(
"FileSystemId" => FileSystemId,
"Name" => Name,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_storage_virtual_machine(
FileSystemId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateStorageVirtualMachine",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileSystemId" => FileSystemId,
"Name" => Name,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_volume(name, volume_type)
create_volume(name, volume_type, params::Dict{String,<:Any})
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
# Arguments
- `name`: Specifies the name of the volume that you're creating.
- `volume_type`: Specifies the type of volume to create; ONTAP and OPENZFS are the only
valid volume types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"OntapConfiguration"`: Specifies the configuration to use when creating the ONTAP volume.
- `"OpenZFSConfiguration"`: Specifies the configuration to use when creating the OpenZFS
volume.
- `"Tags"`:
"""
function create_volume(Name, VolumeType; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"CreateVolume",
Dict{String,Any}(
"Name" => Name,
"VolumeType" => VolumeType,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_volume(
Name,
VolumeType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateVolume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"VolumeType" => VolumeType,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_volume_from_backup(backup_id, name)
create_volume_from_backup(backup_id, name, params::Dict{String,<:Any})
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
# Arguments
- `backup_id`:
- `name`: The name of the new volume you're creating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"OntapConfiguration"`: Specifies the configuration of the ONTAP volume that you are
creating.
- `"Tags"`:
"""
function create_volume_from_backup(
BackupId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"CreateVolumeFromBackup",
Dict{String,Any}(
"BackupId" => BackupId, "Name" => Name, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_volume_from_backup(
BackupId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"CreateVolumeFromBackup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BackupId" => BackupId,
"Name" => Name,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_backup(backup_id)
delete_backup(backup_id, params::Dict{String,<:Any})
Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is
gone. The DeleteBackup call returns instantly. The backup won't show up in later
DescribeBackups calls. The data in a deleted backup is also deleted and can't be recovered
by any means.
# Arguments
- `backup_id`: The ID of the backup that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A string of up to 63 ASCII characters that Amazon FSx uses to
ensure idempotent deletion. This parameter is automatically filled on your behalf when
using the CLI or SDK.
"""
function delete_backup(BackupId; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"DeleteBackup",
Dict{String,Any}("BackupId" => BackupId, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_backup(
BackupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"DeleteBackup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"BackupId" => BackupId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_repository_association(association_id)
delete_data_repository_association(association_id, params::Dict{String,<:Any})
Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the
data repository association unlinks the file system from the Amazon S3 bucket. When
deleting a data repository association, you have the option of deleting the data in the
file system that corresponds to the data repository association. Data repository
associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding
scratch_1 deployment type.
# Arguments
- `association_id`: The ID of the data repository association that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"DeleteDataInFileSystem"`: Set to true to delete the data in the file system that
corresponds to the data repository association.
"""
function delete_data_repository_association(
AssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DeleteDataRepositoryAssociation",
Dict{String,Any}(
"AssociationId" => AssociationId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_repository_association(
AssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"DeleteDataRepositoryAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationId" => AssociationId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_file_cache(file_cache_id)
delete_file_cache(file_cache_id, params::Dict{String,<:Any})
Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its
data is gone. The DeleteFileCache operation returns while the cache has the DELETING
status. You can check the cache deletion status by calling the DescribeFileCaches
operation, which returns a list of caches in your account. If you pass the cache ID for a
deleted cache, the DescribeFileCaches operation returns a FileCacheNotFound error. The
data in a deleted cache is also deleted and can't be recovered by any means.
# Arguments
- `file_cache_id`: The ID of the cache that's being deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
"""
function delete_file_cache(FileCacheId; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"DeleteFileCache",
Dict{String,Any}(
"FileCacheId" => FileCacheId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_file_cache(
FileCacheId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"DeleteFileCache",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileCacheId" => FileCacheId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_file_system(file_system_id)
delete_file_system(file_system_id, params::Dict{String,<:Any})
Deletes a file system. After deletion, the file system no longer exists, and its data is
gone. Any existing automatic backups and snapshots are also deleted. To delete an Amazon
FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines
(SVMs) on the file system. Then provide a FileSystemId value to the DeleteFileSystem
operation. By default, when you delete an Amazon FSx for Windows File Server file system, a
final backup is created upon deletion. This final backup isn't subject to the file system's
retention policy, and must be manually deleted. To delete an Amazon FSx for Lustre file
system, first unmount it from every connected Amazon EC2 instance, then provide a
FileSystemId value to the DeleteFileSystem operation. By default, Amazon FSx will not take
a final backup when the DeleteFileSystem operation is invoked. On file systems not linked
to an Amazon S3 bucket, set SkipFinalBackup to false to take a final backup of the file
system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all
of your data is written back to S3 before deleting your file system, you can either monitor
for the AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can
run an export data repository task. If you have automatic export enabled and want to use an
export data repository task, you have to disable automatic export before executing the
export data repository task. The DeleteFileSystem operation returns while the file system
has the DELETING status. You can check the file system deletion status by calling the
DescribeFileSystems operation, which returns a list of file systems in your account. If you
pass the file system ID for a deleted file system, the DescribeFileSystems operation
returns a FileSystemNotFound error. If a data repository task is in a PENDING or EXECUTING
state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400
(Bad Request). The data in a deleted file system is also deleted and can't be recovered
by any means.
# Arguments
- `file_system_id`: The ID of the file system that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A string of up to 63 ASCII characters that Amazon FSx uses to
ensure idempotent deletion. This token is automatically filled on your behalf when using
the Command Line Interface (CLI) or an Amazon Web Services SDK.
- `"LustreConfiguration"`:
- `"OpenZFSConfiguration"`: The configuration object for the OpenZFS file system used in
the DeleteFileSystem operation.
- `"WindowsConfiguration"`:
"""
function delete_file_system(FileSystemId; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"DeleteFileSystem",
Dict{String,Any}(
"FileSystemId" => FileSystemId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_file_system(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"DeleteFileSystem",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileSystemId" => FileSystemId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_snapshot(snapshot_id)
delete_snapshot(snapshot_id, params::Dict{String,<:Any})
Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists,
and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system
backup. The DeleteSnapshot operation returns instantly. The snapshot appears with the
lifecycle status of DELETING until the deletion is complete.
# Arguments
- `snapshot_id`: The ID of the snapshot that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
"""
function delete_snapshot(SnapshotId; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"DeleteSnapshot",
Dict{String,Any}(
"SnapshotId" => SnapshotId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_snapshot(
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"DeleteSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SnapshotId" => SnapshotId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_storage_virtual_machine(storage_virtual_machine_id)
delete_storage_virtual_machine(storage_virtual_machine_id, params::Dict{String,<:Any})
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting
an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
# Arguments
- `storage_virtual_machine_id`: The ID of the SVM that you want to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
"""
function delete_storage_virtual_machine(
StorageVirtualMachineId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DeleteStorageVirtualMachine",
Dict{String,Any}(
"StorageVirtualMachineId" => StorageVirtualMachineId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_storage_virtual_machine(
StorageVirtualMachineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"DeleteStorageVirtualMachine",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StorageVirtualMachineId" => StorageVirtualMachineId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_volume(volume_id)
delete_volume(volume_id, params::Dict{String,<:Any})
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
# Arguments
- `volume_id`: The ID of the volume that you are deleting.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"OntapConfiguration"`: For Amazon FSx for ONTAP volumes, specify whether to take a final
backup of the volume and apply tags to the backup. To apply tags to the backup, you must
have the fsx:TagResource permission.
- `"OpenZFSConfiguration"`: For Amazon FSx for OpenZFS volumes, specify whether to delete
all child volumes and snapshots.
"""
function delete_volume(VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"DeleteVolume",
Dict{String,Any}("VolumeId" => VolumeId, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_volume(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"DeleteVolume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VolumeId" => VolumeId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_backups()
describe_backups(params::Dict{String,<:Any})
Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided
for that backup. Otherwise, it returns all backups owned by your Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling. When
retrieving all backups, you can optionally specify the MaxResults parameter to limit the
number of backups in a response. If more backups remain, Amazon FSx returns a NextToken
value in the response. In this case, send a later request with the NextToken request
parameter set to the value of the NextToken value from the last response. This operation is
used in an iterative process to retrieve a list of your backups. DescribeBackups is called
first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has no
NextToken value. When using this operation, keep the following in mind: The operation
might return fewer than the MaxResults value of backup descriptions while still including a
NextToken value. The order of the backups returned in the response of one DescribeBackups
call and the order of the backups returned across the responses of a multi-call iteration
is unspecified.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BackupIds"`: The IDs of the backups that you want to retrieve. This parameter value
overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.
- `"Filters"`: The filters structure. The supported names are file-system-id, backup-type,
file-system-type, and volume-id.
- `"MaxResults"`: Maximum number of backups to return in the response. This parameter value
must be greater than 0. The number of items that Amazon FSx returns is the minimum of the
MaxResults parameter specified in the request and the service's internal maximum number of
items per page.
- `"NextToken"`: An opaque pagination token returned from a previous DescribeBackups
operation. If a token is present, the operation continues the list from where the returning
call left off.
"""
function describe_backups(; aws_config::AbstractAWSConfig=global_aws_config())
return fsx("DescribeBackups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_backups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeBackups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_data_repository_associations()
describe_data_repository_associations(params::Dict{String,<:Any})
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data
repository associations, if one or more AssociationIds values are provided in the request,
or if filters are used in the request. Data repository associations are supported on Amazon
File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1
deployment type. You can use filters to narrow the response to include just data repository
associations for specific file systems (use the file-system-id filter with the ID of the
file system) or caches (use the file-cache-id filter with the ID of the cache), or data
repository associations for a specific repository type (use the data-repository-type filter
with a value of S3 or NFS). If you don't use filters, the response returns all data
repository associations owned by your Amazon Web Services account in the Amazon Web
Services Region of the endpoint that you're calling. When retrieving all data repository
associations, you can paginate the response by using the optional MaxResults parameter to
limit the number of data repository associations returned in a response. If more data
repository associations remain, a NextToken value is returned in the response. In this
case, send a later request with the NextToken request parameter set to the value of
NextToken from the last response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssociationIds"`: IDs of the data repository associations whose descriptions you want
to retrieve (String).
- `"Filters"`:
- `"MaxResults"`: The maximum number of resources to return in the response. This value
must be an integer greater than zero.
- `"NextToken"`:
"""
function describe_data_repository_associations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeDataRepositoryAssociations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_repository_associations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeDataRepositoryAssociations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_data_repository_tasks()
describe_data_repository_tasks(params::Dict{String,<:Any})
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data
repository tasks, if one or more TaskIds values are provided in the request, or if filters
are used in the request. You can use filters to narrow the response to include just tasks
for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it
returns all data repository tasks owned by your Amazon Web Services account in the Amazon
Web Services Region of the endpoint that you're calling. When retrieving all tasks, you can
paginate the response by using the optional MaxResults parameter to limit the number of
tasks returned in a response. If more tasks remain, a NextToken value is returned in the
response. In this case, send a later request with the NextToken request parameter set to
the value of NextToken from the last response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: (Optional) You can use filters to narrow the DescribeDataRepositoryTasks
response to include just tasks for specific file systems, or tasks in a specific lifecycle
state.
- `"MaxResults"`:
- `"NextToken"`:
- `"TaskIds"`: (Optional) IDs of the tasks whose descriptions you want to retrieve (String).
"""
function describe_data_repository_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"DescribeDataRepositoryTasks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_data_repository_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeDataRepositoryTasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_file_caches()
describe_file_caches(params::Dict{String,<:Any})
Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value
is provided for that cache. Otherwise, it returns descriptions of all caches owned by your
Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're
calling. When retrieving all cache descriptions, you can optionally specify the MaxResults
parameter to limit the number of descriptions in a response. If more cache descriptions
remain, the operation returns a NextToken value in the response. In this case, send a later
request with the NextToken request parameter set to the value of NextToken from the last
response. This operation is used in an iterative process to retrieve a list of your cache
descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the
operation continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken. When using this operation, keep the
following in mind: The implementation might return fewer than MaxResults cache
descriptions while still including a NextToken value. The order of caches returned in the
response of one DescribeFileCaches call and the order of caches returned across the
responses of a multicall iteration is unspecified.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FileCacheIds"`: IDs of the caches whose descriptions you want to retrieve (String).
- `"MaxResults"`:
- `"NextToken"`:
"""
function describe_file_caches(; aws_config::AbstractAWSConfig=global_aws_config())
return fsx("DescribeFileCaches"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_file_caches(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeFileCaches", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_file_system_aliases(file_system_id)
describe_file_system_aliases(file_system_id, params::Dict{String,<:Any})
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File
Server file system. A history of all DNS aliases that have been associated with and
disassociated from the file system is available in the list of AdministrativeAction
provided in the DescribeFileSystems operation response.
# Arguments
- `file_system_id`: The ID of the file system to return the associated DNS aliases for
(String).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"MaxResults"`: Maximum number of DNS aliases to return in the response (integer). This
parameter value must be greater than 0. The number of items that Amazon FSx returns is the
minimum of the MaxResults parameter specified in the request and the service's internal
maximum number of items per page.
- `"NextToken"`: Opaque pagination token returned from a previous DescribeFileSystemAliases
operation (String). If a token is included in the request, the action continues the list
from where the previous returning call left off.
"""
function describe_file_system_aliases(
FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeFileSystemAliases",
Dict{String,Any}(
"FileSystemId" => FileSystemId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_file_system_aliases(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"DescribeFileSystemAliases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileSystemId" => FileSystemId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_file_systems()
describe_file_systems(params::Dict{String,<:Any})
Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is
provided for that file system. Otherwise, it returns descriptions of all file systems owned
by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that
you're calling. When retrieving all file system descriptions, you can optionally specify
the MaxResults parameter to limit the number of descriptions in a response. If more file
system descriptions remain, Amazon FSx returns a NextToken value in the response. In this
case, send a later request with the NextToken request parameter set to the value of
NextToken from the last response. This operation is used in an iterative process to
retrieve a list of your file system descriptions. DescribeFileSystems is called first
without a NextTokenvalue. Then the operation continues to be called with the NextToken
parameter set to the value of the last NextToken value until a response has no NextToken.
When using this operation, keep the following in mind: The implementation might return
fewer than MaxResults file system descriptions while still including a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the
order of file systems returned across the responses of a multicall iteration is
unspecified.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FileSystemIds"`: IDs of the file systems whose descriptions you want to retrieve
(String).
- `"MaxResults"`: Maximum number of file systems to return in the response (integer). This
parameter value must be greater than 0. The number of items that Amazon FSx returns is the
minimum of the MaxResults parameter specified in the request and the service's internal
maximum number of items per page.
- `"NextToken"`: Opaque pagination token returned from a previous DescribeFileSystems
operation (String). If a token present, the operation continues the list from where the
returning call left off.
"""
function describe_file_systems(; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"DescribeFileSystems"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_file_systems(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeFileSystems",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_shared_vpc_configuration()
describe_shared_vpc_configuration(params::Dict{String,<:Any})
Indicates whether participant accounts in your organization can create Amazon FSx for
NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud
(VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared
subnets.
"""
function describe_shared_vpc_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeSharedVpcConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_shared_vpc_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeSharedVpcConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_snapshots()
describe_snapshots(params::Dict{String,<:Any})
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds
value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web
Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit
the number of snapshots in a response. If more backups remain, Amazon FSx returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response. Use this operation
in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called
first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has no
NextToken value. When using this operation, keep the following in mind: The operation
might return fewer than the MaxResults value of snapshot descriptions while still including
a NextToken value. The order of snapshots returned in the response of one
DescribeSnapshots call and the order of backups returned across the responses of a
multi-call iteration is unspecified.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: The filters structure. The supported names are file-system-id or volume-id.
- `"IncludeShared"`: Set to false (default) if you want to only see the snapshots owned by
your Amazon Web Services account. Set to true if you want to see the snapshots in your
account and the ones shared with you from another account.
- `"MaxResults"`:
- `"NextToken"`:
- `"SnapshotIds"`: The IDs of the snapshots that you want to retrieve. This parameter value
overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.
"""
function describe_snapshots(; aws_config::AbstractAWSConfig=global_aws_config())
return fsx("DescribeSnapshots"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_snapshots(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeSnapshots", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_storage_virtual_machines()
describe_storage_virtual_machines(params::Dict{String,<:Any})
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Enter a filter name:value pair to view a select set of SVMs.
- `"MaxResults"`:
- `"NextToken"`:
- `"StorageVirtualMachineIds"`: Enter the ID of one or more SVMs that you want to view.
"""
function describe_storage_virtual_machines(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeStorageVirtualMachines";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_storage_virtual_machines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeStorageVirtualMachines",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_volumes()
describe_volumes(params::Dict{String,<:Any})
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Enter a filter Name and Values pair to view a select set of volumes.
- `"MaxResults"`:
- `"NextToken"`:
- `"VolumeIds"`: The IDs of the volumes whose descriptions you want to retrieve.
"""
function describe_volumes(; aws_config::AbstractAWSConfig=global_aws_config())
return fsx("DescribeVolumes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_volumes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DescribeVolumes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
disassociate_file_system_aliases(aliases, file_system_id)
disassociate_file_system_aliases(aliases, file_system_id, params::Dict{String,<:Any})
Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases
from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a
DNS alias that is not associated with the file system, Amazon FSx responds with an HTTP
status code 400 (Bad Request). For more information, see Working with DNS Aliases. The
system generated response showing the DNS aliases that Amazon FSx is attempting to
disassociate from the file system. Use the API operation to monitor the status of the
aliases Amazon FSx is disassociating with the file system.
# Arguments
- `aliases`: An array of one or more DNS alias names to disassociate, or remove, from the
file system.
- `file_system_id`: Specifies the file system from which to disassociate the DNS aliases.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
"""
function disassociate_file_system_aliases(
Aliases, FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"DisassociateFileSystemAliases",
Dict{String,Any}(
"Aliases" => Aliases,
"FileSystemId" => FileSystemId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_file_system_aliases(
Aliases,
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"DisassociateFileSystemAliases",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Aliases" => Aliases,
"FileSystemId" => FileSystemId,
"ClientRequestToken" => string(uuid4()),
),
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 tags for Amazon FSx resources. When retrieving all tags, you can optionally specify
the MaxResults parameter to limit the number of tags in a response. If more tags remain,
Amazon FSx returns a NextToken value in the response. In this case, send a later request
with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your tags.
ListTagsForResource is called first without a NextTokenvalue. Then the action continues to
be called with the NextToken parameter set to the value of the last NextToken value until a
response has no NextToken. When using this action, keep the following in mind: The
implementation might return fewer than MaxResults file system descriptions while still
including a NextToken value. The order of tags returned in the response of one
ListTagsForResource call and the order of tags returned across the responses of a
multi-call iteration is unspecified.
# Arguments
- `resource_arn`: The ARN of the Amazon FSx resource that will have its tags listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of tags to return in the response (integer). This
parameter value must be greater than 0. The number of items that Amazon FSx returns is the
minimum of the MaxResults parameter specified in the request and the service's internal
maximum number of items per page.
- `"NextToken"`: Opaque pagination token returned from a previous ListTagsForResource
operation (String). If a token present, the action continues the list from where the
returning call left off.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"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 fsx(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
release_file_system_nfs_v3_locks(file_system_id)
release_file_system_nfs_v3_locks(file_system_id, params::Dict{String,<:Any})
Releases the file system lock from an Amazon FSx for OpenZFS file system.
# Arguments
- `file_system_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
"""
function release_file_system_nfs_v3_locks(
FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"ReleaseFileSystemNfsV3Locks",
Dict{String,Any}(
"FileSystemId" => FileSystemId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function release_file_system_nfs_v3_locks(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"ReleaseFileSystemNfsV3Locks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileSystemId" => FileSystemId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
restore_volume_from_snapshot(snapshot_id, volume_id)
restore_volume_from_snapshot(snapshot_id, volume_id, params::Dict{String,<:Any})
Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
# Arguments
- `snapshot_id`: The ID of the source snapshot. Specifies the snapshot that you are
restoring from.
- `volume_id`: The ID of the volume that you are restoring.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"Options"`: The settings used when restoring the specified volume from snapshot.
DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the
specified snapshot. If there are intermediate snapshots and this option isn't used,
RestoreVolumeFromSnapshot fails. DELETE_CLONED_VOLUMES - Deletes any dependent clone
volumes created from intermediate snapshots. If there are any dependent clone volumes and
this option isn't used, RestoreVolumeFromSnapshot fails.
"""
function restore_volume_from_snapshot(
SnapshotId, VolumeId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"RestoreVolumeFromSnapshot",
Dict{String,Any}(
"SnapshotId" => SnapshotId,
"VolumeId" => VolumeId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function restore_volume_from_snapshot(
SnapshotId,
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"RestoreVolumeFromSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SnapshotId" => SnapshotId,
"VolumeId" => VolumeId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_misconfigured_state_recovery(file_system_id)
start_misconfigured_state_recovery(file_system_id, params::Dict{String,<:Any})
After performing steps to repair the Active Directory configuration of an FSx for Windows
File Server file system, use this action to initiate the process of Amazon FSx attempting
to reconnect to the file system.
# Arguments
- `file_system_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
"""
function start_misconfigured_state_recovery(
FileSystemId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"StartMisconfiguredStateRecovery",
Dict{String,Any}(
"FileSystemId" => FileSystemId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_misconfigured_state_recovery(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"StartMisconfiguredStateRecovery",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileSystemId" => FileSystemId, "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 an Amazon FSx resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Amazon FSx resource that you want
to tag.
- `tags`: A list of tags for the resource. If a tag with a given key already exists, the
value is replaced by the one specified in this parameter.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"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 fsx(
"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})
This action removes a tag from an Amazon FSx resource.
# Arguments
- `resource_arn`: The ARN of the Amazon FSx resource to untag.
- `tag_keys`: A list of keys of tags on the resource to untag. In case the tag key doesn't
exist, the call will still succeed to be idempotent.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"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 fsx(
"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_data_repository_association(association_id)
update_data_repository_association(association_id, params::Dict{String,<:Any})
Updates the configuration of an existing data repository association on an Amazon FSx for
Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12
and 2.15 file systems, excluding scratch_1 deployment type.
# Arguments
- `association_id`: The ID of the data repository association that you are updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"ImportedFileChunkSize"`: For files imported from a data repository, this value
determines the stripe count and maximum amount of data per file (in MiB) stored on a single
physical disk. The maximum number of disks that a single file can be striped across is
limited by the total number of disks that make up the file system. The default chunk size
is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a
maximum size of 5 TB.
- `"S3"`: The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre
file system with a data repository association. The configuration defines which file events
(new, changed, or deleted files or directories) are automatically imported from the linked
data repository to the file system or automatically exported from the file system to the
data repository.
"""
function update_data_repository_association(
AssociationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"UpdateDataRepositoryAssociation",
Dict{String,Any}(
"AssociationId" => AssociationId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_repository_association(
AssociationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"UpdateDataRepositoryAssociation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssociationId" => AssociationId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_file_cache(file_cache_id)
update_file_cache(file_cache_id, params::Dict{String,<:Any})
Updates the configuration of an existing Amazon File Cache resource. You can update
multiple properties in a single request.
# Arguments
- `file_cache_id`: The ID of the cache that you are updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"LustreConfiguration"`: The configuration updates for an Amazon File Cache resource.
"""
function update_file_cache(FileCacheId; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"UpdateFileCache",
Dict{String,Any}(
"FileCacheId" => FileCacheId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_file_cache(
FileCacheId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"UpdateFileCache",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileCacheId" => FileCacheId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_file_system(file_system_id)
update_file_system(file_system_id, params::Dict{String,<:Any})
Use this operation to update the configuration of an existing Amazon FSx file system. You
can update multiple properties in a single request. For FSx for Windows File Server file
systems, you can update the following properties: AuditLogConfiguration
AutomaticBackupRetentionDays DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration StorageCapacity StorageType
ThroughputCapacity DiskIopsConfiguration WeeklyMaintenanceStartTime For FSx for
Lustre file systems, you can update the following properties: AutoImportPolicy
AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DataCompressionType
LogConfiguration LustreRootSquashConfiguration MetadataConfiguration
PerUnitStorageThroughput StorageCapacity WeeklyMaintenanceStartTime For FSx for
ONTAP file systems, you can update the following properties: AddRouteTableIds
AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DiskIopsConfiguration
FsxAdminPassword HAPairs RemoveRouteTableIds StorageCapacity
ThroughputCapacity ThroughputCapacityPerHAPair WeeklyMaintenanceStartTime For
FSx for OpenZFS file systems, you can update the following properties: AddRouteTableIds
AutomaticBackupRetentionDays CopyTagsToBackups CopyTagsToVolumes
DailyAutomaticBackupStartTime DiskIopsConfiguration RemoveRouteTableIds
StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime
# Arguments
- `file_system_id`: The ID of the file system that you are updating.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: A string of up to 63 ASCII characters that Amazon FSx uses to
ensure idempotent updates. This string is automatically filled on your behalf when you use
the Command Line Interface (CLI) or an Amazon Web Services SDK.
- `"LustreConfiguration"`:
- `"OntapConfiguration"`:
- `"OpenZFSConfiguration"`: The configuration updates for an FSx for OpenZFS file system.
- `"StorageCapacity"`: Use this parameter to increase the storage capacity of an FSx for
Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system.
Specifies the storage capacity target value, in GiB, to increase the storage capacity for
the file system that you're updating. You can't make a storage capacity increase request
if there is an existing storage capacity increase request in progress. For Lustre file
systems, the storage capacity target value can be the following: For SCRATCH_2,
PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values are in multiples of 2400
GiB. The value must be greater than the current storage capacity. For PERSISTENT HDD file
systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems
and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be
greater than the current storage capacity. For SCRATCH_1 file systems, you can't increase
the storage capacity. For more information, see Managing storage and throughput capacity
in the FSx for Lustre User Guide. For FSx for OpenZFS file systems, the storage capacity
target value must be at least 10 percent greater than the current storage capacity value.
For more information, see Managing storage capacity in the FSx for OpenZFS User Guide. For
Windows file systems, the storage capacity target value must be at least 10 percent greater
than the current storage capacity value. To increase storage capacity, the file system must
have at least 16 MBps of throughput capacity. For more information, see Managing storage
capacity in the Amazon FSxfor Windows File Server User Guide. For ONTAP file systems, the
storage capacity target value must be at least 10 percent greater than the current storage
capacity value. For more information, see Managing storage capacity and provisioned IOPS in
the Amazon FSx for NetApp ONTAP User Guide.
- `"StorageType"`:
- `"WindowsConfiguration"`: The configuration updates for an Amazon FSx for Windows File
Server file system.
"""
function update_file_system(FileSystemId; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"UpdateFileSystem",
Dict{String,Any}(
"FileSystemId" => FileSystemId, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_file_system(
FileSystemId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"UpdateFileSystem",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FileSystemId" => FileSystemId, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_shared_vpc_configuration()
update_shared_vpc_configuration(params::Dict{String,<:Any})
Configures whether participant accounts in your organization can create Amazon FSx for
NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud
(VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide. We
strongly recommend that participant-created Multi-AZ file systems in the shared VPC are
deleted before you disable this feature. Once the feature is disabled, these file systems
will enter a MISCONFIGURED state and behave like Single-AZ file systems. For more
information, see Important considerations before disabling shared VPC support for Multi-AZ
file systems.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"EnableFsxRouteTableUpdatesFromParticipantAccounts"`: Specifies whether participant
accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets. Set to true to
enable or false to disable.
"""
function update_shared_vpc_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"UpdateSharedVpcConfiguration",
Dict{String,Any}("ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_shared_vpc_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"UpdateSharedVpcConfiguration",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_snapshot(name, snapshot_id)
update_snapshot(name, snapshot_id, params::Dict{String,<:Any})
Updates the name of an Amazon FSx for OpenZFS snapshot.
# Arguments
- `name`: The name of the snapshot to update.
- `snapshot_id`: The ID of the snapshot that you want to update, in the format
fsvolsnap-0123456789abcdef0.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
"""
function update_snapshot(
Name, SnapshotId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"UpdateSnapshot",
Dict{String,Any}(
"Name" => Name,
"SnapshotId" => SnapshotId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_snapshot(
Name,
SnapshotId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"UpdateSnapshot",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name,
"SnapshotId" => SnapshotId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_storage_virtual_machine(storage_virtual_machine_id)
update_storage_virtual_machine(storage_virtual_machine_id, params::Dict{String,<:Any})
Updates an FSx for ONTAP storage virtual machine (SVM).
# Arguments
- `storage_virtual_machine_id`: The ID of the SVM that you want to update, in the format
svm-0123456789abcdef0.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ActiveDirectoryConfiguration"`: Specifies updates to an SVM's Microsoft Active
Directory (AD) configuration.
- `"ClientRequestToken"`:
- `"SvmAdminPassword"`: Specifies a new SvmAdminPassword.
"""
function update_storage_virtual_machine(
StorageVirtualMachineId; aws_config::AbstractAWSConfig=global_aws_config()
)
return fsx(
"UpdateStorageVirtualMachine",
Dict{String,Any}(
"StorageVirtualMachineId" => StorageVirtualMachineId,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_storage_virtual_machine(
StorageVirtualMachineId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"UpdateStorageVirtualMachine",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"StorageVirtualMachineId" => StorageVirtualMachineId,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_volume(volume_id)
update_volume(volume_id, params::Dict{String,<:Any})
Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS
volume.
# Arguments
- `volume_id`: The ID of the volume that you want to update, in the format
fsvol-0123456789abcdef0.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"Name"`: The name of the OpenZFS volume. OpenZFS root volumes are automatically named
FSX. Child volume names must be unique among their parent volume's children. The name of
the volume is part of the mount string for the OpenZFS volume.
- `"OntapConfiguration"`: The configuration of the ONTAP volume that you are updating.
- `"OpenZFSConfiguration"`: The configuration of the OpenZFS volume that you are updating.
"""
function update_volume(VolumeId; aws_config::AbstractAWSConfig=global_aws_config())
return fsx(
"UpdateVolume",
Dict{String,Any}("VolumeId" => VolumeId, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_volume(
VolumeId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return fsx(
"UpdateVolume",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"VolumeId" => VolumeId, "ClientRequestToken" => 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 | 290020 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: gamelift
using AWS.Compat
using AWS.UUIDs
"""
accept_match(acceptance_type, player_ids, ticket_id)
accept_match(acceptance_type, player_ids, ticket_id, params::Dict{String,<:Any})
Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking
configuration may require player acceptance; if so, then matches built with that
configuration cannot be completed unless all players accept the proposed match within a
specified time limit. When FlexMatch builds a match, all the matchmaking tickets involved
in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for
your game to get acceptance from all players in each ticket. Calls to this action are only
valid for tickets that are in this status; calls for tickets not in this status result in
an error. To register acceptance, specify the ticket ID, one or more players, and an
acceptance response. When all players have accepted, Amazon GameLift advances the
matchmaking tickets to status PLACING, and attempts to create a new game session for the
match. If any player rejects the match, or if acceptances are not received before a
specified timeout, the proposed match is dropped. Each matchmaking ticket in the failed
match is handled as follows: If the ticket has one or more players who rejected the
match or failed to respond, the ticket status is set CANCELLED and processing is
terminated. If all players in the ticket accepted the match, the ticket status is
returned to SEARCHING to find a new match. Learn more Add FlexMatch to a game client
FlexMatch events (reference)
# Arguments
- `acceptance_type`: Player response to the proposed match.
- `player_ids`: A unique identifier for a player delivering the response. This parameter
can include one or multiple player IDs.
- `ticket_id`: A unique identifier for a matchmaking ticket. The ticket must be in status
REQUIRES_ACCEPTANCE; otherwise this request will fail.
"""
function accept_match(
AcceptanceType, PlayerIds, TicketId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"AcceptMatch",
Dict{String,Any}(
"AcceptanceType" => AcceptanceType,
"PlayerIds" => PlayerIds,
"TicketId" => TicketId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_match(
AcceptanceType,
PlayerIds,
TicketId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"AcceptMatch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AcceptanceType" => AcceptanceType,
"PlayerIds" => PlayerIds,
"TicketId" => TicketId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
claim_game_server(game_server_group_name)
claim_game_server(game_server_group_name, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Locates an available game server and temporarily reserves it to host gameplay and players.
This operation is called from a game client or client service (such as a matchmaker) to
request hosting resources for a new game session. In response, Amazon GameLift FleetIQ
locates an available game server, places it in CLAIMED status for 60 seconds, and returns
connection information that players can use to connect to the game server. To claim a game
server, identify a game server group. You can also specify a game server ID, although this
approach bypasses Amazon GameLift FleetIQ placement optimization. Optionally, include game
data to pass to the game server at the start of a game session, such as a game map or
player information. Add filter options to further restrict how a game server is chosen,
such as only allowing game servers on ACTIVE instances to be claimed. When a game server is
successfully claimed, connection information is returned. A claimed game server's
utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60
seconds. This time period gives the game server time to update its status to UTILIZED after
players join. If the game server's status is not updated within 60 seconds, the game server
reverts to unclaimed status and is available to be claimed by another request. The claim
time period is a fixed value and is not configurable. If you try to claim a specific game
server, this request will fail in the following cases: If the game server utilization
status is UTILIZED. If the game server claim status is CLAIMED. If the game server is
running on an instance in DRAINING status and the provided filter option does not allow
placing on DRAINING instances. Learn more Amazon GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group where the game
server is running. If you are not specifying a game server to claim, this value identifies
where you want Amazon GameLift FleetIQ to look for an available game server to claim.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FilterOption"`: Object that restricts how a claimed game server is chosen.
- `"GameServerData"`: A set of custom game server properties, formatted as a single string
value. This data is passed to a game client or service when it requests information on game
servers.
- `"GameServerId"`: A custom string that uniquely identifies the game server to claim. If
this parameter is left empty, Amazon GameLift FleetIQ searches for an available game server
in the specified game server group.
"""
function claim_game_server(
GameServerGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ClaimGameServer",
Dict{String,Any}("GameServerGroupName" => GameServerGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function claim_game_server(
GameServerGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"ClaimGameServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GameServerGroupName" => GameServerGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_alias(name, routing_strategy)
create_alias(name, routing_strategy, params::Dict{String,<:Any})
Creates an alias for a fleet. In most situations, you can use an alias ID in place of a
fleet ID. An alias provides a level of abstraction for a fleet that is useful when
redirecting player traffic from one fleet to another, such as when updating your game
build. Amazon GameLift supports two types of routing strategies for aliases: simple and
terminal. A simple alias points to an active fleet. A terminal alias is used to display
messaging or link to a URL instead of routing players to an active fleet. For example, you
might use a terminal alias when a game version is no longer supported and you want to
direct players to an upgrade site. To create a fleet alias, specify an alias name, routing
strategy, and optional description. Each simple alias can point to only one fleet, but a
fleet can have multiple aliases. If successful, a new alias record is returned, including
an alias ID and an ARN. You can reassign an alias to another fleet by calling UpdateAlias.
Related actions All APIs by task
# Arguments
- `name`: A descriptive label that is associated with an alias. Alias names do not need to
be unique.
- `routing_strategy`: The routing configuration, including routing type and fleet target,
for the alias.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A human-readable description of the alias.
- `"Tags"`: A list of labels to assign to the new alias resource. Tags are
developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for
resource management, access management and cost allocation. For more information, see
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
"""
function create_alias(
Name, RoutingStrategy; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreateAlias",
Dict{String,Any}("Name" => Name, "RoutingStrategy" => RoutingStrategy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_alias(
Name,
RoutingStrategy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateAlias",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "RoutingStrategy" => RoutingStrategy),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_build()
create_build(params::Dict{String,<:Any})
Creates a new Amazon GameLift build resource for your game server binary files. Combine
game server binaries into a zip file for use with Amazon GameLift. When setting up a new
game build for Amazon GameLift, we recommend using the CLI command upload-build . This
helper command combines two tasks: (1) it uploads your build files from a file directory to
an Amazon GameLift Amazon S3 location, and (2) it creates a new build resource. You can
use the CreateBuild operation in the following scenarios: Create a new game build with
build files that are in an Amazon S3 location under an Amazon Web Services account that you
control. To use this option, you give Amazon GameLift access to the Amazon S3 bucket. With
permissions in place, specify a build name, operating system, and the Amazon S3 storage
location of your game build. Upload your build files to a Amazon GameLift Amazon S3
location. To use this option, specify a build name and operating system. This operation
creates a new build resource and also returns an Amazon S3 location with temporary access
credentials. Use the credentials to manually upload your build files to the specified
Amazon S3 location. For more information, see Uploading Objects in the Amazon S3 Developer
Guide. After you upload build files to the Amazon GameLift Amazon S3 location, you can't
update them. If successful, this operation creates a new build resource with a unique
build ID and places it in INITIALIZED status. A build must be in READY status before you
can create fleets with it. Learn more Uploading Your Game Create a Build with Files
in Amazon S3 All APIs by task
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: A descriptive label associated with a build. Build names don't need to be
unique. You can change this value later.
- `"OperatingSystem"`: The operating system that your game server binaries run on. This
value determines the type of fleet resources that you use for this build. If your game
build contains multiple executables, they all must run on the same operating system. You
must specify a valid operating system in this request. There is no default value. You can't
change a build's operating system later. If you have active fleets using the Windows
Server 2012 operating system, you can continue to create new builds using this OS until
October 10, 2023, when Microsoft ends its support. All others must use Windows Server 2016
when creating new Windows-based builds.
- `"ServerSdkVersion"`: A server SDK version you used when integrating your game server
build with Amazon GameLift. For more information see Integrate games with custom game
servers. By default Amazon GameLift sets this value to 4.0.2.
- `"StorageLocation"`: Information indicating where your game build files are stored. Use
this parameter only when creating a build with files stored in an Amazon S3 bucket that you
own. The storage location must specify an Amazon S3 bucket name and key. The location must
also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3
bucket. The S3 bucket and your new build must be in the same Region. If a StorageLocation
is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift
will report a SizeOnDisk of 0.
- `"Tags"`: A list of labels to assign to the new build resource. Tags are developer
defined key-value pairs. Tagging Amazon Web Services resources are useful for resource
management, access management and cost allocation. For more information, see Tagging
Amazon Web Services Resources in the Amazon Web Services General Reference. Once the
resource is created, you can use TagResource, UntagResource, and ListTagsForResource to
add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon
Web Services General Reference for actual tagging limits.
- `"Version"`: Version information associated with a build or script. Version strings don't
need to be unique. You can change this value later.
"""
function create_build(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift("CreateBuild"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_build(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreateBuild", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_container_group_definition(container_definitions, name, operating_system, total_cpu_limit, total_memory_limit)
create_container_group_definition(container_definitions, name, operating_system, total_cpu_limit, total_memory_limit, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift containers feature, which is currently in
public preview. Creates a ContainerGroupDefinition resource that describes a set of
containers for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon
GameLift container group is similar to a container \"task\" and \"pod\". Each container
group can have one or more containers. Use container group definitions when you create a
container fleet. Container group definitions determine how Amazon GameLift deploys your
containers to each instance in a container fleet. You can create two types of container
groups, based on scheduling strategy: A replica container group manages the containers
that run your game server application and supporting software. Replica container groups
might be replicated multiple times on each fleet instance, depending on instance resources.
A daemon container group manages containers that run other software, such as background
services, logging, or test processes. You might use a daemon container group for processes
that need to run only once per fleet instance, or processes that need to persist
independently of the replica container group. To create a container group definition,
specify a group name, a list of container definitions, and maximum total CPU and memory
requirements for the container group. Specify an operating system and scheduling strategy
or use the default values. When using the Amazon Web Services CLI tool, you can pass in
your container definitions as a JSON file. This operation requires Identity and Access
Management (IAM) permissions to access container images in Amazon ECR repositories. See
IAM permissions for Amazon GameLift for help setting the appropriate permissions. If
successful, this operation creates a new ContainerGroupDefinition resource with an ARN
value assigned. You can't change the properties of a container group definition. Instead,
create a new one. Learn more Create a container group definition Container fleet
design guide Create a container definition as a JSON file
# Arguments
- `container_definitions`: Definitions for all containers in this group. Each container
definition identifies the container image and specifies configuration settings for the
container. See the Container fleet design guide for container guidelines.
- `name`: A descriptive identifier for the container group definition. The name value must
be unique in an Amazon Web Services Region.
- `operating_system`: The platform that is used by containers in the container group
definition. All containers in a group must run on the same operating system.
- `total_cpu_limit`: The maximum amount of CPU units to allocate to the container group.
Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units).
All containers in the group share this memory. If you specify CPU limits for individual
containers, set this parameter based on the following guidelines. The value must be equal
to or greater than the sum of the CPU limits for all containers in the group.
- `total_memory_limit`: The maximum amount of memory (in MiB) to allocate to the container
group. All containers in the group share this memory. If you specify memory limits for
individual containers, set this parameter based on the following guidelines. The value must
be (1) greater than the sum of the soft memory limits for all containers in the group, and
(2) greater than any individual container's hard memory limit.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SchedulingStrategy"`: The method for deploying the container group across fleet
instances. A replica container group might have multiple copies on each fleet instance. A
daemon container group has one copy per fleet instance. Default value is REPLICA.
- `"Tags"`: A list of labels to assign to the container group definition resource. Tags are
developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for
resource management, access management and cost allocation. For more information, see
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
"""
function create_container_group_definition(
ContainerDefinitions,
Name,
OperatingSystem,
TotalCpuLimit,
TotalMemoryLimit;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateContainerGroupDefinition",
Dict{String,Any}(
"ContainerDefinitions" => ContainerDefinitions,
"Name" => Name,
"OperatingSystem" => OperatingSystem,
"TotalCpuLimit" => TotalCpuLimit,
"TotalMemoryLimit" => TotalMemoryLimit,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_container_group_definition(
ContainerDefinitions,
Name,
OperatingSystem,
TotalCpuLimit,
TotalMemoryLimit,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateContainerGroupDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ContainerDefinitions" => ContainerDefinitions,
"Name" => Name,
"OperatingSystem" => OperatingSystem,
"TotalCpuLimit" => TotalCpuLimit,
"TotalMemoryLimit" => TotalMemoryLimit,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_fleet(name)
create_fleet(name, params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Creates a fleet of compute resources to host your game
servers. Use this operation to set up the following types of fleets based on compute type:
Managed EC2 fleet An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2)
instances. Your game server build is deployed to each fleet instance. Amazon GameLift
manages the fleet's instances and controls the lifecycle of game server processes, which
host game sessions for players. EC2 fleets can have instances in multiple locations. Each
instance in the fleet is designated a Compute. To create an EC2 fleet, provide these
required parameters: Either BuildId or ScriptId ComputeType set to EC2 (the default
value) EC2InboundPermissions EC2InstanceType FleetType Name
RuntimeConfiguration with at least one ServerProcesses configuration If successful, this
operation creates a new fleet resource and places it in NEW status while Amazon GameLift
initiates the fleet creation workflow. To debug your fleet, fetch logs, view performance
metrics or other actions on the fleet, create a development fleet with port 22/3389 open.
As a best practice, we recommend opening ports for remote access only when you need them
and closing them when you're finished. When the fleet status is ACTIVE, you can adjust
capacity settings and turn autoscaling on/off for each location. Managed container fleet
A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your
container architecture is deployed to each fleet instance based on the fleet configuration.
Amazon GameLift manages the containers on each fleet instance and controls the lifecycle of
game server processes, which host game sessions for players. Container fleets can have
instances in multiple locations. Each container on an instance that runs game server
processes is registered as a Compute. To create a container fleet, provide these required
parameters: ComputeType set to CONTAINER ContainerGroupsConfiguration
EC2InboundPermissions EC2InstanceType FleetType set to ON_DEMAND Name
RuntimeConfiguration with at least one ServerProcesses configuration If successful, this
operation creates a new fleet resource and places it in NEW status while Amazon GameLift
initiates the fleet creation workflow. When the fleet status is ACTIVE, you can adjust
capacity settings and turn autoscaling on/off for each location. Anywhere fleet An
Anywhere fleet represents compute resources that are not owned or managed by Amazon
GameLift. You might create an Anywhere fleet with your local machine for testing, or use
one to host game servers with on-premises hardware or other game hosting solutions. To
create an Anywhere fleet, provide these required parameters: ComputeType set to ANYWHERE
Locations specifying a custom location Name If successful, this operation creates
a new fleet resource and places it in ACTIVE status. You can register computes with a fleet
in ACTIVE status. Learn more Setting up fleets Setting up a container fleet Debug
fleet creation issues Multi-location fleets
# Arguments
- `name`: A descriptive label that is associated with a fleet. Fleet names do not need to
be unique.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnywhereConfiguration"`: Amazon GameLift Anywhere configuration options.
- `"BuildId"`: The unique identifier for a custom game server build to be deployed to a
fleet with compute type EC2. You can use either the build ID or ARN. The build must be
uploaded to Amazon GameLift and in READY status. This fleet property can't be changed after
the fleet is created.
- `"CertificateConfiguration"`: Prompts Amazon GameLift to generate a TLS/SSL certificate
for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game
clients and the game servers running on Amazon GameLift. By default, the
CertificateConfiguration is DISABLED. You can't change this property after you create the
fleet. Certificate Manager (ACM) certificates expire after 13 months. Certificate
expiration can cause fleets to fail, preventing players from connecting to instances in the
fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a
smooth transition. ACM isn't available in all Amazon Web Services regions. A fleet
creation request with certificate generation enabled in an unsupported Region, fails with a
4xx error. For more information about the supported Regions, see Supported Regions in the
Certificate Manager User Guide.
- `"ComputeType"`: The type of compute resource used to host your game servers. EC2 –
The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the
default setting. CONTAINER – Container images with your game server build and
supporting software are deployed to Amazon EC2 instances for cloud hosting. With this
compute type, you must specify the ContainerGroupsConfiguration parameter. ANYWHERE –
Game servers or container images with your game server and supporting software are deployed
to compute resources that are provided and managed by you. With this compute type, you can
also set the AnywhereConfiguration parameter.
- `"ContainerGroupsConfiguration"`: The container groups to deploy to instances in the
container fleet and other fleet-level configuration settings. Use the
CreateContainerGroupDefinition action to create container groups. A container fleet must
have exactly one replica container group, and can optionally have one daemon container
group. You can't change this property after you create the fleet.
- `"Description"`: A description for the fleet.
- `"EC2InboundPermissions"`: The IP address ranges and port settings that allow inbound
traffic to access game server processes and other processes on this fleet. Set this
parameter for EC2 and container fleets. You can leave this parameter empty when creating
the fleet, but you must call UpdateFleetPortSettings to set it before players can connect
to game sessions. As a best practice, we recommend opening ports for remote access only
when you need them and closing them when you're finished. For Realtime Servers fleets,
Amazon GameLift automatically sets TCP and UDP ranges. To manage inbound access for a
container fleet, set this parameter to the same port numbers that you set for the fleet's
connection port range. During the life of the fleet, update this parameter to control which
connection ports are open to inbound traffic.
- `"EC2InstanceType"`: The Amazon GameLift-supported Amazon EC2 instance type to use with
EC2 and container fleets. Instance type determines the computing resources that will be
used to host your game servers, including CPU, memory, storage, and networking capacity.
See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2
instance types.
- `"FleetType"`: Indicates whether to use On-Demand or Spot instances for this fleet. By
default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus
Spot Instances. This fleet property can't be changed after the fleet is created.
- `"InstanceRoleArn"`: A unique identifier for an IAM role with access permissions to other
Amazon Web Services services. Any application that runs on an instance in the
fleet--including install scripts, server processes, and other processes--can use these
permissions to interact with Amazon Web Services resources that you own or have access to.
For more information about using the role with your game server builds, see Communicate
with other Amazon Web Services resources from your fleets. This fleet property can't be
changed after the fleet is created.
- `"InstanceRoleCredentialsProvider"`: Prompts Amazon GameLift to generate a shared
credentials file for the IAM role that's defined in InstanceRoleArn. The shared credentials
file is stored on each fleet instance and refreshed as needed. Use shared credentials for
applications that are deployed along with the game server executable, if the game server is
integrated with server SDK version 5.x. For more information about using shared
credentials, see Communicate with other Amazon Web Services resources from your fleets.
- `"Locations"`: A set of remote locations to deploy additional instances to and manage as
part of the fleet. This parameter can only be used when creating fleets in Amazon Web
Services Regions that support multiple locations. You can add any Amazon GameLift-supported
Amazon Web Services Region as a remote location, in the form of an Amazon Web Services
Region code, such as us-west-2 or Local Zone code. To create a fleet with instances in the
home Region only, don't set this parameter. When using this parameter, Amazon GameLift
requires you to include your home location in the request.
- `"LogPaths"`: This parameter is no longer used. To specify where Amazon GameLift should
store log files once a server process shuts down, use the Amazon GameLift server API
ProcessReady() and specify one or more directory paths in logParameters. For more
information, see Initialize the server process in the Amazon GameLift Developer Guide.
- `"MetricGroups"`: The name of an Amazon Web Services CloudWatch metric group to add this
fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can
specify an existing metric group name or set a new name to create a new metric group. A
fleet can be included in only one metric group at a time.
- `"NewGameSessionProtectionPolicy"`: The status of termination protection for active game
sessions on the fleet. By default, this property is set to NoProtection. You can also set
game session protection for an individual game session by calling UpdateGameSession.
NoProtection - Game sessions can be terminated during active gameplay as a result of a
scale-down event. FullProtection - Game sessions in ACTIVE status cannot be terminated
during a scale-down event.
- `"PeerVpcAwsAccountId"`: Used when peering your Amazon GameLift fleet with a VPC, the
unique identifier for the Amazon Web Services account that owns the VPC. You can find your
account ID in the Amazon Web Services Management Console under account settings.
- `"PeerVpcId"`: A unique identifier for a VPC with resources to be accessed by your Amazon
GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use
the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC
peering in VPC Peering with Amazon GameLift Fleets.
- `"ResourceCreationLimitPolicy"`: A policy that limits the number of game sessions that an
individual player can create on instances in this fleet within a specified span of time.
- `"RuntimeConfiguration"`: Instructions for how to launch and run server processes on the
fleet. Set runtime configuration for EC2 fleets and container fleets. For an Anywhere
fleets, set this parameter only if the fleet is running the Amazon GameLift Agent. The
runtime configuration defines one or more server process configurations. Each server
process identifies a game executable or Realtime script file and the number of processes to
run concurrently. This parameter replaces the parameters ServerLaunchPath and
ServerLaunchParameters, which are still supported for backward compatibility.
- `"ScriptId"`: The unique identifier for a Realtime configuration script to be deployed to
a fleet with compute type EC2. You can use either the script ID or ARN. Scripts must be
uploaded to Amazon GameLift prior to creating the fleet. This fleet property can't be
changed after the fleet is created.
- `"ServerLaunchParameters"`: This parameter is no longer used. Specify server launch
parameters using the RuntimeConfiguration parameter. Requests that use this parameter
instead continue to be valid.
- `"ServerLaunchPath"`: This parameter is no longer used. Specify a server launch path
using the RuntimeConfiguration parameter. Requests that use this parameter instead continue
to be valid.
- `"Tags"`: A list of labels to assign to the new fleet resource. Tags are
developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for
resource management, access management and cost allocation. For more information, see
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
"""
function create_fleet(Name; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"CreateFleet",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fleet(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreateFleet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_fleet_locations(fleet_id, locations)
create_fleet_locations(fleet_id, locations, params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Adds remote locations to an EC2 or container fleet and
begins populating the new locations with instances. The new instances conform to the
fleet's instance type, auto-scaling, and other configuration settings. You can't add
remote locations to a fleet that resides in an Amazon Web Services Region that doesn't
support multiple locations. Fleets created prior to March 2021 can't support multiple
locations. To add fleet locations, specify the fleet to be updated and provide a list of
one or more locations. If successful, this operation returns the list of added locations
with their status set to NEW. Amazon GameLift initiates the process of starting an instance
in each added location. You can track the status of each new location by monitoring
location creation events using DescribeFleetEvents. Learn more Setting up fleets
Multi-location fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to add locations to. You can use either the
fleet ID or ARN value.
- `locations`: A list of locations to deploy additional instances to and manage as part of
the fleet. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote
location, in the form of an Amazon Web Services Region code such as us-west-2.
"""
function create_fleet_locations(
FleetId, Locations; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreateFleetLocations",
Dict{String,Any}("FleetId" => FleetId, "Locations" => Locations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fleet_locations(
FleetId,
Locations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateFleetLocations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FleetId" => FleetId, "Locations" => Locations),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_game_server_group(game_server_group_name, instance_definitions, launch_template, max_size, min_size, role_arn)
create_game_server_group(game_server_group_name, instance_definitions, launch_template, max_size, min_size, role_arn, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Creates a Amazon GameLift FleetIQ game server group for managing game hosting on a
collection of Amazon Elastic Compute Cloud instances for game hosting. This operation
creates the game server group, creates an Auto Scaling group in your Amazon Web Services
account, and establishes a link between the two groups. You can view the status of your
game server groups in the Amazon GameLift console. Game server group metrics and events are
emitted to Amazon CloudWatch. Before creating a new game server group, you must have the
following: An Amazon Elastic Compute Cloud launch template that specifies how to launch
Amazon Elastic Compute Cloud instances with your game server build. For more information,
see Launching an Instance from a Launch Template in the Amazon Elastic Compute Cloud User
Guide. An IAM role that extends limited access to your Amazon Web Services account to
allow Amazon GameLift FleetIQ to create and interact with the Auto Scaling group. For more
information, see Create IAM roles for cross-service interaction in the Amazon GameLift
FleetIQ Developer Guide. To create a new game server group, specify a unique group name,
IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance
types that can be used in the group. You must also set initial maximum and minimum limits
on the group's instance count. You can optionally set an Auto Scaling policy with target
tracking based on a Amazon GameLift FleetIQ metric. Once the game server group and
corresponding Auto Scaling group are created, you have full access to change the Auto
Scaling group's configuration as needed. Several properties that are set when creating a
game server group, including maximum/minimum size and auto-scaling policy settings, must be
updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group
properties are periodically updated by Amazon GameLift FleetIQ as part of its balancing
activities to optimize for availability and cost. Learn more Amazon GameLift FleetIQ
Guide
# Arguments
- `game_server_group_name`: An identifier for the new game server group. This value is used
to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the Amazon
GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web
Services account.
- `instance_definitions`: The Amazon EC2 instance types and sizes to use in the Auto
Scaling group. The instance definitions must specify at least two different instance types
that are supported by Amazon GameLift FleetIQ. For more information on instance types, see
EC2 Instance Types in the Amazon Elastic Compute Cloud User Guide. You can optionally
specify capacity weighting for each instance type. If no weight value is specified for an
instance type, it is set to the default value \"1\". For more information about capacity
weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto
Scaling User Guide.
- `launch_template`: The Amazon EC2 launch template that contains configuration settings
and game server code to be deployed to all instances in the game server group. You can
specify the template using either the template name or ID. For help with creating a launch
template, see Creating a Launch Template for an Auto Scaling Group in the Amazon Elastic
Compute Cloud Auto Scaling User Guide. After the Auto Scaling group is created, update this
value directly in the Auto Scaling group using the Amazon Web Services console or APIs. If
you specify network interfaces in your launch template, you must explicitly set the
property AssociatePublicIpAddress to \"true\". If no network interface is specified in the
launch template, Amazon GameLift FleetIQ uses your account's default VPC.
- `max_size`: The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
During automatic scaling events, Amazon GameLift FleetIQ and EC2 do not scale up the group
above this maximum. After the Auto Scaling group is created, update this value directly in
the Auto Scaling group using the Amazon Web Services console or APIs.
- `min_size`: The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
During automatic scaling events, Amazon GameLift FleetIQ and Amazon EC2 do not scale down
the group below this minimum. In production, this value should be set to at least 1. After
the Auto Scaling group is created, update this value directly in the Auto Scaling group
using the Amazon Web Services console or APIs.
- `role_arn`: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to
access your Amazon EC2 Auto Scaling groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoScalingPolicy"`: Configuration settings to define a scaling policy for the Auto
Scaling group that is optimized for game hosting. The scaling policy uses the metric
\"PercentUtilizedGameServers\" to maintain a buffer of idle game servers that can
immediately accommodate new games and players. After the Auto Scaling group is created,
update this value directly in the Auto Scaling group using the Amazon Web Services console
or APIs.
- `"BalancingStrategy"`: Indicates how Amazon GameLift FleetIQ balances the use of Spot
Instances and On-Demand Instances in the game server group. Method options include the
following: SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot
Instances are unavailable or not viable for game hosting, the game server group provides no
hosting capacity until Spot Instances can again be used. Until then, no new instances are
started, and the existing nonviable Spot Instances are terminated (after current gameplay
ends) and are not replaced. SPOT_PREFERRED - (default value) Spot Instances are used
whenever available in the game server group. If Spot Instances are unavailable, the game
server group continues to provide hosting capacity by falling back to On-Demand Instances.
Existing nonviable Spot Instances are terminated (after current gameplay ends) and are
replaced with new On-Demand Instances. ON_DEMAND_ONLY - Only On-Demand Instances are
used in the game server group. No Spot Instances are used, even when available, while this
balancing strategy is in force.
- `"GameServerProtectionPolicy"`: A flag that indicates whether instances in the game
server group are protected from early termination. Unprotected instances that have active
game servers running might be terminated during a scale-down event, causing players to be
dropped from the game. Protected instances cannot be terminated while there are active game
servers running except in the event of a forced game server group deletion (see ). An
exception to this is with Spot Instances, which can be terminated by Amazon Web Services
regardless of protection status. This property is set to NO_PROTECTION by default.
- `"Tags"`: A list of labels to assign to the new game server group resource. Tags are
developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for
resource management, access management, and cost allocation. For more information, see
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
- `"VpcSubnets"`: A list of virtual private cloud (VPC) subnets to use with instances in
the game server group. By default, all Amazon GameLift FleetIQ-supported Availability Zones
are used. You can use this parameter to specify VPCs that you've set up. This property
cannot be updated after the game server group is created, and the corresponding Auto
Scaling group will always use the property value that is set with this request, even if the
Auto Scaling group is updated directly.
"""
function create_game_server_group(
GameServerGroupName,
InstanceDefinitions,
LaunchTemplate,
MaxSize,
MinSize,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateGameServerGroup",
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName,
"InstanceDefinitions" => InstanceDefinitions,
"LaunchTemplate" => LaunchTemplate,
"MaxSize" => MaxSize,
"MinSize" => MinSize,
"RoleArn" => RoleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_game_server_group(
GameServerGroupName,
InstanceDefinitions,
LaunchTemplate,
MaxSize,
MinSize,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateGameServerGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName,
"InstanceDefinitions" => InstanceDefinitions,
"LaunchTemplate" => LaunchTemplate,
"MaxSize" => MaxSize,
"MinSize" => MinSize,
"RoleArn" => RoleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_game_session(maximum_player_session_count)
create_game_session(maximum_player_session_count, params::Dict{String,<:Any})
Creates a multiplayer game session for players in a specific fleet location. This operation
prompts an available server process to start a game session and retrieves connection
information for the new game session. As an alternative, consider using the Amazon GameLift
game session placement feature with StartGameSessionPlacement , which uses the FleetIQ
algorithm and queues to optimize the placement process. When creating a game session, you
specify exactly where you want to place it and provide a set of game session configuration
settings. The target fleet must be in ACTIVE status. You can use this operation in the
following ways: To create a game session on an instance in a fleet's home Region,
provide a fleet or alias ID along with your game session configuration. To create a game
session on an instance in a fleet's remote location, provide a fleet or alias ID and a
location name, along with your game session configuration. To create a game session on
an instance in an Anywhere fleet, specify the fleet's custom location. If successful,
Amazon GameLift initiates a workflow to start a new game session and returns a GameSession
object containing the game session configuration and status. When the game session status
is ACTIVE, it is updated with connection information and you can create player sessions for
the game session. By default, newly created game sessions are open to new players. You can
restrict new player access by using UpdateGameSession to change the game session's player
session creation policy. Amazon GameLift retains logs for active for 14 days. To access the
logs, call GetGameSessionLogUrl to download the log files. Available in Amazon GameLift
Local. Learn more Start a game session All APIs by task
# Arguments
- `maximum_player_session_count`: The maximum number of players that can be connected
simultaneously to the game session.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AliasId"`: A unique identifier for the alias associated with the fleet to create a game
session in. You can use either the alias ID or ARN value. Each request must reference
either a fleet ID or alias ID, but not both.
- `"CreatorId"`: A unique identifier for a player or entity creating the game session. If
you add a resource creation limit policy to a fleet, the CreateGameSession operation
requires a CreatorId. Amazon GameLift limits the number of game session creation requests
with the same CreatorId in a specified time period. If you your fleet doesn't have a
resource creation limit policy and you provide a CreatorId in your CreateGameSession
requests, Amazon GameLift limits requests to one request per CreatorId per second. To not
limit CreateGameSession requests with the same CreatorId, don't provide a CreatorId in your
CreateGameSession request.
- `"FleetId"`: A unique identifier for the fleet to create a game session in. You can use
either the fleet ID or ARN value. Each request must reference either a fleet ID or alias
ID, but not both.
- `"GameProperties"`: A set of key-value pairs that can store custom data in a game
session. For example: {\"Key\": \"difficulty\", \"Value\": \"novice\"}. For an example, see
Create a game session with custom properties.
- `"GameSessionData"`: A set of custom game session properties, formatted as a single
string value. This data is passed to a game server process with a request to start a new
game session (see Start a Game Session).
- `"GameSessionId"`: This parameter is deprecated. Use IdempotencyToken instead. Custom
string that uniquely identifies a request for a new game session. Maximum token length is
48 characters. If provided, this string is included in the new game session's ID.
- `"IdempotencyToken"`: Custom string that uniquely identifies the new game session
request. This is useful for ensuring that game session requests with the same idempotency
token are processed only once. Subsequent requests with the same string return the original
GameSession object, with an updated status. Maximum token length is 48 characters. If
provided, this string is included in the new game session's ID. A game session ARN has the
following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom
ID string or idempotency token>. Idempotency tokens remain in use for 30 days after a
game session has ended; game session objects are retained for this time period and then
deleted.
- `"Location"`: A fleet's remote location to place the new game session in. If this
parameter is not set, the new game session is placed in the fleet's home Region. Specify a
remote location with an Amazon Web Services Region code such as us-west-2. When using an
Anywhere fleet, this parameter is required and must be set to the Anywhere fleet's custom
location.
- `"Name"`: A descriptive label that is associated with a game session. Session names do
not need to be unique.
"""
function create_game_session(
MaximumPlayerSessionCount; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreateGameSession",
Dict{String,Any}("MaximumPlayerSessionCount" => MaximumPlayerSessionCount);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_game_session(
MaximumPlayerSessionCount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateGameSession",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("MaximumPlayerSessionCount" => MaximumPlayerSessionCount),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_game_session_queue(name)
create_game_session_queue(name, params::Dict{String,<:Any})
Creates a placement queue that processes requests for new game sessions. A queue uses
FleetIQ algorithms to determine the best placement locations and find an available game
server there, then prompts the game server process to start a new game session. A game
session queue is configured with a set of destinations (Amazon GameLift fleets or aliases),
which determine the locations where the queue can place new game sessions. These
destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon
Web Services Regions. If the queue includes multi-location fleets, the queue is able to
place game sessions in all of a fleet's remote locations. You can opt to filter out
individual locations if needed. The queue configuration also determines how FleetIQ selects
the best available placement for a new game session. Before searching for an available game
server, FleetIQ first prioritizes the queue's destinations and locations, with the best
placement locations on top. You can set up the queue to use the FleetIQ default
prioritization or provide an alternate set of priorities. To create a new queue, provide a
name, timeout value, and a list of destinations. Optionally, specify a sort configuration
and/or a filter, and define a set of latency cap policies. You can also include the ARN for
an Amazon Simple Notification Service (SNS) topic to receive notifications of game session
placement activity. Notifications using SNS or CloudWatch events is the preferred way to
track placement activity. If successful, a new GameSessionQueue object is returned with an
assigned queue ARN. New game session requests, which are submitted to queue with
StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN. Learn
more Design a game session queue Create a game session queue Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue |
DeleteGameSessionQueue | All APIs by task
# Arguments
- `name`: A descriptive label that is associated with game session queue. Queue names must
be unique within each Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomEventData"`: Information to be added to all events that are related to this game
session queue.
- `"Destinations"`: A list of fleets and/or fleet aliases that can be used to fulfill game
session placement requests in the queue. Destinations are identified by either a fleet ARN
or a fleet alias ARN, and are listed in order of placement preference.
- `"FilterConfiguration"`: A list of locations where a queue is allowed to place new game
sessions. Locations are specified in the form of Amazon Web Services Region codes, such as
us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
- `"NotificationTarget"`: An SNS topic ARN that is set up to receive game session placement
notifications. See Setting up notifications for game session placement.
- `"PlayerLatencyPolicies"`: A set of policies that act as a sliding cap on player latency.
FleetIQ works to deliver low latency for most players in a game session. These policies
ensure that no individual player can be placed into a game with unreasonably high latency.
Use multiple policies to gradually relax latency requirements a step at a time. Multiple
policies are applied based on their maximum allowed latency, starting with the lowest value.
- `"PriorityConfiguration"`: Custom settings to use when prioritizing destinations and
locations for game session placements. This configuration replaces the FleetIQ default
prioritization process. Priority types that are not explicitly named will be automatically
applied at the end of the prioritization process.
- `"Tags"`: A list of labels to assign to the new game session queue resource. Tags are
developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for
resource management, access management and cost allocation. For more information, see
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
- `"TimeoutInSeconds"`: The maximum time, in seconds, that a new game session placement
request remains in the queue. When a request exceeds this time, the game session placement
changes to a TIMED_OUT status. By default, this property is set to 600.
"""
function create_game_session_queue(Name; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"CreateGameSessionQueue",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_game_session_queue(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreateGameSessionQueue",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_location(location_name)
create_location(location_name, params::Dict{String,<:Any})
Creates a custom location for use in an Anywhere fleet.
# Arguments
- `location_name`: A descriptive name for the custom location.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of labels to assign to the new matchmaking configuration resource. Tags
are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for
resource management, access management and cost allocation. For more information, see
Tagging Amazon Web Services Resources in the Amazon Web Services General Rareference.
"""
function create_location(LocationName; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"CreateLocation",
Dict{String,Any}("LocationName" => LocationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_location(
LocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateLocation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationName" => LocationName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_matchmaking_configuration(acceptance_required, name, request_timeout_seconds, rule_set_name)
create_matchmaking_configuration(acceptance_required, name, request_timeout_seconds, rule_set_name, params::Dict{String,<:Any})
Defines a new matchmaking configuration for use with FlexMatch. Whether your are using
FlexMatch with Amazon GameLift hosting or as a standalone matchmaking service, the
matchmaking configuration sets out rules for matching players and forming teams. If you're
also using Amazon GameLift hosting, it defines how to start game sessions for each match.
Your matchmaking system can use multiple configurations to handle different game scenarios.
All matchmaking requests identify the matchmaking configuration to use and provide player
attributes consistent with that configuration. To create a matchmaking configuration, you
must provide the following: configuration name and FlexMatch mode (with or without Amazon
GameLift hosting); a rule set that specifies how to evaluate players and find acceptable
matches; whether player acceptance is required; and the maximum time allowed for a
matchmaking attempt. When using FlexMatch with Amazon GameLift hosting, you also need to
identify the game session queue to use when starting a game session for the match. In
addition, you must set up an Amazon Simple Notification Service topic to receive
matchmaking notifications. Provide the topic ARN in the matchmaking configuration. Learn
more Design a FlexMatch matchmaker Set up FlexMatch event notification
# Arguments
- `acceptance_required`: A flag that determines whether a match that was created with this
configuration must be accepted by the matched players. To require acceptance, set to TRUE.
With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to
indicate when a completed potential match is waiting for player acceptance.
- `name`: A unique identifier for the matchmaking configuration. This name is used to
identify the configuration associated with a matchmaking request or ticket.
- `request_timeout_seconds`: The maximum duration, in seconds, that a matchmaking ticket
can remain in process before timing out. Requests that fail due to timing out can be
resubmitted as needed.
- `rule_set_name`: A unique identifier for the matchmaking rule set to use with this
configuration. You can use either the rule set name or ARN value. A matchmaking
configuration can only use rule sets that are defined in the same Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptanceTimeoutSeconds"`: The length of time (in seconds) to wait for players to
accept a proposed match, if acceptance is required.
- `"AdditionalPlayerCount"`: The number of player slots in a match to keep open for future
players. For example, if the configuration's rule set specifies a match for a single
10-person team, and the additional player count is set to 2, 10 players will be selected
for the match and 2 more player slots will be open for future players. This parameter is
not used if FlexMatchMode is set to STANDALONE.
- `"BackfillMode"`: The method used to backfill game sessions that are created with this
matchmaking configuration. Specify MANUAL when your game manages backfill requests manually
or does not use the match backfill feature. Specify AUTOMATIC to have Amazon GameLift
create a backfill request whenever a game session has one or more open slots. Learn more
about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic
backfill is not available when FlexMatchMode is set to STANDALONE.
- `"CustomEventData"`: Information to be added to all events related to this matchmaking
configuration.
- `"Description"`: A human-readable description of the matchmaking configuration.
- `"FlexMatchMode"`: Indicates whether this matchmaking configuration is being used with
Amazon GameLift hosting or as a standalone matchmaking solution. STANDALONE - FlexMatch
forms matches and returns match information, including players and team assignments, in a
MatchmakingSucceeded event. WITH_QUEUE - FlexMatch forms matches and uses the specified
Amazon GameLift queue to start a game session for the match.
- `"GameProperties"`: A set of key-value pairs that can store custom data in a game
session. For example: {\"Key\": \"difficulty\", \"Value\": \"novice\"}. This information is
added to the new GameSession object that is created for a successful match. This parameter
is not used if FlexMatchMode is set to STANDALONE.
- `"GameSessionData"`: A set of custom game session properties, formatted as a single
string value. This data is passed to a game server process with a request to start a new
game session (see Start a Game Session). This information is added to the new GameSession
object that is created for a successful match. This parameter is not used if FlexMatchMode
is set to STANDALONE.
- `"GameSessionQueueArns"`: The Amazon Resource Name (ARN) that is assigned to a Amazon
GameLift game session queue resource and uniquely identifies it. ARNs are unique across all
Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>.
Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted
game sessions for matches that are created with this matchmaking configuration. If
FlexMatchMode is set to STANDALONE, do not set this parameter.
- `"NotificationTarget"`: An SNS topic ARN that is set up to receive matchmaking
notifications. See Setting up notifications for matchmaking for more information.
- `"Tags"`: A list of labels to assign to the new matchmaking configuration resource. Tags
are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for
resource management, access management and cost allocation. For more information, see
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
"""
function create_matchmaking_configuration(
AcceptanceRequired,
Name,
RequestTimeoutSeconds,
RuleSetName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateMatchmakingConfiguration",
Dict{String,Any}(
"AcceptanceRequired" => AcceptanceRequired,
"Name" => Name,
"RequestTimeoutSeconds" => RequestTimeoutSeconds,
"RuleSetName" => RuleSetName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_matchmaking_configuration(
AcceptanceRequired,
Name,
RequestTimeoutSeconds,
RuleSetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateMatchmakingConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AcceptanceRequired" => AcceptanceRequired,
"Name" => Name,
"RequestTimeoutSeconds" => RequestTimeoutSeconds,
"RuleSetName" => RuleSetName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_matchmaking_rule_set(name, rule_set_body)
create_matchmaking_rule_set(name, rule_set_body, params::Dict{String,<:Any})
Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to
create, such as the number and size of teams. It also sets the parameters for acceptable
player matches, such as minimum skill level or character type. To create a matchmaking rule
set, provide unique rule set name and the rule set body in JSON format. Rule sets must be
defined in the same Region as the matchmaking configuration they are used with. Since
matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax
using ValidateMatchmakingRuleSet before creating a new rule set. Learn more Build a
rule set Design a matchmaker Matchmaking with FlexMatch
# Arguments
- `name`: A unique identifier for the matchmaking rule set. A matchmaking configuration
identifies the rule set it uses by this name value. Note that the rule set name is
different from the optional name field in the rule set body.
- `rule_set_body`: A collection of matchmaking rules, formatted as a JSON string. Comments
are not allowed in JSON, but most elements support a description field.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: A list of labels to assign to the new matchmaking rule set resource. Tags are
developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for
resource management, access management and cost allocation. For more information, see
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
"""
function create_matchmaking_rule_set(
Name, RuleSetBody; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreateMatchmakingRuleSet",
Dict{String,Any}("Name" => Name, "RuleSetBody" => RuleSetBody);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_matchmaking_rule_set(
Name,
RuleSetBody,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateMatchmakingRuleSet",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "RuleSetBody" => RuleSetBody),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_player_session(game_session_id, player_id)
create_player_session(game_session_id, player_id, params::Dict{String,<:Any})
Reserves an open player slot in a game session for a player. New player sessions can be
created in any game session with an open slot that is in ACTIVE status and has a player
creation policy of ACCEPT_ALL. You can add a group of players to a game session with
CreatePlayerSessions . To create a player session, specify a game session ID, player ID,
and optionally a set of player data. If successful, a slot is reserved in the game session
for the player and a new PlayerSessions object is returned with a player session ID. The
player references the player session ID when sending a connection request to the game
session, and the game server can use it to validate the player reservation with the Amazon
GameLift service. Player sessions cannot be updated. The maximum number of players per
game session is 200. It is not adjustable. Related actions All APIs by task
# Arguments
- `game_session_id`: A unique identifier for the game session to add a player to.
- `player_id`: A unique identifier for a player. Player IDs are developer-defined.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PlayerData"`: Developer-defined information related to a player. Amazon GameLift does
not use this data, so it can be formatted as needed for use in the game.
"""
function create_player_session(
GameSessionId, PlayerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreatePlayerSession",
Dict{String,Any}("GameSessionId" => GameSessionId, "PlayerId" => PlayerId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_player_session(
GameSessionId,
PlayerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreatePlayerSession",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GameSessionId" => GameSessionId, "PlayerId" => PlayerId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_player_sessions(game_session_id, player_ids)
create_player_sessions(game_session_id, player_ids, params::Dict{String,<:Any})
Reserves open slots in a game session for a group of players. New player sessions can be
created in any game session with an open slot that is in ACTIVE status and has a player
creation policy of ACCEPT_ALL. To add a single player to a game session, use
CreatePlayerSession To create player sessions, specify a game session ID and a list of
player IDs. Optionally, provide a set of player data for each player ID. If successful, a
slot is reserved in the game session for each player, and new PlayerSession objects are
returned with player session IDs. Each player references their player session ID when
sending a connection request to the game session, and the game server can use it to
validate the player reservation with the Amazon GameLift service. Player sessions cannot be
updated. The maximum number of players per game session is 200. It is not adjustable.
Related actions All APIs by task
# Arguments
- `game_session_id`: A unique identifier for the game session to add players to.
- `player_ids`: List of unique identifiers for the players to be added.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PlayerDataMap"`: Map of string pairs, each specifying a player ID and a set of
developer-defined information related to the player. Amazon GameLift does not use this
data, so it can be formatted as needed for use in the game. Any player data strings for
player IDs that are not included in the PlayerIds parameter are ignored.
"""
function create_player_sessions(
GameSessionId, PlayerIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreatePlayerSessions",
Dict{String,Any}("GameSessionId" => GameSessionId, "PlayerIds" => PlayerIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_player_sessions(
GameSessionId,
PlayerIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreatePlayerSessions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameSessionId" => GameSessionId, "PlayerIds" => PlayerIds
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_script()
create_script(params::Dict{String,<:Any})
Creates a new script record for your Realtime Servers script. Realtime scripts are
JavaScript that provide configuration settings and optional custom game logic for your
game. The script is deployed when you create a Realtime Servers fleet to host your game
sessions. Script logic is executed during an active game session. To create a new script
record, specify a script name and provide the script file(s). The script files and all
dependencies must be zipped into a single file. You can pull the zip file from either of
these locations: A locally available directory. Use the ZipFile parameter for this
option. An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web
Services account. Use the StorageLocation parameter for this option. You'll need to have an
Identity Access Management (IAM) role that allows the Amazon GameLift service to access
your S3 bucket. If the call is successful, a new script record is created with a unique
script ID. If the script file is provided as a local file, the file is uploaded to an
Amazon GameLift-owned S3 bucket and the script record's storage location reflects this
location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file
at this storage location as needed for deployment. Learn more Amazon GameLift Realtime
Servers Set Up a Role for Amazon GameLift Access Related actions All APIs by task
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: A descriptive label that is associated with a script. Script names don't need
to be unique. You can use UpdateScript to change this value later.
- `"StorageLocation"`: The location of the Amazon S3 bucket where a zipped file containing
your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket
name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access
the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to
create a new script. By default, Amazon GameLift uploads the latest version of the zip
file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter
to specify an earlier version.
- `"Tags"`: A list of labels to assign to the new script resource. Tags are
developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for
resource management, access management and cost allocation. For more information, see
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once
the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to
add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon
Web Services General Reference for actual tagging limits.
- `"Version"`: Version information associated with a build or script. Version strings don't
need to be unique. You can use UpdateScript to change this value later.
- `"ZipFile"`: A data object containing your Realtime scripts and dependencies as a zip
file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB. When
using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip
file name. It must be prepended with the string \"fileb://\" to indicate that the file data
is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.
"""
function create_script(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift("CreateScript"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_script(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreateScript", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_vpc_peering_authorization(game_lift_aws_account_id, peer_vpc_id)
create_vpc_peering_authorization(game_lift_aws_account_id, peer_vpc_id, params::Dict{String,<:Any})
Requests authorization to create or delete a peer connection between the VPC for your
Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services
account. VPC peering enables the game servers on your fleet to communicate directly with
other Amazon Web Services resources. After you've received authorization, use
CreateVpcPeeringConnection to establish the peering connection. For more information, see
VPC Peering with Amazon GameLift Fleets. You can peer with VPCs that are owned by any
Amazon Web Services account you have access to, including the account that you use to
manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different
Regions. To request authorization to create a connection, call this operation from the
Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift
fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use
the account that manages that DynamoDB resource. Identify the following values: (1) The ID
of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account
that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the
specified VPC. To request authorization to delete a connection, call this operation from
the Amazon Web Services account with the VPC that is peered with your Amazon GameLift
fleet. Identify the following values: (1) VPC ID that you want to delete the peering
connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon
GameLift. The authorization remains valid for 24 hours unless it is canceled. You must
create or delete the peering connection while the authorization is valid. Related actions
All APIs by task
# Arguments
- `game_lift_aws_account_id`: A unique identifier for the Amazon Web Services account that
you use to manage your Amazon GameLift fleet. You can find your Account ID in the Amazon
Web Services Management Console under account settings.
- `peer_vpc_id`: A unique identifier for a VPC with resources to be accessed by your Amazon
GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use
the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC
peering in VPC Peering with Amazon GameLift Fleets.
"""
function create_vpc_peering_authorization(
GameLiftAwsAccountId, PeerVpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"CreateVpcPeeringAuthorization",
Dict{String,Any}(
"GameLiftAwsAccountId" => GameLiftAwsAccountId, "PeerVpcId" => PeerVpcId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpc_peering_authorization(
GameLiftAwsAccountId,
PeerVpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateVpcPeeringAuthorization",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameLiftAwsAccountId" => GameLiftAwsAccountId, "PeerVpcId" => PeerVpcId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vpc_peering_connection(fleet_id, peer_vpc_aws_account_id, peer_vpc_id)
create_vpc_peering_connection(fleet_id, peer_vpc_aws_account_id, peer_vpc_id, params::Dict{String,<:Any})
Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web
Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game
servers on your fleet to communicate directly with other Amazon Web Services resources. You
can peer with VPCs in any Amazon Web Services account that you have access to, including
the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs
that are in different Regions. For more information, see VPC Peering with Amazon GameLift
Fleets. Before calling this operation to establish the peering connection, you first need
to use CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the
authorization for the specified VPC is issued, you have 24 hours to establish the
connection. These two operations handle all tasks necessary to peer the two VPCs, including
acceptance, updating routing tables, etc. To establish the connection, call this operation
from the Amazon Web Services account that is used to manage the Amazon GameLift fleets.
Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering
connection for; (2) The Amazon Web Services account with the VPC that you want to peer
with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If
successful, a connection request is created. You can use continuous polling to track the
request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for
success or failure using DescribeFleetEvents . Related actions All APIs by task
# Arguments
- `fleet_id`: A unique identifier for the fleet. You can use either the fleet ID or ARN
value. This tells Amazon GameLift which GameLift VPC to peer with.
- `peer_vpc_aws_account_id`: A unique identifier for the Amazon Web Services account with
the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID
in the Amazon Web Services Management Console under account settings.
- `peer_vpc_id`: A unique identifier for a VPC with resources to be accessed by your Amazon
GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use
the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC
peering in VPC Peering with Amazon GameLift Fleets.
"""
function create_vpc_peering_connection(
FleetId,
PeerVpcAwsAccountId,
PeerVpcId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateVpcPeeringConnection",
Dict{String,Any}(
"FleetId" => FleetId,
"PeerVpcAwsAccountId" => PeerVpcAwsAccountId,
"PeerVpcId" => PeerVpcId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vpc_peering_connection(
FleetId,
PeerVpcAwsAccountId,
PeerVpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"CreateVpcPeeringConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FleetId" => FleetId,
"PeerVpcAwsAccountId" => PeerVpcAwsAccountId,
"PeerVpcId" => PeerVpcId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_alias(alias_id)
delete_alias(alias_id, params::Dict{String,<:Any})
Deletes an alias. This operation removes all record of the alias. Game clients attempting
to access a server process using the deleted alias receive an error. To delete an alias,
specify the alias ID to be deleted. Related actions All APIs by task
# Arguments
- `alias_id`: A unique identifier of the alias that you want to delete. You can use either
the alias ID or ARN value.
"""
function delete_alias(AliasId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DeleteAlias",
Dict{String,Any}("AliasId" => AliasId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_alias(
AliasId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteAlias",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("AliasId" => AliasId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_build(build_id)
delete_build(build_id, params::Dict{String,<:Any})
Deletes a build. This operation permanently deletes the build resource and any uploaded
build files. Deleting a build does not affect the status of any active fleets using the
build, but you can no longer create new fleets with the deleted build. To delete a build,
specify the build ID. Learn more Upload a Custom Server Build All APIs by task
# Arguments
- `build_id`: A unique identifier for the build to delete. You can use either the build ID
or ARN value.
"""
function delete_build(BuildId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DeleteBuild",
Dict{String,Any}("BuildId" => BuildId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_build(
BuildId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteBuild",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("BuildId" => BuildId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_container_group_definition(name)
delete_container_group_definition(name, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift containers feature, which is currently in
public preview. Deletes a container group definition resource. You can delete a container
group definition if there are no fleets using the definition. To delete a container group
definition, identify the resource to delete. Learn more Manage a container group
definition
# Arguments
- `name`: The unique identifier for the container group definition to delete. You can use
either the Name or ARN value.
"""
function delete_container_group_definition(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteContainerGroupDefinition",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_container_group_definition(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteContainerGroupDefinition",
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 all resources and information related to a fleet and shuts down any currently
running fleet instances, including those in remote locations. If the fleet being deleted
has a VPC peering connection, you first need to get a valid authorization (good for 24
hours) by calling CreateVpcPeeringAuthorization. You don't need to explicitly delete the
VPC peering connection. To delete a fleet, specify the fleet ID to be terminated. During
the deletion process, the fleet status is changed to DELETING. When completed, the status
switches to TERMINATED and the fleet event FLEET_DELETED is emitted. Learn more Setting
up Amazon GameLift Fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to be deleted. You can use either the fleet
ID or ARN value.
"""
function delete_fleet(FleetId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"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 gamelift(
"DeleteFleet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fleet_locations(fleet_id, locations)
delete_fleet_locations(fleet_id, locations, params::Dict{String,<:Any})
Removes locations from a multi-location fleet. When deleting a location, all game server
process and all instances that are still active in the location are shut down. To delete
fleet locations, identify the fleet ID and provide a list of the locations to be deleted.
If successful, GameLift sets the location status to DELETING, and begins to shut down
existing server processes and terminate instances in each location being deleted. When
completed, the location status changes to TERMINATED. Learn more Setting up Amazon
GameLift fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to delete locations for. You can use either
the fleet ID or ARN value.
- `locations`: The list of fleet locations to delete. Specify locations in the form of an
Amazon Web Services Region code, such as us-west-2.
"""
function delete_fleet_locations(
FleetId, Locations; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteFleetLocations",
Dict{String,Any}("FleetId" => FleetId, "Locations" => Locations);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fleet_locations(
FleetId,
Locations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DeleteFleetLocations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FleetId" => FleetId, "Locations" => Locations),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_game_server_group(game_server_group_name)
delete_game_server_group(game_server_group_name, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Terminates a game server group and permanently deletes the game server group record. You
have several options for how these resources are impacted when deleting the game server
group. Depending on the type of delete operation selected, this operation might affect
these resources: The game server group The corresponding Auto Scaling group All game
servers that are currently running in the group To delete a game server group, identify
the game server group to delete and specify the type of delete operation to initiate. Game
server groups can only be deleted if they are in ACTIVE or ERROR status. If the delete
request is successful, a series of operations are kicked off. The game server group status
is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and
stops automatic scaling activity. Once all game servers in the game server group are
deregistered, Amazon GameLift FleetIQ can begin deleting resources. If any of the delete
operations fail, the game server group is placed in ERROR status. Amazon GameLift FleetIQ
emits delete events to Amazon CloudWatch. Learn more Amazon GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group. Use either the
name or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeleteOption"`: The type of delete to perform. Options include the following:
SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling
group only when it has no game servers that are in UTILIZED status. FORCE_DELETE –
Terminates the game server group, including all active game servers regardless of their
utilization status, and the Amazon EC2 Auto Scaling group. RETAIN – Does a safe
delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.
"""
function delete_game_server_group(
GameServerGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteGameServerGroup",
Dict{String,Any}("GameServerGroupName" => GameServerGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_game_server_group(
GameServerGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DeleteGameServerGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GameServerGroupName" => GameServerGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_game_session_queue(name)
delete_game_session_queue(name, params::Dict{String,<:Any})
Deletes a game session queue. Once a queue is successfully deleted, unfulfilled
StartGameSessionPlacement requests that reference the queue will fail. To delete a queue,
specify the queue name.
# Arguments
- `name`: A descriptive label that is associated with game session queue. Queue names must
be unique within each Region. You can use either the queue ID or ARN value.
"""
function delete_game_session_queue(Name; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DeleteGameSessionQueue",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_game_session_queue(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteGameSessionQueue",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_location(location_name)
delete_location(location_name, params::Dict{String,<:Any})
Deletes a custom location. Before deleting a custom location, review any fleets currently
using the custom location and deregister the location if it is in use. For more
information, see DeregisterCompute.
# Arguments
- `location_name`: The location name of the custom location to be deleted.
"""
function delete_location(LocationName; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DeleteLocation",
Dict{String,Any}("LocationName" => LocationName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_location(
LocationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DeleteLocation",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("LocationName" => LocationName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_matchmaking_configuration(name)
delete_matchmaking_configuration(name, params::Dict{String,<:Any})
Permanently removes a FlexMatch matchmaking configuration. To delete, specify the
configuration name. A matchmaking configuration cannot be deleted if it is being used in
any active matchmaking tickets.
# Arguments
- `name`: A unique identifier for the matchmaking configuration. You can use either the
configuration name or ARN value.
"""
function delete_matchmaking_configuration(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteMatchmakingConfiguration",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_matchmaking_configuration(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteMatchmakingConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_matchmaking_rule_set(name)
delete_matchmaking_rule_set(name, params::Dict{String,<:Any})
Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set
name. Rule sets cannot be deleted if they are currently being used by a matchmaking
configuration. Learn more Build a rule set
# Arguments
- `name`: A unique identifier for the matchmaking rule set to be deleted. (Note: The rule
set name is different from the optional \"name\" field in the rule set body.) You can use
either the rule set name or ARN value.
"""
function delete_matchmaking_rule_set(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteMatchmakingRuleSet",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_matchmaking_rule_set(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteMatchmakingRuleSet",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_scaling_policy(fleet_id, name)
delete_scaling_policy(fleet_id, name, params::Dict{String,<:Any})
Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon
GameLift removes all record of it. To delete a scaling policy, specify both the scaling
policy name and the fleet ID it is associated with. To temporarily suspend scaling
policies, use StopFleetActions. This operation suspends all policies for the fleet.
# Arguments
- `fleet_id`: A unique identifier for the fleet to be deleted. You can use either the fleet
ID or ARN value.
- `name`: A descriptive label that is associated with a fleet's scaling policy. Policy
names do not need to be unique.
"""
function delete_scaling_policy(
FleetId, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteScalingPolicy",
Dict{String,Any}("FleetId" => FleetId, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_scaling_policy(
FleetId,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DeleteScalingPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("FleetId" => FleetId, "Name" => Name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_script(script_id)
delete_script(script_id, params::Dict{String,<:Any})
Deletes a Realtime script. This operation permanently deletes the script record. If script
files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).
To delete a script, specify the script ID. Before deleting a script, be sure to terminate
all fleets that are deployed with the script being deleted. Fleet instances periodically
check for script updates, and if the script record no longer exists, the instance will go
into an error state and be unable to host game sessions. Learn more Amazon GameLift
Realtime Servers Related actions All APIs by task
# Arguments
- `script_id`: A unique identifier for the Realtime script to delete. You can use either
the script ID or ARN value.
"""
function delete_script(ScriptId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DeleteScript",
Dict{String,Any}("ScriptId" => ScriptId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_script(
ScriptId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DeleteScript",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ScriptId" => ScriptId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpc_peering_authorization(game_lift_aws_account_id, peer_vpc_id)
delete_vpc_peering_authorization(game_lift_aws_account_id, peer_vpc_id, params::Dict{String,<:Any})
Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an
existing VPC peering connection, use DeleteVpcPeeringConnection. Related actions All
APIs by task
# Arguments
- `game_lift_aws_account_id`: A unique identifier for the Amazon Web Services account that
you use to manage your Amazon GameLift fleet. You can find your Account ID in the Amazon
Web Services Management Console under account settings.
- `peer_vpc_id`: A unique identifier for a VPC with resources to be accessed by your Amazon
GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use
the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC
peering in VPC Peering with Amazon GameLift Fleets.
"""
function delete_vpc_peering_authorization(
GameLiftAwsAccountId, PeerVpcId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteVpcPeeringAuthorization",
Dict{String,Any}(
"GameLiftAwsAccountId" => GameLiftAwsAccountId, "PeerVpcId" => PeerVpcId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpc_peering_authorization(
GameLiftAwsAccountId,
PeerVpcId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DeleteVpcPeeringAuthorization",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameLiftAwsAccountId" => GameLiftAwsAccountId, "PeerVpcId" => PeerVpcId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vpc_peering_connection(fleet_id, vpc_peering_connection_id)
delete_vpc_peering_connection(fleet_id, vpc_peering_connection_id, params::Dict{String,<:Any})
Removes a VPC peering connection. To delete the connection, you must have a valid
authorization for the VPC peering connection that you want to delete.. Once a valid
authorization exists, call this operation from the Amazon Web Services account that is used
to manage the Amazon GameLift fleets. Identify the connection to delete by the connection
ID and fleet ID. If successful, the connection is removed. Related actions All APIs by
task
# Arguments
- `fleet_id`: A unique identifier for the fleet. This fleet specified must match the fleet
referenced in the VPC peering connection record. You can use either the fleet ID or ARN
value.
- `vpc_peering_connection_id`: A unique identifier for a VPC peering connection.
"""
function delete_vpc_peering_connection(
FleetId, VpcPeeringConnectionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeleteVpcPeeringConnection",
Dict{String,Any}(
"FleetId" => FleetId, "VpcPeeringConnectionId" => VpcPeeringConnectionId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vpc_peering_connection(
FleetId,
VpcPeeringConnectionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DeleteVpcPeeringConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FleetId" => FleetId, "VpcPeeringConnectionId" => VpcPeeringConnectionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_compute(compute_name, fleet_id)
deregister_compute(compute_name, fleet_id, params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Removes a compute resource from an Amazon GameLift
Anywhere fleet or container fleet. Deregistered computes can no longer host game sessions
through Amazon GameLift. For an Anywhere fleet or a container fleet that's running the
Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an
Anywhere fleet that doesn't use the Agent, call this operation to deregister fleet
computes. To deregister a compute, call this operation from the compute that's being
deregistered and specify the compute name and the fleet ID.
# Arguments
- `compute_name`: The unique identifier of the compute resource to deregister. For an
Anywhere fleet compute, use the registered compute name. For a container fleet, use the
compute name (for example,
a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9) or the compute ARN.
- `fleet_id`: A unique identifier for the fleet the compute resource is currently
registered to.
"""
function deregister_compute(
ComputeName, FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeregisterCompute",
Dict{String,Any}("ComputeName" => ComputeName, "FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_compute(
ComputeName,
FleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DeregisterCompute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ComputeName" => ComputeName, "FleetId" => FleetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_game_server(game_server_group_name, game_server_id)
deregister_game_server(game_server_group_name, game_server_id, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Removes the game server from a game server group. As a result of this operation, the
deregistered game server can no longer be claimed and will not be returned in a list of
active game servers. To deregister a game server, specify the game server group and game
server ID. If successful, this operation emits a CloudWatch event with termination
timestamp and reason. Learn more Amazon GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group where the game
server is running.
- `game_server_id`: A custom string that uniquely identifies the game server to deregister.
"""
function deregister_game_server(
GameServerGroupName, GameServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DeregisterGameServer",
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName, "GameServerId" => GameServerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_game_server(
GameServerGroupName,
GameServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DeregisterGameServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName,
"GameServerId" => GameServerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_alias(alias_id)
describe_alias(alias_id, params::Dict{String,<:Any})
Retrieves properties for an alias. This operation returns all alias metadata and settings.
To get an alias's target fleet ID only, use ResolveAlias. To get alias properties, specify
the alias ID. If successful, the requested alias record is returned. Related actions All
APIs by task
# Arguments
- `alias_id`: The unique identifier for the fleet alias that you want to retrieve. You can
use either the alias ID or ARN value.
"""
function describe_alias(AliasId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeAlias",
Dict{String,Any}("AliasId" => AliasId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_alias(
AliasId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeAlias",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("AliasId" => AliasId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_build(build_id)
describe_build(build_id, params::Dict{String,<:Any})
Retrieves properties for a custom game build. To request a build resource, specify a build
ID. If successful, an object containing the build properties is returned. Learn more
Upload a Custom Server Build All APIs by task
# Arguments
- `build_id`: A unique identifier for the build to retrieve properties for. You can use
either the build ID or ARN value.
"""
function describe_build(BuildId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeBuild",
Dict{String,Any}("BuildId" => BuildId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_build(
BuildId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeBuild",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("BuildId" => BuildId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_compute(compute_name, fleet_id)
describe_compute(compute_name, fleet_id, params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Retrieves properties for a compute resource in an Amazon
GameLift fleet. To get a list of all computes in a fleet, call ListCompute. To request
information on a specific compute, provide the fleet ID and compute name. If successful,
this operation returns details for the requested compute resource. Depending on the fleet's
compute type, the result includes the following information: For EC2 fleets, this
operation returns information about the EC2 instance. For ANYWHERE fleets, this operation
returns information about the registered compute. For CONTAINER fleets, this operation
returns information about the container that's registered as a compute, and the instance
it's running on. The compute name is the container name.
# Arguments
- `compute_name`: The unique identifier of the compute resource to retrieve properties for.
For an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance,
use the instance ID. For a container fleet, use the compute name (for example,
a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9) or the compute ARN.
- `fleet_id`: A unique identifier for the fleet that the compute belongs to. You can use
either the fleet ID or ARN value.
"""
function describe_compute(
ComputeName, FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeCompute",
Dict{String,Any}("ComputeName" => ComputeName, "FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_compute(
ComputeName,
FleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DescribeCompute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ComputeName" => ComputeName, "FleetId" => FleetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_container_group_definition(name)
describe_container_group_definition(name, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift containers feature, which is currently in
public preview. Retrieves the properties of a container group definition, including all
container definitions in the group. To retrieve a container group definition, provide a
resource identifier. If successful, this operation returns the complete properties of the
container group definition. Learn more Manage a container group definition
# Arguments
- `name`: The unique identifier for the container group definition to retrieve properties
for. You can use either the Name or ARN value.
"""
function describe_container_group_definition(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeContainerGroupDefinition",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_container_group_definition(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeContainerGroupDefinition",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ec2_instance_limits()
describe_ec2_instance_limits(params::Dict{String,<:Any})
Retrieves the instance limits and current utilization for an Amazon Web Services Region or
location. Instance limits control the number of instances, per instance type, per location,
that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The
information returned includes the maximum number of instances allowed and your account's
current usage across all fleets. This information can affect your ability to scale your
Amazon GameLift fleets. You can request a limit increase for your account by using the
Service limits page in the Amazon GameLift console. Instance limits differ based on whether
the instances are deployed in a fleet's home Region or in a remote location. For remote
locations, limits also differ based on the combination of home Region and remote location.
All requests must specify an Amazon Web Services Region (either explicitly or as your
default settings). To get the limit for a remote location, you must also specify the
location. For example, the following requests all return different results: Request
specifies the Region ap-northeast-1 with no location. The result is limits and usage data
on all instance types that are deployed in us-east-2, by all of the fleets that reside in
ap-northeast-1. Request specifies the Region us-east-1 with location ca-central-1. The
result is limits and usage data on all instance types that are deployed in ca-central-1, by
all of the fleets that reside in us-east-2. These limits do not affect fleets in any other
Regions that deploy instances to ca-central-1. Request specifies the Region eu-west-1
with location ca-central-1. The result is limits and usage data on all instance types that
are deployed in ca-central-1, by all of the fleets that reside in eu-west-1. This
operation can be used in the following ways: To get limit and usage data for all instance
types that are deployed in an Amazon Web Services Region by fleets that reside in the same
Region: Specify the Region only. Optionally, specify a single instance type to retrieve
information for. To get limit and usage data for all instance types that are deployed to
a remote location by fleets that reside in different Amazon Web Services Region: Provide
both the Amazon Web Services Region and the remote location. Optionally, specify a single
instance type to retrieve information for. If successful, an EC2InstanceLimits object is
returned with limits and usage data for each requested instance type. Learn more Setting
up Amazon GameLift fleets
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EC2InstanceType"`: Name of an Amazon EC2 instance type that is supported in Amazon
GameLift. A fleet instance type determines the computing resources of each instance in the
fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for
this parameter to retrieve limits for all instance types.
- `"Location"`: The name of a remote location to request instance limits for, in the form
of an Amazon Web Services Region code such as us-west-2.
"""
function describe_ec2_instance_limits(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeEC2InstanceLimits"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_ec2_instance_limits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeEC2InstanceLimits",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_attributes()
describe_fleet_attributes(params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Retrieves core fleet-wide properties for fleets in an
Amazon Web Services Region. Properties include the computing hardware and deployment
configuration for instances in the fleet. You can use this operation in the following ways:
To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs. To
get attributes for all fleets, do not provide a fleet identifier. When requesting
attributes for multiple fleets, use the pagination parameters to retrieve results as a set
of sequential pages. If successful, a FleetAttributes object is returned for each fleet
requested, unless the fleet identifier is not found. Some API operations limit the number
of fleet IDs that allowed in one request. If a request exceeds this limit, the request
fails and the error message contains the maximum allowed number. Learn more Setting up
Amazon GameLift fleets
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FleetIds"`: A list of unique fleet identifiers to retrieve attributes for. You can use
either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not
include this parameter.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages. This parameter is ignored when the request
specifies one or a list of fleet IDs.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value. This parameter is ignored when the
request specifies one or a list of fleet IDs.
"""
function describe_fleet_attributes(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeFleetAttributes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_fleet_attributes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeFleetAttributes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_capacity()
describe_fleet_capacity(params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Retrieves the resource capacity settings for one or more
fleets. For a container fleet, this operation also returns counts for replica container
groups. With multi-location fleets, this operation retrieves data for the fleet's home
Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity.
This operation can be used in the following ways: To get capacity data for one or more
specific fleets, provide a list of fleet IDs or fleet ARNs. To get capacity data for all
fleets, do not provide a fleet identifier. When requesting multiple fleets, use the
pagination parameters to retrieve results as a set of sequential pages. If successful, a
FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object
includes a Location property, which is set to the fleet's home Region. Capacity values are
returned only for fleets that currently exist. Some API operations may limit the number of
fleet IDs that are allowed in one request. If a request exceeds this limit, the request
fails and the error message includes the maximum allowed. Learn more Setting up Amazon
GameLift fleets GameLift metrics for fleets
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FleetIds"`: A unique identifier for the fleet to retrieve capacity information for. You
can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity
information for all fleets.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages. This parameter is ignored when the request
specifies one or a list of fleet IDs.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value. This parameter is ignored when the
request specifies one or a list of fleet IDs.
"""
function describe_fleet_capacity(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeFleetCapacity"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_fleet_capacity(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeFleetCapacity",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_events(fleet_id)
describe_fleet_events(fleet_id, params::Dict{String,<:Any})
Retrieves entries from a fleet's event log. Fleet events are initiated by changes in
status, such as during fleet creation and termination, changes in capacity, etc. If a fleet
has multiple locations, events are also initiated by changes to status and capacity in
remote locations. You can specify a time range to limit the result set. Use the pagination
parameters to retrieve results as a set of sequential pages. If successful, a collection
of event log entries matching the request are returned. Learn more Setting up Amazon
GameLift fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to get event logs for. You can use either
the fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndTime"`: The most recent date to retrieve event logs for. If no end time is
specified, this call returns entries from the specified start time up to the present.
Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
- `"StartTime"`: The earliest date to retrieve event logs for. If no start time is
specified, this call returns entries starting from when the fleet was created to the
specified end time. Format is a number expressed in Unix time as milliseconds (ex:
\"1469498468.057\").
"""
function describe_fleet_events(FleetId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeFleetEvents",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_events(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeFleetEvents",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_location_attributes(fleet_id)
describe_fleet_location_attributes(fleet_id, params::Dict{String,<:Any})
Retrieves information on a fleet's remote locations, including life-cycle status and any
suspended fleet activity. This operation can be used in the following ways: To get data
for specific locations, provide a fleet identifier and a list of locations. Location data
is returned in the order that it is requested. To get data for all locations, provide a
fleet identifier only. Location data is returned in no particular order. When requesting
attributes for multiple locations, use the pagination parameters to retrieve results as a
set of sequential pages. If successful, a LocationAttributes object is returned for each
requested location. If the fleet does not have a requested location, no information is
returned. This operation does not return the home Region. To get information on a fleet's
home Region, call DescribeFleetAttributes. Learn more Setting up Amazon GameLift fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to retrieve remote locations for. You can
use either the fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages. This limit is not currently enforced.
- `"Locations"`: A list of fleet locations to retrieve information for. Specify locations
in the form of an Amazon Web Services Region code, such as us-west-2.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
"""
function describe_fleet_location_attributes(
FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeFleetLocationAttributes",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_location_attributes(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeFleetLocationAttributes",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_location_capacity(fleet_id, location)
describe_fleet_location_capacity(fleet_id, location, params::Dict{String,<:Any})
Retrieves the resource capacity settings for a fleet location. The data returned includes
the current capacity (number of EC2 instances) and some scaling settings for the requested
fleet location. For a container fleet, this operation also returns counts for replica
container groups. Use this operation to retrieve capacity information for a fleet's remote
location or home Region (you can also retrieve home Region capacity by calling
DescribeFleetCapacity). To retrieve capacity data, identify a fleet and location. If
successful, a FleetCapacity object is returned for the requested fleet location. Learn
more Setting up Amazon GameLift fleets GameLift metrics for fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to request location capacity for. You can
use either the fleet ID or ARN value.
- `location`: The fleet location to retrieve capacity information for. Specify a location
in the form of an Amazon Web Services Region code, such as us-west-2.
"""
function describe_fleet_location_capacity(
FleetId, Location; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeFleetLocationCapacity",
Dict{String,Any}("FleetId" => FleetId, "Location" => Location);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_location_capacity(
FleetId,
Location,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DescribeFleetLocationCapacity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FleetId" => FleetId, "Location" => Location),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_location_utilization(fleet_id, location)
describe_fleet_location_utilization(fleet_id, location, params::Dict{String,<:Any})
Retrieves current usage data for a fleet location. Utilization data provides a snapshot of
current game hosting activity at the requested location. Use this operation to retrieve
utilization information for a fleet's remote location or home Region (you can also retrieve
home Region utilization by calling DescribeFleetUtilization). To retrieve utilization data,
identify a fleet and location. If successful, a FleetUtilization object is returned for
the requested fleet location. Learn more Setting up Amazon GameLift fleets GameLift
metrics for fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to request location utilization for. You
can use either the fleet ID or ARN value.
- `location`: The fleet location to retrieve utilization information for. Specify a
location in the form of an Amazon Web Services Region code, such as us-west-2.
"""
function describe_fleet_location_utilization(
FleetId, Location; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeFleetLocationUtilization",
Dict{String,Any}("FleetId" => FleetId, "Location" => Location);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_location_utilization(
FleetId,
Location,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DescribeFleetLocationUtilization",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FleetId" => FleetId, "Location" => Location),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_port_settings(fleet_id)
describe_fleet_port_settings(fleet_id, params::Dict{String,<:Any})
Retrieves a fleet's inbound connection permissions. Connection permissions specify IP
addresses and port settings that incoming traffic can use to access server processes in the
fleet. Game server processes that are running in the fleet must use a port that falls
within this range. To connect to game server processes on a container fleet, the port
settings should include one or more of the fleet's connection ports. Use this operation in
the following ways: To retrieve the port settings for a fleet, identify the fleet's
unique identifier. To check the status of recent updates to a fleet remote location,
specify the fleet ID and a location. Port setting updates can take time to propagate across
all locations. If successful, a set of IpPermission objects is returned for the
requested fleet ID. When specifying a location, this operation returns a pending status. If
the requested fleet has been deleted, the result set is empty. Learn more Setting up
Amazon GameLift fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to retrieve port settings for. You can use
either the fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Location"`: A remote location to check for status of port setting updates. Use the
Amazon Web Services Region code format, such as us-west-2.
"""
function describe_fleet_port_settings(
FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeFleetPortSettings",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_port_settings(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeFleetPortSettings",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_utilization()
describe_fleet_utilization(params::Dict{String,<:Any})
Retrieves utilization statistics for one or more fleets. Utilization data provides a
snapshot of how the fleet's hosting resources are currently being used. For fleets with
remote locations, this operation retrieves data for the fleet's home Region only. See
DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote
locations. This operation can be used in the following ways: To get utilization data for
one or more specific fleets, provide a list of fleet IDs or fleet ARNs. To get
utilization data for all fleets, do not provide a fleet identifier. When requesting
multiple fleets, use the pagination parameters to retrieve results as a set of sequential
pages. If successful, a FleetUtilization object is returned for each requested fleet ID,
unless the fleet identifier is not found. Each fleet utilization object includes a Location
property, which is set to the fleet's home Region. Some API operations may limit the
number of fleet IDs allowed in one request. If a request exceeds this limit, the request
fails and the error message includes the maximum allowed. Learn more Setting up Amazon
GameLift Fleets GameLift Metrics for Fleets
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FleetIds"`: A unique identifier for the fleet to retrieve utilization data for. You can
use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not
include this parameter.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages. This parameter is ignored when the request
specifies one or a list of fleet IDs.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value. This parameter is ignored when the
request specifies one or a list of fleet IDs.
"""
function describe_fleet_utilization(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeFleetUtilization"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_fleet_utilization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeFleetUtilization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_game_server(game_server_group_name, game_server_id)
describe_game_server(game_server_group_name, game_server_id, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information for a registered game server. Information includes game server
status, health check info, and the instance that the game server is running on. To
retrieve game server information, specify the game server ID. If successful, the requested
game server object is returned. Learn more Amazon GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group where the game
server is running.
- `game_server_id`: A custom string that uniquely identifies the game server information to
be retrieved.
"""
function describe_game_server(
GameServerGroupName, GameServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeGameServer",
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName, "GameServerId" => GameServerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_game_server(
GameServerGroupName,
GameServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DescribeGameServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName,
"GameServerId" => GameServerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_game_server_group(game_server_group_name)
describe_game_server_group(game_server_group_name, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information on a game server group. This operation returns only properties
related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto
Scaling group, such as launch template, auto scaling policies, and maximum/minimum group
size, access the Auto Scaling group directly. To get attributes for a game server group,
provide a group name or ARN value. If successful, a GameServerGroup object is returned.
Learn more Amazon GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group. Use either the
name or ARN value.
"""
function describe_game_server_group(
GameServerGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeGameServerGroup",
Dict{String,Any}("GameServerGroupName" => GameServerGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_game_server_group(
GameServerGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DescribeGameServerGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GameServerGroupName" => GameServerGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_game_server_instances(game_server_group_name)
describe_game_server_instances(game_server_group_name, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a Amazon
GameLift FleetIQ game server group. Use this operation to detect when instances are active
or not available to host new game servers. To request status for all instances in the game
server group, provide a game server group ID only. To request status for specific
instances, provide the game server group ID and one or more instance IDs. Use the
pagination parameters to retrieve results in sequential segments. If successful, a
collection of GameServerInstance objects is returned. This operation is not designed to be
called with every game server claim request; this practice can cause you to exceed your API
limit, which results in errors. Instead, as a best practice, cache the results and refresh
your cache no more than once every 10 seconds. Learn more Amazon GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group. Use either the
name or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceIds"`: The Amazon EC2 instance IDs that you want to retrieve status on. Amazon
EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve
all instances in the game server group, leave this parameter empty.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
"""
function describe_game_server_instances(
GameServerGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeGameServerInstances",
Dict{String,Any}("GameServerGroupName" => GameServerGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_game_server_instances(
GameServerGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DescribeGameServerInstances",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GameServerGroupName" => GameServerGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_game_session_details()
describe_game_session_details(params::Dict{String,<:Any})
Retrieves additional game session properties, including the game session protection policy
in force, a set of one or more game sessions in a specific fleet location. You can
optionally filter the results by current game session status. This operation can be used in
the following ways: To retrieve details for all game sessions that are currently running
on all locations in a fleet, provide a fleet or alias ID, with an optional status filter.
This approach returns details from the fleet's home Region and all remote locations. To
retrieve details for all game sessions that are currently running on a specific fleet
location, provide a fleet or alias ID and a location name, with optional status filter. The
location can be the fleet's home Region or any remote location. To retrieve details for a
specific game session, provide the game session ID. This approach looks for the game
session ID in all fleets that reside in the Amazon Web Services Region defined in the
request. Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSessionDetail object is returned for each game session that matches
the request. Learn more Find a game session All APIs by task
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AliasId"`: A unique identifier for the alias associated with the fleet to retrieve all
game sessions for. You can use either the alias ID or ARN value.
- `"FleetId"`: A unique identifier for the fleet to retrieve all game sessions active on
the fleet. You can use either the fleet ID or ARN value.
- `"GameSessionId"`: A unique identifier for the game session to retrieve.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"Location"`: A fleet location to get game session details for. You can specify a fleet's
home Region or a remote location. Use the Amazon Web Services Region code format, such as
us-west-2.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
- `"StatusFilter"`: Game session status to filter results on. Possible game session
statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are
transitory).
"""
function describe_game_session_details(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeGameSessionDetails"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_game_session_details(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeGameSessionDetails",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_game_session_placement(placement_id)
describe_game_session_placement(placement_id, params::Dict{String,<:Any})
Retrieves information, including current status, about a game session placement request.
To get game session placement details, specify the placement ID. This operation is not
designed to be continually called to track game session status. This practice can cause you
to exceed your API limit, which results in errors. Instead, you must configure configure an
Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or
queues. Continuously polling with DescribeGameSessionPlacement should only be used for
games in development with low game session usage.
# Arguments
- `placement_id`: A unique identifier for a game session placement to retrieve.
"""
function describe_game_session_placement(
PlacementId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeGameSessionPlacement",
Dict{String,Any}("PlacementId" => PlacementId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_game_session_placement(
PlacementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DescribeGameSessionPlacement",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PlacementId" => PlacementId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_game_session_queues()
describe_game_session_queues(params::Dict{String,<:Any})
Retrieves the properties for one or more game session queues. When requesting multiple
queues, use the pagination parameters to retrieve results as a set of sequential pages.
When specifying a list of queues, objects are returned only for queues that currently exist
in the Region. Learn more View Your Queues
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages. You can request up to 50 results.
- `"Names"`: A list of queue names to retrieve information for. You can use either the
queue ID or ARN value. To request settings for all queues, leave this parameter empty.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
"""
function describe_game_session_queues(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeGameSessionQueues"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_game_session_queues(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeGameSessionQueues",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_game_sessions()
describe_game_sessions(params::Dict{String,<:Any})
Retrieves a set of one or more game sessions in a specific fleet location. You can
optionally filter the results by current game session status. This operation can be used in
the following ways: To retrieve all game sessions that are currently running on all
locations in a fleet, provide a fleet or alias ID, with an optional status filter. This
approach returns all game sessions in the fleet's home Region and all remote locations.
To retrieve all game sessions that are currently running on a specific fleet location,
provide a fleet or alias ID and a location name, with optional status filter. The location
can be the fleet's home Region or any remote location. To retrieve a specific game
session, provide the game session ID. This approach looks for the game session ID in all
fleets that reside in the Amazon Web Services Region defined in the request. Use the
pagination parameters to retrieve results as a set of sequential pages. If successful, a
GameSession object is returned for each game session that matches the request. This
operation is not designed to be continually called to track game session status. This
practice can cause you to exceed your API limit, which results in errors. Instead, you must
configure an Amazon Simple Notification Service (SNS) topic to receive notifications from
FlexMatch or queues. Continuously polling with DescribeGameSessions should only be used for
games in development with low game session usage. Available in Amazon GameLift Local.
Learn more Find a game session All APIs by task
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AliasId"`: A unique identifier for the alias associated with the fleet to retrieve game
sessions for. You can use either the alias ID or ARN value.
- `"FleetId"`: A unique identifier for the fleet to retrieve game sessions for. You can use
either the fleet ID or ARN value.
- `"GameSessionId"`: A unique identifier for the game session to retrieve.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"Location"`: A fleet location to get game sessions for. You can specify a fleet's home
Region or a remote location. Use the Amazon Web Services Region code format, such as
us-west-2.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
- `"StatusFilter"`: Game session status to filter results on. You can filter on the
following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are
transitory and used for only very brief periods of time.
"""
function describe_game_sessions(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeGameSessions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_game_sessions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeGameSessions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_instances(fleet_id)
describe_instances(fleet_id, params::Dict{String,<:Any})
Retrieves information about the EC2 instances in an Amazon GameLift managed fleet,
including instance ID, connection data, and status. You can use this operation with a
multi-location fleet to get location-specific instance information. As an alternative, use
the operations ListCompute and DescribeCompute to retrieve information for compute
resources, including EC2 and Anywhere fleets. You can call this operation in the following
ways: To get information on all instances in a fleet's home Region, specify the fleet ID.
To get information on all instances in a fleet's remote location, specify the fleet ID
and location name. To get information on a specific instance in a fleet, specify the
fleet ID and instance ID. Use the pagination parameters to retrieve results as a set of
sequential pages. If successful, this operation returns Instance objects for each
requested instance, listed in no particular order. If you call this operation for an
Anywhere fleet, you receive an InvalidRequestException. Learn more Remotely connect to
fleet instances Debug fleet issues Related actions All APIs by task
# Arguments
- `fleet_id`: A unique identifier for the fleet to retrieve instance information for. You
can use either the fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InstanceId"`: A unique identifier for an instance to retrieve. Specify an instance ID
or leave blank to retrieve all instances in the fleet.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"Location"`: The name of a location to retrieve instance information for, in the form of
an Amazon Web Services Region code such as us-west-2.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
"""
function describe_instances(FleetId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeInstances",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_instances(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeInstances",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_matchmaking(ticket_ids)
describe_matchmaking(ticket_ids, params::Dict{String,<:Any})
Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket
information, including--after a successful match is made--connection information for the
resulting new game session. To request matchmaking tickets, provide a list of up to 10
ticket IDs. If the request is successful, a ticket object is returned for each requested ID
that currently exists. This operation is not designed to be continually called to track
matchmaking ticket status. This practice can cause you to exceed your API limit, which
results in errors. Instead, as a best practice, set up an Amazon Simple Notification
Service to receive notifications, and provide the topic ARN in the matchmaking
configuration. Learn more Add FlexMatch to a game client Set Up FlexMatch event
notification
# Arguments
- `ticket_ids`: A unique identifier for a matchmaking ticket. You can include up to 10 ID
values.
"""
function describe_matchmaking(TicketIds; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeMatchmaking",
Dict{String,Any}("TicketIds" => TicketIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_matchmaking(
TicketIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DescribeMatchmaking",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TicketIds" => TicketIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_matchmaking_configurations()
describe_matchmaking_configurations(params::Dict{String,<:Any})
Retrieves the details of FlexMatch matchmaking configurations. This operation offers the
following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations
for a specified list, or (3) retrieve all configurations that use a specified rule set
name. When requesting multiple items, use the pagination parameters to retrieve results as
a set of sequential pages. If successful, a configuration is returned for each requested
name. When specifying a list of names, only configurations that currently exist are
returned. Learn more Setting up FlexMatch matchmakers
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages. This parameter is limited to 10.
- `"Names"`: A unique identifier for the matchmaking configuration(s) to retrieve. You can
use either the configuration name or ARN value. To request all existing configurations,
leave this parameter empty.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
- `"RuleSetName"`: A unique identifier for the matchmaking rule set. You can use either the
rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations
that use this rule set.
"""
function describe_matchmaking_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeMatchmakingConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_matchmaking_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeMatchmakingConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_matchmaking_rule_sets()
describe_matchmaking_rule_sets(params::Dict{String,<:Any})
Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing
rule sets for the Region, or provide a list of one or more rule set names. When requesting
multiple items, use the pagination parameters to retrieve results as a set of sequential
pages. If successful, a rule set is returned for each requested name. Learn more
Build a rule set
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"Names"`: A list of one or more matchmaking rule set names to retrieve details for.
(Note: The rule set name is different from the optional \"name\" field in the rule set
body.) You can use either the rule set name or ARN value.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
"""
function describe_matchmaking_rule_sets(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeMatchmakingRuleSets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_matchmaking_rule_sets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeMatchmakingRuleSets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_player_sessions()
describe_player_sessions(params::Dict{String,<:Any})
Retrieves properties for one or more player sessions. This action can be used in the
following ways: To retrieve a specific player session, provide the player session ID
only. To retrieve all player sessions in a game session, provide the game session ID
only. To retrieve all player sessions for a specific player, provide a player ID only.
To request player sessions, specify either a player session ID, game session ID, or player
ID. You can filter this request by player session status. If you provide a specific
PlayerSessionId or PlayerId, Amazon GameLift ignores the filter criteria. Use the
pagination parameters to retrieve results as a set of sequential pages. If successful, a
PlayerSession object is returned for each session that matches the request. Related
actions All APIs by task
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GameSessionId"`: A unique identifier for the game session to retrieve player sessions
for.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages. If a player session ID is specified, this
parameter is ignored.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value. If a player session ID is specified,
this parameter is ignored.
- `"PlayerId"`: A unique identifier for a player to retrieve player sessions for.
- `"PlayerSessionId"`: A unique identifier for a player session to retrieve.
- `"PlayerSessionStatusFilter"`: Player session status to filter results on. Note that when
a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the
PlayerSessionStatusFilter has no effect on the response. Possible player session statuses
include the following: RESERVED -- The player session request has been received, but the
player has not yet connected to the server process and/or been validated. ACTIVE -- The
player has been validated by the server process and is currently connected. COMPLETED --
The player connection has been dropped. TIMEDOUT -- A player session request was
received, but the player did not connect and/or was not validated within the timeout limit
(60 seconds).
"""
function describe_player_sessions(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribePlayerSessions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_player_sessions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribePlayerSessions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_runtime_configuration(fleet_id)
describe_runtime_configuration(fleet_id, params::Dict{String,<:Any})
Retrieves a fleet's runtime configuration settings. The runtime configuration determines
which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the
runtime configuration describes server processes that run on each fleet instance. For
container fleets, the runtime configuration describes server processes that run in each
replica container group. You can update a fleet's runtime configuration at any time using
UpdateRuntimeConfiguration. To get the current runtime configuration for a fleet, provide
the fleet ID. If successful, a RuntimeConfiguration object is returned for the requested
fleet. If the requested fleet has been deleted, the result set is empty. Learn more
Setting up Amazon GameLift fleets Running multiple processes on a fleet
# Arguments
- `fleet_id`: A unique identifier for the fleet to get the runtime configuration for. You
can use either the fleet ID or ARN value.
"""
function describe_runtime_configuration(
FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeRuntimeConfiguration",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_runtime_configuration(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeRuntimeConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_scaling_policies(fleet_id)
describe_scaling_policies(fleet_id, params::Dict{String,<:Any})
Retrieves all scaling policies applied to a fleet. To get a fleet's scaling policies,
specify the fleet ID. You can filter this request by policy status, such as to retrieve
only active scaling policies. Use the pagination parameters to retrieve results as a set of
sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet. A
fleet may have all of its scaling policies suspended. This operation does not affect the
status of the scaling policies, which remains ACTIVE.
# Arguments
- `fleet_id`: A unique identifier for the fleet for which to retrieve scaling policies. You
can use either the fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"Location"`: The fleet location. If you don't specify this value, the response contains
the scaling policies of every location in the fleet.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
- `"StatusFilter"`: Scaling policy status to filter results on. A scaling policy is only in
force when in an ACTIVE status. ACTIVE -- The scaling policy is currently in force.
UPDATEREQUESTED -- A request to update the scaling policy has been received. UPDATING --
A change is being made to the scaling policy. DELETEREQUESTED -- A request to delete the
scaling policy has been received. DELETING -- The scaling policy is being deleted.
DELETED -- The scaling policy has been deleted. ERROR -- An error occurred in creating
the policy. It should be removed and recreated.
"""
function describe_scaling_policies(
FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeScalingPolicies",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_scaling_policies(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeScalingPolicies",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_script(script_id)
describe_script(script_id, params::Dict{String,<:Any})
Retrieves properties for a Realtime script. To request a script record, specify the script
ID. If successful, an object containing the script properties is returned. Learn more
Amazon GameLift Realtime Servers Related actions All APIs by task
# Arguments
- `script_id`: A unique identifier for the Realtime script to retrieve properties for. You
can use either the script ID or ARN value.
"""
function describe_script(ScriptId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"DescribeScript",
Dict{String,Any}("ScriptId" => ScriptId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_script(
ScriptId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"DescribeScript",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ScriptId" => ScriptId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_peering_authorizations()
describe_vpc_peering_authorizations(params::Dict{String,<:Any})
Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services
account. This operation returns all VPC peering authorizations and requests for peering.
This includes those initiated and received by this account. Related actions All APIs by
task
"""
function describe_vpc_peering_authorizations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeVpcPeeringAuthorizations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_peering_authorizations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeVpcPeeringAuthorizations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vpc_peering_connections()
describe_vpc_peering_connections(params::Dict{String,<:Any})
Retrieves information on VPC peering connections. Use this operation to get peering
information for all fleets or for one specific fleet ID. To retrieve connection
information, call this operation from the Amazon Web Services account that is used to
manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to
retrieve all connection records. If successful, the retrieved information includes both
active and pending connections. Active connections identify the IpV4 CIDR block that the
VPC uses to connect. Related actions All APIs by task
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FleetId"`: A unique identifier for the fleet. You can use either the fleet ID or ARN
value.
"""
function describe_vpc_peering_connections(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeVpcPeeringConnections";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vpc_peering_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"DescribeVpcPeeringConnections",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compute_access(compute_name, fleet_id)
get_compute_access(compute_name, fleet_id, params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Requests authorization to remotely connect to a hosting
resource in a Amazon GameLift managed fleet. This operation is not used with Amazon
GameLift Anywhere fleets To request access, specify the compute name and the fleet ID. If
successful, this operation returns a set of temporary Amazon Web Services credentials,
including a two-part access key and a session token. EC2 fleets With an EC2 fleet (where
compute type is EC2), use these credentials with Amazon EC2 Systems Manager (SSM) to start
a session with the compute. For more details, see Starting a session (CLI) in the Amazon
EC2 Systems Manager User Guide. Container fleets With a container fleet (where compute
type is CONTAINER), use these credentials and the target value with SSM to connect to the
fleet instance where the container is running. After you're connected to the instance, use
Docker commands to interact with the container. Learn more Remotely connect to fleet
instances Debug fleet issues Remotely connect to a container fleet
# Arguments
- `compute_name`: A unique identifier for the compute resource that you want to connect to.
For an EC2 fleet compute, use the instance ID. For a container fleet, use the compute name
(for example, a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9) or the
compute ARN.
- `fleet_id`: A unique identifier for the fleet that holds the compute resource that you
want to connect to. You can use either the fleet ID or ARN value.
"""
function get_compute_access(
ComputeName, FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"GetComputeAccess",
Dict{String,Any}("ComputeName" => ComputeName, "FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_compute_access(
ComputeName,
FleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"GetComputeAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ComputeName" => ComputeName, "FleetId" => FleetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_compute_auth_token(compute_name, fleet_id)
get_compute_auth_token(compute_name, fleet_id, params::Dict{String,<:Any})
Requests an authentication token from Amazon GameLift for a compute resource in an Amazon
GameLift Anywhere fleet or container fleet. Game servers that are running on the compute
use this token to communicate with the Amazon GameLift service, such as when calling the
Amazon GameLift server SDK action InitSDK(). Authentication tokens are valid for a limited
time span, so you need to request a fresh token before the current token expires. Use this
operation based on the fleet compute type: For EC2 fleets, auth token retrieval and
refresh is handled automatically. All game servers that are running on all fleet instances
have access to a valid auth token. For ANYWHERE and CONTAINER fleets, if you're using the
Amazon GameLift Agent, auth token retrieval and refresh is handled automatically for any
container or Anywhere compute where the Agent is running. If you're not using the Agent,
create a mechanism to retrieve and refresh auth tokens for computes that are running game
server processes. Learn more Create an Anywhere fleet Test your integration
Server SDK reference guides (for version 5.x)
# Arguments
- `compute_name`: The name of the compute resource you are requesting the authentication
token for. For an Anywhere fleet compute, use the registered compute name. For an EC2 fleet
instance, use the instance ID. For a container fleet, use the compute name (for example,
a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9) or the compute ARN.
- `fleet_id`: A unique identifier for the fleet that the compute is registered to.
"""
function get_compute_auth_token(
ComputeName, FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"GetComputeAuthToken",
Dict{String,Any}("ComputeName" => ComputeName, "FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_compute_auth_token(
ComputeName,
FleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"GetComputeAuthToken",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ComputeName" => ComputeName, "FleetId" => FleetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_game_session_log_url(game_session_id)
get_game_session_log_url(game_session_id, params::Dict{String,<:Any})
Retrieves the location of stored game session logs for a specified game session on Amazon
GameLift managed fleets. When a game session is terminated, Amazon GameLift automatically
stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the
logs. See the Amazon Web Services Service Limits page for maximum log file sizes. Log
files that exceed this limit are not saved. All APIs by task
# Arguments
- `game_session_id`: A unique identifier for the game session to get logs for.
"""
function get_game_session_log_url(
GameSessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"GetGameSessionLogUrl",
Dict{String,Any}("GameSessionId" => GameSessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_game_session_log_url(
GameSessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"GetGameSessionLogUrl",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GameSessionId" => GameSessionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_access(fleet_id, instance_id)
get_instance_access(fleet_id, instance_id, params::Dict{String,<:Any})
Requests authorization to remotely connect to an instance in an Amazon GameLift managed
fleet. Use this operation to connect to instances with game servers that use Amazon
GameLift server SDK 4.x or earlier. To connect to instances with game servers that use
server SDK 5.x or later, call GetComputeAccess. To request access to an instance, specify
IDs for the instance and the fleet it belongs to. You can retrieve instance IDs for a fleet
by calling DescribeInstances with the fleet ID. If successful, this operation returns an
IP address and credentials. The returned credentials match the operating system of the
instance, as follows: For a Windows instance: returns a user name and secret (password)
for use with a Windows Remote Desktop client. For a Linux instance: returns a user name
and secret (RSA private key) for use with an SSH client. You must save the secret to a .pem
file. If you're using the CLI, see the example Get credentials for a Linux instance for
tips on automatically saving the secret to a .pem file. Learn more Remotely connect
to fleet instances Debug fleet issues Related actions All APIs by task
# Arguments
- `fleet_id`: A unique identifier for the fleet that contains the instance you want to
access. You can request access to instances in EC2 fleets with the following statuses:
ACTIVATING, ACTIVE, or ERROR. Use either a fleet ID or an ARN value. You can access
fleets in ERROR status for a short period of time before Amazon GameLift deletes them.
- `instance_id`: A unique identifier for the instance you want to access. You can access an
instance in any status.
"""
function get_instance_access(
FleetId, InstanceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"GetInstanceAccess",
Dict{String,Any}("FleetId" => FleetId, "InstanceId" => InstanceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_access(
FleetId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"GetInstanceAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("FleetId" => FleetId, "InstanceId" => InstanceId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_aliases()
list_aliases(params::Dict{String,<:Any})
Retrieves all aliases for this Amazon Web Services account. You can filter the result set
by alias name and/or routing strategy type. Use the pagination parameters to retrieve
results in sequential pages. Returned aliases are not listed in any particular order.
Related actions All APIs by task
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"Name"`: A descriptive label that is associated with an alias. Alias names do not need
to be unique.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
- `"RoutingStrategyType"`: The routing type to filter results on. Use this parameter to
retrieve only aliases with a certain routing type. To retrieve all aliases, leave this
parameter empty. Possible routing types include the following: SIMPLE -- The alias
resolves to one specific fleet. Use this type when routing to active fleets. TERMINAL --
The alias does not resolve to a fleet but instead can be used to display a message to the
user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy
message embedded.
"""
function list_aliases(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift("ListAliases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_aliases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ListAliases", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_builds()
list_builds(params::Dict{String,<:Any})
Retrieves build resources for all builds associated with the Amazon Web Services account in
use. You can limit results to builds that are in a specific status by using the Status
parameter. Use the pagination parameters to retrieve results in a set of sequential pages.
Build resources are not listed in any particular order. Learn more Upload a Custom
Server Build All APIs by task
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, don't specify a value.
- `"Status"`: Build status to filter results by. To retrieve all builds, leave this
parameter empty. Possible build statuses include the following: INITIALIZED -- A new
build has been defined, but no files have been uploaded. You cannot create fleets for
builds that are in this status. When a build is successfully created, the build status is
set to this value. READY -- The game build has been successfully uploaded. You can now
create new fleets for this build. FAILED -- The game build upload failed. You cannot
create new fleets for this build.
"""
function list_builds(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift("ListBuilds"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_builds(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ListBuilds", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_compute(fleet_id)
list_compute(fleet_id, params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Retrieves information on the compute resources in an
Amazon GameLift fleet. To request a list of computes, specify the fleet ID. Use the
pagination parameters to retrieve results in a set of sequential pages. You can filter the
result set by location. If successful, this operation returns information on all computes
in the requested fleet. Depending on the fleet's compute type, the result includes the
following information: For EC2 fleets, this operation returns information about the EC2
instance. Compute names are instance IDs. For ANYWHERE fleets, this operation returns the
compute names and details provided when the compute was registered with RegisterCompute.
The GameLiftServiceSdkEndpoint or GameLiftAgentEndpoint is included. For CONTAINER
fleets, this operation returns information about containers that are registered as
computes, and the instances they're running on. Compute names are container names.
# Arguments
- `fleet_id`: A unique identifier for the fleet to retrieve compute resources for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"Location"`: The name of a location to retrieve compute resources for. For an Amazon
GameLift Anywhere fleet, use a custom location. For a multi-location EC2 or container
fleet, provide a Amazon Web Services Region or Local Zone code (for example: us-west-2 or
us-west-2-lax-1).
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
"""
function list_compute(FleetId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"ListCompute",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_compute(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ListCompute",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_container_group_definitions()
list_container_group_definitions(params::Dict{String,<:Any})
This operation is used with the Amazon GameLift containers feature, which is currently in
public preview. Retrieves all container group definitions for the Amazon Web Services
account and Amazon Web Services Region that are currently in use. You can filter the result
set by the container groups' scheduling strategy. Use the pagination parameters to retrieve
results in a set of sequential pages. This operation returns the list of container group
definitions in no particular order. Learn more Manage a container group definition
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
- `"SchedulingStrategy"`: The type of container group definitions to retrieve. DAEMON --
Daemon container groups run background processes and are deployed once per fleet instance.
REPLICA -- Replica container groups run your game server application and supporting
software. Replica groups might be deployed multiple times per fleet instance.
"""
function list_container_group_definitions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ListContainerGroupDefinitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_container_group_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ListContainerGroupDefinitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fleets()
list_fleets(params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Retrieves a collection of fleet resources in an Amazon Web
Services Region. You can filter the result set to find only those fleets that are deployed
with a specific build or script. For fleets that have multiple locations, this operation
retrieves fleets based on their home Region only. You can use operation in the following
ways: To get a list of all fleets in a Region, don't provide a build or script
identifier. To get a list of all fleets where a specific game build is deployed, provide
the build ID. To get a list of all Realtime Servers fleets with a specific configuration
script, provide the script ID. To get a list of all fleets with a specific container
group definition, provide the ContainerGroupDefinition ID. Use the pagination parameters
to retrieve results as a set of sequential pages. If successful, this operation returns a
list of fleet IDs that match the request parameters. A NextToken value is also returned if
there are more result pages to retrieve. Fleet IDs are returned in no particular order.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BuildId"`: A unique identifier for the build to request fleets for. Use this parameter
to return only fleets using a specified build. Use either the build ID or ARN value.
- `"ContainerGroupDefinitionName"`: The container group definition name to request fleets
for. Use this parameter to return only fleets that are deployed with the specified
container group definition.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
- `"ScriptId"`: A unique identifier for the Realtime script to request fleets for. Use this
parameter to return only fleets using a specified script. Use either the script ID or ARN
value.
"""
function list_fleets(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift("ListFleets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_fleets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ListFleets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_game_server_groups()
list_game_server_groups(params::Dict{String,<:Any})
Lists a game server groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The game server groups' limit.
- `"NextToken"`: Specify the pagination token from a previous request to retrieve the next
page of results.
"""
function list_game_server_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"ListGameServerGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_game_server_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ListGameServerGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_game_servers(game_server_group_name)
list_game_servers(game_server_group_name, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information on all game servers that are currently active in a specified game
server group. You can opt to sort the list by game server age. Use the pagination
parameters to retrieve results in a set of sequential segments. Learn more Amazon
GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: An identifier for the game server group to retrieve a list of
game servers from. Use either the name or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
- `"SortOrder"`: Indicates how to sort the returned data based on game server registration
timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to
retrieve newest game servers first. If this parameter is left empty, game servers are
returned in no particular order.
"""
function list_game_servers(
GameServerGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ListGameServers",
Dict{String,Any}("GameServerGroupName" => GameServerGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_game_servers(
GameServerGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"ListGameServers",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GameServerGroupName" => GameServerGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_locations()
list_locations(params::Dict{String,<:Any})
Lists all custom and Amazon Web Services locations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters the list for AWS or CUSTOM locations.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
"""
function list_locations(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift("ListLocations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_locations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ListLocations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_scripts()
list_scripts(params::Dict{String,<:Any})
Retrieves script records for all Realtime scripts that are associated with the Amazon Web
Services account in use. Learn more Amazon GameLift Realtime Servers Related actions
All APIs by task
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, don't specify a value.
"""
function list_scripts(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift("ListScripts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_scripts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ListScripts", 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 tags assigned to a Amazon GameLift resource. Use resource tags to organize
Amazon Web Services resources for a range of purposes. This operation handles the
permissions necessary to manage tags for Amazon GameLift resources that support tagging. To
list tags for a resource, specify the unique ARN value for the resource. Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies Related actions All APIs by task
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that uniquely identifies the Amazon
GameLift resource that you want to retrieve tags for. Amazon GameLift includes resource
ARNs in the data object for the resource. You can retrieve the ARN by calling a List or
Describe operation for the resource type.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"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 gamelift(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_scaling_policy(fleet_id, metric_name, name)
put_scaling_policy(fleet_id, metric_name, name, params::Dict{String,<:Any})
Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically
scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs
Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when
a certain threshold is reached. There are two types of scaling policies: target-based and
rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this
option is the most commonly used. Use rule-based policies when you need to exert
fine-grained control over auto-scaling. Fleets can have multiple scaling policies of each
type in force at the same time; you can have one target-based policy, one or multiple
rule-based scaling policies, or both. We recommend caution, however, because multiple
auto-scaling policies can have unintended consequences. Learn more about how to work with
auto-scaling in Set Up Fleet Automatic Scaling. Target-based policy A target-based policy
tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a
fleet's hosting capacity is ready to host game sessions but is not currently in use. This
is the fleet's buffer; it measures the additional player demand that the fleet could handle
at current capacity. With a target-based policy, you set your ideal buffer size and leave
it to Amazon GameLift to take whatever action is needed to maintain that target. For
example, you might choose to maintain a 10% buffer for a fleet that has the capacity to
host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action
whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon
GameLift will start new instances or stop unused instances in order to return to the 10%
buffer. To create or update a target-based policy, specify a fleet ID and name, and set
the policy type to \"TargetBased\". Specify the metric to track
(PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired
buffer value. Exclude all other parameters. On a successful request, the policy name is
returned. The scaling policy is automatically in force as soon as it's successfully
created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will
be in force once the fleet actions are restarted. Rule-based policy A rule-based policy
tracks specified fleet metric, sets a threshold value, and specifies the type of action to
initiate when triggered. With a rule-based policy, you can select from several available
fleet metrics. Each policy specifies whether to scale up or scale down (and by how much),
so you need one policy for each type of action. For example, a policy may make the
following statement: \"If the percentage of idle instances is greater than 20% for more
than 15 minutes, then reduce the fleet capacity by 10%.\" A policy's rule statement has the
following structure: If [MetricName] is [ComparisonOperator] [Threshold] for
[EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment]. To
implement the example, the rule statement would look like this: If [PercentIdleInstances]
is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].
To create or update a scaling policy, specify a unique combination of name and fleet ID,
and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule
statement. On a successful request, the policy name is returned. Scaling policies are
automatically in force as soon as they're successfully created. If the fleet's auto-scaling
actions are temporarily suspended, the new policy will be in force once the fleet actions
are restarted.
# Arguments
- `fleet_id`: A unique identifier for the fleet to apply this policy to. You can use either
the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or
DELETING.
- `metric_name`: Name of the Amazon GameLift-defined metric that is used to trigger a
scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift
with Amazon CloudWatch. ActivatingGameSessions -- Game sessions in the process of being
created. ActiveGameSessions -- Game sessions that are currently running.
ActiveInstances -- Fleet instances that are currently running at least one game session.
AvailableGameSessions -- Additional game sessions that fleet could host simultaneously,
given current capacity. AvailablePlayerSessions -- Empty player slots in currently
active game sessions. This includes game sessions that are not currently accepting players.
Reserved player slots are not included. CurrentPlayerSessions -- Player slots in active
game sessions that are being used by a player or are reserved for a player.
IdleInstances -- Active instances that are currently hosting zero game sessions.
PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that
a fleet could host simultaneously, given current capacity. Use this metric for a
target-based scaling policy. PercentIdleInstances -- Percentage of the total number of
active instances that are hosting zero game sessions. QueueDepth -- Pending game session
placement requests, in any queue, where the current fleet is the top-priority destination.
WaitTime -- Current wait time for pending game session placement requests, in any queue,
where the current fleet is the top-priority destination.
- `name`: A descriptive label that is associated with a fleet's scaling policy. Policy
names do not need to be unique. A fleet can have only one scaling policy with the same name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ComparisonOperator"`: Comparison operator to use when measuring the metric against the
threshold value.
- `"EvaluationPeriods"`: Length of time (in minutes) the metric must be at or beyond the
threshold before a scaling event is triggered.
- `"PolicyType"`: The type of scaling policy to create. For a target-based policy, set the
parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration.
For a rule-based policy set the following parameters: MetricName, ComparisonOperator,
Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- `"ScalingAdjustment"`: Amount of adjustment to make, based on the scaling adjustment type.
- `"ScalingAdjustmentType"`: The type of adjustment to make to a fleet's instance count:
ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current
instance count. Positive values scale up while negative values scale down. ExactCapacity
-- set the instance count to the scaling adjustment value. PercentChangeInCapacity --
increase or reduce the current instance count by the scaling adjustment, read as a
percentage. Positive values scale up while negative values scale down; for example, a value
of \"-10\" scales the fleet down by 10%.
- `"TargetConfiguration"`: An object that contains settings for a target-based scaling
policy.
- `"Threshold"`: Metric value used to trigger a scaling event.
"""
function put_scaling_policy(
FleetId, MetricName, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"PutScalingPolicy",
Dict{String,Any}("FleetId" => FleetId, "MetricName" => MetricName, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_scaling_policy(
FleetId,
MetricName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"PutScalingPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FleetId" => FleetId, "MetricName" => MetricName, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_compute(compute_name, fleet_id)
register_compute(compute_name, fleet_id, params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Registers a compute resource in an Amazon GameLift fleet.
Register computes with an Amazon GameLift Anywhere fleet or a container fleet. For an
Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent
handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the
Agent, call this operation to register fleet computes. To register a compute, give the
compute a name (must be unique within the fleet) and specify the compute resource's DNS
name or IP address. Provide a fleet ID and a fleet location to associate with the compute
being registered. You can optionally include the path to a TLS certificate on the compute
resource. If successful, this operation returns compute details, including an Amazon
GameLift SDK endpoint or Agent endpoint. Game server processes running on the compute can
use this endpoint to communicate with the Amazon GameLift service. Each server process
includes the SDK endpoint in its call to the Amazon GameLift server SDK action InitSDK().
To view compute details, call DescribeCompute with the compute name. Learn more
Create an Anywhere fleet Test your integration Server SDK reference guides (for
version 5.x)
# Arguments
- `compute_name`: A descriptive label for the compute resource.
- `fleet_id`: A unique identifier for the fleet to register the compute to. You can use
either the fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificatePath"`: The path to a TLS certificate on your compute resource. Amazon
GameLift doesn't validate the path and certificate.
- `"DnsName"`: The DNS name of the compute resource. Amazon GameLift requires either a DNS
name or IP address.
- `"IpAddress"`: The IP address of the compute resource. Amazon GameLift requires either a
DNS name or IP address.
- `"Location"`: The name of a custom location to associate with the compute resource being
registered.
"""
function register_compute(
ComputeName, FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"RegisterCompute",
Dict{String,Any}("ComputeName" => ComputeName, "FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_compute(
ComputeName,
FleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"RegisterCompute",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ComputeName" => ComputeName, "FleetId" => FleetId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_game_server(game_server_group_name, game_server_id, instance_id)
register_game_server(game_server_group_name, game_server_id, instance_id, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Creates a new game server resource and notifies Amazon GameLift FleetIQ that the game
server is ready to host gameplay and players. This operation is called by a game server
process that is running on an instance in a game server group. Registering game servers
enables Amazon GameLift FleetIQ to track available game servers and enables game clients
and services to claim a game server for a new game session. To register a game server,
identify the game server group and instance where the game server is running, and provide a
unique identifier for the game server. You can also include connection and game server
data. Once a game server is successfully registered, it is put in status AVAILABLE. A
request to register a game server may fail if the instance it is running on is in the
process of shutting down as part of instance balancing or scale-down activity. Learn more
Amazon GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group where the game
server is running.
- `game_server_id`: A custom string that uniquely identifies the game server to register.
Game server IDs are developer-defined and must be unique across all game server groups in
your Amazon Web Services account.
- `instance_id`: The unique identifier for the instance where the game server is running.
This ID is available in the instance metadata. EC2 instance IDs use a 17-character format,
for example: i-1234567890abcdef0.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionInfo"`: Information that is needed to make inbound client connections to the
game server. This might include the IP address and port, DNS name, and other information.
- `"GameServerData"`: A set of custom game server properties, formatted as a single string
value. This data is passed to a game client or service when it requests information on game
servers.
"""
function register_game_server(
GameServerGroupName,
GameServerId,
InstanceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"RegisterGameServer",
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName,
"GameServerId" => GameServerId,
"InstanceId" => InstanceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_game_server(
GameServerGroupName,
GameServerId,
InstanceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"RegisterGameServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName,
"GameServerId" => GameServerId,
"InstanceId" => InstanceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
request_upload_credentials(build_id)
request_upload_credentials(build_id, params::Dict{String,<:Any})
Retrieves a fresh set of credentials for use when uploading a new set of game build files
to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see
CreateBuild. To request new credentials, specify the build ID as returned with an initial
CreateBuild request. If successful, a new set of credentials are returned, along with the
S3 storage location associated with the build ID. Learn more Create a Build with Files
in S3 All APIs by task
# Arguments
- `build_id`: A unique identifier for the build to get credentials for. You can use either
the build ID or ARN value.
"""
function request_upload_credentials(
BuildId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"RequestUploadCredentials",
Dict{String,Any}("BuildId" => BuildId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function request_upload_credentials(
BuildId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"RequestUploadCredentials",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("BuildId" => BuildId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resolve_alias(alias_id)
resolve_alias(alias_id, params::Dict{String,<:Any})
Attempts to retrieve a fleet ID that is associated with an alias. Specify a unique alias
identifier. If the alias has a SIMPLE routing strategy, Amazon GameLift returns a fleet ID.
If the alias has a TERMINAL routing strategy, the result is a
TerminalRoutingStrategyException. Related actions All APIs by task
# Arguments
- `alias_id`: The unique identifier of the alias that you want to retrieve a fleet ID for.
You can use either the alias ID or ARN value.
"""
function resolve_alias(AliasId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"ResolveAlias",
Dict{String,Any}("AliasId" => AliasId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resolve_alias(
AliasId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ResolveAlias",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("AliasId" => AliasId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resume_game_server_group(game_server_group_name, resume_actions)
resume_game_server_group(game_server_group_name, resume_actions, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Reinstates activity on a game server group after it has been suspended. A game server group
might be suspended by the SuspendGameServerGroup operation, or it might be suspended
involuntarily due to a configuration problem. In the second case, you can manually resume
activity on the group once the configuration problem has been resolved. Refer to the game
server group status and status reason for more information on why group activity is
suspended. To resume activity, specify a game server group ARN and the type of activity to
be resumed. If successful, a GameServerGroup object is returned showing that the resumed
activity is no longer listed in SuspendedActions. Learn more Amazon GameLift FleetIQ
Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group. Use either the
name or ARN value.
- `resume_actions`: The activity to resume for this game server group.
"""
function resume_game_server_group(
GameServerGroupName, ResumeActions; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ResumeGameServerGroup",
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName, "ResumeActions" => ResumeActions
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resume_game_server_group(
GameServerGroupName,
ResumeActions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"ResumeGameServerGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName,
"ResumeActions" => ResumeActions,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_game_sessions()
search_game_sessions(params::Dict{String,<:Any})
Retrieves all active game sessions that match a set of search criteria and sorts them into
a specified order. This operation is not designed to continually track game session status
because that practice can cause you to exceed your API limit and generate errors. Instead,
configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications
from a matchmaker or a game session placement queue. When searching for game sessions, you
specify exactly where you want to search and provide a search filter expression, a sort
expression, or both. A search request can search only one fleet, but it can search all of a
fleet's locations. This operation can be used in the following ways: To search all game
sessions that are currently running on all locations in a fleet, provide a fleet or alias
ID. This approach returns game sessions in the fleet's home Region and all remote locations
that fit the search criteria. To search all game sessions that are currently running on a
specific fleet location, provide a fleet or alias ID and a location name. For location, you
can specify a fleet's home Region or any remote location. Use the pagination parameters
to retrieve results as a set of sequential pages. If successful, a GameSession object is
returned for each game session that matches the request. Search finds game sessions that
are in ACTIVE status only. To retrieve information on game sessions in other statuses, use
DescribeGameSessions . To set search and sort criteria, create a filter expression using
the following game session attributes. For game session search examples, see the Examples
section of this topic. gameSessionId -- A unique identifier for the game session. You
can use either a GameSessionId or GameSessionArn value. gameSessionName -- Name
assigned to a game session. Game session names do not need to be unique to a game session.
gameSessionProperties -- A set of key-value pairs that can store custom data in a game
session. For example: {\"Key\": \"difficulty\", \"Value\": \"novice\"}. The filter
expression must specify the GameProperty -- a Key and a string Value to search for the game
sessions. For example, to search for the above key-value pair, specify the following search
filter: gameSessionProperties.difficulty = \"novice\". All game property values are
searched as strings. For examples of searching game sessions, see the ones below, and also
see Search game sessions by game property. maximumSessions -- Maximum number of player
sessions allowed for a game session. creationTimeMillis -- Value indicating when a game
session was created. It is expressed in Unix time as milliseconds. playerSessionCount --
Number of players currently connected to a game session. This value changes rapidly as
players join the session or drop out. hasAvailablePlayerSessions -- Boolean value
indicating whether a game session has reached its maximum number of players. It is highly
recommended that all search requests include this filter attribute to optimize search
performance and return only sessions that players can join. Returned values for
playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions
and others drop out. Results should be considered a snapshot in time. Be sure to refresh
search results often, and handle sessions that fill up before a player can join. All
APIs by task
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AliasId"`: A unique identifier for the alias associated with the fleet to search for
active game sessions. You can use either the alias ID or ARN value. Each request must
reference either a fleet ID or alias ID, but not both.
- `"FilterExpression"`: String containing the search criteria for the session search. If no
filter expression is included, the request returns results for all game sessions in the
fleet that are in ACTIVE status. A filter expression can contain one or multiple
conditions. Each condition consists of the following: Operand -- Name of a game session
attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties,
maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
Comparator -- Valid comparators are: =, <>, <, >, <=, >=. Value --
Value to be searched for. Values may be numbers, boolean values (true/false) or strings
depending on the operand. String values are case sensitive and must be enclosed in single
quotes. Special characters must be escaped. Boolean and string values can only be used with
the comparators = and <>. For example, the following filter expression searches on
gameSessionName: \"FilterExpression\": \"gameSessionName = 'Matt's Awesome Game 1'\". To
chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT
and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y). Session search
evaluates conditions from left to right using the following precedence rules: =,
<>, <, >, <=, >= Parentheses NOT AND OR For example, this
filter expression retrieves game sessions hosting at least ten players that have an open
player slot: \"maximumSessions>=10 AND hasAvailablePlayerSessions=true\".
- `"FleetId"`: A unique identifier for the fleet to search for active game sessions. You
can use either the fleet ID or ARN value. Each request must reference either a fleet ID or
alias ID, but not both.
- `"Limit"`: The maximum number of results to return. Use this parameter with NextToken to
get results as a set of sequential pages. The maximum number of results returned is 20,
even if this value is not set or is set higher than 20.
- `"Location"`: A fleet location to search for game sessions. You can specify a fleet's
home Region or a remote location. Use the Amazon Web Services Region code format, such as
us-west-2.
- `"NextToken"`: A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation. To start at the
beginning of the result set, do not specify a value.
- `"SortExpression"`: Instructions on how to sort the search results. If no sort expression
is included, the request returns results in random order. A sort expression consists of the
following elements: Operand -- Name of a game session attribute. Valid values are
gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis,
playerSessionCount, hasAvailablePlayerSessions. Order -- Valid sort orders are ASC
(ascending) and DESC (descending). For example, this sort expression returns the oldest
active sessions first: \"SortExpression\": \"creationTimeMillis ASC\". Results with a null
value for the sort operand are returned at the end of the list.
"""
function search_game_sessions(; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"SearchGameSessions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function search_game_sessions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"SearchGameSessions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
start_fleet_actions(actions, fleet_id)
start_fleet_actions(actions, fleet_id, params::Dict{String,<:Any})
Resumes certain types of activity on fleet instances that were suspended with
StopFleetActions. For multi-location fleets, fleet actions are managed separately for each
location. Currently, this operation is used to restart a fleet's auto-scaling activity.
This operation can be used in the following ways: To restart actions on instances in the
fleet's home Region, provide a fleet ID and the type of actions to resume. To restart
actions on instances in one of the fleet's remote locations, provide a fleet ID, a location
name, and the type of actions to resume. If successful, Amazon GameLift once again
initiates scaling events as triggered by the fleet's scaling policies. If actions on the
fleet location were never stopped, this operation will have no effect. Learn more
Setting up Amazon GameLift fleets
# Arguments
- `actions`: List of actions to restart on the fleet.
- `fleet_id`: A unique identifier for the fleet to restart actions on. You can use either
the fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Location"`: The fleet location to restart fleet actions for. Specify a location in the
form of an Amazon Web Services Region code, such as us-west-2.
"""
function start_fleet_actions(
Actions, FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"StartFleetActions",
Dict{String,Any}("Actions" => Actions, "FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_fleet_actions(
Actions,
FleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"StartFleetActions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Actions" => Actions, "FleetId" => FleetId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_game_session_placement(game_session_queue_name, maximum_player_session_count, placement_id)
start_game_session_placement(game_session_queue_name, maximum_player_session_count, placement_id, params::Dict{String,<:Any})
Places a request for a new game session in a queue. When processing a placement request,
Amazon GameLift searches for available resources on the queue's destinations, scanning each
until it finds resources or the placement request times out. A game session placement
request can also request player sessions. When a new game session is successfully created,
Amazon GameLift creates a player session for each player included in the request. When
placing a game session, by default Amazon GameLift tries each fleet in the order they are
listed in the queue configuration. Ideally, a queue's destinations are listed in preference
order. Alternatively, when requesting a game session with players, you can also provide
latency data for each player in relevant Regions. Latency data indicates the performance
lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses
latency data to reorder the list of destinations to place the game session in a Region with
minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates
each Region's average lag for all players and reorders to get the best game play across all
players. To place a new game session request, specify the following: The queue name and
a set of game session properties and settings A unique ID (such as a UUID) for the
placement. You use this ID to track the status of the placement request (Optional) A set
of player data and a unique player ID for each player that you are joining to the new game
session (player data is optional, but if you include it, you must also provide a unique ID
for each player) Latency data for all players (if you want to optimize game play for the
players) If successful, a new game session placement is created. To track the status of a
placement request, call DescribeGameSessionPlacement and check the request's status. If the
status is FULFILLED, a new game session has been created and a game session ARN and Region
are referenced. If the placement request times out, you can resubmit the request or retry
it with a different queue.
# Arguments
- `game_session_queue_name`: Name of the queue to use to place the new game session. You
can use either the queue name or ARN value.
- `maximum_player_session_count`: The maximum number of players that can be connected
simultaneously to the game session.
- `placement_id`: A unique identifier to assign to the new game session placement. This
value is developer-defined. The value must be unique across all Regions and cannot be
reused.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DesiredPlayerSessions"`: Set of information on each player to create a player session
for.
- `"GameProperties"`: A set of key-value pairs that can store custom data in a game
session. For example: {\"Key\": \"difficulty\", \"Value\": \"novice\"}.
- `"GameSessionData"`: A set of custom game session properties, formatted as a single
string value. This data is passed to a game server process in the GameSession object with a
request to start a new game session (see Start a Game Session).
- `"GameSessionName"`: A descriptive label that is associated with a game session. Session
names do not need to be unique.
- `"PlayerLatencies"`: A set of values, expressed in milliseconds, that indicates the
amount of latency that a player experiences when connected to Amazon Web Services Regions.
This information is used to try to place the new game session where it can offer the best
possible gameplay experience for the players.
"""
function start_game_session_placement(
GameSessionQueueName,
MaximumPlayerSessionCount,
PlacementId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"StartGameSessionPlacement",
Dict{String,Any}(
"GameSessionQueueName" => GameSessionQueueName,
"MaximumPlayerSessionCount" => MaximumPlayerSessionCount,
"PlacementId" => PlacementId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_game_session_placement(
GameSessionQueueName,
MaximumPlayerSessionCount,
PlacementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"StartGameSessionPlacement",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameSessionQueueName" => GameSessionQueueName,
"MaximumPlayerSessionCount" => MaximumPlayerSessionCount,
"PlacementId" => PlacementId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_match_backfill(configuration_name, players)
start_match_backfill(configuration_name, players, params::Dict{String,<:Any})
Finds new players to fill open slots in currently running game sessions. The backfill match
process is essentially identical to the process of forming new matches. Backfill requests
use the same matchmaker that was used to make the original match, and they provide
matchmaking data for all players currently in the game session. FlexMatch uses this
information to select new players so that backfilled match continues to meet the original
match requirements. When using FlexMatch with Amazon GameLift managed hosting, you can
request a backfill match from a client service by calling this operation with a
GameSessions ID. You also have the option of making backfill requests directly from your
game server. In response to a request, FlexMatch creates player sessions for the new
players, updates the GameSession resource, and sends updated matchmaking data to the game
server. You can request a backfill match at any point after a game session is started. Each
game session can have only one active backfill request at a time; a subsequent request
automatically replaces the earlier request. When using FlexMatch as a standalone component,
request a backfill match by calling this operation without a game session identifier. As
with newly formed matches, matchmaking results are returned in a matchmaking event so that
your game can update the game session that is being backfilled. To request a backfill
match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking
data for all current players in the game session being backfilled. Optionally, specify the
GameSession ARN. If successful, a match backfill ticket is created and returned with status
set to QUEUED. Track the status of backfill tickets using the same method for tracking
tickets for new matches. Only game sessions created by FlexMatch are supported for match
backfill. Learn more Backfill existing games with FlexMatch Matchmaking events
(reference) How Amazon GameLift FlexMatch works
# Arguments
- `configuration_name`: Name of the matchmaker to use for this request. You can use either
the configuration name or ARN value. The ARN of the matchmaker that was used with the
original game session is listed in the GameSession object, MatchmakerData property.
- `players`: Match information on all players that are currently assigned to the game
session. This information is used by the matchmaker to find new players and add them to the
existing game. You can include up to 199 Players in a StartMatchBackfill request.
PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession
object, MatchmakerData property, for all players who are currently assigned to the game
session. The matchmaker data is in JSON syntax, formatted as a string. For more details,
see Match Data. The backfill request must specify the team membership for every player.
Do not specify team if you are not using backfill. LatencyInMs -- If the matchmaker uses
player latency, include a latency value, in milliseconds, for the Region that the game
session is currently in. Do not include latency values for any other Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GameSessionArn"`: A unique identifier for the game session. Use the game session ID.
When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.
- `"TicketId"`: A unique identifier for a matchmaking ticket. If no ticket ID is specified
here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track
the match backfill ticket status and retrieve match results.
"""
function start_match_backfill(
ConfigurationName, Players; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"StartMatchBackfill",
Dict{String,Any}("ConfigurationName" => ConfigurationName, "Players" => Players);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_match_backfill(
ConfigurationName,
Players,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"StartMatchBackfill",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationName" => ConfigurationName, "Players" => Players
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_matchmaking(configuration_name, players)
start_matchmaking(configuration_name, players, params::Dict{String,<:Any})
Uses FlexMatch to create a game match for a group of players based on custom matchmaking
rules. With games that use Amazon GameLift managed hosting, this operation also triggers
Amazon GameLift to find hosting resources and start a new game session for the new match.
Each matchmaking request includes information on one or more players and specifies the
FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to
build a match that includes all players in the request, placing them in the same team and
finding additional players as needed to fill the match. To start matchmaking, provide a
unique ticket ID, specify a matchmaking configuration, and include the players to be
matched. You must also include any player attributes that are required by the matchmaking
configuration's rule set. If successful, a matchmaking ticket is returned with status set
to QUEUED. Track matchmaking events to respond as needed and acquire game session
connection information for successfully completed matches. Ticket status updates are
tracked using event notification through Amazon Simple Notification Service, which is
defined in the matchmaking configuration. Learn more Add FlexMatch to a game client
Set Up FlexMatch event notification How Amazon GameLift FlexMatch works
# Arguments
- `configuration_name`: Name of the matchmaking configuration to use for this request.
Matchmaking configurations must exist in the same Region as this request. You can use
either the configuration name or ARN value.
- `players`: Information on each player to be matched. This information must include a
player ID, and may contain player attributes and latency data to be used in the matchmaking
process. After a successful match, Player objects contain the name of the team the player
is assigned to. You can include up to 10 Players in a StartMatchmaking request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TicketId"`: A unique identifier for a matchmaking ticket. If no ticket ID is specified
here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track
the matchmaking ticket status and retrieve match results.
"""
function start_matchmaking(
ConfigurationName, Players; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"StartMatchmaking",
Dict{String,Any}("ConfigurationName" => ConfigurationName, "Players" => Players);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_matchmaking(
ConfigurationName,
Players,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"StartMatchmaking",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ConfigurationName" => ConfigurationName, "Players" => Players
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_fleet_actions(actions, fleet_id)
stop_fleet_actions(actions, fleet_id, params::Dict{String,<:Any})
Suspends certain types of activity in a fleet location. Currently, this operation is used
to stop auto-scaling activity. For multi-location fleets, fleet actions are managed
separately for each location. Stopping fleet actions has several potential purposes. It
allows you to temporarily stop auto-scaling activity but retain your scaling policies for
use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and
then opt out of it for certain locations. This operation can be used in the following
ways: To stop actions on instances in the fleet's home Region, provide a fleet ID and
the type of actions to suspend. To stop actions on instances in one of the fleet's
remote locations, provide a fleet ID, a location name, and the type of actions to suspend.
If successful, Amazon GameLift no longer initiates scaling events except in response to
manual changes using UpdateFleetCapacity. To restart fleet actions again, call
StartFleetActions. Learn more Setting up Amazon GameLift Fleets
# Arguments
- `actions`: List of actions to suspend on the fleet.
- `fleet_id`: A unique identifier for the fleet to stop actions on. You can use either the
fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Location"`: The fleet location to stop fleet actions for. Specify a location in the
form of an Amazon Web Services Region code, such as us-west-2.
"""
function stop_fleet_actions(
Actions, FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"StopFleetActions",
Dict{String,Any}("Actions" => Actions, "FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_fleet_actions(
Actions,
FleetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"StopFleetActions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Actions" => Actions, "FleetId" => FleetId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_game_session_placement(placement_id)
stop_game_session_placement(placement_id, params::Dict{String,<:Any})
Cancels a game session placement that is in PENDING status. To stop a placement, provide
the placement ID values. If successful, the placement is moved to CANCELLED status.
# Arguments
- `placement_id`: A unique identifier for a game session placement to stop.
"""
function stop_game_session_placement(
PlacementId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"StopGameSessionPlacement",
Dict{String,Any}("PlacementId" => PlacementId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_game_session_placement(
PlacementId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"StopGameSessionPlacement",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PlacementId" => PlacementId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_matchmaking(ticket_id)
stop_matchmaking(ticket_id, params::Dict{String,<:Any})
Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To
stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is
stopped, and the ticket status is changed to CANCELLED. This call is also used to turn off
automatic backfill for an individual game session. This is for game sessions that are
created with a matchmaking configuration that has automatic backfill enabled. The ticket ID
is included in the MatchmakerData of an updated game session object, which is provided to
the game server. If the operation is successful, the service sends back an empty JSON
struct with the HTTP 200 response (not an empty HTTP body). Learn more Add FlexMatch
to a game client
# Arguments
- `ticket_id`: A unique identifier for a matchmaking ticket.
"""
function stop_matchmaking(TicketId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"StopMatchmaking",
Dict{String,Any}("TicketId" => TicketId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_matchmaking(
TicketId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"StopMatchmaking",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TicketId" => TicketId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
suspend_game_server_group(game_server_group_name, suspend_actions)
suspend_game_server_group(game_server_group_name, suspend_actions, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Temporarily stops activity on a game server group without terminating instances or the game
server group. You can restart activity by calling ResumeGameServerGroup. You can suspend
the following activity: Instance type replacement - This activity evaluates the current
game hosting viability of all Spot instance types that are defined for the game server
group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which
have a higher chance of game server interruptions. It then balances capacity across the
remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling
group continues with its current balance, regardless of viability. Instance protection,
utilization metrics, and capacity scaling activities continue to be active. To suspend
activity, specify a game server group ARN and the type of activity to be suspended. If
successful, a GameServerGroup object is returned showing that the activity is listed in
SuspendedActions. Learn more Amazon GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group. Use either the
name or ARN value.
- `suspend_actions`: The activity to suspend for this game server group.
"""
function suspend_game_server_group(
GameServerGroupName, SuspendActions; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"SuspendGameServerGroup",
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName, "SuspendActions" => SuspendActions
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function suspend_game_server_group(
GameServerGroupName,
SuspendActions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"SuspendGameServerGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName,
"SuspendActions" => SuspendActions,
),
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 a tag to an Amazon GameLift resource. You can use tags to organize resources,
create IAM permissions policies to manage access to groups of resources, customize Amazon
Web Services cost breakdowns, and more. This operation handles the permissions necessary to
manage tags for Amazon GameLift resources that support tagging. To add a tag to a resource,
specify the unique ARN value for the resource and provide a tag list containing one or more
tags. The operation succeeds even if the list includes tags that are already assigned to
the resource. Learn more Tagging Amazon Web Services Resources in the Amazon Web
Services General Reference Amazon Web Services Tagging Strategies Related actions
All APIs by task
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that uniquely identifies the Amazon
GameLift resource that you want to assign tags to. Amazon GameLift includes resource ARNs
in the data object for the resource. You can retrieve the ARN by calling a List or Describe
operation for the resource type.
- `tags`: A list of one or more tags to assign to the specified Amazon GameLift resource.
Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be
lower than stated. See Tagging Amazon Web Services Resources for tagging limits.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"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 gamelift(
"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 assigned to a Amazon GameLift resource. You can use resource tags to organize
Amazon Web Services resources for a range of purposes. This operation handles the
permissions necessary to manage tags for Amazon GameLift resources that support tagging. To
remove a tag from a resource, specify the unique ARN value for the resource and provide a
string list containing one or more tags to remove. This operation succeeds even if the list
includes tags that aren't assigned to the resource. Learn more Tagging Amazon Web
Services Resources in the Amazon Web Services General Reference Amazon Web Services
Tagging Strategies Related actions All APIs by task
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) that uniquely identifies the Amazon
GameLift resource that you want to remove tags from. Amazon GameLift includes resource ARNs
in the data object for the resource. You can retrieve the ARN by calling a List or Describe
operation for the resource type.
- `tag_keys`: A list of one or more tag keys to remove from the specified Amazon GameLift
resource.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"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 gamelift(
"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_id)
update_alias(alias_id, params::Dict{String,<:Any})
Updates properties for an alias. Specify the unique identifier of the alias to be updated
and the new property values. When reassigning an alias to a new fleet, provide an updated
routing strategy. If successful, the updated alias record is returned. Related actions
All APIs by task
# Arguments
- `alias_id`: A unique identifier for the alias that you want to update. You can use either
the alias ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A human-readable description of the alias.
- `"Name"`: A descriptive label that is associated with an alias. Alias names do not need
to be unique.
- `"RoutingStrategy"`: The routing configuration, including routing type and fleet target,
for the alias.
"""
function update_alias(AliasId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"UpdateAlias",
Dict{String,Any}("AliasId" => AliasId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_alias(
AliasId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateAlias",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("AliasId" => AliasId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_build(build_id)
update_build(build_id, params::Dict{String,<:Any})
Updates metadata in a build resource, including the build name and version. To update the
metadata, specify the build ID to update and provide the new values. If successful, a build
object containing the updated metadata is returned. Learn more Upload a Custom Server
Build All APIs by task
# Arguments
- `build_id`: A unique identifier for the build to update. You can use either the build ID
or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: A descriptive label associated with a build. Build names don't need to be
unique.
- `"Version"`: Version information associated with a build or script. Version strings don't
need to be unique.
"""
function update_build(BuildId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"UpdateBuild",
Dict{String,Any}("BuildId" => BuildId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_build(
BuildId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateBuild",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("BuildId" => BuildId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_fleet_attributes(fleet_id)
update_fleet_attributes(fleet_id, params::Dict{String,<:Any})
Updates a fleet's mutable attributes, such as game session protection and resource creation
limits. To update fleet attributes, specify the fleet ID and the property values that you
want to change. If successful, Amazon GameLift returns the identifiers for the updated
fleet. Learn more Setting up Amazon GameLift fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to update attribute metadata for. You can
use either the fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AnywhereConfiguration"`: Amazon GameLift Anywhere configuration options.
- `"Description"`: A human-readable description of a fleet.
- `"MetricGroups"`: The name of a metric group to add this fleet to. Use a metric group in
Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric
group name, or create a new metric group by providing a new name. A fleet can only be in
one metric group at a time.
- `"Name"`: A descriptive label that is associated with a fleet. Fleet names do not need to
be unique.
- `"NewGameSessionProtectionPolicy"`: The game session protection policy to apply to all
new game sessions created in this fleet. Game sessions that already exist are not affected.
You can set protection for individual game sessions using UpdateGameSession .
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated
during a scale-down event.
- `"ResourceCreationLimitPolicy"`: Policy settings that limit the number of game sessions
an individual player can create over a span of time.
"""
function update_fleet_attributes(FleetId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"UpdateFleetAttributes",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_fleet_attributes(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateFleetAttributes",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_fleet_capacity(fleet_id)
update_fleet_capacity(fleet_id, params::Dict{String,<:Any})
This operation has been expanded to use with the Amazon GameLift containers feature, which
is currently in public preview. Updates capacity settings for a managed EC2 fleet or
container fleet. For these fleets, you adjust capacity by changing the number of instances
in the fleet. Fleet capacity determines the number of game sessions and players that the
fleet can host based on its configuration. For fleets with multiple locations, use this
operation to manage capacity settings in each location individually. Use this operation to
set these fleet capacity properties: Minimum/maximum size: Set hard limits on the number
of Amazon EC2 instances allowed. If Amazon GameLift receives a request--either through
manual update or automatic scaling--it won't change the capacity to a value outside of this
range. Desired capacity: As an alternative to automatic scaling, manually set the number
of Amazon EC2 instances to be maintained. Before changing a fleet's desired capacity, check
the maximum capacity of the fleet's Amazon EC2 instance type by calling
DescribeEC2InstanceLimits. To update capacity for a fleet's home Region, or if the fleet
has no remote locations, omit the Location parameter. The fleet must be in ACTIVE status.
To update capacity for a fleet's remote location, set the Location parameter to the
location to update. The location must be in ACTIVE status. If successful, Amazon GameLift
updates the capacity settings and returns the identifiers for the updated fleet and/or
location. If a requested change to desired capacity exceeds the instance type's limit, the
LimitExceeded exception occurs. Updates often prompt an immediate change in fleet
capacity, such as when current capacity is different than the new desired capacity or
outside the new limits. In this scenario, Amazon GameLift automatically initiates steps to
add or remove instances in the fleet location. You can track a fleet's current capacity by
calling DescribeFleetCapacity or DescribeFleetLocationCapacity. Learn more Scaling
fleet capacity
# Arguments
- `fleet_id`: A unique identifier for the fleet to update capacity settings for. You can
use either the fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DesiredInstances"`: The number of Amazon EC2 instances you want to maintain in the
specified fleet location. This value must fall between the minimum and maximum size limits.
Changes in desired instance value can take up to 1 minute to be reflected when viewing the
fleet's capacity settings.
- `"Location"`: The name of a remote location to update fleet capacity settings for, in the
form of an Amazon Web Services Region code such as us-west-2.
- `"MaxSize"`: The maximum number of instances that are allowed in the specified fleet
location. If this parameter is not set, the default is 1.
- `"MinSize"`: The minimum number of instances that are allowed in the specified fleet
location. If this parameter is not set, the default is 0.
"""
function update_fleet_capacity(FleetId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"UpdateFleetCapacity",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_fleet_capacity(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateFleetCapacity",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_fleet_port_settings(fleet_id)
update_fleet_port_settings(fleet_id, params::Dict{String,<:Any})
Updates permissions that allow inbound traffic to connect to game sessions in the fleet.
To update settings, specify the fleet ID to be updated and specify the changes to be made.
List the permissions you want to add in InboundPermissionAuthorizations, and permissions
you want to remove in InboundPermissionRevocations. Permissions to be removed must match
existing fleet permissions. For a container fleet, inbound permissions must specify port
numbers that are defined in the fleet's connection port settings. If successful, the fleet
ID for the updated fleet is returned. For fleets with remote locations, port setting
updates can take time to propagate across all locations. You can check the status of
updates in each location by calling DescribeFleetPortSettings with a location name. Learn
more Setting up Amazon GameLift fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to update port settings for. You can use
either the fleet ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InboundPermissionAuthorizations"`: A collection of port settings to be added to the
fleet resource.
- `"InboundPermissionRevocations"`: A collection of port settings to be removed from the
fleet resource.
"""
function update_fleet_port_settings(
FleetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateFleetPortSettings",
Dict{String,Any}("FleetId" => FleetId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_fleet_port_settings(
FleetId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateFleetPortSettings",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("FleetId" => FleetId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_game_server(game_server_group_name, game_server_id)
update_game_server(game_server_group_name, game_server_id, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Updates information about a registered game server to help Amazon GameLift FleetIQ track
game server availability. This operation is called by a game server process that is running
on an instance in a game server group. Use this operation to update the following types of
game server information. You can make all three types of updates in the same request: To
update the game server's utilization status from AVAILABLE (when the game server is
available to be claimed) to UTILIZED (when the game server is currently hosting games).
Identify the game server and game server group and specify the new utilization status. You
can't change the status from to UTILIZED to AVAILABLE . To report health status, identify
the game server and game server group and set health check to HEALTHY. If a game server
does not report health status for a certain length of time, the game server is no longer
considered healthy. As a result, it will be eventually deregistered from the game server
group to avoid affecting utilization metrics. The best practice is to report health every
60 seconds. To change game server metadata, provide updated game server data. Once a
game server is successfully updated, the relevant statuses and timestamps are updated.
Learn more Amazon GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group where the game
server is running.
- `game_server_id`: A custom string that uniquely identifies the game server to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GameServerData"`: A set of custom game server properties, formatted as a single string
value. This data is passed to a game client or service when it requests information on game
servers.
- `"HealthCheck"`: Indicates health status of the game server. A request that includes this
parameter updates the game server's LastHealthCheckTime timestamp.
- `"UtilizationStatus"`: Indicates if the game server is available or is currently hosting
gameplay. You can update a game server status from AVAILABLE to UTILIZED, but you can't
change a the status from UTILIZED to AVAILABLE.
"""
function update_game_server(
GameServerGroupName, GameServerId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateGameServer",
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName, "GameServerId" => GameServerId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_game_server(
GameServerGroupName,
GameServerId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"UpdateGameServer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GameServerGroupName" => GameServerGroupName,
"GameServerId" => GameServerId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_game_server_group(game_server_group_name)
update_game_server_group(game_server_group_name, params::Dict{String,<:Any})
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Updates Amazon GameLift FleetIQ-specific properties for a game server group. Many Auto
Scaling group properties are updated on the Auto Scaling group directly, including the
launch template, Auto Scaling policies, and maximum/minimum/desired instance counts. To
update the game server group, specify the game server group ID and provide the updated
values. Before applying the updates, the new values are validated to ensure that Amazon
GameLift FleetIQ can continue to perform instance balancing activity. If successful, a
GameServerGroup object is returned. Learn more Amazon GameLift FleetIQ Guide
# Arguments
- `game_server_group_name`: A unique identifier for the game server group. Use either the
name or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"BalancingStrategy"`: Indicates how Amazon GameLift FleetIQ balances the use of Spot
Instances and On-Demand Instances in the game server group. Method options include the
following: SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot
Instances are unavailable or not viable for game hosting, the game server group provides no
hosting capacity until Spot Instances can again be used. Until then, no new instances are
started, and the existing nonviable Spot Instances are terminated (after current gameplay
ends) and are not replaced. SPOT_PREFERRED - (default value) Spot Instances are used
whenever available in the game server group. If Spot Instances are unavailable, the game
server group continues to provide hosting capacity by falling back to On-Demand Instances.
Existing nonviable Spot Instances are terminated (after current gameplay ends) and are
replaced with new On-Demand Instances. ON_DEMAND_ONLY - Only On-Demand Instances are
used in the game server group. No Spot Instances are used, even when available, while this
balancing strategy is in force.
- `"GameServerProtectionPolicy"`: A flag that indicates whether instances in the game
server group are protected from early termination. Unprotected instances that have active
game servers running might be terminated during a scale-down event, causing players to be
dropped from the game. Protected instances cannot be terminated while there are active game
servers running except in the event of a forced game server group deletion (see ). An
exception to this is with Spot Instances, which can be terminated by Amazon Web Services
regardless of protection status. This property is set to NO_PROTECTION by default.
- `"InstanceDefinitions"`: An updated list of Amazon EC2 instance types to use in the Auto
Scaling group. The instance definitions must specify at least two different instance types
that are supported by Amazon GameLift FleetIQ. This updated list replaces the entire
current list of instance definitions for the game server group. For more information on
instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally
specify capacity weighting for each instance type. If no weight value is specified for an
instance type, it is set to the default value \"1\". For more information about capacity
weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto
Scaling User Guide.
- `"RoleArn"`: The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift
to access your Amazon EC2 Auto Scaling groups.
"""
function update_game_server_group(
GameServerGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateGameServerGroup",
Dict{String,Any}("GameServerGroupName" => GameServerGroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_game_server_group(
GameServerGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"UpdateGameServerGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GameServerGroupName" => GameServerGroupName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_game_session(game_session_id)
update_game_session(game_session_id, params::Dict{String,<:Any})
Updates the mutable properties of a game session. To update a game session, specify the
game session ID and the values you want to change. If successful, the updated GameSession
object is returned. All APIs by task
# Arguments
- `game_session_id`: A unique identifier for the game session to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GameProperties"`: A set of key-value pairs that can store custom data in a game
session. For example: {\"Key\": \"difficulty\", \"Value\": \"novice\"}. You can use this
parameter to modify game properties in an active game session. This action adds new
properties and modifies existing properties. There is no way to delete properties. For an
example, see Update the value of a game property.
- `"MaximumPlayerSessionCount"`: The maximum number of players that can be connected
simultaneously to the game session.
- `"Name"`: A descriptive label that is associated with a game session. Session names do
not need to be unique.
- `"PlayerSessionCreationPolicy"`: A policy that determines whether the game session is
accepting new players.
- `"ProtectionPolicy"`: Game session protection policy to apply to this game session only.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated
during a scale-down event.
"""
function update_game_session(
GameSessionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateGameSession",
Dict{String,Any}("GameSessionId" => GameSessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_game_session(
GameSessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"UpdateGameSession",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GameSessionId" => GameSessionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_game_session_queue(name)
update_game_session_queue(name, params::Dict{String,<:Any})
Updates the configuration of a game session queue, which determines how the queue processes
new game session requests. To update settings, specify the queue name to be updated and
provide the new settings. When updating destinations, provide a complete list of
destinations. Learn more Using Multi-Region Queues
# Arguments
- `name`: A descriptive label that is associated with game session queue. Queue names must
be unique within each Region. You can use either the queue ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomEventData"`: Information to be added to all events that are related to this game
session queue.
- `"Destinations"`: A list of fleets and/or fleet aliases that can be used to fulfill game
session placement requests in the queue. Destinations are identified by either a fleet ARN
or a fleet alias ARN, and are listed in order of placement preference. When updating this
list, provide a complete list of destinations.
- `"FilterConfiguration"`: A list of locations where a queue is allowed to place new game
sessions. Locations are specified in the form of Amazon Web Services Region codes, such as
us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
To remove an existing filter configuration, pass in an empty set.
- `"NotificationTarget"`: An SNS topic ARN that is set up to receive game session placement
notifications. See Setting up notifications for game session placement.
- `"PlayerLatencyPolicies"`: A set of policies that act as a sliding cap on player latency.
FleetIQ works to deliver low latency for most players in a game session. These policies
ensure that no individual player can be placed into a game with unreasonably high latency.
Use multiple policies to gradually relax latency requirements a step at a time. Multiple
policies are applied based on their maximum allowed latency, starting with the lowest
value. When updating policies, provide a complete collection of policies.
- `"PriorityConfiguration"`: Custom settings to use when prioritizing destinations and
locations for game session placements. This configuration replaces the FleetIQ default
prioritization process. Priority types that are not explicitly named will be automatically
applied at the end of the prioritization process. To remove an existing priority
configuration, pass in an empty set.
- `"TimeoutInSeconds"`: The maximum time, in seconds, that a new game session placement
request remains in the queue. When a request exceeds this time, the game session placement
changes to a TIMED_OUT status. By default, this property is set to 600.
"""
function update_game_session_queue(Name; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"UpdateGameSessionQueue",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_game_session_queue(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateGameSessionQueue",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_matchmaking_configuration(name)
update_matchmaking_configuration(name, params::Dict{String,<:Any})
Updates settings for a FlexMatch matchmaking configuration. These changes affect all
matches and game sessions that are created after the update. To update settings, specify
the configuration name to be updated and provide the new settings. Learn more Design a
FlexMatch matchmaker
# Arguments
- `name`: A unique identifier for the matchmaking configuration to update. You can use
either the configuration name or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceptanceRequired"`: A flag that indicates whether a match that was created with this
configuration must be accepted by the matched players. To require acceptance, set to TRUE.
With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to
indicate when a completed potential match is waiting for player acceptance.
- `"AcceptanceTimeoutSeconds"`: The length of time (in seconds) to wait for players to
accept a proposed match, if acceptance is required.
- `"AdditionalPlayerCount"`: The number of player slots in a match to keep open for future
players. For example, if the configuration's rule set specifies a match for a single
10-person team, and the additional player count is set to 2, 10 players will be selected
for the match and 2 more player slots will be open for future players. This parameter is
not used if FlexMatchMode is set to STANDALONE.
- `"BackfillMode"`: The method that is used to backfill game sessions created with this
matchmaking configuration. Specify MANUAL when your game manages backfill requests manually
or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a
match backfill request whenever a game session has one or more open slots. Learn more about
manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill
is not available when FlexMatchMode is set to STANDALONE.
- `"CustomEventData"`: Information to add to all events related to the matchmaking
configuration.
- `"Description"`: A description for the matchmaking configuration.
- `"FlexMatchMode"`: Indicates whether this matchmaking configuration is being used with
Amazon GameLift hosting or as a standalone matchmaking solution. STANDALONE - FlexMatch
forms matches and returns match information, including players and team assignments, in a
MatchmakingSucceeded event. WITH_QUEUE - FlexMatch forms matches and uses the specified
Amazon GameLift queue to start a game session for the match.
- `"GameProperties"`: A set of key-value pairs that can store custom data in a game
session. For example: {\"Key\": \"difficulty\", \"Value\": \"novice\"}. This information is
added to the new GameSession object that is created for a successful match. This parameter
is not used if FlexMatchMode is set to STANDALONE.
- `"GameSessionData"`: A set of custom game session properties, formatted as a single
string value. This data is passed to a game server process with a request to start a new
game session (see Start a Game Session). This information is added to the game session that
is created for a successful match. This parameter is not used if FlexMatchMode is set to
STANDALONE.
- `"GameSessionQueueArns"`: The Amazon Resource Name (ARN) that is assigned to a Amazon
GameLift game session queue resource and uniquely identifies it. ARNs are unique across all
Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>.
Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted
game sessions for matches that are created with this matchmaking configuration. If
FlexMatchMode is set to STANDALONE, do not set this parameter.
- `"NotificationTarget"`: An SNS topic ARN that is set up to receive matchmaking
notifications. See Setting up notifications for matchmaking for more information.
- `"RequestTimeoutSeconds"`: The maximum duration, in seconds, that a matchmaking ticket
can remain in process before timing out. Requests that fail due to timing out can be
resubmitted as needed.
- `"RuleSetName"`: A unique identifier for the matchmaking rule set to use with this
configuration. You can use either the rule set name or ARN value. A matchmaking
configuration can only use rule sets that are defined in the same Region.
"""
function update_matchmaking_configuration(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateMatchmakingConfiguration",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_matchmaking_configuration(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateMatchmakingConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_runtime_configuration(fleet_id, runtime_configuration)
update_runtime_configuration(fleet_id, runtime_configuration, params::Dict{String,<:Any})
Updates the runtime configuration for the specified fleet. The runtime configuration tells
Amazon GameLift how to launch server processes on computes in the fleet. For managed EC2
fleets, it determines what server processes to run on each fleet instance. For container
fleets, it describes what server processes to run in each replica container group. You can
update a fleet's runtime configuration at any time after the fleet is created; it does not
need to be in ACTIVE status. To update runtime configuration, specify the fleet ID and
provide a RuntimeConfiguration with an updated set of server process configurations. If
successful, the fleet's runtime configuration settings are updated. Fleet computes that run
game server processes regularly check for and receive updated runtime configurations. The
computes immediately take action to comply with the new configuration by launching new
server processes or by not replacing existing processes when they shut down. Updating a
fleet's runtime configuration never affects existing server processes. Learn more
Setting up Amazon GameLift fleets
# Arguments
- `fleet_id`: A unique identifier for the fleet to update runtime configuration for. You
can use either the fleet ID or ARN value.
- `runtime_configuration`: Instructions for launching server processes on fleet computes.
Server processes run either a custom game build executable or a Realtime Servers script.
The runtime configuration lists the types of server processes to run, how to launch them,
and the number of processes to run concurrently.
"""
function update_runtime_configuration(
FleetId, RuntimeConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"UpdateRuntimeConfiguration",
Dict{String,Any}(
"FleetId" => FleetId, "RuntimeConfiguration" => RuntimeConfiguration
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_runtime_configuration(
FleetId,
RuntimeConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"UpdateRuntimeConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FleetId" => FleetId, "RuntimeConfiguration" => RuntimeConfiguration
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_script(script_id)
update_script(script_id, params::Dict{String,<:Any})
Updates Realtime script metadata and content. To update script metadata, specify the script
ID and provide updated name and/or version values. To update script content, provide an
updated zip file by pointing to either a local file or an Amazon S3 bucket location. You
can use either method regardless of how the original script was uploaded. Use the Version
parameter to track updates to the script. If the call is successful, the updated metadata
is stored in the script record and a revised script is uploaded to the Amazon GameLift
service. Once the script is updated and acquired by a fleet instance, the new version is
used for all new game sessions. Learn more Amazon GameLift Realtime Servers Related
actions All APIs by task
# Arguments
- `script_id`: A unique identifier for the Realtime script to update. You can use either
the script ID or ARN value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: A descriptive label that is associated with a script. Script names don't need
to be unique.
- `"StorageLocation"`: The location of the Amazon S3 bucket where a zipped file containing
your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket
name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access
the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to
create a new script. By default, Amazon GameLift uploads the latest version of the zip
file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter
to specify an earlier version.
- `"Version"`: Version information associated with a build or script. Version strings don't
need to be unique.
- `"ZipFile"`: A data object containing your Realtime scripts and dependencies as a zip
file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB. When
using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip
file name. It must be prepended with the string \"fileb://\" to indicate that the file data
is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.
"""
function update_script(ScriptId; aws_config::AbstractAWSConfig=global_aws_config())
return gamelift(
"UpdateScript",
Dict{String,Any}("ScriptId" => ScriptId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_script(
ScriptId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"UpdateScript",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ScriptId" => ScriptId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
validate_matchmaking_rule_set(rule_set_body)
validate_matchmaking_rule_set(rule_set_body, params::Dict{String,<:Any})
Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule
set is using syntactically correct JSON and that it conforms to allowed property
expressions. To validate syntax, provide a rule set JSON string. Learn more Build a
rule set
# Arguments
- `rule_set_body`: A collection of matchmaking rules to validate, formatted as a JSON
string.
"""
function validate_matchmaking_rule_set(
RuleSetBody; aws_config::AbstractAWSConfig=global_aws_config()
)
return gamelift(
"ValidateMatchmakingRuleSet",
Dict{String,Any}("RuleSetBody" => RuleSetBody);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function validate_matchmaking_rule_set(
RuleSetBody,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return gamelift(
"ValidateMatchmakingRuleSet",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RuleSetBody" => RuleSetBody), 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 | 81944 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: glacier
using AWS.Compat
using AWS.UUIDs
"""
abort_multipart_upload(account_id, upload_id, vault_name)
abort_multipart_upload(account_id, upload_id, vault_name, params::Dict{String,<:Any})
This operation aborts a multipart upload identified by the upload ID. After the Abort
Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload
or complete the multipart upload. Aborting a completed upload fails. However, aborting an
already-aborted upload will succeed, for a short time. For more information about uploading
a part and completing a multipart upload, see UploadMultipartPart and
CompleteMultipartUpload. This operation is idempotent. An AWS account has full permission
to perform all operations (actions). However, AWS Identity and Access Management (IAM)
users don't have any permissions by default. You must grant them explicit permission to
perform specific actions. For more information, see Access Control Using AWS Identity and
Access Management (IAM). For conceptual information and underlying REST API, see Working
with Archives in Amazon S3 Glacier and Abort Multipart Upload in the Amazon Glacier
Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `upload_id`: The upload ID of the multipart upload to delete.
- `vault_name`: The name of the vault.
"""
function abort_multipart_upload(
accountId, uploadId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads/$(uploadId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function abort_multipart_upload(
accountId,
uploadId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads/$(uploadId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
abort_vault_lock(account_id, vault_name)
abort_vault_lock(account_id, vault_name, params::Dict{String,<:Any})
This operation aborts the vault locking process if the vault lock is not in the Locked
state. If the vault lock is in the Locked state when this operation is requested, the
operation returns an AccessDeniedException error. Aborting the vault locking process
removes the vault lock policy from the specified vault. A vault lock is put into the
InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by
calling CompleteVaultLock. You can get the state of a vault lock by calling GetVaultLock.
For more information about the vault locking process, see Amazon Glacier Vault Lock. For
more information about vault lock policies, see Amazon Glacier Access Control with Vault
Lock Policies. This operation is idempotent. You can successfully invoke this operation
multiple times, if the vault lock is in the InProgress state or if there is no policy
associated with the vault.
# Arguments
- `account_id`: The AccountId value is the AWS account ID. This value must match the AWS
account ID associated with the credentials used to sign the request. You can either specify
an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses
the AWS account ID associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
"""
function abort_vault_lock(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)/lock-policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function abort_vault_lock(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)/lock-policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_tags_to_vault(account_id, vault_name)
add_tags_to_vault(account_id, vault_name, params::Dict{String,<:Any})
This operation adds the specified tags to a vault. Each tag is composed of a key and a
value. Each vault can have up to 10 tags. If your request would cause the tag limit for the
vault to be exceeded, the operation throws the LimitExceededException error. If a tag
already exists on the vault under a specified key, the existing key value will be
overwritten. For more information about tags, see Tagging Amazon S3 Glacier Resources.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Tags"`: The tags to add to the vault. Each tag is composed of a key and a value. The
value can be an empty string.
"""
function add_tags_to_vault(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/tags?operation=add";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_tags_to_vault(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/tags?operation=add",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
complete_multipart_upload(account_id, upload_id, vault_name)
complete_multipart_upload(account_id, upload_id, vault_name, params::Dict{String,<:Any})
You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts
have been uploaded and that Glacier can now assemble the archive from the uploaded parts.
After assembling and saving the archive to the vault, Glacier returns the URI path of the
newly created archive resource. Using the URI path, you can then access the archive. After
you upload an archive, you should save the archive ID returned to retrieve the archive at a
later point. You can also get the vault inventory to obtain a list of archive IDs in a
vault. For more information, see InitiateJob. In the request, you must include the computed
SHA256 tree hash of the entire archive you have uploaded. For information about computing a
SHA256 tree hash, see Computing Checksums. On the server side, Glacier also constructs the
SHA256 tree hash of the assembled archive. If the values match, Glacier saves the archive
to the vault; otherwise, it returns an error, and the operation fails. The ListParts
operation returns a list of parts uploaded for a specific multipart upload. It includes
checksum information for each uploaded part that can be used to debug a bad checksum issue.
Additionally, Glacier also checks for any missing content ranges when assembling the
archive, if missing content ranges are found, Glacier returns an error and the operation
fails. Complete Multipart Upload is an idempotent operation. After your first successful
complete multipart upload, if you call the operation again within a short period, the
operation will succeed and return the same archive ID. This is useful in the event you
experience a network issue that causes an aborted connection or receive a 500 server error,
in which case you can repeat your Complete Multipart Upload request and get the same
archive ID without creating duplicate archives. Note, however, that after the multipart
upload completes, you cannot call the List Parts operation and the multipart upload will
not appear in List Multipart Uploads response, even if idempotent complete is possible. An
AWS account has full permission to perform all operations (actions). However, AWS Identity
and Access Management (IAM) users don't have any permissions by default. You must grant
them explicit permission to perform specific actions. For more information, see Access
Control Using AWS Identity and Access Management (IAM). For conceptual information and
underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Complete
Multipart Upload in the Amazon Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `upload_id`: The upload ID of the multipart upload.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-archive-size"`: The total size, in bytes, of the entire archive. This value
should be the sum of all the sizes of the individual parts that you uploaded.
- `"x-amz-sha256-tree-hash"`: The SHA256 tree hash of the entire archive. It is the tree
hash of SHA256 tree hash of the individual parts. If the value you specify in the request
does not match the SHA256 tree hash of the final assembled archive as computed by Amazon S3
Glacier (Glacier), Glacier returns an error and the request fails.
"""
function complete_multipart_upload(
accountId, uploadId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads/$(uploadId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function complete_multipart_upload(
accountId,
uploadId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads/$(uploadId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
complete_vault_lock(account_id, lock_id, vault_name)
complete_vault_lock(account_id, lock_id, vault_name, params::Dict{String,<:Any})
This operation completes the vault locking process by transitioning the vault lock from the
InProgress state to the Locked state, which causes the vault lock policy to become
unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock.
You can obtain the state of the vault lock by calling GetVaultLock. For more information
about the vault locking process, Amazon Glacier Vault Lock. This operation is idempotent.
This request is always successful if the vault lock is in the Locked state and the provided
lock ID matches the lock ID originally used to lock the vault. If an invalid lock ID is
passed in the request when the vault lock is in the Locked state, the operation returns an
AccessDeniedException error. If an invalid lock ID is passed in the request when the vault
lock is in the InProgress state, the operation throws an InvalidParameter error.
# Arguments
- `account_id`: The AccountId value is the AWS account ID. This value must match the AWS
account ID associated with the credentials used to sign the request. You can either specify
an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses
the AWS account ID associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
- `lock_id`: The lockId value is the lock ID obtained from a InitiateVaultLock request.
- `vault_name`: The name of the vault.
"""
function complete_vault_lock(
accountId, lockId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/lock-policy/$(lockId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function complete_vault_lock(
accountId,
lockId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/lock-policy/$(lockId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_vault(account_id, vault_name)
create_vault(account_id, vault_name, params::Dict{String,<:Any})
This operation creates a new vault with the specified name. The name of the vault must be
unique within a region for an AWS account. You can create up to 1,000 vaults per account.
If you need to create more vaults, contact Amazon S3 Glacier. You must use the following
guidelines when naming a vault. Names can be between 1 and 255 characters long. Allowed
characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period). This
operation is idempotent. An AWS account has full permission to perform all operations
(actions). However, AWS Identity and Access Management (IAM) users don't have any
permissions by default. You must grant them explicit permission to perform specific
actions. For more information, see Access Control Using AWS Identity and Access Management
(IAM). For conceptual information and underlying REST API, see Creating a Vault in Amazon
Glacier and Create Vault in the Amazon Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID. This value must match the AWS
account ID associated with the credentials used to sign the request. You can either specify
an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses
the AWS account ID associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
"""
function create_vault(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"PUT",
"/$(accountId)/vaults/$(vaultName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_vault(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"PUT",
"/$(accountId)/vaults/$(vaultName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_archive(account_id, archive_id, vault_name)
delete_archive(account_id, archive_id, vault_name, params::Dict{String,<:Any})
This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval
of this archive will fail. Archive retrievals that are in progress for this archive ID may
or may not succeed according to the following scenarios: If the archive retrieval job is
actively preparing the data for download when Amazon S3 Glacier receives the delete archive
request, the archival retrieval operation might fail. If the archive retrieval job has
successfully prepared the archive for download when Amazon S3 Glacier receives the delete
archive request, you will be able to download the output. This operation is idempotent.
Attempting to delete an already-deleted archive does not result in an error. An AWS account
has full permission to perform all operations (actions). However, AWS Identity and Access
Management (IAM) users don't have any permissions by default. You must grant them explicit
permission to perform specific actions. For more information, see Access Control Using AWS
Identity and Access Management (IAM). For conceptual information and underlying REST API,
see Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier
Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `archive_id`: The ID of the archive to delete.
- `vault_name`: The name of the vault.
"""
function delete_archive(
accountId, archiveId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)/archives/$(archiveId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_archive(
accountId,
archiveId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)/archives/$(archiveId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vault(account_id, vault_name)
delete_vault(account_id, vault_name, params::Dict{String,<:Any})
This operation deletes a vault. Amazon S3 Glacier will delete a vault only if there are no
archives in the vault as of the last inventory and there have been no writes to the vault
since the last inventory. If either of these conditions is not satisfied, the vault
deletion fails (that is, the vault is not removed) and Amazon S3 Glacier returns an error.
You can use DescribeVault to return the number of archives in a vault, and you can use
Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory
contains the archive IDs you use to delete archives using Delete Archive (DELETE archive).
This operation is idempotent. An AWS account has full permission to perform all operations
(actions). However, AWS Identity and Access Management (IAM) users don't have any
permissions by default. You must grant them explicit permission to perform specific
actions. For more information, see Access Control Using AWS Identity and Access Management
(IAM). For conceptual information and underlying REST API, see Deleting a Vault in Amazon
Glacier and Delete Vault in the Amazon S3 Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
"""
function delete_vault(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vault(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vault_access_policy(account_id, vault_name)
delete_vault_access_policy(account_id, vault_name, params::Dict{String,<:Any})
This operation deletes the access policy associated with the specified vault. The operation
is eventually consistent; that is, it might take some time for Amazon S3 Glacier to
completely remove the access policy, and you might still see the effect of the policy for a
short time after you send the delete request. This operation is idempotent. You can invoke
delete multiple times, even if there is no policy associated with the vault. For more
information about vault access policies, see Amazon Glacier Access Control with Vault
Access Policies.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
"""
function delete_vault_access_policy(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)/access-policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vault_access_policy(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)/access-policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_vault_notifications(account_id, vault_name)
delete_vault_notifications(account_id, vault_name, params::Dict{String,<:Any})
This operation deletes the notification configuration set for a vault. The operation is
eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely
disable the notifications and you might still receive some notifications for a short time
after you send the delete request. An AWS account has full permission to perform all
operations (actions). However, AWS Identity and Access Management (IAM) users don't have
any permissions by default. You must grant them explicit permission to perform specific
actions. For more information, see Access Control Using AWS Identity and Access Management
(IAM). For conceptual information and underlying REST API, see Configuring Vault
Notifications in Amazon S3 Glacier and Delete Vault Notification Configuration in the
Amazon S3 Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
"""
function delete_vault_notifications(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)/notification-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_vault_notifications(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"DELETE",
"/$(accountId)/vaults/$(vaultName)/notification-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job(account_id, job_id, vault_name)
describe_job(account_id, job_id, vault_name, params::Dict{String,<:Any})
This operation returns information about a job you previously initiated, including the job
initiation date, the user who initiated the job, the job status code/message and the Amazon
SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job. For more
information about initiating a job, see InitiateJob. This operation enables you to check
the status of your job. However, it is strongly recommended that you set up an Amazon SNS
topic and specify it in your initiate job request so that Glacier can notify the topic
after it completes the job. A job ID will not expire for at least 24 hours after Glacier
completes the job. An AWS account has full permission to perform all operations (actions).
However, AWS Identity and Access Management (IAM) users don't have any permissions by
default. You must grant them explicit permission to perform specific actions. For more
information, see Access Control Using AWS Identity and Access Management (IAM). For more
information about using this operation, see the documentation for the underlying REST API
Describe Job in the Amazon Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `job_id`: The ID of the job to describe.
- `vault_name`: The name of the vault.
"""
function describe_job(
accountId, jobId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/jobs/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_job(
accountId,
jobId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_vault(account_id, vault_name)
describe_vault(account_id, vault_name, params::Dict{String,<:Any})
This operation returns information about a vault, including the vault's Amazon Resource
Name (ARN), the date the vault was created, the number of archives it contains, and the
total size of all the archives in the vault. The number of archives and their total size
are as of the last inventory generation. This means that if you add or remove an archive
from a vault, and then immediately use Describe Vault, the change in contents will not be
immediately reflected. If you want to retrieve the latest inventory of the vault, use
InitiateJob. Amazon S3 Glacier generates vault inventories approximately daily. For more
information, see Downloading a Vault Inventory in Amazon S3 Glacier. An AWS account has
full permission to perform all operations (actions). However, AWS Identity and Access
Management (IAM) users don't have any permissions by default. You must grant them explicit
permission to perform specific actions. For more information, see Access Control Using AWS
Identity and Access Management (IAM). For conceptual information and underlying REST API,
see Retrieving Vault Metadata in Amazon S3 Glacier and Describe Vault in the Amazon
Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
"""
function describe_vault(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_vault(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_retrieval_policy(account_id)
get_data_retrieval_policy(account_id, params::Dict{String,<:Any})
This operation returns the current data retrieval policy for the account and region
specified in the GET request. For more information about data retrieval policies, see
Amazon Glacier Data Retrieval Policies.
# Arguments
- `account_id`: The AccountId value is the AWS account ID. This value must match the AWS
account ID associated with the credentials used to sign the request. You can either specify
an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses
the AWS account ID associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
"""
function get_data_retrieval_policy(
accountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/policies/data-retrieval";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_retrieval_policy(
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/policies/data-retrieval",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job_output(account_id, job_id, vault_name)
get_job_output(account_id, job_id, vault_name, params::Dict{String,<:Any})
This operation downloads the output of the job you initiated using InitiateJob. Depending
on the job type you specified when you initiated the job, the output will be either the
content of an archive or a vault inventory. You can download all the job output or download
a portion of the output by specifying a byte range. In the case of an archive retrieval
job, depending on the byte range you specify, Amazon S3 Glacier (Glacier) returns the
checksum for the portion of the data. You can compute the checksum on the client and verify
that the values match to ensure the portion you downloaded is the correct data. A job ID
will not expire for at least 24 hours after Glacier completes the job. That a byte range.
For both archive and inventory retrieval jobs, you should verify the downloaded size
against the size returned in the headers from the Get Job Output response. For archive
retrieval jobs, you should also verify that the size is what you expected. If you download
a portion of the output, the expected size is based on the range of bytes you specified.
For example, if you specify a range of bytes=0-1048575, you should verify your download
size is 1,048,576 bytes. If you download an entire archive, the expected size is the size
of the archive when you uploaded it to Amazon S3 Glacier The expected size is also returned
in the headers from the Get Job Output response. In the case of an archive retrieval job,
depending on the byte range you specify, Glacier returns the checksum for the portion of
the data. To ensure the portion you downloaded is the correct data, compute the checksum on
the client, verify that the values match, and verify that the size is what you expected. A
job ID does not expire for at least 24 hours after Glacier completes the job. That is, you
can download the job output within the 24 hours period after Amazon Glacier completes the
job. An AWS account has full permission to perform all operations (actions). However, AWS
Identity and Access Management (IAM) users don't have any permissions by default. You must
grant them explicit permission to perform specific actions. For more information, see
Access Control Using AWS Identity and Access Management (IAM). For conceptual information
and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and
Get Job Output
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `job_id`: The job ID whose data is downloaded.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Range"`: The range of bytes to retrieve from the output. For example, if you want to
download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this
operation downloads the entire output. If the job output is large, then you can use a range
to retrieve a portion of the output. This allows you to download the entire output in
smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to
download and you decide to download 128 MB chunks of data at a time, which is a total of
eight Get Job Output requests. You use the following process to download the job output:
Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all
128 MB of data was received. Along with the data, the response includes a SHA256 tree
hash of the payload. You compute the checksum of the payload on the client and compare it
with the checksum you received in the response to ensure you received all the expected
data. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time
specifying the appropriate byte range. After downloading all the parts of the job output,
you have a list of eight checksum values. Compute the tree hash of these values to find the
checksum of the entire output. Using the DescribeJob API, obtain job information of the job
that provided you the output. The response includes the checksum of the entire archive
stored in Amazon S3 Glacier. You compare this value with the checksum you computed to
ensure you have downloaded the entire archive content with no errors.
"""
function get_job_output(
accountId, jobId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/jobs/$(jobId)/output";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job_output(
accountId,
jobId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/jobs/$(jobId)/output",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vault_access_policy(account_id, vault_name)
get_vault_access_policy(account_id, vault_name, params::Dict{String,<:Any})
This operation retrieves the access-policy subresource set on the vault; for more
information on setting this subresource, see Set Vault Access Policy (PUT access-policy).
If there is no access policy set on the vault, the operation returns a 404 Not found error.
For more information about vault access policies, see Amazon Glacier Access Control with
Vault Access Policies.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
"""
function get_vault_access_policy(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/access-policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vault_access_policy(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/access-policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vault_lock(account_id, vault_name)
get_vault_lock(account_id, vault_name, params::Dict{String,<:Any})
This operation retrieves the following attributes from the lock-policy subresource set on
the specified vault: The vault lock policy set on the vault. The state of the vault
lock, which is either InProgess or Locked. When the lock ID expires. The lock ID is used
to complete the vault locking process. When the vault lock was initiated and put into the
InProgress state. A vault lock is put into the InProgress state by calling
InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock.
You can abort the vault locking process by calling AbortVaultLock. For more information
about the vault locking process, Amazon Glacier Vault Lock. If there is no vault lock
policy set on the vault, the operation returns a 404 Not found error. For more information
about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
"""
function get_vault_lock(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/lock-policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vault_lock(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/lock-policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_vault_notifications(account_id, vault_name)
get_vault_notifications(account_id, vault_name, params::Dict{String,<:Any})
This operation retrieves the notification-configuration subresource of the specified vault.
For information about setting a notification configuration on a vault, see
SetVaultNotifications. If a notification configuration for a vault is not set, the
operation returns a 404 Not Found error. For more information about vault notifications,
see Configuring Vault Notifications in Amazon S3 Glacier. An AWS account has full
permission to perform all operations (actions). However, AWS Identity and Access Management
(IAM) users don't have any permissions by default. You must grant them explicit permission
to perform specific actions. For more information, see Access Control Using AWS Identity
and Access Management (IAM). For conceptual information and underlying REST API, see
Configuring Vault Notifications in Amazon S3 Glacier and Get Vault Notification
Configuration in the Amazon Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
"""
function get_vault_notifications(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/notification-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_vault_notifications(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/notification-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
initiate_job(account_id, vault_name)
initiate_job(account_id, vault_name, params::Dict{String,<:Any})
This operation initiates a job of the specified type, which can be a select, an archival
retrieval, or a vault retrieval. For more information about using this operation, see the
documentation for the underlying REST API Initiate a Job.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"jobParameters"`: Provides options for specifying job information.
"""
function initiate_job(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function initiate_job(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
initiate_multipart_upload(account_id, vault_name)
initiate_multipart_upload(account_id, vault_name, params::Dict{String,<:Any})
This operation initiates a multipart upload. Amazon S3 Glacier creates a multipart upload
resource and returns its ID in the response. The multipart upload ID is used in subsequent
requests to upload parts of an archive (see UploadMultipartPart). When you initiate a
multipart upload, you specify the part size in number of bytes. The part size must be a
megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB),
4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the
maximum is 4 GB. Every part you upload to this resource (see UploadMultipartPart), except
the last one, must have the same size. The last one can be the same size or smaller. For
example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload
with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.
You don't need to know the size of the archive when you start a multipart upload because
Amazon S3 Glacier does not require you to specify the overall archive size. After you
complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart upload
resource referenced by the ID. Glacier also removes the multipart upload resource if you
cancel the multipart upload or it may be removed if there is no activity for a period of 24
hours. An AWS account has full permission to perform all operations (actions). However, AWS
Identity and Access Management (IAM) users don't have any permissions by default. You must
grant them explicit permission to perform specific actions. For more information, see
Access Control Using AWS Identity and Access Management (IAM). For conceptual information
and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and
Initiate Multipart Upload in the Amazon Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-archive-description"`: The archive description that you are uploading in parts.
The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576
(1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable
part size is 1 MB, and the maximum is 4 GB (4096 MB).
- `"x-amz-part-size"`: The size of each part except the last, in bytes. The last part can
be smaller than this part size.
"""
function initiate_multipart_upload(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function initiate_multipart_upload(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
initiate_vault_lock(account_id, vault_name)
initiate_vault_lock(account_id, vault_name, params::Dict{String,<:Any})
This operation initiates the vault locking process by doing the following: Installing a
vault lock policy on the specified vault. Setting the lock state of vault lock to
InProgress. Returning a lock ID, which is used to complete the vault locking process.
You can set one vault lock policy for each vault and this policy can be up to 20 KB in
size. For more information about vault lock policies, see Amazon Glacier Access Control
with Vault Lock Policies. You must complete the vault locking process within 24 hours
after the vault lock enters the InProgress state. After the 24 hour window ends, the lock
ID expires, the vault automatically exits the InProgress state, and the vault lock policy
is removed from the vault. You call CompleteVaultLock to complete the vault locking process
by setting the state of the vault lock to Locked. After a vault lock is in the Locked
state, you cannot initiate a new vault lock for the vault. You can abort the vault locking
process by calling AbortVaultLock. You can get the state of the vault lock by calling
GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault
Lock. If this operation is called when the vault lock is in the InProgress state, the
operation returns an AccessDeniedException error. When the vault lock is in the InProgress
state you must call AbortVaultLock before you can initiate a new vault lock policy.
# Arguments
- `account_id`: The AccountId value is the AWS account ID. This value must match the AWS
account ID associated with the credentials used to sign the request. You can either specify
an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses
the AWS account ID associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"policy"`: The vault lock policy as a JSON string, which uses \"\" as an escape
character.
"""
function initiate_vault_lock(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/lock-policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function initiate_vault_lock(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/lock-policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs(account_id, vault_name)
list_jobs(account_id, vault_name, params::Dict{String,<:Any})
This operation lists jobs for a vault, including jobs that are in-progress and jobs that
have recently finished. The List Job operation returns a list of these jobs sorted by job
initiation time. Amazon Glacier retains recently completed jobs for a period before
deleting them; however, it eventually removes completed jobs. The output of completed jobs
can be retrieved. Retaining completed jobs for a period of time after they have completed
enables you to get a job output in the event you miss the job completion notification or
your first attempt to download it fails. For example, suppose you start an archive
retrieval job to download an archive. After the job completes, you start to download the
archive but encounter a network error. In this scenario, you can retry and download the
archive while the job exists. The List Jobs operation supports pagination. You should
always check the response Marker field. If there are no more jobs to list, the Marker field
is set to null. If there are more jobs to list, the Marker field is set to a non-null
value, which you can use to continue the pagination of the list. To return a list of jobs
that begins at a specific job, set the marker request parameter to the Marker value for
that job that you obtained from a previous List Jobs request. You can set a maximum limit
for the number of jobs returned in the response by specifying the limit parameter in the
request. The default limit is 50. The number of jobs returned might be fewer than the
limit, but the number of returned jobs never exceeds the limit. Additionally, you can
filter the jobs list returned by specifying the optional statuscode parameter or completed
parameter, or both. Using the statuscode parameter, you can specify to return only jobs
that match either the InProgress, Succeeded, or Failed status. Using the completed
parameter, you can specify to return only jobs that were completed (true) or jobs that were
not completed (false). For more information about using this operation, see the
documentation for the underlying REST API List Jobs.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"completed"`: The state of the jobs to return. You can specify true or false.
- `"limit"`: The maximum number of jobs to be returned. The default limit is 50. The number
of jobs returned might be fewer than the specified limit, but the number of returned jobs
never exceeds the limit.
- `"marker"`: An opaque string used for pagination. This value specifies the job at which
the listing of jobs should begin. Get the marker value from a previous List Jobs response.
You only need to include the marker if you are continuing the pagination of results started
in a previous List Jobs request.
- `"statuscode"`: The type of job status to return. You can specify the following values:
InProgress, Succeeded, or Failed.
"""
function list_jobs(accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config())
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_jobs(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_multipart_uploads(account_id, vault_name)
list_multipart_uploads(account_id, vault_name, params::Dict{String,<:Any})
This operation lists in-progress multipart uploads for the specified vault. An in-progress
multipart upload is a multipart upload that has been initiated by an
InitiateMultipartUpload request, but has not yet been completed or aborted. The list
returned in the List Multipart Upload response has no guaranteed order. The List Multipart
Uploads operation supports pagination. By default, this operation returns up to 50
multipart uploads in the response. You should always check the response for a marker at
which to continue the list; if there are no more items the marker is null. To return a list
of multipart uploads that begins at a specific upload, set the marker request parameter to
the value you obtained from a previous List Multipart Upload request. You can also limit
the number of uploads returned in the response by specifying the limit parameter in the
request. Note the difference between this operation and listing parts (ListParts). The List
Multipart Uploads operation lists all multipart uploads for a vault and does not require a
multipart upload ID. The List Parts operation requires a multipart upload ID since parts
are associated with a single upload. An AWS account has full permission to perform all
operations (actions). However, AWS Identity and Access Management (IAM) users don't have
any permissions by default. You must grant them explicit permission to perform specific
actions. For more information, see Access Control Using AWS Identity and Access Management
(IAM). For conceptual information and the underlying REST API, see Working with Archives in
Amazon S3 Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`: Specifies the maximum number of uploads returned in the response body. If this
value is not specified, the List Uploads operation returns up to 50 uploads.
- `"marker"`: An opaque string used for pagination. This value specifies the upload at
which the listing of uploads should begin. Get the marker value from a previous List
Uploads response. You need only include the marker if you are continuing the pagination of
results started in a previous List Uploads request.
"""
function list_multipart_uploads(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_multipart_uploads(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_parts(account_id, upload_id, vault_name)
list_parts(account_id, upload_id, vault_name, params::Dict{String,<:Any})
This operation lists the parts of an archive that have been uploaded in a specific
multipart upload. You can make this request at any time during an in-progress multipart
upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an
error for completed uploads. The list returned in the List Parts response is sorted by part
range. The List Parts operation supports pagination. By default, this operation returns up
to 50 uploaded parts in the response. You should always check the response for a marker at
which to continue the list; if there are no more items the marker is null. To return a list
of parts that begins at a specific part, set the marker request parameter to the value you
obtained from a previous List Parts request. You can also limit the number of parts
returned in the response by specifying the limit parameter in the request. An AWS account
has full permission to perform all operations (actions). However, AWS Identity and Access
Management (IAM) users don't have any permissions by default. You must grant them explicit
permission to perform specific actions. For more information, see Access Control Using AWS
Identity and Access Management (IAM). For conceptual information and the underlying REST
API, see Working with Archives in Amazon S3 Glacier and List Parts in the Amazon Glacier
Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `upload_id`: The upload ID of the multipart upload.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`: The maximum number of parts to be returned. The default limit is 50. The
number of parts returned might be fewer than the specified limit, but the number of
returned parts never exceeds the limit.
- `"marker"`: An opaque string used for pagination. This value specifies the part at which
the listing of parts should begin. Get the marker value from the response of a previous
List Parts response. You need only include the marker if you are continuing the pagination
of results started in a previous List Parts request.
"""
function list_parts(
accountId, uploadId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads/$(uploadId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_parts(
accountId,
uploadId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads/$(uploadId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_provisioned_capacity(account_id)
list_provisioned_capacity(account_id, params::Dict{String,<:Any})
This operation lists the provisioned capacity units for the specified AWS account.
# Arguments
- `account_id`: The AWS account ID of the account that owns the vault. You can either
specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3
Glacier uses the AWS account ID associated with the credentials used to sign the request.
If you use an account ID, don't include any hyphens ('-') in the ID.
"""
function list_provisioned_capacity(
accountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/provisioned-capacity";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_provisioned_capacity(
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/provisioned-capacity",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_vault(account_id, vault_name)
list_tags_for_vault(account_id, vault_name, params::Dict{String,<:Any})
This operation lists all the tags attached to a vault. The operation returns an empty map
if there are no tags. For more information about tags, see Tagging Amazon S3 Glacier
Resources.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
"""
function list_tags_for_vault(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/tags";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_vault(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults/$(vaultName)/tags",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_vaults(account_id)
list_vaults(account_id, params::Dict{String,<:Any})
This operation lists all vaults owned by the calling user's account. The list returned in
the response is ASCII-sorted by vault name. By default, this operation returns up to 10
items. If there are more vaults to list, the response marker field contains the vault
Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request;
otherwise, the marker field is null. To return a list of vaults that begins at a specific
vault, set the marker request parameter to the vault ARN you obtained from a previous List
Vaults request. You can also limit the number of vaults returned in the response by
specifying the limit parameter in the request. An AWS account has full permission to
perform all operations (actions). However, AWS Identity and Access Management (IAM) users
don't have any permissions by default. You must grant them explicit permission to perform
specific actions. For more information, see Access Control Using AWS Identity and Access
Management (IAM). For conceptual information and underlying REST API, see Retrieving Vault
Metadata in Amazon S3 Glacier and List Vaults in the Amazon Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID. This value must match the AWS
account ID associated with the credentials used to sign the request. You can either specify
an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses
the AWS account ID associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"limit"`: The maximum number of vaults to be returned. The default limit is 10. The
number of vaults returned might be fewer than the specified limit, but the number of
returned vaults never exceeds the limit.
- `"marker"`: A string used for pagination. The marker specifies the vault ARN after which
the listing of vaults should begin.
"""
function list_vaults(accountId; aws_config::AbstractAWSConfig=global_aws_config())
return glacier(
"GET",
"/$(accountId)/vaults";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_vaults(
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"GET",
"/$(accountId)/vaults",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
purchase_provisioned_capacity(account_id)
purchase_provisioned_capacity(account_id, params::Dict{String,<:Any})
This operation purchases a provisioned capacity unit for an AWS account.
# Arguments
- `account_id`: The AWS account ID of the account that owns the vault. You can either
specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3
Glacier uses the AWS account ID associated with the credentials used to sign the request.
If you use an account ID, don't include any hyphens ('-') in the ID.
"""
function purchase_provisioned_capacity(
accountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"POST",
"/$(accountId)/provisioned-capacity";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function purchase_provisioned_capacity(
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"POST",
"/$(accountId)/provisioned-capacity",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_tags_from_vault(account_id, vault_name)
remove_tags_from_vault(account_id, vault_name, params::Dict{String,<:Any})
This operation removes one or more tags from the set of tags attached to a vault. For more
information about tags, see Tagging Amazon S3 Glacier Resources. This operation is
idempotent. The operation will be successful, even if there are no tags attached to the
vault.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TagKeys"`: A list of tag keys. Each corresponding tag is removed from the vault.
"""
function remove_tags_from_vault(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/tags?operation=remove";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_tags_from_vault(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/tags?operation=remove",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_data_retrieval_policy(account_id)
set_data_retrieval_policy(account_id, params::Dict{String,<:Any})
This operation sets and then enacts a data retrieval policy in the region specified in the
PUT request. You can set one policy per region for an AWS account. The policy is enacted
within a few minutes of a successful PUT operation. The set policy operation does not
affect retrieval jobs that were in progress before the policy was enacted. For more
information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.
# Arguments
- `account_id`: The AccountId value is the AWS account ID. This value must match the AWS
account ID associated with the credentials used to sign the request. You can either specify
an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses
the AWS account ID associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Policy"`: The data retrieval policy in JSON format.
"""
function set_data_retrieval_policy(
accountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"PUT",
"/$(accountId)/policies/data-retrieval";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_data_retrieval_policy(
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"PUT",
"/$(accountId)/policies/data-retrieval",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_vault_access_policy(account_id, vault_name)
set_vault_access_policy(account_id, vault_name, params::Dict{String,<:Any})
This operation configures an access policy for a vault and will overwrite an existing
policy. To configure a vault access policy, send a PUT request to the access-policy
subresource of the vault. An access policy is specific to a vault and is also called a
vault subresource. You can set one access policy per vault and the policy can be up to 20
KB in size. For more information about vault access policies, see Amazon Glacier Access
Control with Vault Access Policies.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"policy"`: The vault access policy as a JSON string.
"""
function set_vault_access_policy(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"PUT",
"/$(accountId)/vaults/$(vaultName)/access-policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_vault_access_policy(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"PUT",
"/$(accountId)/vaults/$(vaultName)/access-policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_vault_notifications(account_id, vault_name)
set_vault_notifications(account_id, vault_name, params::Dict{String,<:Any})
This operation configures notifications that will be sent when specific events happen to a
vault. By default, you don't get any notifications. To configure vault notifications, send
a PUT request to the notification-configuration subresource of the vault. The request
should include a JSON document that provides an Amazon SNS topic and specific events for
which you want Amazon S3 Glacier to send notifications to the topic. Amazon SNS topics must
grant permission to the vault to be allowed to publish notifications to the topic. You can
configure a vault to publish a notification for the following vault events:
ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive
retrieval is completed (InitiateJob). The status of the completed job can be \"Succeeded\"
or \"Failed\". The notification sent to the SNS topic is the same output as returned from
DescribeJob. InventoryRetrievalCompleted This event occurs when a job that was
initiated for an inventory retrieval is completed (InitiateJob). The status of the
completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is
the same output as returned from DescribeJob. An AWS account has full permission to
perform all operations (actions). However, AWS Identity and Access Management (IAM) users
don't have any permissions by default. You must grant them explicit permission to perform
specific actions. For more information, see Access Control Using AWS Identity and Access
Management (IAM). For conceptual information and underlying REST API, see Configuring Vault
Notifications in Amazon S3 Glacier and Set Vault Notification Configuration in the Amazon
Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"vaultNotificationConfig"`: Provides options for specifying notification configuration.
"""
function set_vault_notifications(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"PUT",
"/$(accountId)/vaults/$(vaultName)/notification-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_vault_notifications(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"PUT",
"/$(accountId)/vaults/$(vaultName)/notification-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_archive(account_id, vault_name)
upload_archive(account_id, vault_name, params::Dict{String,<:Any})
This operation adds an archive to a vault. This is a synchronous operation, and for a
successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID
in the x-amz-archive-id header of the response. You must use the archive ID to access your
data in Amazon S3 Glacier. After you upload an archive, you should save the archive ID
returned so that you can retrieve or delete the archive later. Besides saving the archive
ID, you can also index it and give it a friendly name to allow for better searching. You
can also use the optional archive description field to specify how the archive is referred
to in an external index of archives, such as you might create in Amazon DynamoDB. You can
also get the vault inventory to obtain a list of archive IDs in a vault. For more
information, see InitiateJob. You must provide a SHA256 tree hash of the data you are
uploading. For information about computing a SHA256 tree hash, see Computing Checksums.
You can optionally specify an archive description of up to 1,024 printable ASCII
characters. You can get the archive description when you either retrieve the archive or get
the vault inventory. For more information, see InitiateJob. Amazon Glacier does not
interpret the description in any way. An archive description does not need to be unique.
You cannot use the description to retrieve or sort the archive list. Archives are
immutable. After you upload an archive, you cannot edit the archive or its description. An
AWS account has full permission to perform all operations (actions). However, AWS Identity
and Access Management (IAM) users don't have any permissions by default. You must grant
them explicit permission to perform specific actions. For more information, see Access
Control Using AWS Identity and Access Management (IAM). For conceptual information and
underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the
Amazon Glacier Developer Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"body"`: The data to upload.
- `"x-amz-archive-description"`: The optional description of the archive you are uploading.
- `"x-amz-sha256-tree-hash"`: The SHA256 tree hash of the data being uploaded.
"""
function upload_archive(
accountId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/archives";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upload_archive(
accountId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"POST",
"/$(accountId)/vaults/$(vaultName)/archives",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_multipart_part(account_id, upload_id, vault_name)
upload_multipart_part(account_id, upload_id, vault_name, params::Dict{String,<:Any})
This operation uploads a part of an archive. You can upload archive parts in any order. You
can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.
Amazon Glacier rejects your upload part request if any of the following conditions is true:
SHA256 tree hash does not matchTo ensure that part data is not corrupted in
transmission, you compute a SHA256 tree hash of the part and include it in your request.
Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 tree hash. If these
hash values don't match, the operation fails. For information about computing a SHA256 tree
hash, see Computing Checksums. Part size does not matchThe size of each part except the
last must match the size specified in the corresponding InitiateMultipartUpload request.
The size of the last part must be the same size as, or smaller than, the specified size.
If you upload a part whose size is smaller than the part size you specified in your
initiate multipart upload request and that part is not the last part, then the upload part
request will succeed. However, the subsequent Complete Multipart Upload request will fail.
Range does not alignThe byte range value in the request does not align with the part
size specified in the corresponding initiate request. For example, if you specify a part
size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to
8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6
MB, the range does not align with the part size and the upload will fail. This operation
is idempotent. If you upload the same part multiple times, the data included in the most
recent request overwrites the previously uploaded data. An AWS account has full permission
to perform all operations (actions). However, AWS Identity and Access Management (IAM)
users don't have any permissions by default. You must grant them explicit permission to
perform specific actions. For more information, see Access Control Using AWS Identity and
Access Management (IAM). For conceptual information and underlying REST API, see Uploading
Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer
Guide.
# Arguments
- `account_id`: The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.
- `upload_id`: The upload ID of the multipart upload.
- `vault_name`: The name of the vault.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Content-Range"`: Identifies the range of bytes in the assembled archive that will be
uploaded in this part. Amazon S3 Glacier uses this information to assemble the archive in
the proper sequence. The format of this header follows RFC 2616. An example header is
Content-Range:bytes 0-4194303/*.
- `"body"`: The data to upload.
- `"x-amz-sha256-tree-hash"`: The SHA256 tree hash of the data being uploaded.
"""
function upload_multipart_part(
accountId, uploadId, vaultName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glacier(
"PUT",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads/$(uploadId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upload_multipart_part(
accountId,
uploadId,
vaultName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glacier(
"PUT",
"/$(accountId)/vaults/$(vaultName)/multipart-uploads/$(uploadId)",
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 | 102414 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: global_accelerator
using AWS.Compat
using AWS.UUIDs
"""
add_custom_routing_endpoints(endpoint_configurations, endpoint_group_arn)
add_custom_routing_endpoints(endpoint_configurations, endpoint_group_arn, params::Dict{String,<:Any})
Associate a virtual private cloud (VPC) subnet endpoint with your custom routing
accelerator. The listener port range must be large enough to support the number of IP
addresses that can be specified in your subnet. The number of ports required is: subnet
size times the number of ports per destination EC2 instances. For example, a subnet defined
as /24 requires a listener port range of at least 255 ports. Note: You must have enough
remaining listener ports available to map to the subnet ports, or the call will fail with a
LimitExceededException. By default, all destinations in a subnet in a custom routing
accelerator cannot receive traffic. To enable all destinations to receive traffic, or to
specify individual port mappings that can receive traffic, see the
AllowCustomRoutingTraffic operation.
# Arguments
- `endpoint_configurations`: The list of endpoint objects to add to a custom routing
accelerator.
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group for the custom
routing endpoint.
"""
function add_custom_routing_endpoints(
EndpointConfigurations,
EndpointGroupArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"AddCustomRoutingEndpoints",
Dict{String,Any}(
"EndpointConfigurations" => EndpointConfigurations,
"EndpointGroupArn" => EndpointGroupArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_custom_routing_endpoints(
EndpointConfigurations,
EndpointGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"AddCustomRoutingEndpoints",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointConfigurations" => EndpointConfigurations,
"EndpointGroupArn" => EndpointGroupArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_endpoints(endpoint_configurations, endpoint_group_arn)
add_endpoints(endpoint_configurations, endpoint_group_arn, params::Dict{String,<:Any})
Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended
option for adding endpoints. The alternative options are to add endpoints when you create
an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group
(with the UpdateEndpointGroup API). There are two advantages to using AddEndpoints to add
endpoints in Global Accelerator: It's faster, because Global Accelerator only has to
resolve the new endpoints that you're adding, rather than resolving new and existing
endpoints. It's more convenient, because you don't need to specify the current endpoints
that are already in the endpoint group, in addition to the new endpoints that you want to
add. For information about endpoint types and requirements for endpoints that you can add
to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator
Developer Guide.
# Arguments
- `endpoint_configurations`: The list of endpoint objects.
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group.
"""
function add_endpoints(
EndpointConfigurations,
EndpointGroupArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"AddEndpoints",
Dict{String,Any}(
"EndpointConfigurations" => EndpointConfigurations,
"EndpointGroupArn" => EndpointGroupArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_endpoints(
EndpointConfigurations,
EndpointGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"AddEndpoints",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointConfigurations" => EndpointConfigurations,
"EndpointGroupArn" => EndpointGroupArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
advertise_byoip_cidr(cidr)
advertise_byoip_cidr(cidr, params::Dict{String,<:Any})
Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services
resources through bring your own IP addresses (BYOIP). It can take a few minutes before
traffic to the specified addresses starts routing to Amazon Web Services because of
propagation delays. To stop advertising the BYOIP address range, use WithdrawByoipCidr.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator
Developer Guide.
# Arguments
- `cidr`: The address range, in CIDR notation. This must be the exact range that you
provisioned. You can't advertise only a portion of the provisioned range. For more
information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer
Guide.
"""
function advertise_byoip_cidr(Cidr; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"AdvertiseByoipCidr",
Dict{String,Any}("Cidr" => Cidr);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function advertise_byoip_cidr(
Cidr, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"AdvertiseByoipCidr",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Cidr" => Cidr), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
allow_custom_routing_traffic(endpoint_group_arn, endpoint_id)
allow_custom_routing_traffic(endpoint_group_arn, endpoint_id, params::Dict{String,<:Any})
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet
endpoint that can receive traffic for a custom routing accelerator. You can allow traffic
to all destinations in the subnet endpoint, or allow traffic to a specified list of
destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses
or ports outside of the range that you configured for the endpoint group. After you make
changes, you can verify that the updates are complete by checking the status of your
accelerator: the status changes from IN_PROGRESS to DEPLOYED.
# Arguments
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group.
- `endpoint_id`: An ID for the endpoint. For custom routing accelerators, this is the
virtual private cloud (VPC) subnet ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowAllTrafficToEndpoint"`: Indicates whether all destination IP addresses and ports
for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator.
The value is TRUE or FALSE. When set to TRUE, all destinations in the custom routing VPC
subnet can receive traffic. Note that you cannot specify destination IP addresses and ports
when the value is set to TRUE. When set to FALSE (or not specified), you must specify a
list of destination IP addresses that are allowed to receive traffic. A list of ports is
optional. If you don't specify a list of ports, the ports that can accept traffic is the
same as the ports configured for the endpoint group. The default value is FALSE.
- `"DestinationAddresses"`: A list of specific Amazon EC2 instance IP addresses
(destination addresses) in a subnet that you want to allow to receive traffic. The IP
addresses must be a subset of the IP addresses that you specified for the endpoint group.
DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.
- `"DestinationPorts"`: A list of specific Amazon EC2 instance ports (destination ports)
that you want to allow to receive traffic.
"""
function allow_custom_routing_traffic(
EndpointGroupArn, EndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"AllowCustomRoutingTraffic",
Dict{String,Any}(
"EndpointGroupArn" => EndpointGroupArn, "EndpointId" => EndpointId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function allow_custom_routing_traffic(
EndpointGroupArn,
EndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"AllowCustomRoutingTraffic",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointGroupArn" => EndpointGroupArn, "EndpointId" => EndpointId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_accelerator(idempotency_token, name)
create_accelerator(idempotency_token, name, params::Dict{String,<:Any})
Create an accelerator. An accelerator includes one or more listeners that process inbound
connections and direct traffic to one or more endpoint groups, each of which includes
endpoints, such as Network Load Balancers. Global Accelerator is a global service that
supports endpoints in multiple Amazon Web Services Regions but you must specify the US West
(Oregon) Region to create, update, or otherwise work with accelerators. That is, for
example, specify --region us-west-2 on Amazon Web Services CLI commands.
# Arguments
- `idempotency_token`: A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of an accelerator.
- `name`: The name of the accelerator. The name can have a maximum of 64 characters, must
contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or
end with a hyphen or period.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: Indicates whether an accelerator is enabled. The value is true or false. The
default value is true. If the value is set to true, an accelerator cannot be deleted. If
set to false, the accelerator can be deleted.
- `"IpAddressType"`: The IP address type that an accelerator supports. For a standard
accelerator, the value can be IPV4 or DUAL_STACK.
- `"IpAddresses"`: Optionally, if you've added your own IP address pool to Global
Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the
accelerator's static IPv4 address when you create an accelerator. After you bring an
address range to Amazon Web Services, it appears in your account as an address pool. When
you create an accelerator, you can assign one IPv4 address from your range to it. Global
Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If
you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address
from each range to your accelerator. This restriction is because Global Accelerator assigns
each address range to a different network zone, for high availability. You can specify one
or two addresses, separated by a space. Do not include the /32 suffix. Note that you can't
update IP addresses for an existing accelerator. To change them, you must create a new
accelerator with the new addresses. For more information, see Bring your own IP addresses
(BYOIP) in the Global Accelerator Developer Guide.
- `"Tags"`: Create tags for an accelerator. For more information, see Tagging in Global
Accelerator in the Global Accelerator Developer Guide.
"""
function create_accelerator(
IdempotencyToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"CreateAccelerator",
Dict{String,Any}("IdempotencyToken" => IdempotencyToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_accelerator(
IdempotencyToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateAccelerator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IdempotencyToken" => IdempotencyToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cross_account_attachment(idempotency_token, name)
create_cross_account_attachment(idempotency_token, name, params::Dict{String,<:Any})
Create a cross-account attachment in Global Accelerator. You create a cross-account
attachment to specify the principals who have permission to work with resources in
accelerators in their own account. You specify, in the same attachment, the resources that
are shared. A principal can be an Amazon Web Services account number or the Amazon Resource
Name (ARN) for an accelerator. For account numbers that are listed as principals, to work
with a resource listed in the attachment, you must sign in to an account specified as a
principal. Then, you can work with resources that are listed, with any of your
accelerators. If an accelerator ARN is listed in the cross-account attachment as a
principal, anyone with permission to make updates to the accelerator can work with
resources that are listed in the attachment. Specify each principal and resource
separately. To specify two CIDR address pools, list them individually under Resources, and
so on. For a command line operation, for example, you might use a statement like the
following: \"Resources\": [{\"Cidr\": \"169.254.60.0/24\"},{\"Cidr\":
\"169.254.59.0/24\"}] For more information, see Working with cross-account attachments
and resources in Global Accelerator in the Global Accelerator Developer Guide.
# Arguments
- `idempotency_token`: A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
- `name`: The name of the cross-account attachment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Principals"`: The principals to include in the cross-account attachment. A principal
can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an
accelerator.
- `"Resources"`: The Amazon Resource Names (ARNs) for the resources to include in the
cross-account attachment. A resource can be any supported Amazon Web Services resource type
for Global Accelerator or a CIDR range for a bring your own IP address (BYOIP) address
pool.
- `"Tags"`: Add tags for a cross-account attachment. For more information, see Tagging in
Global Accelerator in the Global Accelerator Developer Guide.
"""
function create_cross_account_attachment(
IdempotencyToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"CreateCrossAccountAttachment",
Dict{String,Any}("IdempotencyToken" => IdempotencyToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cross_account_attachment(
IdempotencyToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateCrossAccountAttachment",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IdempotencyToken" => IdempotencyToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_routing_accelerator(idempotency_token, name)
create_custom_routing_accelerator(idempotency_token, name, params::Dict{String,<:Any})
Create a custom routing accelerator. A custom routing accelerator directs traffic to one of
possibly thousands of Amazon EC2 instance destinations running in a single or multiple
virtual private clouds (VPC) subnet endpoints. Be aware that, by default, all destination
EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations
to receive traffic, or to specify individual port mappings that can receive traffic, see
the AllowCustomRoutingTraffic operation. Global Accelerator is a global service that
supports endpoints in multiple Amazon Web Services Regions but you must specify the US West
(Oregon) Region to create, update, or otherwise work with accelerators. That is, for
example, specify --region us-west-2 on Amazon Web Services CLI commands.
# Arguments
- `idempotency_token`: A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
- `name`: The name of a custom routing accelerator. The name can have a maximum of 64
characters, must contain only alphanumeric characters or hyphens (-), and must not begin or
end with a hyphen.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: Indicates whether an accelerator is enabled. The value is true or false. The
default value is true. If the value is set to true, an accelerator cannot be deleted. If
set to false, the accelerator can be deleted.
- `"IpAddressType"`: The IP address type that an accelerator supports. For a custom routing
accelerator, the value must be IPV4.
- `"IpAddresses"`: Optionally, if you've added your own IP address pool to Global
Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the
accelerator's static IPv4 address when you create an accelerator. After you bring an
address range to Amazon Web Services, it appears in your account as an address pool. When
you create an accelerator, you can assign one IPv4 address from your range to it. Global
Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If
you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address
from each range to your accelerator. This restriction is because Global Accelerator assigns
each address range to a different network zone, for high availability. You can specify one
or two addresses, separated by a space. Do not include the /32 suffix. Note that you can't
update IP addresses for an existing accelerator. To change them, you must create a new
accelerator with the new addresses. For more information, see Bring your own IP addresses
(BYOIP) in the Global Accelerator Developer Guide.
- `"Tags"`: Create tags for an accelerator. For more information, see Tagging in Global
Accelerator in the Global Accelerator Developer Guide.
"""
function create_custom_routing_accelerator(
IdempotencyToken, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"CreateCustomRoutingAccelerator",
Dict{String,Any}("IdempotencyToken" => IdempotencyToken, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_routing_accelerator(
IdempotencyToken,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateCustomRoutingAccelerator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IdempotencyToken" => IdempotencyToken, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_routing_endpoint_group(destination_configurations, endpoint_group_region, idempotency_token, listener_arn)
create_custom_routing_endpoint_group(destination_configurations, endpoint_group_region, idempotency_token, listener_arn, params::Dict{String,<:Any})
Create an endpoint group for the specified listener for a custom routing accelerator. An
endpoint group is a collection of endpoints in one Amazon Web Services Region.
# Arguments
- `destination_configurations`: Sets the port range and protocol for all endpoints (virtual
private cloud subnets) in a custom routing endpoint group to accept client traffic on.
- `endpoint_group_region`: The Amazon Web Services Region where the endpoint group is
located. A listener can have only one endpoint group in a specific Region.
- `idempotency_token`: A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
- `listener_arn`: The Amazon Resource Name (ARN) of the listener for a custom routing
endpoint.
"""
function create_custom_routing_endpoint_group(
DestinationConfigurations,
EndpointGroupRegion,
IdempotencyToken,
ListenerArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateCustomRoutingEndpointGroup",
Dict{String,Any}(
"DestinationConfigurations" => DestinationConfigurations,
"EndpointGroupRegion" => EndpointGroupRegion,
"IdempotencyToken" => IdempotencyToken,
"ListenerArn" => ListenerArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_routing_endpoint_group(
DestinationConfigurations,
EndpointGroupRegion,
IdempotencyToken,
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateCustomRoutingEndpointGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationConfigurations" => DestinationConfigurations,
"EndpointGroupRegion" => EndpointGroupRegion,
"IdempotencyToken" => IdempotencyToken,
"ListenerArn" => ListenerArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_routing_listener(accelerator_arn, idempotency_token, port_ranges)
create_custom_routing_listener(accelerator_arn, idempotency_token, port_ranges, params::Dict{String,<:Any})
Create a listener to process inbound connections from clients to a custom routing
accelerator. Connections arrive to assigned static IP addresses on the port range that you
specify.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the accelerator for a custom routing
listener.
- `idempotency_token`: A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
- `port_ranges`: The port range to support for connections from clients to your
accelerator. Separately, you set port ranges for endpoints. For more information, see About
endpoints for custom routing accelerators.
"""
function create_custom_routing_listener(
AcceleratorArn,
IdempotencyToken,
PortRanges;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateCustomRoutingListener",
Dict{String,Any}(
"AcceleratorArn" => AcceleratorArn,
"IdempotencyToken" => IdempotencyToken,
"PortRanges" => PortRanges,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_routing_listener(
AcceleratorArn,
IdempotencyToken,
PortRanges,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateCustomRoutingListener",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AcceleratorArn" => AcceleratorArn,
"IdempotencyToken" => IdempotencyToken,
"PortRanges" => PortRanges,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_endpoint_group(endpoint_group_region, idempotency_token, listener_arn)
create_endpoint_group(endpoint_group_region, idempotency_token, listener_arn, params::Dict{String,<:Any})
Create an endpoint group for the specified listener. An endpoint group is a collection of
endpoints in one Amazon Web Services Region. A resource must be valid and active when you
add it as an endpoint. For more information about endpoint types and requirements for
endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators
in the Global Accelerator Developer Guide.
# Arguments
- `endpoint_group_region`: The Amazon Web Services Region where the endpoint group is
located. A listener can have only one endpoint group in a specific Region.
- `idempotency_token`: A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
- `listener_arn`: The Amazon Resource Name (ARN) of the listener.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndpointConfigurations"`: The list of endpoint objects.
- `"HealthCheckIntervalSeconds"`: The time—10 seconds or 30 seconds—between each health
check for an endpoint. The default value is 30.
- `"HealthCheckPath"`: If the protocol is HTTP/S, then this specifies the path that is the
destination for health check targets. The default value is slash (/).
- `"HealthCheckPort"`: The port that Global Accelerator uses to check the health of
endpoints that are part of this endpoint group. The default port is the listener port that
this endpoint group is associated with. If listener port is a list of ports, Global
Accelerator uses the first port in the list.
- `"HealthCheckProtocol"`: The protocol that Global Accelerator uses to check the health of
endpoints that are part of this endpoint group. The default value is TCP.
- `"PortOverrides"`: Override specific listener ports used to route traffic to endpoints
that are part of this endpoint group. For example, you can create a port override in which
the listener receives user traffic on ports 80 and 443, but your accelerator routes that
traffic to ports 1080 and 1443, respectively, on the endpoints. For more information, see
Overriding listener ports in the Global Accelerator Developer Guide.
- `"ThresholdCount"`: The number of consecutive health checks required to set the state of
a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default
value is 3.
- `"TrafficDialPercentage"`: The percentage of traffic to send to an Amazon Web Services
Region. Additional traffic is distributed to other endpoint groups for this listener. Use
this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The
percentage is applied to the traffic that would otherwise have been routed to the Region
based on optimal routing. The default value is 100.
"""
function create_endpoint_group(
EndpointGroupRegion,
IdempotencyToken,
ListenerArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateEndpointGroup",
Dict{String,Any}(
"EndpointGroupRegion" => EndpointGroupRegion,
"IdempotencyToken" => IdempotencyToken,
"ListenerArn" => ListenerArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_endpoint_group(
EndpointGroupRegion,
IdempotencyToken,
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateEndpointGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointGroupRegion" => EndpointGroupRegion,
"IdempotencyToken" => IdempotencyToken,
"ListenerArn" => ListenerArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_listener(accelerator_arn, idempotency_token, port_ranges, protocol)
create_listener(accelerator_arn, idempotency_token, port_ranges, protocol, params::Dict{String,<:Any})
Create a listener to process inbound connections from clients to an accelerator.
Connections arrive to assigned static IP addresses on a port, port range, or list of port
ranges that you specify.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of your accelerator.
- `idempotency_token`: A unique, case-sensitive identifier that you provide to ensure the
idempotency—that is, the uniqueness—of the request.
- `port_ranges`: The list of port ranges to support for connections from clients to your
accelerator.
- `protocol`: The protocol for connections from clients to your accelerator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientAffinity"`: Client affinity lets you direct all requests from a user to the same
endpoint, if you have stateful applications, regardless of the port and protocol of the
client request. Client affinity gives you control over whether to always route each client
to the same specific endpoint. Global Accelerator uses a consistent-flow hashing algorithm
to choose the optimal endpoint for a connection. If client affinity is NONE, Global
Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,
destination IP address, destination port, and protocol—to select the hash value, and then
chooses the best endpoint. However, with this setting, if someone uses different ports to
connect to Global Accelerator, their connections might not be always routed to the same
endpoint because the hash value changes. If you want a given client to always be routed to
the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP
setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client)
IP address and destination IP address—to select the hash value. The default value is NONE.
"""
function create_listener(
AcceleratorArn,
IdempotencyToken,
PortRanges,
Protocol;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateListener",
Dict{String,Any}(
"AcceleratorArn" => AcceleratorArn,
"IdempotencyToken" => IdempotencyToken,
"PortRanges" => PortRanges,
"Protocol" => Protocol,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_listener(
AcceleratorArn,
IdempotencyToken,
PortRanges,
Protocol,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"CreateListener",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AcceleratorArn" => AcceleratorArn,
"IdempotencyToken" => IdempotencyToken,
"PortRanges" => PortRanges,
"Protocol" => Protocol,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_accelerator(accelerator_arn)
delete_accelerator(accelerator_arn, params::Dict{String,<:Any})
Delete an accelerator. Before you can delete an accelerator, you must disable it and remove
all dependent resources (listeners and endpoint groups). To disable the accelerator, update
the accelerator to set Enabled to false. When you create an accelerator, by default,
Global Accelerator provides you with a set of two static IP addresses. Alternatively, you
can bring your own IP address ranges to Global Accelerator and assign IP addresses from
those ranges. The IP addresses are assigned to your accelerator for as long as it exists,
even if you disable the accelerator and it no longer accepts or routes traffic. However,
when you delete an accelerator, you lose the static IP addresses that are assigned to the
accelerator, so you can no longer route traffic by using them. As a best practice, ensure
that you have permissions in place to avoid inadvertently deleting accelerators. You can
use IAM policies with Global Accelerator to limit the users who have permissions to delete
an accelerator. For more information, see Identity and access management in the Global
Accelerator Developer Guide.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of an accelerator.
"""
function delete_accelerator(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DeleteAccelerator",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_accelerator(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DeleteAccelerator",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cross_account_attachment(attachment_arn)
delete_cross_account_attachment(attachment_arn, params::Dict{String,<:Any})
Delete a cross-account attachment. When you delete an attachment, Global Accelerator
revokes the permission to use the resources in the attachment from all principals in the
list of principals. Global Accelerator revokes the permission for specific resources. For
more information, see Working with cross-account attachments and resources in Global
Accelerator in the Global Accelerator Developer Guide.
# Arguments
- `attachment_arn`: The Amazon Resource Name (ARN) for the cross-account attachment to
delete.
"""
function delete_cross_account_attachment(
AttachmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DeleteCrossAccountAttachment",
Dict{String,Any}("AttachmentArn" => AttachmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cross_account_attachment(
AttachmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DeleteCrossAccountAttachment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AttachmentArn" => AttachmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_routing_accelerator(accelerator_arn)
delete_custom_routing_accelerator(accelerator_arn, params::Dict{String,<:Any})
Delete a custom routing accelerator. Before you can delete an accelerator, you must disable
it and remove all dependent resources (listeners and endpoint groups). To disable the
accelerator, update the accelerator to set Enabled to false. When you create a custom
routing accelerator, by default, Global Accelerator provides you with a set of two static
IP addresses. The IP addresses are assigned to your accelerator for as long as it exists,
even if you disable the accelerator and it no longer accepts or routes traffic. However,
when you delete an accelerator, you lose the static IP addresses that are assigned to the
accelerator, so you can no longer route traffic by using them. As a best practice, ensure
that you have permissions in place to avoid inadvertently deleting accelerators. You can
use IAM policies with Global Accelerator to limit the users who have permissions to delete
an accelerator. For more information, see Identity and access management in the Global
Accelerator Developer Guide.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the custom routing accelerator to
delete.
"""
function delete_custom_routing_accelerator(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DeleteCustomRoutingAccelerator",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_routing_accelerator(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DeleteCustomRoutingAccelerator",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_routing_endpoint_group(endpoint_group_arn)
delete_custom_routing_endpoint_group(endpoint_group_arn, params::Dict{String,<:Any})
Delete an endpoint group from a listener for a custom routing accelerator.
# Arguments
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group to delete.
"""
function delete_custom_routing_endpoint_group(
EndpointGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DeleteCustomRoutingEndpointGroup",
Dict{String,Any}("EndpointGroupArn" => EndpointGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_routing_endpoint_group(
EndpointGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DeleteCustomRoutingEndpointGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EndpointGroupArn" => EndpointGroupArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_routing_listener(listener_arn)
delete_custom_routing_listener(listener_arn, params::Dict{String,<:Any})
Delete a listener for a custom routing accelerator.
# Arguments
- `listener_arn`: The Amazon Resource Name (ARN) of the listener to delete.
"""
function delete_custom_routing_listener(
ListenerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DeleteCustomRoutingListener",
Dict{String,Any}("ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_routing_listener(
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DeleteCustomRoutingListener",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ListenerArn" => ListenerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_endpoint_group(endpoint_group_arn)
delete_endpoint_group(endpoint_group_arn, params::Dict{String,<:Any})
Delete an endpoint group from a listener.
# Arguments
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group to delete.
"""
function delete_endpoint_group(
EndpointGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DeleteEndpointGroup",
Dict{String,Any}("EndpointGroupArn" => EndpointGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_endpoint_group(
EndpointGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DeleteEndpointGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EndpointGroupArn" => EndpointGroupArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_listener(listener_arn)
delete_listener(listener_arn, params::Dict{String,<:Any})
Delete a listener from an accelerator.
# Arguments
- `listener_arn`: The Amazon Resource Name (ARN) of the listener.
"""
function delete_listener(ListenerArn; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"DeleteListener",
Dict{String,Any}("ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_listener(
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DeleteListener",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ListenerArn" => ListenerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deny_custom_routing_traffic(endpoint_group_arn, endpoint_id)
deny_custom_routing_traffic(endpoint_group_arn, endpoint_id, params::Dict{String,<:Any})
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet
endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic
to all destinations in the VPC endpoint, or deny traffic to a specified list of destination
IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the
range that you configured for the endpoint group. After you make changes, you can verify
that the updates are complete by checking the status of your accelerator: the status
changes from IN_PROGRESS to DEPLOYED.
# Arguments
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group.
- `endpoint_id`: An ID for the endpoint. For custom routing accelerators, this is the
virtual private cloud (VPC) subnet ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DenyAllTrafficToEndpoint"`: Indicates whether all destination IP addresses and ports
for a specified VPC subnet endpoint cannot receive traffic from a custom routing
accelerator. The value is TRUE or FALSE. When set to TRUE, no destinations in the custom
routing VPC subnet can receive traffic. Note that you cannot specify destination IP
addresses and ports when the value is set to TRUE. When set to FALSE (or not specified),
you must specify a list of destination IP addresses that cannot receive traffic. A list of
ports is optional. If you don't specify a list of ports, the ports that can accept traffic
is the same as the ports configured for the endpoint group. The default value is FALSE.
- `"DestinationAddresses"`: A list of specific Amazon EC2 instance IP addresses
(destination addresses) in a subnet that you want to prevent from receiving traffic. The IP
addresses must be a subset of the IP addresses allowed for the VPC subnet associated with
the endpoint group.
- `"DestinationPorts"`: A list of specific Amazon EC2 instance ports (destination ports) in
a subnet endpoint that you want to prevent from receiving traffic.
"""
function deny_custom_routing_traffic(
EndpointGroupArn, EndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DenyCustomRoutingTraffic",
Dict{String,Any}(
"EndpointGroupArn" => EndpointGroupArn, "EndpointId" => EndpointId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deny_custom_routing_traffic(
EndpointGroupArn,
EndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DenyCustomRoutingTraffic",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointGroupArn" => EndpointGroupArn, "EndpointId" => EndpointId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprovision_byoip_cidr(cidr)
deprovision_byoip_cidr(cidr, params::Dict{String,<:Any})
Releases the specified address range that you provisioned to use with your Amazon Web
Services resources through bring your own IP addresses (BYOIP) and deletes the
corresponding address pool. Before you can release an address range, you must stop
advertising it by using WithdrawByoipCidr and you must not have any accelerators that are
using static IP addresses allocated from its address range. For more information, see
Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
# Arguments
- `cidr`: The address range, in CIDR notation. The prefix must be the same prefix that you
specified when you provisioned the address range. For more information, see Bring your own
IP addresses (BYOIP) in the Global Accelerator Developer Guide.
"""
function deprovision_byoip_cidr(Cidr; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"DeprovisionByoipCidr",
Dict{String,Any}("Cidr" => Cidr);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprovision_byoip_cidr(
Cidr, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DeprovisionByoipCidr",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Cidr" => Cidr), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_accelerator(accelerator_arn)
describe_accelerator(accelerator_arn, params::Dict{String,<:Any})
Describe an accelerator.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the accelerator to describe.
"""
function describe_accelerator(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DescribeAccelerator",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_accelerator(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DescribeAccelerator",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_accelerator_attributes(accelerator_arn)
describe_accelerator_attributes(accelerator_arn, params::Dict{String,<:Any})
Describe the attributes of an accelerator.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the accelerator with the attributes
that you want to describe.
"""
function describe_accelerator_attributes(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DescribeAcceleratorAttributes",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_accelerator_attributes(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DescribeAcceleratorAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cross_account_attachment(attachment_arn)
describe_cross_account_attachment(attachment_arn, params::Dict{String,<:Any})
Gets configuration information about a cross-account attachment.
# Arguments
- `attachment_arn`: The Amazon Resource Name (ARN) for the cross-account attachment to
describe.
"""
function describe_cross_account_attachment(
AttachmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DescribeCrossAccountAttachment",
Dict{String,Any}("AttachmentArn" => AttachmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cross_account_attachment(
AttachmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DescribeCrossAccountAttachment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AttachmentArn" => AttachmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_custom_routing_accelerator(accelerator_arn)
describe_custom_routing_accelerator(accelerator_arn, params::Dict{String,<:Any})
Describe a custom routing accelerator.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the accelerator to describe.
"""
function describe_custom_routing_accelerator(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DescribeCustomRoutingAccelerator",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_custom_routing_accelerator(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DescribeCustomRoutingAccelerator",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_custom_routing_accelerator_attributes(accelerator_arn)
describe_custom_routing_accelerator_attributes(accelerator_arn, params::Dict{String,<:Any})
Describe the attributes of a custom routing accelerator.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the custom routing accelerator to
describe the attributes for.
"""
function describe_custom_routing_accelerator_attributes(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DescribeCustomRoutingAcceleratorAttributes",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_custom_routing_accelerator_attributes(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DescribeCustomRoutingAcceleratorAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_custom_routing_endpoint_group(endpoint_group_arn)
describe_custom_routing_endpoint_group(endpoint_group_arn, params::Dict{String,<:Any})
Describe an endpoint group for a custom routing accelerator.
# Arguments
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group to describe.
"""
function describe_custom_routing_endpoint_group(
EndpointGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DescribeCustomRoutingEndpointGroup",
Dict{String,Any}("EndpointGroupArn" => EndpointGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_custom_routing_endpoint_group(
EndpointGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DescribeCustomRoutingEndpointGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EndpointGroupArn" => EndpointGroupArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_custom_routing_listener(listener_arn)
describe_custom_routing_listener(listener_arn, params::Dict{String,<:Any})
The description of a listener for a custom routing accelerator.
# Arguments
- `listener_arn`: The Amazon Resource Name (ARN) of the listener to describe.
"""
function describe_custom_routing_listener(
ListenerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DescribeCustomRoutingListener",
Dict{String,Any}("ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_custom_routing_listener(
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DescribeCustomRoutingListener",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ListenerArn" => ListenerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoint_group(endpoint_group_arn)
describe_endpoint_group(endpoint_group_arn, params::Dict{String,<:Any})
Describe an endpoint group.
# Arguments
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group to describe.
"""
function describe_endpoint_group(
EndpointGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"DescribeEndpointGroup",
Dict{String,Any}("EndpointGroupArn" => EndpointGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_endpoint_group(
EndpointGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DescribeEndpointGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EndpointGroupArn" => EndpointGroupArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_listener(listener_arn)
describe_listener(listener_arn, params::Dict{String,<:Any})
Describe a listener.
# Arguments
- `listener_arn`: The Amazon Resource Name (ARN) of the listener to describe.
"""
function describe_listener(ListenerArn; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"DescribeListener",
Dict{String,Any}("ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_listener(
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"DescribeListener",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ListenerArn" => ListenerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_accelerators()
list_accelerators(params::Dict{String,<:Any})
List the accelerators for an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of Global Accelerator objects that you want to return with
this call. The default value is 10.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_accelerators(; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"ListAccelerators"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_accelerators(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListAccelerators", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_byoip_cidrs()
list_byoip_cidrs(params::Dict{String,<:Any})
Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including
the current state and a history of state changes.
# 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_byoip_cidrs(; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"ListByoipCidrs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_byoip_cidrs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListByoipCidrs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_cross_account_attachments()
list_cross_account_attachments(params::Dict{String,<:Any})
List the cross-account attachments that have been created in Global Accelerator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of cross-account attachment objects that you want to return
with this call. The default value is 10.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_cross_account_attachments(; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"ListCrossAccountAttachments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cross_account_attachments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListCrossAccountAttachments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cross_account_resource_accounts()
list_cross_account_resource_accounts(params::Dict{String,<:Any})
List the accounts that have cross-account resources. For more information, see Working
with cross-account attachments and resources in Global Accelerator in the Global
Accelerator Developer Guide.
"""
function list_cross_account_resource_accounts(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListCrossAccountResourceAccounts";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cross_account_resource_accounts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListCrossAccountResourceAccounts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cross_account_resources(resource_owner_aws_account_id)
list_cross_account_resources(resource_owner_aws_account_id, params::Dict{String,<:Any})
List the cross-account resources available to work with.
# Arguments
- `resource_owner_aws_account_id`: The account ID of a resource owner in a cross-account
attachment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AcceleratorArn"`: The Amazon Resource Name (ARN) of an accelerator in a cross-account
attachment.
- `"MaxResults"`: The number of cross-account resource objects that you want to return with
this call. The default value is 10.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_cross_account_resources(
ResourceOwnerAwsAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListCrossAccountResources",
Dict{String,Any}("ResourceOwnerAwsAccountId" => ResourceOwnerAwsAccountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cross_account_resources(
ResourceOwnerAwsAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"ListCrossAccountResources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceOwnerAwsAccountId" => ResourceOwnerAwsAccountId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_routing_accelerators()
list_custom_routing_accelerators(params::Dict{String,<:Any})
List the custom routing accelerators for an Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of custom routing Global Accelerator objects that you want to
return with this call. The default value is 10.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_custom_routing_accelerators(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListCustomRoutingAccelerators";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_custom_routing_accelerators(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListCustomRoutingAccelerators",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_routing_endpoint_groups(listener_arn)
list_custom_routing_endpoint_groups(listener_arn, params::Dict{String,<:Any})
List the endpoint groups that are associated with a listener for a custom routing
accelerator.
# Arguments
- `listener_arn`: The Amazon Resource Name (ARN) of the listener to list endpoint groups
for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of endpoint group objects that you want to return with this
call. The default value is 10.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_custom_routing_endpoint_groups(
ListenerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListCustomRoutingEndpointGroups",
Dict{String,Any}("ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_custom_routing_endpoint_groups(
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"ListCustomRoutingEndpointGroups",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ListenerArn" => ListenerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_routing_listeners(accelerator_arn)
list_custom_routing_listeners(accelerator_arn, params::Dict{String,<:Any})
List the listeners for a custom routing accelerator.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the accelerator to list listeners
for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of listener objects that you want to return with this call.
The default value is 10.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_custom_routing_listeners(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListCustomRoutingListeners",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_custom_routing_listeners(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"ListCustomRoutingListeners",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_routing_port_mappings(accelerator_arn)
list_custom_routing_port_mappings(accelerator_arn, params::Dict{String,<:Any})
Provides a complete mapping from the public accelerator IP address and port to destination
EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a
custom routing accelerator. For each subnet endpoint that you add, Global Accelerator
creates a new static port mapping for the accelerator. The port mappings don't change after
Global Accelerator generates them, so you can retrieve and cache the full mapping on your
servers. If you remove a subnet from your accelerator, Global Accelerator removes
(reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator
creates new port mappings (the existing ones don't change). If you add or remove EC2
instances in your subnet, the port mappings don't change, because the mappings are created
when you add the subnet to Global Accelerator. The mappings also include a flag for each
destination denoting which destination IP addresses and ports are allowed or denied traffic.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the accelerator to list the custom
routing port mappings for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndpointGroupArn"`: The Amazon Resource Name (ARN) of the endpoint group to list the
custom routing port mappings for.
- `"MaxResults"`: The number of destination port mappings that you want to return with this
call. The default value is 10.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_custom_routing_port_mappings(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListCustomRoutingPortMappings",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_custom_routing_port_mappings(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"ListCustomRoutingPortMappings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_routing_port_mappings_by_destination(destination_address, endpoint_id)
list_custom_routing_port_mappings_by_destination(destination_address, endpoint_id, params::Dict{String,<:Any})
List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint.
The response is the mappings for one destination IP address. This is useful when your
subnet endpoint has mappings that span multiple custom routing accelerators in your
account, or for scenarios where you only want to list the port mappings for a specific
destination instance.
# Arguments
- `destination_address`: The endpoint IP address in a virtual private cloud (VPC) subnet
for which you want to receive back port mappings.
- `endpoint_id`: The ID for the virtual private cloud (VPC) subnet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of destination port mappings that you want to return with this
call. The default value is 10.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_custom_routing_port_mappings_by_destination(
DestinationAddress, EndpointId; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListCustomRoutingPortMappingsByDestination",
Dict{String,Any}(
"DestinationAddress" => DestinationAddress, "EndpointId" => EndpointId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_custom_routing_port_mappings_by_destination(
DestinationAddress,
EndpointId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"ListCustomRoutingPortMappingsByDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationAddress" => DestinationAddress, "EndpointId" => EndpointId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_endpoint_groups(listener_arn)
list_endpoint_groups(listener_arn, params::Dict{String,<:Any})
List the endpoint groups that are associated with a listener.
# Arguments
- `listener_arn`: The Amazon Resource Name (ARN) of the listener.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of endpoint group objects that you want to return with this
call. The default value is 10.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_endpoint_groups(
ListenerArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ListEndpointGroups",
Dict{String,Any}("ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_endpoint_groups(
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"ListEndpointGroups",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ListenerArn" => ListenerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_listeners(accelerator_arn)
list_listeners(accelerator_arn, params::Dict{String,<:Any})
List the listeners for an accelerator.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the accelerator for which you want
to list listener objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of listener objects that you want to return with this call.
The default value is 10.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_listeners(AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"ListListeners",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_listeners(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"ListListeners",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), 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 an accelerator. For more information, see Tagging in Global Accelerator
in the Global Accelerator Developer Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the accelerator to list tags for. An
ARN uniquely identifies an accelerator.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"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 global_accelerator(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
provision_byoip_cidr(cidr, cidr_authorization_context)
provision_byoip_cidr(cidr, cidr_authorization_context, params::Dict{String,<:Any})
Provisions an IP address range to use with your Amazon Web Services resources through bring
your own IP addresses (BYOIP) and creates a corresponding address pool. After the address
range is provisioned, it is ready to be advertised using AdvertiseByoipCidr. For more
information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer
Guide.
# Arguments
- `cidr`: The public IPv4 address range, in CIDR notation. The most specific IP prefix that
you can specify is /24. The address range cannot overlap with another address range that
you've brought to this Amazon Web Services Region or another Region. For more information,
see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
- `cidr_authorization_context`: A signed document that proves that you are authorized to
bring the specified IP address range to Amazon using BYOIP.
"""
function provision_byoip_cidr(
Cidr, CidrAuthorizationContext; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"ProvisionByoipCidr",
Dict{String,Any}(
"Cidr" => Cidr, "CidrAuthorizationContext" => CidrAuthorizationContext
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function provision_byoip_cidr(
Cidr,
CidrAuthorizationContext,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"ProvisionByoipCidr",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Cidr" => Cidr, "CidrAuthorizationContext" => CidrAuthorizationContext
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_custom_routing_endpoints(endpoint_group_arn, endpoint_ids)
remove_custom_routing_endpoints(endpoint_group_arn, endpoint_ids, params::Dict{String,<:Any})
Remove endpoints from a custom routing accelerator.
# Arguments
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group to remove
endpoints from.
- `endpoint_ids`: The IDs for the endpoints. For custom routing accelerators, endpoint IDs
are the virtual private cloud (VPC) subnet IDs.
"""
function remove_custom_routing_endpoints(
EndpointGroupArn, EndpointIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"RemoveCustomRoutingEndpoints",
Dict{String,Any}(
"EndpointGroupArn" => EndpointGroupArn, "EndpointIds" => EndpointIds
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_custom_routing_endpoints(
EndpointGroupArn,
EndpointIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"RemoveCustomRoutingEndpoints",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointGroupArn" => EndpointGroupArn, "EndpointIds" => EndpointIds
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_endpoints(endpoint_group_arn, endpoint_identifiers)
remove_endpoints(endpoint_group_arn, endpoint_identifiers, params::Dict{String,<:Any})
Remove endpoints from an endpoint group. The RemoveEndpoints API operation is the
recommended option for removing endpoints. The alternative is to remove endpoints by
updating an endpoint group by using the UpdateEndpointGroup API operation. There are two
advantages to using AddEndpoints to remove endpoints instead: It's more convenient,
because you only need to specify the endpoints that you want to remove. With the
UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint
group except the ones that you want to remove from the group. It's faster, because Global
Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API
operation, Global Accelerator must resolve all of the endpoints that remain in the group.
# Arguments
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group.
- `endpoint_identifiers`: The identifiers of the endpoints that you want to remove.
"""
function remove_endpoints(
EndpointGroupArn, EndpointIdentifiers; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"RemoveEndpoints",
Dict{String,Any}(
"EndpointGroupArn" => EndpointGroupArn,
"EndpointIdentifiers" => EndpointIdentifiers,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_endpoints(
EndpointGroupArn,
EndpointIdentifiers,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"RemoveEndpoints",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndpointGroupArn" => EndpointGroupArn,
"EndpointIdentifiers" => EndpointIdentifiers,
),
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 tags to an accelerator resource. For more information, see Tagging in Global
Accelerator in the Global Accelerator Developer Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Global Accelerator resource to add
tags to. An ARN uniquely identifies a resource.
- `tags`: The tags to add to a resource. A tag consists of a key and a value that you
define.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"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 global_accelerator(
"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 tags from a Global Accelerator resource. When you specify a tag key, the action
removes both that key and its associated value. The operation succeeds even if you attempt
to remove tags from an accelerator that was already removed. For more information, see
Tagging in Global Accelerator in the Global Accelerator Developer Guide.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the Global Accelerator resource to
remove tags from. An ARN uniquely identifies a resource.
- `tag_keys`: The tag key pairs that you want to remove from the specified resources.
"""
function untag_resource(
ResourceArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"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 global_accelerator(
"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_accelerator(accelerator_arn)
update_accelerator(accelerator_arn, params::Dict{String,<:Any})
Update an accelerator to make changes, such as the following: Change the name of the
accelerator. Disable the accelerator so that it no longer accepts or routes traffic, or
so that you can delete it. Enable the accelerator, if it is disabled. Change the IP
address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's
dual-stack. Be aware that static IP addresses remain assigned to your accelerator for as
long as it exists, even if you disable the accelerator and it no longer accepts or routes
traffic. However, when you delete the accelerator, you lose the static IP addresses that
are assigned to it, so you can no longer route traffic by using them. Global Accelerator
is a global service that supports endpoints in multiple Amazon Web Services Regions but you
must specify the US West (Oregon) Region to create, update, or otherwise work with
accelerators. That is, for example, specify --region us-west-2 on Amazon Web Services CLI
commands.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the accelerator to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: Indicates whether an accelerator is enabled. The value is true or false. The
default value is true. If the value is set to true, the accelerator cannot be deleted. If
set to false, the accelerator can be deleted.
- `"IpAddressType"`: The IP address type that an accelerator supports. For a standard
accelerator, the value can be IPV4 or DUAL_STACK.
- `"IpAddresses"`: The IP addresses for an accelerator.
- `"Name"`: The name of the accelerator. The name can have a maximum of 64 characters, must
contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or
end with a hyphen or period.
"""
function update_accelerator(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"UpdateAccelerator",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_accelerator(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"UpdateAccelerator",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_accelerator_attributes(accelerator_arn)
update_accelerator_attributes(accelerator_arn, params::Dict{String,<:Any})
Update the attributes for an accelerator.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the accelerator that you want to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FlowLogsEnabled"`: Update whether flow logs are enabled. The default value is false. If
the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more
information, see Flow Logs in the Global Accelerator Developer Guide.
- `"FlowLogsS3Bucket"`: The name of the Amazon S3 bucket for the flow logs. Attribute is
required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that
grants Global Accelerator permission to write to the bucket.
- `"FlowLogsS3Prefix"`: Update the prefix for the location in the Amazon S3 bucket for the
flow logs. Attribute is required if FlowLogsEnabled is true. If you specify slash (/) for
the S3 bucket prefix, the log file bucket folder structure will include a double slash
(//), like the following: s3-bucket_name//AWSLogs/aws_account_id
"""
function update_accelerator_attributes(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"UpdateAcceleratorAttributes",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_accelerator_attributes(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"UpdateAcceleratorAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cross_account_attachment(attachment_arn)
update_cross_account_attachment(attachment_arn, params::Dict{String,<:Any})
Update a cross-account attachment to add or remove principals or resources. When you update
an attachment to remove a principal (account ID or accelerator) or a resource, Global
Accelerator revokes the permission for specific resources. For more information, see
Working with cross-account attachments and resources in Global Accelerator in the Global
Accelerator Developer Guide.
# Arguments
- `attachment_arn`: The Amazon Resource Name (ARN) of the cross-account attachment to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddPrincipals"`: The principals to add to the cross-account attachment. A principal is
an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives
permission to work with resources from another account. The resources are also listed in
the attachment. To add more than one principal, separate the account numbers or accelerator
ARNs, or both, with commas.
- `"AddResources"`: The resources to add to the cross-account attachment. A resource listed
in a cross-account attachment can be used with an accelerator by the principals that are
listed in the attachment. To add more than one resource, separate the resource ARNs with
commas.
- `"Name"`: The name of the cross-account attachment.
- `"RemovePrincipals"`: The principals to remove from the cross-account attachment. A
principal is an account or the Amazon Resource Name (ARN) of an accelerator that the
attachment gives permission to work with resources from another account. The resources are
also listed in the attachment. To remove more than one principal, separate the account
numbers or accelerator ARNs, or both, with commas.
- `"RemoveResources"`: The resources to remove from the cross-account attachment. A
resource listed in a cross-account attachment can be used with an accelerator by the
principals that are listed in the attachment. To remove more than one resource, separate
the resource ARNs with commas.
"""
function update_cross_account_attachment(
AttachmentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"UpdateCrossAccountAttachment",
Dict{String,Any}("AttachmentArn" => AttachmentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cross_account_attachment(
AttachmentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"UpdateCrossAccountAttachment",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AttachmentArn" => AttachmentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_custom_routing_accelerator(accelerator_arn)
update_custom_routing_accelerator(accelerator_arn, params::Dict{String,<:Any})
Update a custom routing accelerator.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the accelerator to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Enabled"`: Indicates whether an accelerator is enabled. The value is true or false. The
default value is true. If the value is set to true, the accelerator cannot be deleted. If
set to false, the accelerator can be deleted.
- `"IpAddressType"`: The IP address type that an accelerator supports. For a custom routing
accelerator, the value must be IPV4.
- `"IpAddresses"`: The IP addresses for an accelerator.
- `"Name"`: The name of the accelerator. The name can have a maximum of 64 characters, must
contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or
end with a hyphen or period.
"""
function update_custom_routing_accelerator(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"UpdateCustomRoutingAccelerator",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_custom_routing_accelerator(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"UpdateCustomRoutingAccelerator",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_custom_routing_accelerator_attributes(accelerator_arn)
update_custom_routing_accelerator_attributes(accelerator_arn, params::Dict{String,<:Any})
Update the attributes for a custom routing accelerator.
# Arguments
- `accelerator_arn`: The Amazon Resource Name (ARN) of the custom routing accelerator to
update attributes for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FlowLogsEnabled"`: Update whether flow logs are enabled. The default value is false. If
the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. For more
information, see Flow logs in the Global Accelerator Developer Guide.
- `"FlowLogsS3Bucket"`: The name of the Amazon S3 bucket for the flow logs. Attribute is
required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that
grants Global Accelerator permission to write to the bucket.
- `"FlowLogsS3Prefix"`: Update the prefix for the location in the Amazon S3 bucket for the
flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a
prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for
the S3 bucket prefix, the log file bucket folder structure will include a double slash
(//), like the following: DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
"""
function update_custom_routing_accelerator_attributes(
AcceleratorArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"UpdateCustomRoutingAcceleratorAttributes",
Dict{String,Any}("AcceleratorArn" => AcceleratorArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_custom_routing_accelerator_attributes(
AcceleratorArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"UpdateCustomRoutingAcceleratorAttributes",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AcceleratorArn" => AcceleratorArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_custom_routing_listener(listener_arn, port_ranges)
update_custom_routing_listener(listener_arn, port_ranges, params::Dict{String,<:Any})
Update a listener for a custom routing accelerator.
# Arguments
- `listener_arn`: The Amazon Resource Name (ARN) of the listener to update.
- `port_ranges`: The updated port range to support for connections from clients to your
accelerator. If you remove ports that are currently being used by a subnet endpoint, the
call fails. Separately, you set port ranges for endpoints. For more information, see About
endpoints for custom routing accelerators.
"""
function update_custom_routing_listener(
ListenerArn, PortRanges; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"UpdateCustomRoutingListener",
Dict{String,Any}("ListenerArn" => ListenerArn, "PortRanges" => PortRanges);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_custom_routing_listener(
ListenerArn,
PortRanges,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"UpdateCustomRoutingListener",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ListenerArn" => ListenerArn, "PortRanges" => PortRanges),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_endpoint_group(endpoint_group_arn)
update_endpoint_group(endpoint_group_arn, params::Dict{String,<:Any})
Update an endpoint group. A resource must be valid and active when you add it as an
endpoint.
# Arguments
- `endpoint_group_arn`: The Amazon Resource Name (ARN) of the endpoint group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndpointConfigurations"`: The list of endpoint objects. A resource must be valid and
active when you add it as an endpoint.
- `"HealthCheckIntervalSeconds"`: The time—10 seconds or 30 seconds—between each health
check for an endpoint. The default value is 30.
- `"HealthCheckPath"`: If the protocol is HTTP/S, then this specifies the path that is the
destination for health check targets. The default value is slash (/).
- `"HealthCheckPort"`: The port that Global Accelerator uses to check the health of
endpoints that are part of this endpoint group. The default port is the listener port that
this endpoint group is associated with. If the listener port is a list of ports, Global
Accelerator uses the first port in the list.
- `"HealthCheckProtocol"`: The protocol that Global Accelerator uses to check the health of
endpoints that are part of this endpoint group. The default value is TCP.
- `"PortOverrides"`: Override specific listener ports used to route traffic to endpoints
that are part of this endpoint group. For example, you can create a port override in which
the listener receives user traffic on ports 80 and 443, but your accelerator routes that
traffic to ports 1080 and 1443, respectively, on the endpoints. For more information, see
Overriding listener ports in the Global Accelerator Developer Guide.
- `"ThresholdCount"`: The number of consecutive health checks required to set the state of
a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default
value is 3.
- `"TrafficDialPercentage"`: The percentage of traffic to send to an Amazon Web Services
Region. Additional traffic is distributed to other endpoint groups for this listener. Use
this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The
percentage is applied to the traffic that would otherwise have been routed to the Region
based on optimal routing. The default value is 100.
"""
function update_endpoint_group(
EndpointGroupArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"UpdateEndpointGroup",
Dict{String,Any}("EndpointGroupArn" => EndpointGroupArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_endpoint_group(
EndpointGroupArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"UpdateEndpointGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("EndpointGroupArn" => EndpointGroupArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_listener(listener_arn)
update_listener(listener_arn, params::Dict{String,<:Any})
Update a listener.
# Arguments
- `listener_arn`: The Amazon Resource Name (ARN) of the listener to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientAffinity"`: Client affinity lets you direct all requests from a user to the same
endpoint, if you have stateful applications, regardless of the port and protocol of the
client request. Client affinity gives you control over whether to always route each client
to the same specific endpoint. Global Accelerator uses a consistent-flow hashing algorithm
to choose the optimal endpoint for a connection. If client affinity is NONE, Global
Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,
destination IP address, destination port, and protocol—to select the hash value, and then
chooses the best endpoint. However, with this setting, if someone uses different ports to
connect to Global Accelerator, their connections might not be always routed to the same
endpoint because the hash value changes. If you want a given client to always be routed to
the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP
setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client)
IP address and destination IP address—to select the hash value. The default value is NONE.
- `"PortRanges"`: The updated list of port ranges for the connections from clients to the
accelerator.
- `"Protocol"`: The updated protocol for the connections from clients to the accelerator.
"""
function update_listener(ListenerArn; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"UpdateListener",
Dict{String,Any}("ListenerArn" => ListenerArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_listener(
ListenerArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return global_accelerator(
"UpdateListener",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ListenerArn" => ListenerArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
withdraw_byoip_cidr(cidr)
withdraw_byoip_cidr(cidr, params::Dict{String,<:Any})
Stops advertising an address range that is provisioned as an address pool. You can perform
this operation at most once every 10 seconds, even if you specify different address ranges
each time. It can take a few minutes before traffic to the specified addresses stops
routing to Amazon Web Services because of propagation delays. For more information, see
Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
# Arguments
- `cidr`: The address range, in CIDR notation. For more information, see Bring your own IP
addresses (BYOIP) in the Global Accelerator Developer Guide.
"""
function withdraw_byoip_cidr(Cidr; aws_config::AbstractAWSConfig=global_aws_config())
return global_accelerator(
"WithdrawByoipCidr",
Dict{String,Any}("Cidr" => Cidr);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function withdraw_byoip_cidr(
Cidr, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return global_accelerator(
"WithdrawByoipCidr",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Cidr" => Cidr), 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 | 336830 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: glue
using AWS.Compat
using AWS.UUIDs
"""
batch_create_partition(database_name, partition_input_list, table_name)
batch_create_partition(database_name, partition_input_list, table_name, params::Dict{String,<:Any})
Creates one or more partitions in a batch operation.
# Arguments
- `database_name`: The name of the metadata database in which the partition is to be
created.
- `partition_input_list`: A list of PartitionInput structures that define the partitions to
be created.
- `table_name`: The name of the metadata table in which the partition is to be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the catalog in which the partition is to be created. Currently,
this should be the Amazon Web Services account ID.
"""
function batch_create_partition(
DatabaseName,
PartitionInputList,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchCreatePartition",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionInputList" => PartitionInputList,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_create_partition(
DatabaseName,
PartitionInputList,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchCreatePartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionInputList" => PartitionInputList,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_connection(connection_name_list)
batch_delete_connection(connection_name_list, params::Dict{String,<:Any})
Deletes a list of connection definitions from the Data Catalog.
# Arguments
- `connection_name_list`: A list of names of the connections to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which the connections reside. If none is
provided, the Amazon Web Services account ID is used by default.
"""
function batch_delete_connection(
ConnectionNameList; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchDeleteConnection",
Dict{String,Any}("ConnectionNameList" => ConnectionNameList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_connection(
ConnectionNameList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchDeleteConnection",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ConnectionNameList" => ConnectionNameList), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_partition(database_name, partitions_to_delete, table_name)
batch_delete_partition(database_name, partitions_to_delete, table_name, params::Dict{String,<:Any})
Deletes one or more partitions in a batch operation.
# Arguments
- `database_name`: The name of the catalog database in which the table in question resides.
- `partitions_to_delete`: A list of PartitionInput structures that define the partitions to
be deleted.
- `table_name`: The name of the table that contains the partitions to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partition to be deleted resides. If
none is provided, the Amazon Web Services account ID is used by default.
"""
function batch_delete_partition(
DatabaseName,
PartitionsToDelete,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchDeletePartition",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionsToDelete" => PartitionsToDelete,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_partition(
DatabaseName,
PartitionsToDelete,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchDeletePartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionsToDelete" => PartitionsToDelete,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_table(database_name, tables_to_delete)
batch_delete_table(database_name, tables_to_delete, params::Dict{String,<:Any})
Deletes multiple tables at once. After completing this operation, you no longer have
access to the table versions and partitions that belong to the deleted table. Glue deletes
these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the
service. To ensure the immediate deletion of all related resources, before calling
BatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or
BatchDeletePartition, to delete any resources that belong to the table.
# Arguments
- `database_name`: The name of the catalog database in which the tables to delete reside.
For Hive compatibility, this name is entirely lowercase.
- `tables_to_delete`: A list of the table to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the table resides. If none is provided,
the Amazon Web Services account ID is used by default.
- `"TransactionId"`: The transaction ID at which to delete the table contents.
"""
function batch_delete_table(
DatabaseName, TablesToDelete; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchDeleteTable",
Dict{String,Any}(
"DatabaseName" => DatabaseName, "TablesToDelete" => TablesToDelete
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_table(
DatabaseName,
TablesToDelete,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchDeleteTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName, "TablesToDelete" => TablesToDelete
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_table_version(database_name, table_name, version_ids)
batch_delete_table_version(database_name, table_name, version_ids, params::Dict{String,<:Any})
Deletes a specified batch of versions of a table.
# Arguments
- `database_name`: The database in the catalog in which the table resides. For Hive
compatibility, this name is entirely lowercase.
- `table_name`: The name of the table. For Hive compatibility, this name is entirely
lowercase.
- `version_ids`: A list of the IDs of versions to be deleted. A VersionId is a string
representation of an integer. Each version is incremented by 1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the tables reside. If none is provided,
the Amazon Web Services account ID is used by default.
"""
function batch_delete_table_version(
DatabaseName, TableName, VersionIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchDeleteTableVersion",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"VersionIds" => VersionIds,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_table_version(
DatabaseName,
TableName,
VersionIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchDeleteTableVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"VersionIds" => VersionIds,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_blueprints(names)
batch_get_blueprints(names, params::Dict{String,<:Any})
Retrieves information about a list of blueprints.
# Arguments
- `names`: A list of blueprint names.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeBlueprint"`: Specifies whether or not to include the blueprint in the response.
- `"IncludeParameterSpec"`: Specifies whether or not to include the parameters, as a JSON
string, for the blueprint in the response.
"""
function batch_get_blueprints(Names; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"BatchGetBlueprints",
Dict{String,Any}("Names" => Names);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_blueprints(
Names, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchGetBlueprints",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Names" => Names), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_crawlers(crawler_names)
batch_get_crawlers(crawler_names, params::Dict{String,<:Any})
Returns a list of resource metadata for a given list of crawler names. After calling the
ListCrawlers operation, you can call this operation to access the data to which you have
been granted permissions. This operation supports all IAM permissions, including permission
conditions that uses tags.
# Arguments
- `crawler_names`: A list of crawler names, which might be the names returned from the
ListCrawlers operation.
"""
function batch_get_crawlers(CrawlerNames; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"BatchGetCrawlers",
Dict{String,Any}("CrawlerNames" => CrawlerNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_crawlers(
CrawlerNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchGetCrawlers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CrawlerNames" => CrawlerNames), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_custom_entity_types(names)
batch_get_custom_entity_types(names, params::Dict{String,<:Any})
Retrieves the details for the custom patterns specified by a list of names.
# Arguments
- `names`: A list of names of the custom patterns that you want to retrieve.
"""
function batch_get_custom_entity_types(
Names; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchGetCustomEntityTypes",
Dict{String,Any}("Names" => Names);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_custom_entity_types(
Names, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchGetCustomEntityTypes",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Names" => Names), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_data_quality_result(result_ids)
batch_get_data_quality_result(result_ids, params::Dict{String,<:Any})
Retrieves a list of data quality results for the specified result IDs.
# Arguments
- `result_ids`: A list of unique result IDs for the data quality results.
"""
function batch_get_data_quality_result(
ResultIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchGetDataQualityResult",
Dict{String,Any}("ResultIds" => ResultIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_data_quality_result(
ResultIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchGetDataQualityResult",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResultIds" => ResultIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_dev_endpoints(dev_endpoint_names)
batch_get_dev_endpoints(dev_endpoint_names, params::Dict{String,<:Any})
Returns a list of resource metadata for a given list of development endpoint names. After
calling the ListDevEndpoints operation, you can call this operation to access the data to
which you have been granted permissions. This operation supports all IAM permissions,
including permission conditions that uses tags.
# Arguments
- `dev_endpoint_names`: The list of DevEndpoint names, which might be the names returned
from the ListDevEndpoint operation.
"""
function batch_get_dev_endpoints(
DevEndpointNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchGetDevEndpoints",
Dict{String,Any}("DevEndpointNames" => DevEndpointNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_dev_endpoints(
DevEndpointNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchGetDevEndpoints",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DevEndpointNames" => DevEndpointNames), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_jobs(job_names)
batch_get_jobs(job_names, params::Dict{String,<:Any})
Returns a list of resource metadata for a given list of job names. After calling the
ListJobs operation, you can call this operation to access the data to which you have been
granted permissions. This operation supports all IAM permissions, including permission
conditions that uses tags.
# Arguments
- `job_names`: A list of job names, which might be the names returned from the ListJobs
operation.
"""
function batch_get_jobs(JobNames; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"BatchGetJobs",
Dict{String,Any}("JobNames" => JobNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_jobs(
JobNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchGetJobs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("JobNames" => JobNames), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_partition(database_name, partitions_to_get, table_name)
batch_get_partition(database_name, partitions_to_get, table_name, params::Dict{String,<:Any})
Retrieves partitions in a batch request.
# Arguments
- `database_name`: The name of the catalog database where the partitions reside.
- `partitions_to_get`: A list of partition values identifying the partitions to retrieve.
- `table_name`: The name of the partitions' table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partitions in question reside. If
none is supplied, the Amazon Web Services account ID is used by default.
"""
function batch_get_partition(
DatabaseName,
PartitionsToGet,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchGetPartition",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionsToGet" => PartitionsToGet,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_partition(
DatabaseName,
PartitionsToGet,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchGetPartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionsToGet" => PartitionsToGet,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_table_optimizer(entries)
batch_get_table_optimizer(entries, params::Dict{String,<:Any})
Returns the configuration for the specified table optimizers.
# Arguments
- `entries`: A list of BatchGetTableOptimizerEntry objects specifying the table optimizers
to retrieve.
"""
function batch_get_table_optimizer(
Entries; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchGetTableOptimizer",
Dict{String,Any}("Entries" => Entries);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_table_optimizer(
Entries, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchGetTableOptimizer",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Entries" => Entries), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_triggers(trigger_names)
batch_get_triggers(trigger_names, params::Dict{String,<:Any})
Returns a list of resource metadata for a given list of trigger names. After calling the
ListTriggers operation, you can call this operation to access the data to which you have
been granted permissions. This operation supports all IAM permissions, including permission
conditions that uses tags.
# Arguments
- `trigger_names`: A list of trigger names, which may be the names returned from the
ListTriggers operation.
"""
function batch_get_triggers(TriggerNames; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"BatchGetTriggers",
Dict{String,Any}("TriggerNames" => TriggerNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_triggers(
TriggerNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchGetTriggers",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TriggerNames" => TriggerNames), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_workflows(names)
batch_get_workflows(names, params::Dict{String,<:Any})
Returns a list of resource metadata for a given list of workflow names. After calling the
ListWorkflows operation, you can call this operation to access the data to which you have
been granted permissions. This operation supports all IAM permissions, including permission
conditions that uses tags.
# Arguments
- `names`: A list of workflow names, which may be the names returned from the ListWorkflows
operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeGraph"`: Specifies whether to include a graph when returning the workflow
resource metadata.
"""
function batch_get_workflows(Names; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"BatchGetWorkflows",
Dict{String,Any}("Names" => Names);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_workflows(
Names, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchGetWorkflows",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Names" => Names), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_stop_job_run(job_name, job_run_ids)
batch_stop_job_run(job_name, job_run_ids, params::Dict{String,<:Any})
Stops one or more job runs for a specified job definition.
# Arguments
- `job_name`: The name of the job definition for which to stop job runs.
- `job_run_ids`: A list of the JobRunIds that should be stopped for that job definition.
"""
function batch_stop_job_run(
JobName, JobRunIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchStopJobRun",
Dict{String,Any}("JobName" => JobName, "JobRunIds" => JobRunIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_stop_job_run(
JobName,
JobRunIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchStopJobRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("JobName" => JobName, "JobRunIds" => JobRunIds),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_partition(database_name, entries, table_name)
batch_update_partition(database_name, entries, table_name, params::Dict{String,<:Any})
Updates one or more partitions in a batch operation.
# Arguments
- `database_name`: The name of the metadata database in which the partition is to be
updated.
- `entries`: A list of up to 100 BatchUpdatePartitionRequestEntry objects to update.
- `table_name`: The name of the metadata table in which the partition is to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the catalog in which the partition is to be updated. Currently,
this should be the Amazon Web Services account ID.
"""
function batch_update_partition(
DatabaseName, Entries, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"BatchUpdatePartition",
Dict{String,Any}(
"DatabaseName" => DatabaseName, "Entries" => Entries, "TableName" => TableName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_partition(
DatabaseName,
Entries,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"BatchUpdatePartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"Entries" => Entries,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_data_quality_rule_recommendation_run(run_id)
cancel_data_quality_rule_recommendation_run(run_id, params::Dict{String,<:Any})
Cancels the specified recommendation run that was being used to generate rules.
# Arguments
- `run_id`: The unique run identifier associated with this run.
"""
function cancel_data_quality_rule_recommendation_run(
RunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CancelDataQualityRuleRecommendationRun",
Dict{String,Any}("RunId" => RunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_data_quality_rule_recommendation_run(
RunId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CancelDataQualityRuleRecommendationRun",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RunId" => RunId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_data_quality_ruleset_evaluation_run(run_id)
cancel_data_quality_ruleset_evaluation_run(run_id, params::Dict{String,<:Any})
Cancels a run where a ruleset is being evaluated against a data source.
# Arguments
- `run_id`: The unique run identifier associated with this run.
"""
function cancel_data_quality_ruleset_evaluation_run(
RunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CancelDataQualityRulesetEvaluationRun",
Dict{String,Any}("RunId" => RunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_data_quality_ruleset_evaluation_run(
RunId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CancelDataQualityRulesetEvaluationRun",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RunId" => RunId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_mltask_run(task_run_id, transform_id)
cancel_mltask_run(task_run_id, transform_id, params::Dict{String,<:Any})
Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue
runs on your behalf as part of various machine learning workflows. You can cancel a machine
learning task run at any time by calling CancelMLTaskRun with a task run's parent
transform's TransformID and the task run's TaskRunId.
# Arguments
- `task_run_id`: A unique identifier for the task run.
- `transform_id`: The unique identifier of the machine learning transform.
"""
function cancel_mltask_run(
TaskRunId, TransformId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CancelMLTaskRun",
Dict{String,Any}("TaskRunId" => TaskRunId, "TransformId" => TransformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_mltask_run(
TaskRunId,
TransformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CancelMLTaskRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TaskRunId" => TaskRunId, "TransformId" => TransformId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_statement(id, session_id)
cancel_statement(id, session_id, params::Dict{String,<:Any})
Cancels the statement.
# Arguments
- `id`: The ID of the statement to be cancelled.
- `session_id`: The Session ID of the statement to be cancelled.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RequestOrigin"`: The origin of the request to cancel the statement.
"""
function cancel_statement(Id, SessionId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"CancelStatement",
Dict{String,Any}("Id" => Id, "SessionId" => SessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_statement(
Id,
SessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CancelStatement",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Id" => Id, "SessionId" => SessionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
check_schema_version_validity(data_format, schema_definition)
check_schema_version_validity(data_format, schema_definition, params::Dict{String,<:Any})
Validates the supplied schema. This call has no side effects, it simply validates using the
supplied schema using DataFormat as the format. Since it does not take a schema set name,
no compatibility checks are performed.
# Arguments
- `data_format`: The data format of the schema definition. Currently AVRO, JSON and
PROTOBUF are supported.
- `schema_definition`: The definition of the schema that has to be validated.
"""
function check_schema_version_validity(
DataFormat, SchemaDefinition; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CheckSchemaVersionValidity",
Dict{String,Any}(
"DataFormat" => DataFormat, "SchemaDefinition" => SchemaDefinition
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function check_schema_version_validity(
DataFormat,
SchemaDefinition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CheckSchemaVersionValidity",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataFormat" => DataFormat, "SchemaDefinition" => SchemaDefinition
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_blueprint(blueprint_location, name)
create_blueprint(blueprint_location, name, params::Dict{String,<:Any})
Registers a blueprint with Glue.
# Arguments
- `blueprint_location`: Specifies a path in Amazon S3 where the blueprint is published.
- `name`: The name of the blueprint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the blueprint.
- `"Tags"`: The tags to be applied to this blueprint.
"""
function create_blueprint(
BlueprintLocation, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateBlueprint",
Dict{String,Any}("BlueprintLocation" => BlueprintLocation, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_blueprint(
BlueprintLocation,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateBlueprint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BlueprintLocation" => BlueprintLocation, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_classifier()
create_classifier(params::Dict{String,<:Any})
Creates a classifier in the user's account. This can be a GrokClassifier, an XMLClassifier,
a JsonClassifier, or a CsvClassifier, depending on which field of the request is present.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CsvClassifier"`: A CsvClassifier object specifying the classifier to create.
- `"GrokClassifier"`: A GrokClassifier object specifying the classifier to create.
- `"JsonClassifier"`: A JsonClassifier object specifying the classifier to create.
- `"XMLClassifier"`: An XMLClassifier object specifying the classifier to create.
"""
function create_classifier(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("CreateClassifier"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_classifier(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateClassifier", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_connection(connection_input)
create_connection(connection_input, params::Dict{String,<:Any})
Creates a connection definition in the Data Catalog. Connections used for creating
federated resources require the IAM glue:PassConnection permission.
# Arguments
- `connection_input`: A ConnectionInput object defining the connection to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which to create the connection. If none is
provided, the Amazon Web Services account ID is used by default.
- `"Tags"`: The tags you assign to the connection.
"""
function create_connection(
ConnectionInput; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateConnection",
Dict{String,Any}("ConnectionInput" => ConnectionInput);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connection(
ConnectionInput,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateConnection",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ConnectionInput" => ConnectionInput), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_crawler(name, role, targets)
create_crawler(name, role, targets, params::Dict{String,<:Any})
Creates a new crawler with specified targets, role, configuration, and optional schedule.
At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field,
or the DynamoDBTargets field.
# Arguments
- `name`: Name of the new crawler.
- `role`: The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler
to access customer resources.
- `targets`: A list of collection of targets to crawl.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Classifiers"`: A list of custom classifiers that the user has registered. By default,
all built-in classifiers are included in a crawl, but these custom classifiers always
override the default classifiers for a given classification.
- `"Configuration"`: Crawler configuration information. This versioned JSON string allows
users to specify aspects of a crawler's behavior. For more information, see Setting crawler
configuration options.
- `"CrawlerSecurityConfiguration"`: The name of the SecurityConfiguration structure to be
used by this crawler.
- `"DatabaseName"`: The Glue database where results are written, such as:
arn:aws:daylight:us-east-1::database/sometable/*.
- `"Description"`: A description of the new crawler.
- `"LakeFormationConfiguration"`: Specifies Lake Formation configuration settings for the
crawler.
- `"LineageConfiguration"`: Specifies data lineage configuration settings for the crawler.
- `"RecrawlPolicy"`: A policy that specifies whether to crawl the entire dataset again, or
to crawl only folders that were added since the last crawler run.
- `"Schedule"`: A cron expression used to specify the schedule (see Time-Based Schedules
for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would
specify: cron(15 12 * * ? *).
- `"SchemaChangePolicy"`: The policy for the crawler's update and deletion behavior.
- `"TablePrefix"`: The table prefix used for catalog tables that are created.
- `"Tags"`: The tags to use with this crawler request. You may use tags to limit access to
the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue
in the developer guide.
"""
function create_crawler(
Name, Role, Targets; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateCrawler",
Dict{String,Any}("Name" => Name, "Role" => Role, "Targets" => Targets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_crawler(
Name,
Role,
Targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateCrawler",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "Role" => Role, "Targets" => Targets),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_entity_type(name, regex_string)
create_custom_entity_type(name, regex_string, params::Dict{String,<:Any})
Creates a custom pattern that is used to detect sensitive data across the columns and rows
of your structured data. Each custom pattern you create specifies a regular expression and
an optional list of context words. If no context words are passed only a regular expression
is checked.
# Arguments
- `name`: A name for the custom pattern that allows it to be retrieved or deleted later.
This name must be unique per Amazon Web Services account.
- `regex_string`: A regular expression string that is used for detecting sensitive data in
a custom pattern.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ContextWords"`: A list of context words. If none of these context words are found
within the vicinity of the regular expression the data will not be detected as sensitive
data. If no context words are passed only a regular expression is checked.
- `"Tags"`: A list of tags applied to the custom entity type.
"""
function create_custom_entity_type(
Name, RegexString; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateCustomEntityType",
Dict{String,Any}("Name" => Name, "RegexString" => RegexString);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_entity_type(
Name,
RegexString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateCustomEntityType",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "RegexString" => RegexString),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_data_quality_ruleset(name, ruleset)
create_data_quality_ruleset(name, ruleset, params::Dict{String,<:Any})
Creates a data quality ruleset with DQDL rules applied to a specified Glue table. You
create the ruleset using the Data Quality Definition Language (DQDL). For more information,
see the Glue developer guide.
# Arguments
- `name`: A unique name for the data quality ruleset.
- `ruleset`: A Data Quality Definition Language (DQDL) ruleset. For more information, see
the Glue developer guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Used for idempotency and is recommended to be set to a random ID (such
as a UUID) to avoid creating or starting multiple instances of the same resource.
- `"Description"`: A description of the data quality ruleset.
- `"Tags"`: A list of tags applied to the data quality ruleset.
- `"TargetTable"`: A target table associated with the data quality ruleset.
"""
function create_data_quality_ruleset(
Name, Ruleset; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateDataQualityRuleset",
Dict{String,Any}("Name" => Name, "Ruleset" => Ruleset);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_data_quality_ruleset(
Name,
Ruleset,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateDataQualityRuleset",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Name" => Name, "Ruleset" => Ruleset), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_database(database_input)
create_database(database_input, params::Dict{String,<:Any})
Creates a new database in a Data Catalog.
# Arguments
- `database_input`: The metadata for the database.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which to create the database. If none is
provided, the Amazon Web Services account ID is used by default.
- `"Tags"`: The tags you assign to the database.
"""
function create_database(DatabaseInput; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"CreateDatabase",
Dict{String,Any}("DatabaseInput" => DatabaseInput);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_database(
DatabaseInput,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateDatabase",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatabaseInput" => DatabaseInput), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dev_endpoint(endpoint_name, role_arn)
create_dev_endpoint(endpoint_name, role_arn, params::Dict{String,<:Any})
Creates a new development endpoint.
# Arguments
- `endpoint_name`: The name to be assigned to the new DevEndpoint.
- `role_arn`: The IAM role for the DevEndpoint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Arguments"`: A map of arguments used to configure the DevEndpoint.
- `"ExtraJarsS3Path"`: The path to one or more Java .jar files in an S3 bucket that should
be loaded in your DevEndpoint.
- `"ExtraPythonLibsS3Path"`: The paths to one or more Python libraries in an Amazon S3
bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths
separated by a comma. You can only use pure Python libraries with a DevEndpoint. Libraries
that rely on C extensions, such as the pandas Python data analysis library, are not yet
supported.
- `"GlueVersion"`: Glue version determines the versions of Apache Spark and Python that
Glue supports. The Python version indicates the version supported for running your ETL
scripts on development endpoints. For more information about the available Glue versions
and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue
0.9. You can specify a version of Python support for development endpoints by using the
Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are
provided, the version defaults to Python 2.
- `"NumberOfNodes"`: The number of Glue Data Processing Units (DPUs) to allocate to this
DevEndpoint.
- `"NumberOfWorkers"`: The number of workers of a defined workerType that are allocated to
the development endpoint. The maximum number of workers you can define are 299 for G.1X,
and 149 for G.2X.
- `"PublicKey"`: The public key to be used by this DevEndpoint for authentication. This
attribute is provided for backward compatibility because the recommended attribute to use
is public keys.
- `"PublicKeys"`: A list of public keys to be used by the development endpoints for
authentication. The use of this attribute is preferred over a single public key because the
public keys allow you to have a different private key per client. If you previously
created an endpoint with a public key, you must remove that key to be able to set a list of
public keys. Call the UpdateDevEndpoint API with the public key content in the
deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
- `"SecurityConfiguration"`: The name of the SecurityConfiguration structure to be used
with this DevEndpoint.
- `"SecurityGroupIds"`: Security group IDs for the security groups to be used by the new
DevEndpoint.
- `"SubnetId"`: The subnet ID for the new DevEndpoint to use.
- `"Tags"`: The tags to use with this DevEndpoint. You may use tags to limit access to the
DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue
in the developer guide.
- `"WorkerType"`: The type of predefined worker that is allocated to the development
endpoint. Accepts a value of Standard, G.1X, or G.2X. For the Standard worker type, each
worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. For
the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and
provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk),
and provides 1 executor per worker. We recommend this worker type for memory-intensive
jobs. Known issue: when a development endpoint is created with the G.2X WorkerType
configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of
memory, and a 64 GB disk.
"""
function create_dev_endpoint(
EndpointName, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateDevEndpoint",
Dict{String,Any}("EndpointName" => EndpointName, "RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dev_endpoint(
EndpointName,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateDevEndpoint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("EndpointName" => EndpointName, "RoleArn" => RoleArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job(command, name, role)
create_job(command, name, role, params::Dict{String,<:Any})
Creates a new job definition.
# Arguments
- `command`: The JobCommand that runs this job.
- `name`: The name you assign to this job definition. It must be unique in your account.
- `role`: The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedCapacity"`: This parameter is deprecated. Use MaxCapacity instead. The number
of Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of
2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of
4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing
page.
- `"CodeGenConfigurationNodes"`: The representation of a directed acyclic graph on which
both the Glue Studio visual component and Glue Studio code generation is based.
- `"Connections"`: The connections used for this job.
- `"DefaultArguments"`: The default arguments for every run of this job, specified as
name-value pairs. You can specify arguments here that your own job-execution script
consumes, as well as arguments that Glue itself consumes. Job arguments may be logged. Do
not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets
Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling
Glue APIs in Python topic in the developer guide. For information about the arguments you
can provide to this field when configuring Spark jobs, see the Special Parameters Used by
Glue topic in the developer guide. For information about the arguments you can provide to
this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer
guide.
- `"Description"`: Description of the job being defined.
- `"ExecutionClass"`: Indicates whether the job is run with a standard or flexible
execution class. The standard execution-class is ideal for time-sensitive workloads that
require fast job startup and dedicated resources. The flexible execution class is
appropriate for time-insensitive jobs whose start and completion times may vary. Only jobs
with Glue version 3.0 and above and command type glueetl will be allowed to set
ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
- `"ExecutionProperty"`: An ExecutionProperty specifying the maximum number of concurrent
runs allowed for this job.
- `"GlueVersion"`: In Spark jobs, GlueVersion determines the versions of Apache Spark and
Python that Glue available in a job. The Python version indicates the version supported for
jobs of type Spark. Ray jobs should set GlueVersion to 4.0 or greater. However, the
versions of Ray, Python and additional libraries available in your Ray job are determined
by the Runtime parameter of the Job command. For more information about the available Glue
versions and corresponding Spark and Python versions, see Glue version in the developer
guide. Jobs that are created without specifying a Glue version default to Glue 0.9.
- `"JobMode"`: A mode that describes how a job was created. Valid values are: SCRIPT -
The job was created using the Glue Studio script editor. VISUAL - The job was created
using the Glue Studio visual editor. NOTEBOOK - The job was created using an interactive
sessions notebook. When the JobMode field is missing or null, SCRIPT is assigned as the
default value.
- `"LogUri"`: This field is reserved for future use.
- `"MaintenanceWindow"`: This field specifies a day of the week and hour for a maintenance
window for streaming jobs. Glue periodically performs maintenance activities. During these
maintenance windows, Glue will need to restart your streaming jobs. Glue will restart the
job within 3 hours of the specified maintenance window. For instance, if you set up the
maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM
GMT to 1:00PM GMT.
- `"MaxCapacity"`: For Glue version 1.0 or earlier jobs, using the standard worker type,
the number of Glue data processing units (DPUs) that can be allocated when this job runs. A
DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity
and 16 GB of memory. For more information, see the Glue pricing page. For Glue version
2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type
and the Number of workers. Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python
shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job: When you
specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can allocate either
0.0625 or 1 DPU. The default is 0.0625 DPU. When you specify an Apache Spark ETL job
(JobCommand.Name=\"glueetl\") or Apache Spark streaming ETL job
(JobCommand.Name=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. The default is 10
DPUs. This job type cannot have a fractional DPU allocation.
- `"MaxRetries"`: The maximum number of times to retry this job if it fails.
- `"NonOverridableArguments"`: Arguments for this job that are not overridden when
providing job arguments in a job run, specified as name-value pairs.
- `"NotificationProperty"`: Specifies configuration properties of a job notification.
- `"NumberOfWorkers"`: The number of workers of a defined workerType that are allocated
when a job runs.
- `"SecurityConfiguration"`: The name of the SecurityConfiguration structure to be used
with this job.
- `"SourceControlDetails"`: The details for a source control configuration for a job,
allowing synchronization of job artifacts to or from a remote repository.
- `"Tags"`: The tags to use with this job. You may use tags to limit access to the job. For
more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer
guide.
- `"Timeout"`: The job timeout in minutes. This is the maximum time that a job run can
consume resources before it is terminated and enters TIMEOUT status. The default is 2,880
minutes (48 hours) for batch jobs. Streaming jobs must have timeout values less than 7 days
or 10080 minutes. When the value is left blank, the job will be restarted after 7 days
based if you have not setup a maintenance window. If you have setup maintenance window, it
will be restarted during the maintenance window after 7 days.
- `"WorkerType"`: The type of predefined worker that is allocated when a job runs. Accepts
a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray
jobs. For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with
84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this
worker type for workloads such as data transforms, joins, and queries, to offers a scalable
and cost effective way to run most jobs. For the G.2X worker type, each worker maps to 2
DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1
executor per worker. We recommend this worker type for workloads such as data transforms,
joins, and queries, to offers a scalable and cost effective way to run most jobs. For the
G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk
(approximately 235GB free), and provides 1 executor per worker. We recommend this worker
type for jobs whose workloads contain your most demanding transforms, aggregations, joins,
and queries. This worker type is available only for Glue version 3.0 or later Spark ETL
jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia),
US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo),
Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). For the
G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk
(approximately 487GB free), and provides 1 executor per worker. We recommend this worker
type for jobs whose workloads contain your most demanding transforms, aggregations, joins,
and queries. This worker type is available only for Glue version 3.0 or later Spark ETL
jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type. For
the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB
disk (approximately 34GB free), and provides 1 executor per worker. We recommend this
worker type for low volume streaming jobs. This worker type is only available for Glue
version 3.0 streaming jobs. For the Z.2X worker type, each worker maps to 2 M-DPU
(8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8
Ray workers based on the autoscaler.
"""
function create_job(Command, Name, Role; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"CreateJob",
Dict{String,Any}("Command" => Command, "Name" => Name, "Role" => Role);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job(
Command,
Name,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Command" => Command, "Name" => Name, "Role" => Role),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_mltransform(input_record_tables, name, parameters, role)
create_mltransform(input_record_tables, name, parameters, role, params::Dict{String,<:Any})
Creates an Glue machine learning transform. This operation creates the transform and all
the necessary parameters to train it. Call this operation as the first step in the process
of using a machine learning transform (such as the FindMatches transform) for deduplicating
data. You can provide an optional Description, in addition to the parameters that you want
to use for your algorithm. You must also specify certain parameters for the tasks that Glue
runs on your behalf as part of learning from your data and creating a high-quality machine
learning transform. These parameters include Role, and optionally, AllocatedCapacity,
Timeout, and MaxRetries. For more information, see Jobs.
# Arguments
- `input_record_tables`: A list of Glue table definitions used by the transform.
- `name`: The unique name that you give the transform when you create it.
- `parameters`: The algorithmic parameters that are specific to the transform type used.
Conditionally dependent on the transform type.
- `role`: The name or Amazon Resource Name (ARN) of the IAM role with the required
permissions. The required permissions include both Glue service role permissions to Glue
resources, and Amazon S3 permissions required by the transform. This role needs Glue
service role permissions to allow access to resources in Glue. See Attach a Policy to IAM
Users That Access Glue. This role needs permission to your Amazon Simple Storage Service
(Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the
task run for this transform.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the machine learning transform that is being defined.
The default is an empty string.
- `"GlueVersion"`: This value determines which version of Glue this machine learning
transform is compatible with. Glue 1.0 is recommended for most customers. If the value is
not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue
Versions in the developer guide.
- `"MaxCapacity"`: The number of Glue data processing units (DPUs) that are allocated to
task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU
is a relative measure of processing power that consists of 4 vCPUs of compute capacity and
16 GB of memory. For more information, see the Glue pricing page. MaxCapacity is a
mutually exclusive option with NumberOfWorkers and WorkerType. If either NumberOfWorkers
or WorkerType is set, then MaxCapacity cannot be set. If MaxCapacity is set then neither
NumberOfWorkers or WorkerType can be set. If WorkerType is set, then NumberOfWorkers is
required (and vice versa). MaxCapacity and NumberOfWorkers must both be at least 1.
When the WorkerType field is set to a value other than Standard, the MaxCapacity field is
set automatically and becomes read-only. When the WorkerType field is set to a value other
than Standard, the MaxCapacity field is set automatically and becomes read-only.
- `"MaxRetries"`: The maximum number of times to retry a task for this transform after a
task run fails.
- `"NumberOfWorkers"`: The number of workers of a defined workerType that are allocated
when this task runs. If WorkerType is set, then NumberOfWorkers is required (and vice
versa).
- `"Tags"`: The tags to use with this machine learning transform. You may use tags to limit
access to the machine learning transform. For more information about tags in Glue, see
Amazon Web Services Tags in Glue in the developer guide.
- `"Timeout"`: The timeout of the task run for this transform in minutes. This is the
maximum time that a task run for this transform can consume resources before it is
terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
- `"TransformEncryption"`: The encryption-at-rest settings of the transform that apply to
accessing user data. Machine learning transforms can access user data encrypted in Amazon
S3 using KMS.
- `"WorkerType"`: The type of predefined worker that is allocated when this task runs.
Accepts a value of Standard, G.1X, or G.2X. For the Standard worker type, each worker
provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. For the
G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1
executor per worker. For the G.2X worker type, each worker provides 8 vCPU, 32 GB of
memory and a 128GB disk, and 1 executor per worker. MaxCapacity is a mutually exclusive
option with NumberOfWorkers and WorkerType. If either NumberOfWorkers or WorkerType is
set, then MaxCapacity cannot be set. If MaxCapacity is set then neither NumberOfWorkers
or WorkerType can be set. If WorkerType is set, then NumberOfWorkers is required (and
vice versa). MaxCapacity and NumberOfWorkers must both be at least 1.
"""
function create_mltransform(
InputRecordTables,
Name,
Parameters,
Role;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateMLTransform",
Dict{String,Any}(
"InputRecordTables" => InputRecordTables,
"Name" => Name,
"Parameters" => Parameters,
"Role" => Role,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_mltransform(
InputRecordTables,
Name,
Parameters,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateMLTransform",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InputRecordTables" => InputRecordTables,
"Name" => Name,
"Parameters" => Parameters,
"Role" => Role,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_partition(database_name, partition_input, table_name)
create_partition(database_name, partition_input, table_name, params::Dict{String,<:Any})
Creates a new partition.
# Arguments
- `database_name`: The name of the metadata database in which the partition is to be
created.
- `partition_input`: A PartitionInput structure defining the partition to be created.
- `table_name`: The name of the metadata table in which the partition is to be created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The Amazon Web Services account ID of the catalog in which the partition
is to be created.
"""
function create_partition(
DatabaseName,
PartitionInput,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreatePartition",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionInput" => PartitionInput,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_partition(
DatabaseName,
PartitionInput,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreatePartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionInput" => PartitionInput,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_partition_index(database_name, partition_index, table_name)
create_partition_index(database_name, partition_index, table_name, params::Dict{String,<:Any})
Creates a specified partition index in an existing table.
# Arguments
- `database_name`: Specifies the name of a database in which you want to create a partition
index.
- `partition_index`: Specifies a PartitionIndex structure to create a partition index in an
existing table.
- `table_name`: Specifies the name of a table in which you want to create a partition index.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The catalog ID where the table resides.
"""
function create_partition_index(
DatabaseName,
PartitionIndex,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreatePartitionIndex",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionIndex" => PartitionIndex,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_partition_index(
DatabaseName,
PartitionIndex,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreatePartitionIndex",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionIndex" => PartitionIndex,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_registry(registry_name)
create_registry(registry_name, params::Dict{String,<:Any})
Creates a new registry which may be used to hold a collection of schemas.
# Arguments
- `registry_name`: Name of the registry to be created of max length of 255, and may only
contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the registry. If description is not provided, there
will not be any default value for this.
- `"Tags"`: Amazon Web Services tags that contain a key value pair and may be searched by
console, command line, or API.
"""
function create_registry(RegistryName; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"CreateRegistry",
Dict{String,Any}("RegistryName" => RegistryName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_registry(
RegistryName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateRegistry",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RegistryName" => RegistryName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_schema(data_format, schema_name)
create_schema(data_format, schema_name, params::Dict{String,<:Any})
Creates a new schema set and registers the schema definition. Returns an error if the
schema set already exists without actually registering the version. When the schema set is
created, a version checkpoint will be set to the first version. Compatibility mode
\"DISABLED\" restricts any additional schema versions from being added after the first
schema version. For all other compatibility modes, validation of compatibility settings
will be applied only from the second version onwards when the RegisterSchemaVersion API is
used. When this API is called without a RegistryId, this will create an entry for a
\"default-registry\" in the registry database tables, if it is not already present.
# Arguments
- `data_format`: The data format of the schema definition. Currently AVRO, JSON and
PROTOBUF are supported.
- `schema_name`: Name of the schema to be created of max length of 255, and may only
contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Compatibility"`: The compatibility mode of the schema. The possible values are:
NONE: No compatibility mode applies. You can use this choice in development scenarios or if
you do not know the compatibility mode that you want to apply to schemas. Any new version
added will be accepted without undergoing a compatibility check. DISABLED: This
compatibility choice prevents versioning for a particular schema. You can use this choice
to prevent future versioning of a schema. BACKWARD: This compatibility choice is
recommended as it allows data receivers to read both the current and one previous schema
version. This means that for instance, a new schema version cannot drop data fields or
change the type of these fields, so they can't be read by readers using the previous
version. BACKWARD_ALL: This compatibility choice allows data receivers to read both the
current and all previous schema versions. You can use this choice when you need to delete
fields or add optional fields, and check compatibility against all previous schema
versions. FORWARD: This compatibility choice allows data receivers to read both the
current and one next schema version, but not necessarily later versions. You can use this
choice when you need to add fields or delete optional fields, but only check compatibility
against the last schema version. FORWARD_ALL: This compatibility choice allows data
receivers to read written by producers of any new registered schema. You can use this
choice when you need to add fields or delete optional fields, and check compatibility
against all previous schema versions. FULL: This compatibility choice allows data
receivers to read data written by producers using the previous or next version of the
schema, but not necessarily earlier or later versions. You can use this choice when you
need to add or remove optional fields, but only check compatibility against the last schema
version. FULL_ALL: This compatibility choice allows data receivers to read data written
by producers using all previous schema versions. You can use this choice when you need to
add or remove optional fields, and check compatibility against all previous schema
versions.
- `"Description"`: An optional description of the schema. If description is not provided,
there will not be any automatic default value for this.
- `"RegistryId"`: This is a wrapper shape to contain the registry identity fields. If this
is not provided, the default registry will be used. The ARN format for the same will be:
arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.
- `"SchemaDefinition"`: The schema definition using the DataFormat setting for SchemaName.
- `"Tags"`: Amazon Web Services tags that contain a key value pair and may be searched by
console, command line, or API. If specified, follows the Amazon Web Services tags-on-create
pattern.
"""
function create_schema(
DataFormat, SchemaName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateSchema",
Dict{String,Any}("DataFormat" => DataFormat, "SchemaName" => SchemaName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_schema(
DataFormat,
SchemaName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateSchema",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DataFormat" => DataFormat, "SchemaName" => SchemaName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_script()
create_script(params::Dict{String,<:Any})
Transforms a directed acyclic graph (DAG) into code.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DagEdges"`: A list of the edges in the DAG.
- `"DagNodes"`: A list of the nodes in the DAG.
- `"Language"`: The programming language of the resulting code from the DAG.
"""
function create_script(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("CreateScript"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_script(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateScript", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_security_configuration(encryption_configuration, name)
create_security_configuration(encryption_configuration, name, params::Dict{String,<:Any})
Creates a new security configuration. A security configuration is a set of security
properties that can be used by Glue. You can use a security configuration to encrypt data
at rest. For information about using security configurations in Glue, see Encrypting Data
Written by Crawlers, Jobs, and Development Endpoints.
# Arguments
- `encryption_configuration`: The encryption configuration for the new security
configuration.
- `name`: The name for the new security configuration.
"""
function create_security_configuration(
EncryptionConfiguration, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateSecurityConfiguration",
Dict{String,Any}(
"EncryptionConfiguration" => EncryptionConfiguration, "Name" => Name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_security_configuration(
EncryptionConfiguration,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateSecurityConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EncryptionConfiguration" => EncryptionConfiguration, "Name" => Name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_session(command, id, role)
create_session(command, id, role, params::Dict{String,<:Any})
Creates a new session.
# Arguments
- `command`: The SessionCommand that runs the job.
- `id`: The ID of the session request.
- `role`: The IAM Role ARN
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Connections"`: The number of connections to use for the session.
- `"DefaultArguments"`: A map array of key-value pairs. Max is 75 pairs.
- `"Description"`: The description of the session.
- `"GlueVersion"`: The Glue version determines the versions of Apache Spark and Python that
Glue supports. The GlueVersion must be greater than 2.0.
- `"IdleTimeout"`: The number of minutes when idle before session times out. Default for
Spark ETL jobs is value of Timeout. Consult the documentation for other job types.
- `"MaxCapacity"`: The number of Glue data processing units (DPUs) that can be allocated
when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs
of compute capacity and 16 GB memory.
- `"NumberOfWorkers"`: The number of workers of a defined WorkerType to use for the
session.
- `"RequestOrigin"`: The origin of the request.
- `"SecurityConfiguration"`: The name of the SecurityConfiguration structure to be used
with the session
- `"Tags"`: The map of key value pairs (tags) belonging to the session.
- `"Timeout"`: The number of minutes before session times out. Default for Spark ETL jobs
is 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult the
documentation for other job types.
- `"WorkerType"`: The type of predefined worker that is allocated when a job runs. Accepts
a value of G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray
notebooks. For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory)
with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend
this worker type for workloads such as data transforms, joins, and queries, to offers a
scalable and cost effective way to run most jobs. For the G.2X worker type, each worker
maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and
provides 1 executor per worker. We recommend this worker type for workloads such as data
transforms, joins, and queries, to offers a scalable and cost effective way to run most
jobs. For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory)
with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We
recommend this worker type for jobs whose workloads contain your most demanding transforms,
aggregations, joins, and queries. This worker type is available only for Glue version 3.0
or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US
East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia
Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe
(Stockholm). For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of
memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We
recommend this worker type for jobs whose workloads contain your most demanding transforms,
aggregations, joins, and queries. This worker type is available only for Glue version 3.0
or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X
worker type. For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of
memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based
on the autoscaler.
"""
function create_session(
Command, Id, Role; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateSession",
Dict{String,Any}("Command" => Command, "Id" => Id, "Role" => Role);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_session(
Command,
Id,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateSession",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Command" => Command, "Id" => Id, "Role" => Role),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_table(database_name, table_input)
create_table(database_name, table_input, params::Dict{String,<:Any})
Creates a new table definition in the Data Catalog.
# Arguments
- `database_name`: The catalog database in which to create the new table. For Hive
compatibility, this name is entirely lowercase.
- `table_input`: The TableInput object that defines the metadata table to create in the
catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which to create the Table. If none is
supplied, the Amazon Web Services account ID is used by default.
- `"OpenTableFormatInput"`: Specifies an OpenTableFormatInput structure when creating an
open format table.
- `"PartitionIndexes"`: A list of partition indexes, PartitionIndex structures, to create
in the table.
- `"TransactionId"`: The ID of the transaction.
"""
function create_table(
DatabaseName, TableInput; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateTable",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableInput" => TableInput);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_table(
DatabaseName,
TableInput,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName, "TableInput" => TableInput
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_table_optimizer(catalog_id, database_name, table_name, table_optimizer_configuration, type)
create_table_optimizer(catalog_id, database_name, table_name, table_optimizer_configuration, type, params::Dict{String,<:Any})
Creates a new table optimizer for a specific function. compaction is the only currently
supported optimizer type.
# Arguments
- `catalog_id`: The Catalog ID of the table.
- `database_name`: The name of the database in the catalog in which the table resides.
- `table_name`: The name of the table.
- `table_optimizer_configuration`: A TableOptimizerConfiguration object representing the
configuration of a table optimizer.
- `type`: The type of table optimizer. Currently, the only valid value is compaction.
"""
function create_table_optimizer(
CatalogId,
DatabaseName,
TableName,
TableOptimizerConfiguration,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateTableOptimizer",
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"TableOptimizerConfiguration" => TableOptimizerConfiguration,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_table_optimizer(
CatalogId,
DatabaseName,
TableName,
TableOptimizerConfiguration,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateTableOptimizer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"TableOptimizerConfiguration" => TableOptimizerConfiguration,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_trigger(actions, name, type)
create_trigger(actions, name, type, params::Dict{String,<:Any})
Creates a new trigger.
# Arguments
- `actions`: The actions initiated by this trigger when it fires.
- `name`: The name of the trigger.
- `type`: The type of the new trigger.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the new trigger.
- `"EventBatchingCondition"`: Batch condition that must be met (specified number of events
received or batch time window expired) before EventBridge event trigger fires.
- `"Predicate"`: A predicate to specify when the new trigger should fire. This field is
required when the trigger type is CONDITIONAL.
- `"Schedule"`: A cron expression used to specify the schedule (see Time-Based Schedules
for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would
specify: cron(15 12 * * ? *). This field is required when the trigger type is SCHEDULED.
- `"StartOnCreation"`: Set to true to start SCHEDULED and CONDITIONAL triggers when
created. True is not supported for ON_DEMAND triggers.
- `"Tags"`: The tags to use with this trigger. You may use tags to limit access to the
trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue in
the developer guide.
- `"WorkflowName"`: The name of the workflow associated with the trigger.
"""
function create_trigger(
Actions, Name, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateTrigger",
Dict{String,Any}("Actions" => Actions, "Name" => Name, "Type" => Type);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_trigger(
Actions,
Name,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateTrigger",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Actions" => Actions, "Name" => Name, "Type" => Type),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_usage_profile(configuration, name)
create_usage_profile(configuration, name, params::Dict{String,<:Any})
Creates an Glue usage profile.
# Arguments
- `configuration`: A ProfileConfiguration object specifying the job and session values for
the profile.
- `name`: The name of the usage profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the usage profile.
- `"Tags"`: A list of tags applied to the usage profile.
"""
function create_usage_profile(
Configuration, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateUsageProfile",
Dict{String,Any}("Configuration" => Configuration, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_usage_profile(
Configuration,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateUsageProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Configuration" => Configuration, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user_defined_function(database_name, function_input)
create_user_defined_function(database_name, function_input, params::Dict{String,<:Any})
Creates a new function definition in the Data Catalog.
# Arguments
- `database_name`: The name of the catalog database in which to create the function.
- `function_input`: A FunctionInput object that defines the function to create in the Data
Catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which to create the function. If none is
provided, the Amazon Web Services account ID is used by default.
"""
function create_user_defined_function(
DatabaseName, FunctionInput; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateUserDefinedFunction",
Dict{String,Any}("DatabaseName" => DatabaseName, "FunctionInput" => FunctionInput);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user_defined_function(
DatabaseName,
FunctionInput,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"CreateUserDefinedFunction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName, "FunctionInput" => FunctionInput
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workflow(name)
create_workflow(name, params::Dict{String,<:Any})
Creates a new workflow.
# Arguments
- `name`: The name to be assigned to the workflow. It should be unique within your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultRunProperties"`: A collection of properties to be used as part of each execution
of the workflow.
- `"Description"`: A description of the workflow.
- `"MaxConcurrentRuns"`: You can use this parameter to prevent unwanted multiple updates to
data, to control costs, or in some cases, to prevent exceeding the maximum number of
concurrent runs of any of the component jobs. If you leave this parameter blank, there is
no limit to the number of concurrent workflow runs.
- `"Tags"`: The tags to be used with this workflow.
"""
function create_workflow(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"CreateWorkflow",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workflow(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"CreateWorkflow",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_blueprint(name)
delete_blueprint(name, params::Dict{String,<:Any})
Deletes an existing blueprint.
# Arguments
- `name`: The name of the blueprint to delete.
"""
function delete_blueprint(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteBlueprint",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_blueprint(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteBlueprint",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_classifier(name)
delete_classifier(name, params::Dict{String,<:Any})
Removes a classifier from the Data Catalog.
# Arguments
- `name`: Name of the classifier to remove.
"""
function delete_classifier(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteClassifier",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_classifier(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteClassifier",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_column_statistics_for_partition(column_name, database_name, partition_values, table_name)
delete_column_statistics_for_partition(column_name, database_name, partition_values, table_name, params::Dict{String,<:Any})
Delete the partition column statistics of a column. The Identity and Access Management
(IAM) permission required for this operation is DeletePartition.
# Arguments
- `column_name`: Name of the column.
- `database_name`: The name of the catalog database where the partitions reside.
- `partition_values`: A list of partition values identifying the partition.
- `table_name`: The name of the partitions' table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partitions in question reside. If
none is supplied, the Amazon Web Services account ID is used by default.
"""
function delete_column_statistics_for_partition(
ColumnName,
DatabaseName,
PartitionValues,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteColumnStatisticsForPartition",
Dict{String,Any}(
"ColumnName" => ColumnName,
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_column_statistics_for_partition(
ColumnName,
DatabaseName,
PartitionValues,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteColumnStatisticsForPartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ColumnName" => ColumnName,
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_column_statistics_for_table(column_name, database_name, table_name)
delete_column_statistics_for_table(column_name, database_name, table_name, params::Dict{String,<:Any})
Retrieves table statistics of columns. The Identity and Access Management (IAM) permission
required for this operation is DeleteTable.
# Arguments
- `column_name`: The name of the column.
- `database_name`: The name of the catalog database where the partitions reside.
- `table_name`: The name of the partitions' table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partitions in question reside. If
none is supplied, the Amazon Web Services account ID is used by default.
"""
function delete_column_statistics_for_table(
ColumnName, DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteColumnStatisticsForTable",
Dict{String,Any}(
"ColumnName" => ColumnName,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_column_statistics_for_table(
ColumnName,
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteColumnStatisticsForTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ColumnName" => ColumnName,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connection(connection_name)
delete_connection(connection_name, params::Dict{String,<:Any})
Deletes a connection from the Data Catalog.
# Arguments
- `connection_name`: The name of the connection to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which the connection resides. If none is
provided, the Amazon Web Services account ID is used by default.
"""
function delete_connection(
ConnectionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteConnection",
Dict{String,Any}("ConnectionName" => ConnectionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connection(
ConnectionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteConnection",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ConnectionName" => ConnectionName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_crawler(name)
delete_crawler(name, params::Dict{String,<:Any})
Removes a specified crawler from the Glue Data Catalog, unless the crawler state is RUNNING.
# Arguments
- `name`: The name of the crawler to remove.
"""
function delete_crawler(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteCrawler",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_crawler(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteCrawler",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_entity_type(name)
delete_custom_entity_type(name, params::Dict{String,<:Any})
Deletes a custom pattern by specifying its name.
# Arguments
- `name`: The name of the custom pattern that you want to delete.
"""
function delete_custom_entity_type(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteCustomEntityType",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_entity_type(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteCustomEntityType",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_data_quality_ruleset(name)
delete_data_quality_ruleset(name, params::Dict{String,<:Any})
Deletes a data quality ruleset.
# Arguments
- `name`: A name for the data quality ruleset.
"""
function delete_data_quality_ruleset(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteDataQualityRuleset",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_data_quality_ruleset(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteDataQualityRuleset",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_database(name)
delete_database(name, params::Dict{String,<:Any})
Removes a specified database from a Data Catalog. After completing this operation, you no
longer have access to the tables (and all table versions and partitions that might belong
to the tables) and the user-defined functions in the deleted database. Glue deletes these
\"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling DeleteDatabase,
use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition,
DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources
that belong to the database.
# Arguments
- `name`: The name of the database to delete. For Hive compatibility, this must be all
lowercase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which the database resides. If none is
provided, the Amazon Web Services account ID is used by default.
"""
function delete_database(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteDatabase",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_database(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteDatabase",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dev_endpoint(endpoint_name)
delete_dev_endpoint(endpoint_name, params::Dict{String,<:Any})
Deletes a specified development endpoint.
# Arguments
- `endpoint_name`: The name of the DevEndpoint.
"""
function delete_dev_endpoint(
EndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteDevEndpoint",
Dict{String,Any}("EndpointName" => EndpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dev_endpoint(
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteDevEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointName" => EndpointName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_job(job_name)
delete_job(job_name, params::Dict{String,<:Any})
Deletes a specified job definition. If the job definition is not found, no exception is
thrown.
# Arguments
- `job_name`: The name of the job definition to delete.
"""
function delete_job(JobName; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteJob",
Dict{String,Any}("JobName" => JobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_job(
JobName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobName" => JobName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_mltransform(transform_id)
delete_mltransform(transform_id, params::Dict{String,<:Any})
Deletes an Glue machine learning transform. Machine learning transforms are a special type
of transform that use machine learning to learn the details of the transformation to be
performed by learning from examples provided by humans. These transformations are then
saved by Glue. If you no longer need a transform, you can delete it by calling
DeleteMLTransforms. However, any Glue jobs that still reference the deleted transform will
no longer succeed.
# Arguments
- `transform_id`: The unique identifier of the transform to delete.
"""
function delete_mltransform(TransformId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteMLTransform",
Dict{String,Any}("TransformId" => TransformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_mltransform(
TransformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteMLTransform",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TransformId" => TransformId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_partition(database_name, partition_values, table_name)
delete_partition(database_name, partition_values, table_name, params::Dict{String,<:Any})
Deletes a specified partition.
# Arguments
- `database_name`: The name of the catalog database in which the table in question resides.
- `partition_values`: The values that define the partition.
- `table_name`: The name of the table that contains the partition to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partition to be deleted resides. If
none is provided, the Amazon Web Services account ID is used by default.
"""
function delete_partition(
DatabaseName,
PartitionValues,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeletePartition",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_partition(
DatabaseName,
PartitionValues,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeletePartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_partition_index(database_name, index_name, table_name)
delete_partition_index(database_name, index_name, table_name, params::Dict{String,<:Any})
Deletes a specified partition index from an existing table.
# Arguments
- `database_name`: Specifies the name of a database from which you want to delete a
partition index.
- `index_name`: The name of the partition index to be deleted.
- `table_name`: Specifies the name of a table from which you want to delete a partition
index.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The catalog ID where the table resides.
"""
function delete_partition_index(
DatabaseName, IndexName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeletePartitionIndex",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"IndexName" => IndexName,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_partition_index(
DatabaseName,
IndexName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeletePartitionIndex",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"IndexName" => IndexName,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_registry(registry_id)
delete_registry(registry_id, params::Dict{String,<:Any})
Delete the entire registry including schema and all of its versions. To get the status of
the delete operation, you can call the GetRegistry API after the asynchronous call.
Deleting a registry will deactivate all online operations for the registry such as the
UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs.
# Arguments
- `registry_id`: This is a wrapper structure that may contain the registry name and Amazon
Resource Name (ARN).
"""
function delete_registry(RegistryId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteRegistry",
Dict{String,Any}("RegistryId" => RegistryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_registry(
RegistryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteRegistry",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RegistryId" => RegistryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_policy()
delete_resource_policy(params::Dict{String,<:Any})
Deletes a specified policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyHashCondition"`: The hash value returned when this policy was set.
- `"ResourceArn"`: The ARN of the Glue resource for the resource policy to be deleted.
"""
function delete_resource_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"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 glue(
"DeleteResourcePolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_schema(schema_id)
delete_schema(schema_id, params::Dict{String,<:Any})
Deletes the entire schema set, including the schema set and all of its versions. To get the
status of the delete operation, you can call GetSchema API after the asynchronous call.
Deleting a registry will deactivate all online operations for the schema, such as the
GetSchemaByDefinition, and RegisterSchemaVersion APIs.
# Arguments
- `schema_id`: This is a wrapper structure that may contain the schema name and Amazon
Resource Name (ARN).
"""
function delete_schema(SchemaId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteSchema",
Dict{String,Any}("SchemaId" => SchemaId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_schema(
SchemaId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteSchema",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SchemaId" => SchemaId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_schema_versions(schema_id, versions)
delete_schema_versions(schema_id, versions, params::Dict{String,<:Any})
Remove versions from the specified schema. A version number or range may be supplied. If
the compatibility mode forbids deleting of a version that is necessary, such as
BACKWARDS_FULL, an error is returned. Calling the GetSchemaVersions API after this call
will list the status of the deleted versions. When the range of version numbers contain
check pointed version, the API will return a 409 conflict and will not proceed with the
deletion. You have to remove the checkpoint first using the DeleteSchemaCheckpoint API
before using this API. You cannot use the DeleteSchemaVersions API to delete the first
schema version in the schema set. The first schema version can only be deleted by the
DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata under
the schema versions. Hard deletes will be enforced on the database. If the compatibility
mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is
returned.
# Arguments
- `schema_id`: This is a wrapper structure that may contain the schema name and Amazon
Resource Name (ARN).
- `versions`: A version range may be supplied which may be of the format: a single
version number, 5 a range, 5-8 : deletes versions 5, 6, 7, 8
"""
function delete_schema_versions(
SchemaId, Versions; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteSchemaVersions",
Dict{String,Any}("SchemaId" => SchemaId, "Versions" => Versions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_schema_versions(
SchemaId,
Versions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteSchemaVersions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SchemaId" => SchemaId, "Versions" => Versions),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_security_configuration(name)
delete_security_configuration(name, params::Dict{String,<:Any})
Deletes a specified security configuration.
# Arguments
- `name`: The name of the security configuration to delete.
"""
function delete_security_configuration(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteSecurityConfiguration",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_security_configuration(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteSecurityConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_session(id)
delete_session(id, params::Dict{String,<:Any})
Deletes the session.
# Arguments
- `id`: The ID of the session to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RequestOrigin"`: The name of the origin of the delete session request.
"""
function delete_session(Id; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteSession",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_session(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteSession",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_table(database_name, name)
delete_table(database_name, name, params::Dict{String,<:Any})
Removes a table definition from the Data Catalog. After completing this operation, you no
longer have access to the table versions and partitions that belong to the deleted table.
Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the
discretion of the service. To ensure the immediate deletion of all related resources,
before calling DeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and
DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.
# Arguments
- `database_name`: The name of the catalog database in which the table resides. For Hive
compatibility, this name is entirely lowercase.
- `name`: The name of the table to be deleted. For Hive compatibility, this name is
entirely lowercase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the table resides. If none is provided,
the Amazon Web Services account ID is used by default.
- `"TransactionId"`: The transaction ID at which to delete the table contents.
"""
function delete_table(DatabaseName, Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteTable",
Dict{String,Any}("DatabaseName" => DatabaseName, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_table(
DatabaseName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_table_optimizer(catalog_id, database_name, table_name, type)
delete_table_optimizer(catalog_id, database_name, table_name, type, params::Dict{String,<:Any})
Deletes an optimizer and all associated metadata for a table. The optimization will no
longer be performed on the table.
# Arguments
- `catalog_id`: The Catalog ID of the table.
- `database_name`: The name of the database in the catalog in which the table resides.
- `table_name`: The name of the table.
- `type`: The type of table optimizer.
"""
function delete_table_optimizer(
CatalogId,
DatabaseName,
TableName,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteTableOptimizer",
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_table_optimizer(
CatalogId,
DatabaseName,
TableName,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteTableOptimizer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_table_version(database_name, table_name, version_id)
delete_table_version(database_name, table_name, version_id, params::Dict{String,<:Any})
Deletes a specified version of a table.
# Arguments
- `database_name`: The database in the catalog in which the table resides. For Hive
compatibility, this name is entirely lowercase.
- `table_name`: The name of the table. For Hive compatibility, this name is entirely
lowercase.
- `version_id`: The ID of the table version to be deleted. A VersionID is a string
representation of an integer. Each version is incremented by 1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the tables reside. If none is provided,
the Amazon Web Services account ID is used by default.
"""
function delete_table_version(
DatabaseName, TableName, VersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteTableVersion",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"VersionId" => VersionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_table_version(
DatabaseName,
TableName,
VersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteTableVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"VersionId" => VersionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_trigger(name)
delete_trigger(name, params::Dict{String,<:Any})
Deletes a specified trigger. If the trigger is not found, no exception is thrown.
# Arguments
- `name`: The name of the trigger to delete.
"""
function delete_trigger(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteTrigger",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_trigger(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteTrigger",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_usage_profile(name)
delete_usage_profile(name, params::Dict{String,<:Any})
Deletes the Glue specified usage profile.
# Arguments
- `name`: The name of the usage profile to delete.
"""
function delete_usage_profile(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteUsageProfile",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_usage_profile(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteUsageProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_defined_function(database_name, function_name)
delete_user_defined_function(database_name, function_name, params::Dict{String,<:Any})
Deletes an existing function definition from the Data Catalog.
# Arguments
- `database_name`: The name of the catalog database where the function is located.
- `function_name`: The name of the function definition to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the function to be deleted is located. If
none is supplied, the Amazon Web Services account ID is used by default.
"""
function delete_user_defined_function(
DatabaseName, FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteUserDefinedFunction",
Dict{String,Any}("DatabaseName" => DatabaseName, "FunctionName" => FunctionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_defined_function(
DatabaseName,
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"DeleteUserDefinedFunction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName, "FunctionName" => FunctionName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workflow(name)
delete_workflow(name, params::Dict{String,<:Any})
Deletes a workflow.
# Arguments
- `name`: Name of the workflow to be deleted.
"""
function delete_workflow(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"DeleteWorkflow",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workflow(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"DeleteWorkflow",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_blueprint(name)
get_blueprint(name, params::Dict{String,<:Any})
Retrieves the details of a blueprint.
# Arguments
- `name`: The name of the blueprint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeBlueprint"`: Specifies whether or not to include the blueprint in the response.
- `"IncludeParameterSpec"`: Specifies whether or not to include the parameter specification.
"""
function get_blueprint(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetBlueprint",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_blueprint(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetBlueprint",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_blueprint_run(blueprint_name, run_id)
get_blueprint_run(blueprint_name, run_id, params::Dict{String,<:Any})
Retrieves the details of a blueprint run.
# Arguments
- `blueprint_name`: The name of the blueprint.
- `run_id`: The run ID for the blueprint run you want to retrieve.
"""
function get_blueprint_run(
BlueprintName, RunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetBlueprintRun",
Dict{String,Any}("BlueprintName" => BlueprintName, "RunId" => RunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_blueprint_run(
BlueprintName,
RunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetBlueprintRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BlueprintName" => BlueprintName, "RunId" => RunId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_blueprint_runs(blueprint_name)
get_blueprint_runs(blueprint_name, params::Dict{String,<:Any})
Retrieves the details of blueprint runs for a specified blueprint.
# Arguments
- `blueprint_name`: The name of the blueprint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum size of a list to return.
- `"NextToken"`: A continuation token, if this is a continuation request.
"""
function get_blueprint_runs(
BlueprintName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetBlueprintRuns",
Dict{String,Any}("BlueprintName" => BlueprintName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_blueprint_runs(
BlueprintName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetBlueprintRuns",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("BlueprintName" => BlueprintName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_catalog_import_status()
get_catalog_import_status(params::Dict{String,<:Any})
Retrieves the status of a migration operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the catalog to migrate. Currently, this should be the Amazon Web
Services account ID.
"""
function get_catalog_import_status(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetCatalogImportStatus"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_catalog_import_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetCatalogImportStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_classifier(name)
get_classifier(name, params::Dict{String,<:Any})
Retrieve a classifier by name.
# Arguments
- `name`: Name of the classifier to retrieve.
"""
function get_classifier(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetClassifier",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_classifier(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetClassifier",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_classifiers()
get_classifiers(params::Dict{String,<:Any})
Lists all classifier objects in the Data Catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The size of the list to return (optional).
- `"NextToken"`: An optional continuation token.
"""
function get_classifiers(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetClassifiers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_classifiers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetClassifiers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_column_statistics_for_partition(column_names, database_name, partition_values, table_name)
get_column_statistics_for_partition(column_names, database_name, partition_values, table_name, params::Dict{String,<:Any})
Retrieves partition statistics of columns. The Identity and Access Management (IAM)
permission required for this operation is GetPartition.
# Arguments
- `column_names`: A list of the column names.
- `database_name`: The name of the catalog database where the partitions reside.
- `partition_values`: A list of partition values identifying the partition.
- `table_name`: The name of the partitions' table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partitions in question reside. If
none is supplied, the Amazon Web Services account ID is used by default.
"""
function get_column_statistics_for_partition(
ColumnNames,
DatabaseName,
PartitionValues,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetColumnStatisticsForPartition",
Dict{String,Any}(
"ColumnNames" => ColumnNames,
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_column_statistics_for_partition(
ColumnNames,
DatabaseName,
PartitionValues,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetColumnStatisticsForPartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ColumnNames" => ColumnNames,
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_column_statistics_for_table(column_names, database_name, table_name)
get_column_statistics_for_table(column_names, database_name, table_name, params::Dict{String,<:Any})
Retrieves table statistics of columns. The Identity and Access Management (IAM) permission
required for this operation is GetTable.
# Arguments
- `column_names`: A list of the column names.
- `database_name`: The name of the catalog database where the partitions reside.
- `table_name`: The name of the partitions' table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partitions in question reside. If
none is supplied, the Amazon Web Services account ID is used by default.
"""
function get_column_statistics_for_table(
ColumnNames, DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetColumnStatisticsForTable",
Dict{String,Any}(
"ColumnNames" => ColumnNames,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_column_statistics_for_table(
ColumnNames,
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetColumnStatisticsForTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ColumnNames" => ColumnNames,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_column_statistics_task_run(column_statistics_task_run_id)
get_column_statistics_task_run(column_statistics_task_run_id, params::Dict{String,<:Any})
Get the associated metadata/information for a task run, given a task run ID.
# Arguments
- `column_statistics_task_run_id`: The identifier for the particular column statistics task
run.
"""
function get_column_statistics_task_run(
ColumnStatisticsTaskRunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetColumnStatisticsTaskRun",
Dict{String,Any}("ColumnStatisticsTaskRunId" => ColumnStatisticsTaskRunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_column_statistics_task_run(
ColumnStatisticsTaskRunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetColumnStatisticsTaskRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ColumnStatisticsTaskRunId" => ColumnStatisticsTaskRunId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_column_statistics_task_runs(database_name, table_name)
get_column_statistics_task_runs(database_name, table_name, params::Dict{String,<:Any})
Retrieves information about all runs associated with the specified table.
# Arguments
- `database_name`: The name of the database where the table resides.
- `table_name`: The name of the 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.
"""
function get_column_statistics_task_runs(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetColumnStatisticsTaskRuns",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_column_statistics_task_runs(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetColumnStatisticsTaskRuns",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connection(name)
get_connection(name, params::Dict{String,<:Any})
Retrieves a connection definition from the Data Catalog.
# Arguments
- `name`: The name of the connection definition to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which the connection resides. If none is
provided, the Amazon Web Services account ID is used by default.
- `"HidePassword"`: Allows you to retrieve the connection metadata without returning the
password. For instance, the Glue console uses this flag to retrieve the connection, and
does not display the password. Set this parameter when the caller might not have permission
to use the KMS key to decrypt the password, but it does have permission to access the rest
of the connection properties.
"""
function get_connection(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetConnection",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connection(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetConnection",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connections()
get_connections(params::Dict{String,<:Any})
Retrieves a list of connection definitions from the Data Catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which the connections reside. If none is
provided, the Amazon Web Services account ID is used by default.
- `"Filter"`: A filter that controls which connections are returned.
- `"HidePassword"`: Allows you to retrieve the connection metadata without returning the
password. For instance, the Glue console uses this flag to retrieve the connection, and
does not display the password. Set this parameter when the caller might not have permission
to use the KMS key to decrypt the password, but it does have permission to access the rest
of the connection properties.
- `"MaxResults"`: The maximum number of connections to return in one response.
- `"NextToken"`: A continuation token, if this is a continuation call.
"""
function get_connections(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetConnections"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_connections(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetConnections", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_crawler(name)
get_crawler(name, params::Dict{String,<:Any})
Retrieves metadata for a specified crawler.
# Arguments
- `name`: The name of the crawler to retrieve metadata for.
"""
function get_crawler(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetCrawler",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_crawler(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetCrawler",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_crawler_metrics()
get_crawler_metrics(params::Dict{String,<:Any})
Retrieves metrics about specified crawlers.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CrawlerNameList"`: A list of the names of crawlers about which to retrieve metrics.
- `"MaxResults"`: The maximum size of a list to return.
- `"NextToken"`: A continuation token, if this is a continuation call.
"""
function get_crawler_metrics(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetCrawlerMetrics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_crawler_metrics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetCrawlerMetrics", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_crawlers()
get_crawlers(params::Dict{String,<:Any})
Retrieves metadata for all crawlers defined in the customer account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of crawlers to return on each call.
- `"NextToken"`: A continuation token, if this is a continuation request.
"""
function get_crawlers(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetCrawlers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_crawlers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetCrawlers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_custom_entity_type(name)
get_custom_entity_type(name, params::Dict{String,<:Any})
Retrieves the details of a custom pattern by specifying its name.
# Arguments
- `name`: The name of the custom pattern that you want to retrieve.
"""
function get_custom_entity_type(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetCustomEntityType",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_custom_entity_type(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetCustomEntityType",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_catalog_encryption_settings()
get_data_catalog_encryption_settings(params::Dict{String,<:Any})
Retrieves the security configuration for a specified catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog to retrieve the security configuration for. If
none is provided, the Amazon Web Services account ID is used by default.
"""
function get_data_catalog_encryption_settings(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDataCatalogEncryptionSettings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_catalog_encryption_settings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDataCatalogEncryptionSettings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_quality_result(result_id)
get_data_quality_result(result_id, params::Dict{String,<:Any})
Retrieves the result of a data quality rule evaluation.
# Arguments
- `result_id`: A unique result ID for the data quality result.
"""
function get_data_quality_result(
ResultId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDataQualityResult",
Dict{String,Any}("ResultId" => ResultId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_quality_result(
ResultId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetDataQualityResult",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResultId" => ResultId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_quality_rule_recommendation_run(run_id)
get_data_quality_rule_recommendation_run(run_id, params::Dict{String,<:Any})
Gets the specified recommendation run that was used to generate rules.
# Arguments
- `run_id`: The unique run identifier associated with this run.
"""
function get_data_quality_rule_recommendation_run(
RunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDataQualityRuleRecommendationRun",
Dict{String,Any}("RunId" => RunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_quality_rule_recommendation_run(
RunId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDataQualityRuleRecommendationRun",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RunId" => RunId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_quality_ruleset(name)
get_data_quality_ruleset(name, params::Dict{String,<:Any})
Returns an existing ruleset by identifier or name.
# Arguments
- `name`: The name of the ruleset.
"""
function get_data_quality_ruleset(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetDataQualityRuleset",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_quality_ruleset(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDataQualityRuleset",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_data_quality_ruleset_evaluation_run(run_id)
get_data_quality_ruleset_evaluation_run(run_id, params::Dict{String,<:Any})
Retrieves a specific run where a ruleset is evaluated against a data source.
# Arguments
- `run_id`: The unique run identifier associated with this run.
"""
function get_data_quality_ruleset_evaluation_run(
RunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDataQualityRulesetEvaluationRun",
Dict{String,Any}("RunId" => RunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_data_quality_ruleset_evaluation_run(
RunId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDataQualityRulesetEvaluationRun",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RunId" => RunId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_database(name)
get_database(name, params::Dict{String,<:Any})
Retrieves the definition of a specified database.
# Arguments
- `name`: The name of the database to retrieve. For Hive compatibility, this should be all
lowercase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which the database resides. If none is
provided, the Amazon Web Services account ID is used by default.
"""
function get_database(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetDatabase",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_database(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDatabase",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_databases()
get_databases(params::Dict{String,<:Any})
Retrieves all databases defined in a given Data Catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog from which to retrieve Databases. If none is
provided, the Amazon Web Services account ID is used by default.
- `"MaxResults"`: The maximum number of databases to return in one response.
- `"NextToken"`: A continuation token, if this is a continuation call.
- `"ResourceShareType"`: Allows you to specify that you want to list the databases shared
with your account. The allowable values are FEDERATED, FOREIGN or ALL. If set to
FEDERATED, will list the federated databases (referencing an external entity) shared with
your account. If set to FOREIGN, will list the databases shared with your account. If
set to ALL, will list the databases shared with your account, as well as the databases in
yor local account.
"""
function get_databases(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetDatabases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_databases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDatabases", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_dataflow_graph()
get_dataflow_graph(params::Dict{String,<:Any})
Transforms a Python script into a directed acyclic graph (DAG).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PythonScript"`: The Python script to transform.
"""
function get_dataflow_graph(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetDataflowGraph"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_dataflow_graph(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDataflowGraph", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_dev_endpoint(endpoint_name)
get_dev_endpoint(endpoint_name, params::Dict{String,<:Any})
Retrieves information about a specified development endpoint. When you create a
development endpoint in a virtual private cloud (VPC), Glue returns only a private IP
address, and the public IP address field is not populated. When you create a non-VPC
development endpoint, Glue returns only a public IP address.
# Arguments
- `endpoint_name`: Name of the DevEndpoint to retrieve information for.
"""
function get_dev_endpoint(EndpointName; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetDevEndpoint",
Dict{String,Any}("EndpointName" => EndpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dev_endpoint(
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetDevEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointName" => EndpointName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dev_endpoints()
get_dev_endpoints(params::Dict{String,<:Any})
Retrieves all the development endpoints in this Amazon Web Services account. When you
create a development endpoint in a virtual private cloud (VPC), Glue returns only a private
IP address and the public IP address field is not populated. When you create a non-VPC
development endpoint, Glue returns only a public IP address.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum size of information to return.
- `"NextToken"`: A continuation token, if this is a continuation call.
"""
function get_dev_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetDevEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_dev_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetDevEndpoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_job(job_name)
get_job(job_name, params::Dict{String,<:Any})
Retrieves an existing job definition.
# Arguments
- `job_name`: The name of the job definition to retrieve.
"""
function get_job(JobName; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetJob",
Dict{String,Any}("JobName" => JobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job(
JobName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobName" => JobName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job_bookmark(job_name)
get_job_bookmark(job_name, params::Dict{String,<:Any})
Returns information on a job bookmark entry. For more information about enabling and using
job bookmarks, see: Tracking processed data using job bookmarks Job parameters used
by Glue Job structure
# Arguments
- `job_name`: The name of the job in question.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RunId"`: The unique run identifier associated with this job run.
"""
function get_job_bookmark(JobName; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetJobBookmark",
Dict{String,Any}("JobName" => JobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job_bookmark(
JobName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetJobBookmark",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobName" => JobName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job_run(job_name, run_id)
get_job_run(job_name, run_id, params::Dict{String,<:Any})
Retrieves the metadata for a given job run. Job run history is accessible for 90 days for
your workflow and job run.
# Arguments
- `job_name`: Name of the job definition being run.
- `run_id`: The ID of the job run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PredecessorsIncluded"`: True if a list of predecessor runs should be returned.
"""
function get_job_run(JobName, RunId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetJobRun",
Dict{String,Any}("JobName" => JobName, "RunId" => RunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job_run(
JobName,
RunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetJobRun",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("JobName" => JobName, "RunId" => RunId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job_runs(job_name)
get_job_runs(job_name, params::Dict{String,<:Any})
Retrieves metadata for all runs of a given job definition.
# Arguments
- `job_name`: The name of the job definition for which to retrieve all job runs.
# 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.
"""
function get_job_runs(JobName; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetJobRuns",
Dict{String,Any}("JobName" => JobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job_runs(
JobName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetJobRuns",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobName" => JobName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_jobs()
get_jobs(params::Dict{String,<:Any})
Retrieves all current job definitions.
# 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.
"""
function get_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue("GetJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
get_mapping(source)
get_mapping(source, params::Dict{String,<:Any})
Creates mappings.
# Arguments
- `source`: Specifies the source table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Location"`: Parameters for the mapping.
- `"Sinks"`: A list of target tables.
"""
function get_mapping(Source; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetMapping",
Dict{String,Any}("Source" => Source);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mapping(
Source, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetMapping",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Source" => Source), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mltask_run(task_run_id, transform_id)
get_mltask_run(task_run_id, transform_id, params::Dict{String,<:Any})
Gets details for a specific task run on a machine learning transform. Machine learning task
runs are asynchronous tasks that Glue runs on your behalf as part of various machine
learning workflows. You can check the stats of any task run by calling GetMLTaskRun with
the TaskRunID and its parent transform's TransformID.
# Arguments
- `task_run_id`: The unique identifier of the task run.
- `transform_id`: The unique identifier of the machine learning transform.
"""
function get_mltask_run(
TaskRunId, TransformId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetMLTaskRun",
Dict{String,Any}("TaskRunId" => TaskRunId, "TransformId" => TransformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mltask_run(
TaskRunId,
TransformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetMLTaskRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TaskRunId" => TaskRunId, "TransformId" => TransformId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mltask_runs(transform_id)
get_mltask_runs(transform_id, params::Dict{String,<:Any})
Gets a list of runs for a machine learning transform. Machine learning task runs are
asynchronous tasks that Glue runs on your behalf as part of various machine learning
workflows. You can get a sortable, filterable list of machine learning task runs by calling
GetMLTaskRuns with their parent transform's TransformID and other optional parameters as
documented in this section. This operation returns a list of historic runs and must be
paginated.
# Arguments
- `transform_id`: The unique identifier of the machine learning transform.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filter criteria, in the TaskRunFilterCriteria structure, for the task run.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A token for pagination of the results. The default is empty.
- `"Sort"`: The sorting criteria, in the TaskRunSortCriteria structure, for the task run.
"""
function get_mltask_runs(TransformId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetMLTaskRuns",
Dict{String,Any}("TransformId" => TransformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mltask_runs(
TransformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetMLTaskRuns",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TransformId" => TransformId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mltransform(transform_id)
get_mltransform(transform_id, params::Dict{String,<:Any})
Gets an Glue machine learning transform artifact and all its corresponding metadata.
Machine learning transforms are a special type of transform that use machine learning to
learn the details of the transformation to be performed by learning from examples provided
by humans. These transformations are then saved by Glue. You can retrieve their metadata by
calling GetMLTransform.
# Arguments
- `transform_id`: The unique identifier of the transform, generated at the time that the
transform was created.
"""
function get_mltransform(TransformId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetMLTransform",
Dict{String,Any}("TransformId" => TransformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mltransform(
TransformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetMLTransform",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TransformId" => TransformId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mltransforms()
get_mltransforms(params::Dict{String,<:Any})
Gets a sortable, filterable list of existing Glue machine learning transforms. Machine
learning transforms are a special type of transform that use machine learning to learn the
details of the transformation to be performed by learning from examples provided by humans.
These transformations are then saved by Glue, and you can retrieve their metadata by
calling GetMLTransforms.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filter transformation criteria.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A paginated token to offset the results.
- `"Sort"`: The sorting criteria.
"""
function get_mltransforms(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetMLTransforms"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_mltransforms(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetMLTransforms", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_partition(database_name, partition_values, table_name)
get_partition(database_name, partition_values, table_name, params::Dict{String,<:Any})
Retrieves information about a specified partition.
# Arguments
- `database_name`: The name of the catalog database where the partition resides.
- `partition_values`: The values that define the partition.
- `table_name`: The name of the partition's table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partition in question resides. If
none is provided, the Amazon Web Services account ID is used by default.
"""
function get_partition(
DatabaseName,
PartitionValues,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetPartition",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_partition(
DatabaseName,
PartitionValues,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetPartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_partition_indexes(database_name, table_name)
get_partition_indexes(database_name, table_name, params::Dict{String,<:Any})
Retrieves the partition indexes associated with a table.
# Arguments
- `database_name`: Specifies the name of a database from which you want to retrieve
partition indexes.
- `table_name`: Specifies the name of a table for which you want to retrieve the partition
indexes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The catalog ID where the table resides.
- `"NextToken"`: A continuation token, included if this is a continuation call.
"""
function get_partition_indexes(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetPartitionIndexes",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_partition_indexes(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetPartitionIndexes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_partitions(database_name, table_name)
get_partitions(database_name, table_name, params::Dict{String,<:Any})
Retrieves information about the partitions in a table.
# Arguments
- `database_name`: The name of the catalog database where the partitions reside.
- `table_name`: The name of the partitions' table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partitions in question reside. If
none is provided, the Amazon Web Services account ID is used by default.
- `"ExcludeColumnSchema"`: When true, specifies not returning the partition column schema.
Useful when you are interested only in other partition attributes such as partition values
or location. This approach avoids the problem of a large response by not returning
duplicate data.
- `"Expression"`: An expression that filters the partitions to be returned. The expression
uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser
parses the expression. Operators: The following are the operators that you can use in the
Expression API call: = Checks whether the values of the two operands are equal; if yes,
then the condition becomes true. Example: Assume 'variable a' holds 10 and 'variable b'
holds 20. (a = b) is not true. < > Checks whether the values of two operands are
equal; if the values are not equal, then the condition becomes true. Example: (a < >
b) is true. > Checks whether the value of the left operand is greater than the value
of the right operand; if yes, then the condition becomes true. Example: (a > b) is not
true. < Checks whether the value of the left operand is less than the value of the
right operand; if yes, then the condition becomes true. Example: (a < b) is true. >=
Checks whether the value of the left operand is greater than or equal to the value of the
right operand; if yes, then the condition becomes true. Example: (a >= b) is not true.
<= Checks whether the value of the left operand is less than or equal to the value of
the right operand; if yes, then the condition becomes true. Example: (a <= b) is true.
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL Logical operators. Supported Partition Key
Types: The following are the supported partition keys. string date timestamp
int bigint long tinyint smallint decimal If an type is encountered
that is not valid, an exception is thrown. The following list shows the valid operators on
each type. When you define a crawler, the partitionKey type is created as a STRING, to be
compatible with the catalog partitions. Sample API Call:
- `"MaxResults"`: The maximum number of partitions to return in a single response.
- `"NextToken"`: A continuation token, if this is not the first call to retrieve these
partitions.
- `"QueryAsOfTime"`: The time as of when to read the partition contents. If not set, the
most recent transaction commit time will be used. Cannot be specified along with
TransactionId.
- `"Segment"`: The segment of the table's partitions to scan in this request.
- `"TransactionId"`: The transaction ID at which to read the partition contents.
"""
function get_partitions(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetPartitions",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_partitions(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetPartitions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_plan(mapping, source)
get_plan(mapping, source, params::Dict{String,<:Any})
Gets code to perform a specified mapping.
# Arguments
- `mapping`: The list of mappings from a source table to target tables.
- `source`: The source table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalPlanOptionsMap"`: A map to hold additional optional key-value parameters.
Currently, these key-value pairs are supported: inferSchema — Specifies whether to
set inferSchema to true or false for the default script generated by an Glue job. For
example, to set inferSchema to true, pass the following key value pair:
--additional-plan-options-map '{\"inferSchema\":\"true\"}'
- `"Language"`: The programming language of the code to perform the mapping.
- `"Location"`: The parameters for the mapping.
- `"Sinks"`: The target tables.
"""
function get_plan(Mapping, Source; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetPlan",
Dict{String,Any}("Mapping" => Mapping, "Source" => Source);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_plan(
Mapping,
Source,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetPlan",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Mapping" => Mapping, "Source" => Source), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_registry(registry_id)
get_registry(registry_id, params::Dict{String,<:Any})
Describes the specified registry in detail.
# Arguments
- `registry_id`: This is a wrapper structure that may contain the registry name and Amazon
Resource Name (ARN).
"""
function get_registry(RegistryId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetRegistry",
Dict{String,Any}("RegistryId" => RegistryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_registry(
RegistryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetRegistry",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RegistryId" => RegistryId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policies()
get_resource_policies(params::Dict{String,<:Any})
Retrieves the resource policies set on individual resources by Resource Access Manager
during cross-account permission grants. Also retrieves the Data Catalog resource policy. If
you enabled metadata encryption in Data Catalog settings, and you do not have permission on
the KMS key, the operation can't return the Data Catalog resource policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum size of a list to return.
- `"NextToken"`: A continuation token, if this is a continuation request.
"""
function get_resource_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetResourcePolicies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_resource_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetResourcePolicies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_policy()
get_resource_policy(params::Dict{String,<:Any})
Retrieves a specified resource policy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ResourceArn"`: The ARN of the Glue resource for which to retrieve the resource policy.
If not supplied, the Data Catalog resource policy is returned. Use GetResourcePolicies to
view all existing resource policies. For more information see Specifying Glue Resource
ARNs.
"""
function get_resource_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetResourcePolicy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_resource_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetResourcePolicy", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_schema(schema_id)
get_schema(schema_id, params::Dict{String,<:Any})
Describes the specified schema in detail.
# Arguments
- `schema_id`: This is a wrapper structure to contain schema identity fields. The structure
contains: SchemaIdSchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn or SchemaName and RegistryName has to be provided. SchemaIdSchemaName: The name
of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
"""
function get_schema(SchemaId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetSchema",
Dict{String,Any}("SchemaId" => SchemaId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_schema(
SchemaId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetSchema",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SchemaId" => SchemaId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_schema_by_definition(schema_definition, schema_id)
get_schema_by_definition(schema_definition, schema_id, params::Dict{String,<:Any})
Retrieves a schema by the SchemaDefinition. The schema definition is sent to the Schema
Registry, canonicalized, and hashed. If the hash is matched within the scope of the
SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata
is returned. Otherwise, a 404 or NotFound error is returned. Schema versions in Deleted
statuses will not be included in the results.
# Arguments
- `schema_definition`: The definition of the schema for which schema details are required.
- `schema_id`: This is a wrapper structure to contain schema identity fields. The structure
contains: SchemaIdSchemaArn: The Amazon Resource Name (ARN) of the schema. One of
SchemaArn or SchemaName has to be provided. SchemaIdSchemaName: The name of the schema.
One of SchemaArn or SchemaName has to be provided.
"""
function get_schema_by_definition(
SchemaDefinition, SchemaId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetSchemaByDefinition",
Dict{String,Any}("SchemaDefinition" => SchemaDefinition, "SchemaId" => SchemaId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_schema_by_definition(
SchemaDefinition,
SchemaId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetSchemaByDefinition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SchemaDefinition" => SchemaDefinition, "SchemaId" => SchemaId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_schema_version()
get_schema_version(params::Dict{String,<:Any})
Get the specified schema by its unique ID assigned when a version of the schema is created
or registered. Schema versions in Deleted status will not be included in the results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SchemaId"`: This is a wrapper structure to contain schema identity fields. The
structure contains: SchemaIdSchemaArn: The Amazon Resource Name (ARN) of the schema.
Either SchemaArn or SchemaName and RegistryName has to be provided. SchemaIdSchemaName:
The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
- `"SchemaVersionId"`: The SchemaVersionId of the schema version. This field is required
for fetching by schema ID. Either this or the SchemaId wrapper has to be provided.
- `"SchemaVersionNumber"`: The version number of the schema.
"""
function get_schema_version(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetSchemaVersion"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_schema_version(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetSchemaVersion", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_schema_versions_diff(first_schema_version_number, schema_diff_type, schema_id, second_schema_version_number)
get_schema_versions_diff(first_schema_version_number, schema_diff_type, schema_id, second_schema_version_number, params::Dict{String,<:Any})
Fetches the schema version difference in the specified difference type between two stored
schema versions in the Schema Registry. This API allows you to compare two schema versions
between two schema definitions under the same schema.
# Arguments
- `first_schema_version_number`: The first of the two schema versions to be compared.
- `schema_diff_type`: Refers to SYNTAX_DIFF, which is the currently supported diff type.
- `schema_id`: This is a wrapper structure to contain schema identity fields. The structure
contains: SchemaIdSchemaArn: The Amazon Resource Name (ARN) of the schema. One of
SchemaArn or SchemaName has to be provided. SchemaIdSchemaName: The name of the schema.
One of SchemaArn or SchemaName has to be provided.
- `second_schema_version_number`: The second of the two schema versions to be compared.
"""
function get_schema_versions_diff(
FirstSchemaVersionNumber,
SchemaDiffType,
SchemaId,
SecondSchemaVersionNumber;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetSchemaVersionsDiff",
Dict{String,Any}(
"FirstSchemaVersionNumber" => FirstSchemaVersionNumber,
"SchemaDiffType" => SchemaDiffType,
"SchemaId" => SchemaId,
"SecondSchemaVersionNumber" => SecondSchemaVersionNumber,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_schema_versions_diff(
FirstSchemaVersionNumber,
SchemaDiffType,
SchemaId,
SecondSchemaVersionNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetSchemaVersionsDiff",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirstSchemaVersionNumber" => FirstSchemaVersionNumber,
"SchemaDiffType" => SchemaDiffType,
"SchemaId" => SchemaId,
"SecondSchemaVersionNumber" => SecondSchemaVersionNumber,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_security_configuration(name)
get_security_configuration(name, params::Dict{String,<:Any})
Retrieves a specified security configuration.
# Arguments
- `name`: The name of the security configuration to retrieve.
"""
function get_security_configuration(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetSecurityConfiguration",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_security_configuration(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetSecurityConfiguration",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_security_configurations()
get_security_configurations(params::Dict{String,<:Any})
Retrieves a list of all security configurations.
# 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 a continuation call.
"""
function get_security_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetSecurityConfigurations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_security_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetSecurityConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_session(id)
get_session(id, params::Dict{String,<:Any})
Retrieves the session.
# Arguments
- `id`: The ID of the session.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RequestOrigin"`: The origin of the request.
"""
function get_session(Id; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetSession",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_session(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetSession",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_statement(id, session_id)
get_statement(id, session_id, params::Dict{String,<:Any})
Retrieves the statement.
# Arguments
- `id`: The Id of the statement.
- `session_id`: The Session ID of the statement.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RequestOrigin"`: The origin of the request.
"""
function get_statement(Id, SessionId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetStatement",
Dict{String,Any}("Id" => Id, "SessionId" => SessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_statement(
Id,
SessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetStatement",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Id" => Id, "SessionId" => SessionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_table(database_name, name)
get_table(database_name, name, params::Dict{String,<:Any})
Retrieves the Table definition in a Data Catalog for a specified table.
# Arguments
- `database_name`: The name of the database in the catalog in which the table resides. For
Hive compatibility, this name is entirely lowercase.
- `name`: The name of the table for which to retrieve the definition. For Hive
compatibility, this name is entirely lowercase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the table resides. If none is provided,
the Amazon Web Services account ID is used by default.
- `"QueryAsOfTime"`: The time as of when to read the table contents. If not set, the most
recent transaction commit time will be used. Cannot be specified along with TransactionId.
- `"TransactionId"`: The transaction ID at which to read the table contents.
"""
function get_table(DatabaseName, Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetTable",
Dict{String,Any}("DatabaseName" => DatabaseName, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_table(
DatabaseName,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_table_optimizer(catalog_id, database_name, table_name, type)
get_table_optimizer(catalog_id, database_name, table_name, type, params::Dict{String,<:Any})
Returns the configuration of all optimizers associated with a specified table.
# Arguments
- `catalog_id`: The Catalog ID of the table.
- `database_name`: The name of the database in the catalog in which the table resides.
- `table_name`: The name of the table.
- `type`: The type of table optimizer.
"""
function get_table_optimizer(
CatalogId,
DatabaseName,
TableName,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetTableOptimizer",
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_table_optimizer(
CatalogId,
DatabaseName,
TableName,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetTableOptimizer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_table_version(database_name, table_name)
get_table_version(database_name, table_name, params::Dict{String,<:Any})
Retrieves a specified version of a table.
# Arguments
- `database_name`: The database in the catalog in which the table resides. For Hive
compatibility, this name is entirely lowercase.
- `table_name`: The name of the table. For Hive compatibility, this name is entirely
lowercase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the tables reside. If none is provided,
the Amazon Web Services account ID is used by default.
- `"VersionId"`: The ID value of the table version to be retrieved. A VersionID is a string
representation of an integer. Each version is incremented by 1.
"""
function get_table_version(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetTableVersion",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_table_version(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetTableVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_table_versions(database_name, table_name)
get_table_versions(database_name, table_name, params::Dict{String,<:Any})
Retrieves a list of strings that identify available versions of a specified table.
# Arguments
- `database_name`: The database in the catalog in which the table resides. For Hive
compatibility, this name is entirely lowercase.
- `table_name`: The name of the table. For Hive compatibility, this name is entirely
lowercase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the tables reside. If none is provided,
the Amazon Web Services account ID is used by default.
- `"MaxResults"`: The maximum number of table versions to return in one response.
- `"NextToken"`: A continuation token, if this is not the first call.
"""
function get_table_versions(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetTableVersions",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_table_versions(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetTableVersions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_tables(database_name)
get_tables(database_name, params::Dict{String,<:Any})
Retrieves the definitions of some or all of the tables in a given Database.
# Arguments
- `database_name`: The database in the catalog whose tables to list. For Hive
compatibility, this name is entirely lowercase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the tables reside. If none is provided,
the Amazon Web Services account ID is used by default.
- `"Expression"`: A regular expression pattern. If present, only those tables whose names
match the pattern are returned.
- `"MaxResults"`: The maximum number of tables to return in a single response.
- `"NextToken"`: A continuation token, included if this is a continuation call.
- `"QueryAsOfTime"`: The time as of when to read the table contents. If not set, the most
recent transaction commit time will be used. Cannot be specified along with TransactionId.
- `"TransactionId"`: The transaction ID at which to read the table contents.
"""
function get_tables(DatabaseName; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetTables",
Dict{String,Any}("DatabaseName" => DatabaseName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_tables(
DatabaseName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetTables",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatabaseName" => DatabaseName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_tags(resource_arn)
get_tags(resource_arn, params::Dict{String,<:Any})
Retrieves a list of tags associated with a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which to retrieve tags.
"""
function get_tags(ResourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetTags",
Dict{String,Any}("ResourceArn" => ResourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_tags(
ResourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceArn" => ResourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_trigger(name)
get_trigger(name, params::Dict{String,<:Any})
Retrieves the definition of a trigger.
# Arguments
- `name`: The name of the trigger to retrieve.
"""
function get_trigger(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetTrigger",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_trigger(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetTrigger",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_triggers()
get_triggers(params::Dict{String,<:Any})
Gets all the triggers associated with a job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DependentJobName"`: The name of the job to retrieve triggers for. The trigger that can
start this job is returned, and if there is no such trigger, all triggers are returned.
- `"MaxResults"`: The maximum size of the response.
- `"NextToken"`: A continuation token, if this is a continuation call.
"""
function get_triggers(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("GetTriggers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_triggers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetTriggers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_unfiltered_partition_metadata(catalog_id, database_name, partition_values, supported_permission_types, table_name)
get_unfiltered_partition_metadata(catalog_id, database_name, partition_values, supported_permission_types, table_name, params::Dict{String,<:Any})
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata. For
IAM authorization, the public IAM action associated with this API is glue:GetPartition.
# Arguments
- `catalog_id`: The catalog ID where the partition resides.
- `database_name`: (Required) Specifies the name of a database that contains the partition.
- `partition_values`: (Required) A list of partition key values.
- `supported_permission_types`: (Required) A list of supported permission types.
- `table_name`: (Required) Specifies the name of a table that contains the partition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuditContext"`: A structure containing Lake Formation audit context information.
- `"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.
- `"Region"`: Specified only if the base tables belong to a different Amazon Web Services
Region.
"""
function get_unfiltered_partition_metadata(
CatalogId,
DatabaseName,
PartitionValues,
SupportedPermissionTypes,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetUnfilteredPartitionMetadata",
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"SupportedPermissionTypes" => SupportedPermissionTypes,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_unfiltered_partition_metadata(
CatalogId,
DatabaseName,
PartitionValues,
SupportedPermissionTypes,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetUnfilteredPartitionMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"SupportedPermissionTypes" => SupportedPermissionTypes,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_unfiltered_partitions_metadata(catalog_id, database_name, supported_permission_types, table_name)
get_unfiltered_partitions_metadata(catalog_id, database_name, supported_permission_types, table_name, params::Dict{String,<:Any})
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata. For
IAM authorization, the public IAM action associated with this API is glue:GetPartitions.
# Arguments
- `catalog_id`: The ID of the Data Catalog where the partitions in question reside. If none
is provided, the AWS account ID is used by default.
- `database_name`: The name of the catalog database where the partitions reside.
- `supported_permission_types`: A list of supported permission types.
- `table_name`: The name of the table that contains the partition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuditContext"`: A structure containing Lake Formation audit context information.
- `"Expression"`: An expression that filters the partitions to be returned. The expression
uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser
parses the expression. Operators: The following are the operators that you can use in the
Expression API call: = Checks whether the values of the two operands are equal; if yes,
then the condition becomes true. Example: Assume 'variable a' holds 10 and 'variable b'
holds 20. (a = b) is not true. < > Checks whether the values of two operands are
equal; if the values are not equal, then the condition becomes true. Example: (a < >
b) is true. > Checks whether the value of the left operand is greater than the value
of the right operand; if yes, then the condition becomes true. Example: (a > b) is not
true. < Checks whether the value of the left operand is less than the value of the
right operand; if yes, then the condition becomes true. Example: (a < b) is true. >=
Checks whether the value of the left operand is greater than or equal to the value of the
right operand; if yes, then the condition becomes true. Example: (a >= b) is not true.
<= Checks whether the value of the left operand is less than or equal to the value of
the right operand; if yes, then the condition becomes true. Example: (a <= b) is true.
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL Logical operators. Supported Partition Key
Types: The following are the supported partition keys. string date timestamp
int bigint long tinyint smallint decimal If an type is encountered
that is not valid, an exception is thrown.
- `"MaxResults"`: The maximum number of partitions to return in a single response.
- `"NextToken"`: A continuation token, if this is not the first call to retrieve these
partitions.
- `"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.
- `"Region"`: Specified only if the base tables belong to a different Amazon Web Services
Region.
- `"Segment"`: The segment of the table's partitions to scan in this request.
"""
function get_unfiltered_partitions_metadata(
CatalogId,
DatabaseName,
SupportedPermissionTypes,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetUnfilteredPartitionsMetadata",
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"SupportedPermissionTypes" => SupportedPermissionTypes,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_unfiltered_partitions_metadata(
CatalogId,
DatabaseName,
SupportedPermissionTypes,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetUnfilteredPartitionsMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"SupportedPermissionTypes" => SupportedPermissionTypes,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_unfiltered_table_metadata(catalog_id, database_name, name, supported_permission_types)
get_unfiltered_table_metadata(catalog_id, database_name, name, supported_permission_types, params::Dict{String,<:Any})
Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data
Catalog. For IAM authorization, the public IAM action associated with this API is
glue:GetTable.
# Arguments
- `catalog_id`: The catalog ID where the table resides.
- `database_name`: (Required) Specifies the name of a database that contains the table.
- `name`: (Required) Specifies the name of a table for which you are requesting metadata.
- `supported_permission_types`: Indicates the level of filtering a third-party analytical
engine is capable of enforcing when calling the GetUnfilteredTableMetadata API operation.
Accepted values are: COLUMN_PERMISSION - Column permissions ensure that users can access
only specific columns in the table. If there are particular columns contain sensitive data,
data lake administrators can define column filters that exclude access to specific columns.
CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering (include or
exclude columns) and row filter expressions to restrict access to individual elements in
the table. NESTED_PERMISSION - Nested permissions combines cell-level filtering and
nested column filtering to restrict access to columns and/or nested columns in specific
rows based on row filter expressions. NESTED_CELL_PERMISSION - Nested cell permissions
combines nested permission with nested cell-level filtering. This allows different subsets
of nested columns to be restricted based on an array of row filter expressions. Note:
Each of these permission types follows a hierarchical order where each subsequent
permission type includes all permission of the previous type. Important: If you provide a
supported permission type that doesn't match the user's level of permissions on the table,
then Lake Formation raises an exception. For example, if the third-party engine calling the
GetUnfilteredTableMetadata operation can enforce only column-level filtering, and the user
has nested cell filtering applied on the table, Lake Formation throws an exception, and
will not return unfiltered table metadata and data access credentials.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuditContext"`: A structure containing Lake Formation audit context information.
- `"ParentResourceArn"`: The resource ARN of the view.
- `"Permissions"`: The Lake Formation data permissions of the caller on the table. Used to
authorize the call when no view context is found.
- `"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.
- `"Region"`: Specified only if the base tables belong to a different Amazon Web Services
Region.
- `"RootResourceArn"`: The resource ARN of the root view in a chain of nested views.
- `"SupportedDialect"`: A structure specifying the dialect and dialect version used by the
query engine.
"""
function get_unfiltered_table_metadata(
CatalogId,
DatabaseName,
Name,
SupportedPermissionTypes;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetUnfilteredTableMetadata",
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"Name" => Name,
"SupportedPermissionTypes" => SupportedPermissionTypes,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_unfiltered_table_metadata(
CatalogId,
DatabaseName,
Name,
SupportedPermissionTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetUnfilteredTableMetadata",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"Name" => Name,
"SupportedPermissionTypes" => SupportedPermissionTypes,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_usage_profile(name)
get_usage_profile(name, params::Dict{String,<:Any})
Retrieves information about the specified Glue usage profile.
# Arguments
- `name`: The name of the usage profile to retrieve.
"""
function get_usage_profile(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetUsageProfile",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_usage_profile(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetUsageProfile",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user_defined_function(database_name, function_name)
get_user_defined_function(database_name, function_name, params::Dict{String,<:Any})
Retrieves a specified function definition from the Data Catalog.
# Arguments
- `database_name`: The name of the catalog database where the function is located.
- `function_name`: The name of the function.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the function to be retrieved is located.
If none is provided, the Amazon Web Services account ID is used by default.
"""
function get_user_defined_function(
DatabaseName, FunctionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetUserDefinedFunction",
Dict{String,Any}("DatabaseName" => DatabaseName, "FunctionName" => FunctionName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_user_defined_function(
DatabaseName,
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetUserDefinedFunction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName, "FunctionName" => FunctionName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user_defined_functions(pattern)
get_user_defined_functions(pattern, params::Dict{String,<:Any})
Retrieves multiple function definitions from the Data Catalog.
# Arguments
- `pattern`: An optional function-name pattern string that filters the function definitions
returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the functions to be retrieved are
located. If none is provided, the Amazon Web Services account ID is used by default.
- `"DatabaseName"`: The name of the catalog database where the functions are located. If
none is provided, functions from all the databases across the catalog will be returned.
- `"MaxResults"`: The maximum number of functions to return in one response.
- `"NextToken"`: A continuation token, if this is a continuation call.
"""
function get_user_defined_functions(
Pattern; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetUserDefinedFunctions",
Dict{String,Any}("Pattern" => Pattern);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_user_defined_functions(
Pattern, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetUserDefinedFunctions",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Pattern" => Pattern), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow(name)
get_workflow(name, params::Dict{String,<:Any})
Retrieves resource metadata for a workflow.
# Arguments
- `name`: The name of the workflow to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeGraph"`: Specifies whether to include a graph when returning the workflow
resource metadata.
"""
function get_workflow(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetWorkflow",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetWorkflow",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow_run(name, run_id)
get_workflow_run(name, run_id, params::Dict{String,<:Any})
Retrieves the metadata for a given workflow run. Job run history is accessible for 90 days
for your workflow and job run.
# Arguments
- `name`: Name of the workflow being run.
- `run_id`: The ID of the workflow run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeGraph"`: Specifies whether to include the workflow graph in response or not.
"""
function get_workflow_run(Name, RunId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetWorkflowRun",
Dict{String,Any}("Name" => Name, "RunId" => RunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow_run(
Name,
RunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetWorkflowRun",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Name" => Name, "RunId" => RunId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow_run_properties(name, run_id)
get_workflow_run_properties(name, run_id, params::Dict{String,<:Any})
Retrieves the workflow run properties which were set during the run.
# Arguments
- `name`: Name of the workflow which was run.
- `run_id`: The ID of the workflow run whose run properties should be returned.
"""
function get_workflow_run_properties(
Name, RunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetWorkflowRunProperties",
Dict{String,Any}("Name" => Name, "RunId" => RunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow_run_properties(
Name,
RunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"GetWorkflowRunProperties",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Name" => Name, "RunId" => RunId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow_runs(name)
get_workflow_runs(name, params::Dict{String,<:Any})
Retrieves metadata for all runs of a given workflow.
# Arguments
- `name`: Name of the workflow whose metadata of runs should be returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeGraph"`: Specifies whether to include the workflow graph in response or not.
- `"MaxResults"`: The maximum number of workflow runs to be included in the response.
- `"NextToken"`: The maximum size of the response.
"""
function get_workflow_runs(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"GetWorkflowRuns",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow_runs(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"GetWorkflowRuns",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_catalog_to_glue()
import_catalog_to_glue(params::Dict{String,<:Any})
Imports an existing Amazon Athena Data Catalog to Glue.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the catalog to import. Currently, this should be the Amazon Web
Services account ID.
"""
function import_catalog_to_glue(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"ImportCatalogToGlue"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function import_catalog_to_glue(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ImportCatalogToGlue",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_blueprints()
list_blueprints(params::Dict{String,<:Any})
Lists all the blueprint names in an account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum size of a list to return.
- `"NextToken"`: A continuation token, if this is a continuation request.
- `"Tags"`: Filters the list by an Amazon Web Services resource tag.
"""
function list_blueprints(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListBlueprints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_blueprints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListBlueprints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_column_statistics_task_runs()
list_column_statistics_task_runs(params::Dict{String,<:Any})
List all task runs for a particular account.
# 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.
"""
function list_column_statistics_task_runs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListColumnStatisticsTaskRuns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_column_statistics_task_runs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListColumnStatisticsTaskRuns",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_crawlers()
list_crawlers(params::Dict{String,<:Any})
Retrieves the names of all crawler resources in this Amazon Web Services account, or the
resources with the specified tag. This operation allows you to see which resources are
available in your account, and their names. This operation takes the optional Tags field,
which you can use as a filter on the response so that tagged resources can be retrieved as
a group. If you choose to use tags filtering, only resources with the tag are retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum size of a list to return.
- `"NextToken"`: A continuation token, if this is a continuation request.
- `"Tags"`: Specifies to return only these tagged resources.
"""
function list_crawlers(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListCrawlers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_crawlers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListCrawlers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_crawls(crawler_name)
list_crawls(crawler_name, params::Dict{String,<:Any})
Returns all the crawls of a specified crawler. Returns only the crawls that have occurred
since the launch date of the crawler history feature, and only retains up to 12 months of
crawls. Older crawls will not be returned. You may use this API to: Retrive all the
crawls of a specified crawler. Retrieve all the crawls of a specified crawler within a
limited count. Retrieve all the crawls of a specified crawler in a specific time range.
Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU
hour value.
# Arguments
- `crawler_name`: The name of the crawler whose runs you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: Filters the crawls by the criteria you specify in a list of CrawlsFilter
objects.
- `"MaxResults"`: The maximum number of results to return. The default is 20, and maximum
is 100.
- `"NextToken"`: A continuation token, if this is a continuation call.
"""
function list_crawls(CrawlerName; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"ListCrawls",
Dict{String,Any}("CrawlerName" => CrawlerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_crawls(
CrawlerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"ListCrawls",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CrawlerName" => CrawlerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_entity_types()
list_custom_entity_types(params::Dict{String,<:Any})
Lists all the custom patterns that have been created.
# 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 paginated token to offset the results.
- `"Tags"`: A list of key-value pair tags.
"""
function list_custom_entity_types(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"ListCustomEntityTypes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_custom_entity_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListCustomEntityTypes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_quality_results()
list_data_quality_results(params::Dict{String,<:Any})
Returns all data quality execution results for your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filter criteria.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A paginated token to offset the results.
"""
function list_data_quality_results(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"ListDataQualityResults"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_data_quality_results(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListDataQualityResults",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_quality_rule_recommendation_runs()
list_data_quality_rule_recommendation_runs(params::Dict{String,<:Any})
Lists the recommendation runs meeting the filter criteria.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filter criteria.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A paginated token to offset the results.
"""
function list_data_quality_rule_recommendation_runs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListDataQualityRuleRecommendationRuns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_quality_rule_recommendation_runs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListDataQualityRuleRecommendationRuns",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_quality_ruleset_evaluation_runs()
list_data_quality_ruleset_evaluation_runs(params::Dict{String,<:Any})
Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data
source.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filter criteria.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A paginated token to offset the results.
"""
function list_data_quality_ruleset_evaluation_runs(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListDataQualityRulesetEvaluationRuns";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_data_quality_ruleset_evaluation_runs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListDataQualityRulesetEvaluationRuns",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_data_quality_rulesets()
list_data_quality_rulesets(params::Dict{String,<:Any})
Returns a paginated list of rulesets for the specified list of Glue tables.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: The filter criteria.
- `"MaxResults"`: The maximum number of results to return.
- `"NextToken"`: A paginated token to offset the results.
- `"Tags"`: A list of key-value pair tags.
"""
function list_data_quality_rulesets(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"ListDataQualityRulesets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_data_quality_rulesets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListDataQualityRulesets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dev_endpoints()
list_dev_endpoints(params::Dict{String,<:Any})
Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or
the resources with the specified tag. This operation allows you to see which resources are
available in your account, and their names. This operation takes the optional Tags field,
which you can use as a filter on the response so that tagged resources can be retrieved as
a group. If you choose to use tags filtering, only resources with the tag are retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum size of a list to return.
- `"NextToken"`: A continuation token, if this is a continuation request.
- `"Tags"`: Specifies to return only these tagged resources.
"""
function list_dev_endpoints(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListDevEndpoints"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_dev_endpoints(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListDevEndpoints", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_jobs()
list_jobs(params::Dict{String,<:Any})
Retrieves the names of all job resources in this Amazon Web Services account, or the
resources with the specified tag. This operation allows you to see which resources are
available in your account, and their names. This operation takes the optional Tags field,
which you can use as a filter on the response so that tagged resources can be retrieved as
a group. If you choose to use tags filtering, only resources with the tag are retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum size of a list to return.
- `"NextToken"`: A continuation token, if this is a continuation request.
- `"Tags"`: Specifies to return only these tagged resources.
"""
function list_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue("ListJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_mltransforms()
list_mltransforms(params::Dict{String,<:Any})
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this
Amazon Web Services account, or the resources with the specified tag. This operation takes
the optional Tags field, which you can use as a filter of the responses so that tagged
resources can be retrieved as a group. If you choose to use tag filtering, only resources
with the tags are retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: A TransformFilterCriteria used to filter the machine learning transforms.
- `"MaxResults"`: The maximum size of a list to return.
- `"NextToken"`: A continuation token, if this is a continuation request.
- `"Sort"`: A TransformSortCriteria used to sort the machine learning transforms.
- `"Tags"`: Specifies to return only these tagged resources.
"""
function list_mltransforms(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListMLTransforms"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_mltransforms(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListMLTransforms", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_registries()
list_registries(params::Dict{String,<:Any})
Returns a list of registries that you have created, with minimal registry information.
Registries in the Deleting status will not be included in the results. Empty results will
be returned if there are no registries available.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results required per page. If the value is not
supplied, this will be defaulted to 25 per page.
- `"NextToken"`: A continuation token, if this is a continuation call.
"""
function list_registries(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListRegistries"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_registries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListRegistries", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_schema_versions(schema_id)
list_schema_versions(schema_id, params::Dict{String,<:Any})
Returns a list of schema versions that you have created, with minimal information. Schema
versions in Deleted status will not be included in the results. Empty results will be
returned if there are no schema versions available.
# Arguments
- `schema_id`: This is a wrapper structure to contain schema identity fields. The structure
contains: SchemaIdSchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn or SchemaName and RegistryName has to be provided. SchemaIdSchemaName: The name
of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results required per page. If the value is not
supplied, this will be defaulted to 25 per page.
- `"NextToken"`: A continuation token, if this is a continuation call.
"""
function list_schema_versions(SchemaId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"ListSchemaVersions",
Dict{String,Any}("SchemaId" => SchemaId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_schema_versions(
SchemaId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"ListSchemaVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SchemaId" => SchemaId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_schemas()
list_schemas(params::Dict{String,<:Any})
Returns a list of schemas with minimal details. Schemas in Deleting status will not be
included in the results. Empty results will be returned if there are no schemas available.
When the RegistryId is not provided, all the schemas across registries will be part of the
API response.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results required per page. If the value is not
supplied, this will be defaulted to 25 per page.
- `"NextToken"`: A continuation token, if this is a continuation call.
- `"RegistryId"`: A wrapper structure that may contain the registry name and Amazon
Resource Name (ARN).
"""
function list_schemas(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListSchemas"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_schemas(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListSchemas", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_sessions()
list_sessions(params::Dict{String,<:Any})
Retrieve a list of sessions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results.
- `"NextToken"`: The token for the next set of results, or null if there are no more
result.
- `"RequestOrigin"`: The origin of the request.
- `"Tags"`: Tags belonging to the session.
"""
function list_sessions(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListSessions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_sessions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListSessions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_statements(session_id)
list_statements(session_id, params::Dict{String,<:Any})
Lists statements for the session.
# Arguments
- `session_id`: The Session ID of the statements.
# 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.
- `"RequestOrigin"`: The origin of the request to list statements.
"""
function list_statements(SessionId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"ListStatements",
Dict{String,Any}("SessionId" => SessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_statements(
SessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"ListStatements",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SessionId" => SessionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_table_optimizer_runs(catalog_id, database_name, table_name, type)
list_table_optimizer_runs(catalog_id, database_name, table_name, type, params::Dict{String,<:Any})
Lists the history of previous optimizer runs for a specific table.
# Arguments
- `catalog_id`: The Catalog ID of the table.
- `database_name`: The name of the database in the catalog in which the table resides.
- `table_name`: The name of the table.
- `type`: The type of table optimizer. Currently, the only valid value is compaction.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of optimizer runs to return on each call.
- `"NextToken"`: A continuation token, if this is a continuation call.
"""
function list_table_optimizer_runs(
CatalogId,
DatabaseName,
TableName,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"ListTableOptimizerRuns",
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_table_optimizer_runs(
CatalogId,
DatabaseName,
TableName,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"ListTableOptimizerRuns",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_triggers()
list_triggers(params::Dict{String,<:Any})
Retrieves the names of all trigger resources in this Amazon Web Services account, or the
resources with the specified tag. This operation allows you to see which resources are
available in your account, and their names. This operation takes the optional Tags field,
which you can use as a filter on the response so that tagged resources can be retrieved as
a group. If you choose to use tags filtering, only resources with the tag are retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DependentJobName"`: The name of the job for which to retrieve triggers. The trigger
that can start this job is returned. If there is no such trigger, all triggers are returned.
- `"MaxResults"`: The maximum size of a list to return.
- `"NextToken"`: A continuation token, if this is a continuation request.
- `"Tags"`: Specifies to return only these tagged resources.
"""
function list_triggers(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListTriggers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_triggers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListTriggers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_usage_profiles()
list_usage_profiles(params::Dict{String,<:Any})
List all the Glue usage profiles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of usage profiles to return in a single response.
- `"NextToken"`: A continuation token, included if this is a continuation call.
"""
function list_usage_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListUsageProfiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_usage_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListUsageProfiles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_workflows()
list_workflows(params::Dict{String,<:Any})
Lists names of workflows created in the account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum size of a list to return.
- `"NextToken"`: A continuation token, if this is a continuation request.
"""
function list_workflows(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("ListWorkflows"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_workflows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ListWorkflows", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
put_data_catalog_encryption_settings(data_catalog_encryption_settings)
put_data_catalog_encryption_settings(data_catalog_encryption_settings, params::Dict{String,<:Any})
Sets the security configuration for a specified catalog. After the configuration has been
set, the specified encryption is applied to every catalog write thereafter.
# Arguments
- `data_catalog_encryption_settings`: The security configuration to set.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog to set the security configuration for. If none
is provided, the Amazon Web Services account ID is used by default.
"""
function put_data_catalog_encryption_settings(
DataCatalogEncryptionSettings; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"PutDataCatalogEncryptionSettings",
Dict{String,Any}("DataCatalogEncryptionSettings" => DataCatalogEncryptionSettings);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_data_catalog_encryption_settings(
DataCatalogEncryptionSettings,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"PutDataCatalogEncryptionSettings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataCatalogEncryptionSettings" => DataCatalogEncryptionSettings
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_policy(policy_in_json)
put_resource_policy(policy_in_json, params::Dict{String,<:Any})
Sets the Data Catalog resource policy for access control.
# Arguments
- `policy_in_json`: Contains the policy document to set, in JSON format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EnableHybrid"`: If 'TRUE', indicates that you are using both methods to grant
cross-account access to Data Catalog resources: By directly updating the resource policy
with PutResourePolicy By using the Grant permissions command on the Amazon Web Services
Management Console. Must be set to 'TRUE' if you have already used the Management Console
to grant cross-account access, otherwise the call fails. Default is 'FALSE'.
- `"PolicyExistsCondition"`: A value of MUST_EXIST is used to update a policy. A value of
NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the
call does not depend on the existence of a policy.
- `"PolicyHashCondition"`: The hash value returned when the previous policy was set using
PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not
use this parameter if no previous policy has been set.
- `"ResourceArn"`: Do not use. For internal use only.
"""
function put_resource_policy(
PolicyInJson; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"PutResourcePolicy",
Dict{String,Any}("PolicyInJson" => PolicyInJson);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_policy(
PolicyInJson,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"PutResourcePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyInJson" => PolicyInJson), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_schema_version_metadata(metadata_key_value)
put_schema_version_metadata(metadata_key_value, params::Dict{String,<:Any})
Puts the metadata key value pair for a specified schema version ID. A maximum of 10 key
value pairs will be allowed per schema version. They can be added over one or more calls.
# Arguments
- `metadata_key_value`: The metadata key's corresponding value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SchemaId"`: The unique ID for the schema.
- `"SchemaVersionId"`: The unique version ID of the schema version.
- `"SchemaVersionNumber"`: The version number of the schema.
"""
function put_schema_version_metadata(
MetadataKeyValue; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"PutSchemaVersionMetadata",
Dict{String,Any}("MetadataKeyValue" => MetadataKeyValue);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_schema_version_metadata(
MetadataKeyValue,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"PutSchemaVersionMetadata",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("MetadataKeyValue" => MetadataKeyValue), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_workflow_run_properties(name, run_id, run_properties)
put_workflow_run_properties(name, run_id, run_properties, params::Dict{String,<:Any})
Puts the specified workflow run properties for the given workflow run. If a property
already exists for the specified run, then it overrides the value otherwise adds the
property to existing properties.
# Arguments
- `name`: Name of the workflow which was run.
- `run_id`: The ID of the workflow run for which the run properties should be updated.
- `run_properties`: The properties to put for the specified run.
"""
function put_workflow_run_properties(
Name, RunId, RunProperties; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"PutWorkflowRunProperties",
Dict{String,Any}(
"Name" => Name, "RunId" => RunId, "RunProperties" => RunProperties
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_workflow_run_properties(
Name,
RunId,
RunProperties,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"PutWorkflowRunProperties",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "RunId" => RunId, "RunProperties" => RunProperties
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
query_schema_version_metadata()
query_schema_version_metadata(params::Dict{String,<:Any})
Queries for the schema version metadata information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: Maximum number of results required per page. If the value is not
supplied, this will be defaulted to 25 per page.
- `"MetadataList"`: Search key-value pairs for metadata, if they are not provided all the
metadata information will be fetched.
- `"NextToken"`: A continuation token, if this is a continuation call.
- `"SchemaId"`: A wrapper structure that may contain the schema name and Amazon Resource
Name (ARN).
- `"SchemaVersionId"`: The unique version ID of the schema version.
- `"SchemaVersionNumber"`: The version number of the schema.
"""
function query_schema_version_metadata(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"QuerySchemaVersionMetadata"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function query_schema_version_metadata(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"QuerySchemaVersionMetadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_schema_version(schema_definition, schema_id)
register_schema_version(schema_definition, schema_id, params::Dict{String,<:Any})
Adds a new version to the existing schema. Returns an error if new version of schema does
not meet the compatibility requirements of the schema set. This API will not create a new
schema set and will return a 404 error if the schema set is not already present in the
Schema Registry. If this is the first schema definition to be registered in the Schema
Registry, this API will store the schema version and return immediately. Otherwise, this
call has the potential to run longer than other operations due to compatibility modes. You
can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes. If
the same schema definition is already stored in Schema Registry as a version, the schema ID
of the existing schema is returned to the caller.
# Arguments
- `schema_definition`: The schema definition using the DataFormat setting for the
SchemaName.
- `schema_id`: This is a wrapper structure to contain schema identity fields. The structure
contains: SchemaIdSchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn or SchemaName and RegistryName has to be provided. SchemaIdSchemaName: The name
of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.
"""
function register_schema_version(
SchemaDefinition, SchemaId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"RegisterSchemaVersion",
Dict{String,Any}("SchemaDefinition" => SchemaDefinition, "SchemaId" => SchemaId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_schema_version(
SchemaDefinition,
SchemaId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"RegisterSchemaVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SchemaDefinition" => SchemaDefinition, "SchemaId" => SchemaId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_schema_version_metadata(metadata_key_value)
remove_schema_version_metadata(metadata_key_value, params::Dict{String,<:Any})
Removes a key value pair from the schema version metadata for the specified schema version
ID.
# Arguments
- `metadata_key_value`: The value of the metadata key.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SchemaId"`: A wrapper structure that may contain the schema name and Amazon Resource
Name (ARN).
- `"SchemaVersionId"`: The unique version ID of the schema version.
- `"SchemaVersionNumber"`: The version number of the schema.
"""
function remove_schema_version_metadata(
MetadataKeyValue; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"RemoveSchemaVersionMetadata",
Dict{String,Any}("MetadataKeyValue" => MetadataKeyValue);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_schema_version_metadata(
MetadataKeyValue,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"RemoveSchemaVersionMetadata",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("MetadataKeyValue" => MetadataKeyValue), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_job_bookmark(job_name)
reset_job_bookmark(job_name, params::Dict{String,<:Any})
Resets a bookmark entry. For more information about enabling and using job bookmarks, see:
Tracking processed data using job bookmarks Job parameters used by Glue Job
structure
# Arguments
- `job_name`: The name of the job in question.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RunId"`: The unique run identifier associated with this job run.
"""
function reset_job_bookmark(JobName; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"ResetJobBookmark",
Dict{String,Any}("JobName" => JobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_job_bookmark(
JobName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ResetJobBookmark",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobName" => JobName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resume_workflow_run(name, node_ids, run_id)
resume_workflow_run(name, node_ids, run_id, params::Dict{String,<:Any})
Restarts selected nodes of a previous partially completed workflow run and resumes the
workflow run. The selected nodes and all nodes that are downstream from the selected nodes
are run.
# Arguments
- `name`: The name of the workflow to resume.
- `node_ids`: A list of the node IDs for the nodes you want to restart. The nodes that are
to be restarted must have a run attempt in the original run.
- `run_id`: The ID of the workflow run to resume.
"""
function resume_workflow_run(
Name, NodeIds, RunId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"ResumeWorkflowRun",
Dict{String,Any}("Name" => Name, "NodeIds" => NodeIds, "RunId" => RunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resume_workflow_run(
Name,
NodeIds,
RunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"ResumeWorkflowRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "NodeIds" => NodeIds, "RunId" => RunId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
run_statement(code, session_id)
run_statement(code, session_id, params::Dict{String,<:Any})
Executes the statement.
# Arguments
- `code`: The statement code to be run.
- `session_id`: The Session Id of the statement to be run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RequestOrigin"`: The origin of the request.
"""
function run_statement(Code, SessionId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"RunStatement",
Dict{String,Any}("Code" => Code, "SessionId" => SessionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function run_statement(
Code,
SessionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"RunStatement",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Code" => Code, "SessionId" => SessionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_tables()
search_tables(params::Dict{String,<:Any})
Searches a set of tables based on properties in the table metadata as well as on the parent
database. You can search against text or filter conditions. You can only get tables that
you have access to based on the security policies defined in Lake Formation. You need at
least a read-only access to the table for it to be returned. If you do not have access to
all the columns in the table, these columns will not be searched against when returning the
list of tables back to you. If you have access to the columns but not the data in the
columns, those columns and the associated metadata for those columns will be included in
the search.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: A unique identifier, consisting of account_id .
- `"Filters"`: A list of key-value pairs, and a comparator used to filter the search
results. Returns all entities matching the predicate. The Comparator member of the
PropertyPredicate struct is used only for time fields, and can be omitted for other field
types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm
is used. The Key field (for example, the value of the Name field) is split on certain
punctuation characters, for example, -, :, #, etc. into tokens. Then each token is
exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name
and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not
returned.
- `"MaxResults"`: The maximum number of tables to return in a single response.
- `"NextToken"`: A continuation token, included if this is a continuation call.
- `"ResourceShareType"`: Allows you to specify that you want to search the tables shared
with your account. The allowable values are FOREIGN or ALL. If set to FOREIGN, will
search the tables shared with your account. If set to ALL, will search the tables shared
with your account, as well as the tables in yor local account.
- `"SearchText"`: A string used for a text search. Specifying a value in quotes filters
based on an exact match to the value.
- `"SortCriteria"`: A list of criteria for sorting the results by a field name, in an
ascending or descending order.
"""
function search_tables(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("SearchTables"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function search_tables(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"SearchTables", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
start_blueprint_run(blueprint_name, role_arn)
start_blueprint_run(blueprint_name, role_arn, params::Dict{String,<:Any})
Starts a new run of the specified blueprint.
# Arguments
- `blueprint_name`: The name of the blueprint.
- `role_arn`: Specifies the IAM role used to create the workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Parameters"`: Specifies the parameters as a BlueprintParameters object.
"""
function start_blueprint_run(
BlueprintName, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartBlueprintRun",
Dict{String,Any}("BlueprintName" => BlueprintName, "RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_blueprint_run(
BlueprintName,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StartBlueprintRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BlueprintName" => BlueprintName, "RoleArn" => RoleArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_column_statistics_task_run(database_name, role, table_name)
start_column_statistics_task_run(database_name, role, table_name, params::Dict{String,<:Any})
Starts a column statistics task run, for a specified table and columns.
# Arguments
- `database_name`: The name of the database where the table resides.
- `role`: The IAM role that the service assumes to generate statistics.
- `table_name`: The name of the table to generate statistics.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogID"`: The ID of the Data Catalog where the table reside. If none is supplied,
the Amazon Web Services account ID is used by default.
- `"ColumnNameList"`: A list of the column names to generate statistics. If none is
supplied, all column names for the table will be used by default.
- `"SampleSize"`: The percentage of rows used to generate statistics. If none is supplied,
the entire table will be used to generate stats.
- `"SecurityConfiguration"`: Name of the security configuration that is used to encrypt
CloudWatch logs for the column stats task run.
"""
function start_column_statistics_task_run(
DatabaseName, Role, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartColumnStatisticsTaskRun",
Dict{String,Any}(
"DatabaseName" => DatabaseName, "Role" => Role, "TableName" => TableName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_column_statistics_task_run(
DatabaseName,
Role,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StartColumnStatisticsTaskRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName, "Role" => Role, "TableName" => TableName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_crawler(name)
start_crawler(name, params::Dict{String,<:Any})
Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler
is already running, returns a CrawlerRunningException.
# Arguments
- `name`: Name of the crawler to start.
"""
function start_crawler(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"StartCrawler",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_crawler(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartCrawler",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_crawler_schedule(crawler_name)
start_crawler_schedule(crawler_name, params::Dict{String,<:Any})
Changes the schedule state of the specified crawler to SCHEDULED, unless the crawler is
already running or the schedule state is already SCHEDULED.
# Arguments
- `crawler_name`: Name of the crawler to schedule.
"""
function start_crawler_schedule(
CrawlerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartCrawlerSchedule",
Dict{String,Any}("CrawlerName" => CrawlerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_crawler_schedule(
CrawlerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StartCrawlerSchedule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CrawlerName" => CrawlerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_data_quality_rule_recommendation_run(data_source, role)
start_data_quality_rule_recommendation_run(data_source, role, params::Dict{String,<:Any})
Starts a recommendation run that is used to generate rules when you don't know what rules
to write. Glue Data Quality analyzes the data and comes up with recommendations for a
potential ruleset. You can then triage the ruleset and modify the generated ruleset to your
liking. Recommendation runs are automatically deleted after 90 days.
# Arguments
- `data_source`: The data source (Glue table) associated with this run.
- `role`: An IAM role supplied to encrypt the results of the run.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Used for idempotency and is recommended to be set to a random ID (such
as a UUID) to avoid creating or starting multiple instances of the same resource.
- `"CreatedRulesetName"`: A name for the ruleset.
- `"NumberOfWorkers"`: The number of G.1X workers to be used in the run. The default is 5.
- `"Timeout"`: The timeout for a run in minutes. This is the maximum time that a run can
consume resources before it is terminated and enters TIMEOUT status. The default is 2,880
minutes (48 hours).
"""
function start_data_quality_rule_recommendation_run(
DataSource, Role; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartDataQualityRuleRecommendationRun",
Dict{String,Any}("DataSource" => DataSource, "Role" => Role);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_data_quality_rule_recommendation_run(
DataSource,
Role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StartDataQualityRuleRecommendationRun",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DataSource" => DataSource, "Role" => Role), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_data_quality_ruleset_evaluation_run(data_source, role, ruleset_names)
start_data_quality_ruleset_evaluation_run(data_source, role, ruleset_names, params::Dict{String,<:Any})
Once you have a ruleset definition (either recommended or your own), you call this
operation to evaluate the ruleset against a data source (Glue table). The evaluation
computes results which you can retrieve with the GetDataQualityResult API.
# Arguments
- `data_source`: The data source (Glue table) associated with this run.
- `role`: An IAM role supplied to encrypt the results of the run.
- `ruleset_names`: A list of ruleset names.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AdditionalDataSources"`: A map of reference strings to additional data sources you can
specify for an evaluation run.
- `"AdditionalRunOptions"`: Additional run options you can specify for an evaluation run.
- `"ClientToken"`: Used for idempotency and is recommended to be set to a random ID (such
as a UUID) to avoid creating or starting multiple instances of the same resource.
- `"NumberOfWorkers"`: The number of G.1X workers to be used in the run. The default is 5.
- `"Timeout"`: The timeout for a run in minutes. This is the maximum time that a run can
consume resources before it is terminated and enters TIMEOUT status. The default is 2,880
minutes (48 hours).
"""
function start_data_quality_ruleset_evaluation_run(
DataSource, Role, RulesetNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartDataQualityRulesetEvaluationRun",
Dict{String,Any}(
"DataSource" => DataSource, "Role" => Role, "RulesetNames" => RulesetNames
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_data_quality_ruleset_evaluation_run(
DataSource,
Role,
RulesetNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StartDataQualityRulesetEvaluationRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DataSource" => DataSource,
"Role" => Role,
"RulesetNames" => RulesetNames,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_export_labels_task_run(output_s3_path, transform_id)
start_export_labels_task_run(output_s3_path, transform_id, params::Dict{String,<:Any})
Begins an asynchronous task to export all labeled data for a particular transform. This
task is the only label-related API call that is not part of the typical active learning
workflow. You typically use StartExportLabelsTaskRun when you want to work with all of your
existing labels at the same time, such as when you want to remove or change labels that
were previously submitted as truth. This API operation accepts the TransformId whose labels
you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the
labels to. The operation returns a TaskRunId. You can check on the status of your task run
by calling the GetMLTaskRun API.
# Arguments
- `output_s3_path`: The Amazon S3 path where you export the labels.
- `transform_id`: The unique identifier of the machine learning transform.
"""
function start_export_labels_task_run(
OutputS3Path, TransformId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartExportLabelsTaskRun",
Dict{String,Any}("OutputS3Path" => OutputS3Path, "TransformId" => TransformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_export_labels_task_run(
OutputS3Path,
TransformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StartExportLabelsTaskRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OutputS3Path" => OutputS3Path, "TransformId" => TransformId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_import_labels_task_run(input_s3_path, transform_id)
start_import_labels_task_run(input_s3_path, transform_id, params::Dict{String,<:Any})
Enables you to provide additional labels (examples of truth) to be used to teach the
machine learning transform and improve its quality. This API operation is generally used as
part of the active learning workflow that starts with the
StartMLLabelingSetGenerationTaskRun call and that ultimately results in improving the
quality of your machine learning transform. After the StartMLLabelingSetGenerationTaskRun
finishes, Glue machine learning will have generated a series of questions for humans to
answer. (Answering these questions is often called 'labeling' in the machine learning
workflows). In the case of the FindMatches transform, these questions are of the form,
“What is the correct way to group these rows together into groups composed entirely of
matching records?” After the labeling process is finished, users upload their
answers/labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun
finishes, all future runs of the machine learning transform use the new and improved labels
and perform a higher-quality transformation. By default,
StartMLLabelingSetGenerationTaskRun continually learns from and combines all labels that
you upload unless you set Replace to true. If you set Replace to true,
StartImportLabelsTaskRun deletes and forgets all previously uploaded labels and learns only
from the exact set that you upload. Replacing labels can be helpful if you realize that you
previously uploaded incorrect labels, and you believe that they are having a negative
effect on your transform quality. You can check on the status of your task run by calling
the GetMLTaskRun operation.
# Arguments
- `input_s3_path`: The Amazon Simple Storage Service (Amazon S3) path from where you import
the labels.
- `transform_id`: The unique identifier of the machine learning transform.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ReplaceAllLabels"`: Indicates whether to overwrite your existing labels.
"""
function start_import_labels_task_run(
InputS3Path, TransformId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartImportLabelsTaskRun",
Dict{String,Any}("InputS3Path" => InputS3Path, "TransformId" => TransformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_import_labels_task_run(
InputS3Path,
TransformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StartImportLabelsTaskRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InputS3Path" => InputS3Path, "TransformId" => TransformId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_job_run(job_name)
start_job_run(job_name, params::Dict{String,<:Any})
Starts a job run using a job definition.
# Arguments
- `job_name`: The name of the job definition to use.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllocatedCapacity"`: This field is deprecated. Use MaxCapacity instead. The number of
Glue data processing units (DPUs) to allocate to this JobRun. You can allocate a minimum of
2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of
4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing
page.
- `"Arguments"`: The job arguments associated with this run. For this job run, they replace
the default arguments set in the job definition itself. You can specify arguments here that
your own job-execution script consumes, as well as arguments that Glue itself consumes. Job
arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from
a Glue Connection, Secrets Manager or other secret management mechanism if you intend to
keep them within the Job. For information about how to specify and consume your own Job
arguments, see the Calling Glue APIs in Python topic in the developer guide. For
information about the arguments you can provide to this field when configuring Spark jobs,
see the Special Parameters Used by Glue topic in the developer guide. For information about
the arguments you can provide to this field when configuring Ray jobs, see Using job
parameters in Ray jobs in the developer guide.
- `"ExecutionClass"`: Indicates whether the job is run with a standard or flexible
execution class. The standard execution-class is ideal for time-sensitive workloads that
require fast job startup and dedicated resources. The flexible execution class is
appropriate for time-insensitive jobs whose start and completion times may vary. Only jobs
with Glue version 3.0 and above and command type glueetl will be allowed to set
ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
- `"JobRunId"`: The ID of a previous JobRun to retry.
- `"MaxCapacity"`: For Glue version 1.0 or earlier jobs, using the standard worker type,
the number of Glue data processing units (DPUs) that can be allocated when this job runs. A
DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity
and 16 GB of memory. For more information, see the Glue pricing page. For Glue version
2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a Worker type
and the Number of workers. Do not set MaxCapacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are running a Python
shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job: When you
specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can allocate either
0.0625 or 1 DPU. The default is 0.0625 DPU. When you specify an Apache Spark ETL job
(JobCommand.Name=\"glueetl\") or Apache Spark streaming ETL job
(JobCommand.Name=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. The default is 10
DPUs. This job type cannot have a fractional DPU allocation.
- `"NotificationProperty"`: Specifies configuration properties of a job run notification.
- `"NumberOfWorkers"`: The number of workers of a defined workerType that are allocated
when a job runs.
- `"SecurityConfiguration"`: The name of the SecurityConfiguration structure to be used
with this job run.
- `"Timeout"`: The JobRun timeout in minutes. This is the maximum time that a job run can
consume resources before it is terminated and enters TIMEOUT status. This value overrides
the timeout value set in the parent job. Streaming jobs must have timeout values less than
7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7
days based if you have not setup a maintenance window. If you have setup maintenance
window, it will be restarted during the maintenance window after 7 days.
- `"WorkerType"`: The type of predefined worker that is allocated when a job runs. Accepts
a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray
jobs. For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with
84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this
worker type for workloads such as data transforms, joins, and queries, to offers a scalable
and cost effective way to run most jobs. For the G.2X worker type, each worker maps to 2
DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1
executor per worker. We recommend this worker type for workloads such as data transforms,
joins, and queries, to offers a scalable and cost effective way to run most jobs. For the
G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk
(approximately 235GB free), and provides 1 executor per worker. We recommend this worker
type for jobs whose workloads contain your most demanding transforms, aggregations, joins,
and queries. This worker type is available only for Glue version 3.0 or later Spark ETL
jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia),
US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo),
Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). For the
G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk
(approximately 487GB free), and provides 1 executor per worker. We recommend this worker
type for jobs whose workloads contain your most demanding transforms, aggregations, joins,
and queries. This worker type is available only for Glue version 3.0 or later Spark ETL
jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type. For
the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB
disk (approximately 34GB free), and provides 1 executor per worker. We recommend this
worker type for low volume streaming jobs. This worker type is only available for Glue
version 3.0 streaming jobs. For the Z.2X worker type, each worker maps to 2 M-DPU
(8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8
Ray workers based on the autoscaler.
"""
function start_job_run(JobName; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"StartJobRun",
Dict{String,Any}("JobName" => JobName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_job_run(
JobName, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartJobRun",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobName" => JobName), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_mlevaluation_task_run(transform_id)
start_mlevaluation_task_run(transform_id, params::Dict{String,<:Any})
Starts a task to estimate the quality of the transform. When you provide label sets as
examples of truth, Glue machine learning uses some of those examples to learn from them.
The rest of the labels are used as a test to estimate quality. Returns a unique identifier
for the run. You can call GetMLTaskRun to get more information about the stats of the
EvaluationTaskRun.
# Arguments
- `transform_id`: The unique identifier of the machine learning transform.
"""
function start_mlevaluation_task_run(
TransformId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartMLEvaluationTaskRun",
Dict{String,Any}("TransformId" => TransformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_mlevaluation_task_run(
TransformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StartMLEvaluationTaskRun",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TransformId" => TransformId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_mllabeling_set_generation_task_run(output_s3_path, transform_id)
start_mllabeling_set_generation_task_run(output_s3_path, transform_id, params::Dict{String,<:Any})
Starts the active learning workflow for your machine learning transform to improve the
transform's quality by generating label sets and adding labels. When the
StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated a \"labeling set\"
or a set of questions for humans to answer. In the case of the FindMatches transform, these
questions are of the form, “What is the correct way to group these rows together into
groups composed entirely of matching records?” After the labeling process is finished,
you can upload your labels with a call to StartImportLabelsTaskRun. After
StartImportLabelsTaskRun finishes, all future runs of the machine learning transform will
use the new and improved labels and perform a higher-quality transformation.
# Arguments
- `output_s3_path`: The Amazon Simple Storage Service (Amazon S3) path where you generate
the labeling set.
- `transform_id`: The unique identifier of the machine learning transform.
"""
function start_mllabeling_set_generation_task_run(
OutputS3Path, TransformId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartMLLabelingSetGenerationTaskRun",
Dict{String,Any}("OutputS3Path" => OutputS3Path, "TransformId" => TransformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_mllabeling_set_generation_task_run(
OutputS3Path,
TransformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StartMLLabelingSetGenerationTaskRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OutputS3Path" => OutputS3Path, "TransformId" => TransformId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_trigger(name)
start_trigger(name, params::Dict{String,<:Any})
Starts an existing trigger. See Triggering Jobs for information about how different types
of trigger are started.
# Arguments
- `name`: The name of the trigger to start.
"""
function start_trigger(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"StartTrigger",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_trigger(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartTrigger",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_workflow_run(name)
start_workflow_run(name, params::Dict{String,<:Any})
Starts a new run of the specified workflow.
# Arguments
- `name`: The name of the workflow to start.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RunProperties"`: The workflow run properties for the new workflow run.
"""
function start_workflow_run(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"StartWorkflowRun",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_workflow_run(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StartWorkflowRun",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_column_statistics_task_run(database_name, table_name)
stop_column_statistics_task_run(database_name, table_name, params::Dict{String,<:Any})
Stops a task run for the specified table.
# Arguments
- `database_name`: The name of the database where the table resides.
- `table_name`: The name of the table.
"""
function stop_column_statistics_task_run(
DatabaseName, TableName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StopColumnStatisticsTaskRun",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_column_statistics_task_run(
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StopColumnStatisticsTaskRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseName" => DatabaseName, "TableName" => TableName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_crawler(name)
stop_crawler(name, params::Dict{String,<:Any})
If the specified crawler is running, stops the crawl.
# Arguments
- `name`: Name of the crawler to stop.
"""
function stop_crawler(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"StopCrawler",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_crawler(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StopCrawler",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_crawler_schedule(crawler_name)
stop_crawler_schedule(crawler_name, params::Dict{String,<:Any})
Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the
crawler if it is already running.
# Arguments
- `crawler_name`: Name of the crawler whose schedule state to set.
"""
function stop_crawler_schedule(
CrawlerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StopCrawlerSchedule",
Dict{String,Any}("CrawlerName" => CrawlerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_crawler_schedule(
CrawlerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StopCrawlerSchedule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CrawlerName" => CrawlerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_session(id)
stop_session(id, params::Dict{String,<:Any})
Stops the session.
# Arguments
- `id`: The ID of the session to be stopped.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"RequestOrigin"`: The origin of the request.
"""
function stop_session(Id; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"StopSession",
Dict{String,Any}("Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_session(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StopSession",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Id" => Id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_trigger(name)
stop_trigger(name, params::Dict{String,<:Any})
Stops a specified trigger.
# Arguments
- `name`: The name of the trigger to stop.
"""
function stop_trigger(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"StopTrigger",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_trigger(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"StopTrigger",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_workflow_run(name, run_id)
stop_workflow_run(name, run_id, params::Dict{String,<:Any})
Stops the execution of the specified workflow run.
# Arguments
- `name`: The name of the workflow to stop.
- `run_id`: The ID of the workflow run to stop.
"""
function stop_workflow_run(Name, RunId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"StopWorkflowRun",
Dict{String,Any}("Name" => Name, "RunId" => RunId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_workflow_run(
Name,
RunId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"StopWorkflowRun",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Name" => Name, "RunId" => RunId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource_arn, tags_to_add)
tag_resource(resource_arn, tags_to_add, params::Dict{String,<:Any})
Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services
resource. In Glue, you can tag only certain resources. For information about what resources
you can tag, see Amazon Web Services Tags in Glue.
# Arguments
- `resource_arn`: The ARN of the Glue resource to which to add the tags. For more
information about Glue resource ARNs, see the Glue ARN string pattern.
- `tags_to_add`: Tags to add to this resource.
"""
function tag_resource(
ResourceArn, TagsToAdd; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"TagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagsToAdd" => TagsToAdd);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
ResourceArn,
TagsToAdd,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"TagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ResourceArn" => ResourceArn, "TagsToAdd" => TagsToAdd),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_resource(resource_arn, tags_to_remove)
untag_resource(resource_arn, tags_to_remove, params::Dict{String,<:Any})
Removes tags from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource from which to remove the
tags.
- `tags_to_remove`: Tags to remove from this resource.
"""
function untag_resource(
ResourceArn, TagsToRemove; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UntagResource",
Dict{String,Any}("ResourceArn" => ResourceArn, "TagsToRemove" => TagsToRemove);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_resource(
ResourceArn,
TagsToRemove,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UntagResource",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ResourceArn" => ResourceArn, "TagsToRemove" => TagsToRemove
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_blueprint(blueprint_location, name)
update_blueprint(blueprint_location, name, params::Dict{String,<:Any})
Updates a registered blueprint.
# Arguments
- `blueprint_location`: Specifies a path in Amazon S3 where the blueprint is published.
- `name`: The name of the blueprint.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the blueprint.
"""
function update_blueprint(
BlueprintLocation, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateBlueprint",
Dict{String,Any}("BlueprintLocation" => BlueprintLocation, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_blueprint(
BlueprintLocation,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateBlueprint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("BlueprintLocation" => BlueprintLocation, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_classifier()
update_classifier(params::Dict{String,<:Any})
Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a
CsvClassifier, depending on which field is present).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CsvClassifier"`: A CsvClassifier object with updated fields.
- `"GrokClassifier"`: A GrokClassifier object with updated fields.
- `"JsonClassifier"`: A JsonClassifier object with updated fields.
- `"XMLClassifier"`: An XMLClassifier object with updated fields.
"""
function update_classifier(; aws_config::AbstractAWSConfig=global_aws_config())
return glue("UpdateClassifier"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function update_classifier(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateClassifier", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
update_column_statistics_for_partition(column_statistics_list, database_name, partition_values, table_name)
update_column_statistics_for_partition(column_statistics_list, database_name, partition_values, table_name, params::Dict{String,<:Any})
Creates or updates partition statistics of columns. The Identity and Access Management
(IAM) permission required for this operation is UpdatePartition.
# Arguments
- `column_statistics_list`: A list of the column statistics.
- `database_name`: The name of the catalog database where the partitions reside.
- `partition_values`: A list of partition values identifying the partition.
- `table_name`: The name of the partitions' table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partitions in question reside. If
none is supplied, the Amazon Web Services account ID is used by default.
"""
function update_column_statistics_for_partition(
ColumnStatisticsList,
DatabaseName,
PartitionValues,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateColumnStatisticsForPartition",
Dict{String,Any}(
"ColumnStatisticsList" => ColumnStatisticsList,
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_column_statistics_for_partition(
ColumnStatisticsList,
DatabaseName,
PartitionValues,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateColumnStatisticsForPartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ColumnStatisticsList" => ColumnStatisticsList,
"DatabaseName" => DatabaseName,
"PartitionValues" => PartitionValues,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_column_statistics_for_table(column_statistics_list, database_name, table_name)
update_column_statistics_for_table(column_statistics_list, database_name, table_name, params::Dict{String,<:Any})
Creates or updates table statistics of columns. The Identity and Access Management (IAM)
permission required for this operation is UpdateTable.
# Arguments
- `column_statistics_list`: A list of the column statistics.
- `database_name`: The name of the catalog database where the partitions reside.
- `table_name`: The name of the partitions' table.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partitions in question reside. If
none is supplied, the Amazon Web Services account ID is used by default.
"""
function update_column_statistics_for_table(
ColumnStatisticsList,
DatabaseName,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateColumnStatisticsForTable",
Dict{String,Any}(
"ColumnStatisticsList" => ColumnStatisticsList,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_column_statistics_for_table(
ColumnStatisticsList,
DatabaseName,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateColumnStatisticsForTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ColumnStatisticsList" => ColumnStatisticsList,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_connection(connection_input, name)
update_connection(connection_input, name, params::Dict{String,<:Any})
Updates a connection definition in the Data Catalog.
# Arguments
- `connection_input`: A ConnectionInput object that redefines the connection in question.
- `name`: The name of the connection definition to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which the connection resides. If none is
provided, the Amazon Web Services account ID is used by default.
"""
function update_connection(
ConnectionInput, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateConnection",
Dict{String,Any}("ConnectionInput" => ConnectionInput, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connection(
ConnectionInput,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateConnection",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ConnectionInput" => ConnectionInput, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_crawler(name)
update_crawler(name, params::Dict{String,<:Any})
Updates a crawler. If a crawler is running, you must stop it using StopCrawler before
updating it.
# Arguments
- `name`: Name of the new crawler.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Classifiers"`: A list of custom classifiers that the user has registered. By default,
all built-in classifiers are included in a crawl, but these custom classifiers always
override the default classifiers for a given classification.
- `"Configuration"`: Crawler configuration information. This versioned JSON string allows
users to specify aspects of a crawler's behavior. For more information, see Setting crawler
configuration options.
- `"CrawlerSecurityConfiguration"`: The name of the SecurityConfiguration structure to be
used by this crawler.
- `"DatabaseName"`: The Glue database where results are stored, such as:
arn:aws:daylight:us-east-1::database/sometable/*.
- `"Description"`: A description of the new crawler.
- `"LakeFormationConfiguration"`: Specifies Lake Formation configuration settings for the
crawler.
- `"LineageConfiguration"`: Specifies data lineage configuration settings for the crawler.
- `"RecrawlPolicy"`: A policy that specifies whether to crawl the entire dataset again, or
to crawl only folders that were added since the last crawler run.
- `"Role"`: The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the
new crawler to access customer resources.
- `"Schedule"`: A cron expression used to specify the schedule (see Time-Based Schedules
for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would
specify: cron(15 12 * * ? *).
- `"SchemaChangePolicy"`: The policy for the crawler's update and deletion behavior.
- `"TablePrefix"`: The table prefix used for catalog tables that are created.
- `"Targets"`: A list of targets to crawl.
"""
function update_crawler(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"UpdateCrawler",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_crawler(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateCrawler",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_crawler_schedule(crawler_name)
update_crawler_schedule(crawler_name, params::Dict{String,<:Any})
Updates the schedule of a crawler using a cron expression.
# Arguments
- `crawler_name`: The name of the crawler whose schedule to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Schedule"`: The updated cron expression used to specify the schedule (see Time-Based
Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you
would specify: cron(15 12 * * ? *).
"""
function update_crawler_schedule(
CrawlerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateCrawlerSchedule",
Dict{String,Any}("CrawlerName" => CrawlerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_crawler_schedule(
CrawlerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateCrawlerSchedule",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CrawlerName" => CrawlerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_data_quality_ruleset(name)
update_data_quality_ruleset(name, params::Dict{String,<:Any})
Updates the specified data quality ruleset.
# Arguments
- `name`: The name of the data quality ruleset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the ruleset.
- `"Ruleset"`: A Data Quality Definition Language (DQDL) ruleset. For more information, see
the Glue developer guide.
"""
function update_data_quality_ruleset(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateDataQualityRuleset",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_data_quality_ruleset(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateDataQualityRuleset",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_database(database_input, name)
update_database(database_input, name, params::Dict{String,<:Any})
Updates an existing database definition in a Data Catalog.
# Arguments
- `database_input`: A DatabaseInput object specifying the new definition of the metadata
database in the catalog.
- `name`: The name of the database to update in the catalog. For Hive compatibility, this
is folded to lowercase.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog in which the metadata database resides. If none
is provided, the Amazon Web Services account ID is used by default.
"""
function update_database(
DatabaseInput, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateDatabase",
Dict{String,Any}("DatabaseInput" => DatabaseInput, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_database(
DatabaseInput,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateDatabase",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatabaseInput" => DatabaseInput, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dev_endpoint(endpoint_name)
update_dev_endpoint(endpoint_name, params::Dict{String,<:Any})
Updates a specified development endpoint.
# Arguments
- `endpoint_name`: The name of the DevEndpoint to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AddArguments"`: The map of arguments to add the map of arguments used to configure the
DevEndpoint. Valid arguments are: \"--enable-glue-datacatalog\": \"\" You can specify
a version of Python support for development endpoints by using the Arguments parameter in
the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version
defaults to Python 2.
- `"AddPublicKeys"`: The list of public keys for the DevEndpoint to use.
- `"CustomLibraries"`: Custom Python or Java libraries to be loaded in the DevEndpoint.
- `"DeleteArguments"`: The list of argument keys to be deleted from the map of arguments
used to configure the DevEndpoint.
- `"DeletePublicKeys"`: The list of public keys to be deleted from the DevEndpoint.
- `"PublicKey"`: The public key for the DevEndpoint to use.
- `"UpdateEtlLibraries"`: True if the list of custom libraries to be loaded in the
development endpoint needs to be updated, or False if otherwise.
"""
function update_dev_endpoint(
EndpointName; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateDevEndpoint",
Dict{String,Any}("EndpointName" => EndpointName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dev_endpoint(
EndpointName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateDevEndpoint",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EndpointName" => EndpointName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_job(job_name, job_update)
update_job(job_name, job_update, params::Dict{String,<:Any})
Updates an existing job definition. The previous job definition is completely overwritten
by this information.
# Arguments
- `job_name`: The name of the job definition to update.
- `job_update`: Specifies the values with which to update the job definition. Unspecified
configuration is removed or reset to default values.
"""
function update_job(JobName, JobUpdate; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"UpdateJob",
Dict{String,Any}("JobName" => JobName, "JobUpdate" => JobUpdate);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_job(
JobName,
JobUpdate,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("JobName" => JobName, "JobUpdate" => JobUpdate),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_job_from_source_control()
update_job_from_source_control(params::Dict{String,<:Any})
Synchronizes a job from the source control repository. This operation takes the job
artifacts that are located in the remote repository and updates the Glue internal stores
with these artifacts. This API supports optional parameters which take in the repository
information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthStrategy"`: The type of authentication, which can be an authentication token stored
in Amazon Web Services Secrets Manager, or a personal access token.
- `"AuthToken"`: The value of the authorization token.
- `"BranchName"`: An optional branch in the remote repository.
- `"CommitId"`: A commit ID for a commit in the remote repository.
- `"Folder"`: An optional folder in the remote repository.
- `"JobName"`: The name of the Glue job to be synchronized to or from the remote repository.
- `"Provider"`: The provider for the remote repository. Possible values: GITHUB,
AWS_CODE_COMMIT, GITLAB, BITBUCKET.
- `"RepositoryName"`: The name of the remote repository that contains the job artifacts.
For BitBucket providers, RepositoryName should include WorkspaceName. Use the format
<WorkspaceName>/<RepositoryName>.
- `"RepositoryOwner"`: The owner of the remote repository that contains the job artifacts.
"""
function update_job_from_source_control(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"UpdateJobFromSourceControl"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_job_from_source_control(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateJobFromSourceControl",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_mltransform(transform_id)
update_mltransform(transform_id, params::Dict{String,<:Any})
Updates an existing machine learning transform. Call this operation to tune the algorithm
parameters to achieve better results. After calling this operation, you can call the
StartMLEvaluationTaskRun operation to assess how well your new parameters achieved your
goals (such as improving the quality of your machine learning transform, or making it more
cost-effective).
# Arguments
- `transform_id`: A unique identifier that was generated when the transform was created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the transform. The default is an empty string.
- `"GlueVersion"`: This value determines which version of Glue this machine learning
transform is compatible with. Glue 1.0 is recommended for most customers. If the value is
not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue
Versions in the developer guide.
- `"MaxCapacity"`: The number of Glue data processing units (DPUs) that are allocated to
task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU
is a relative measure of processing power that consists of 4 vCPUs of compute capacity and
16 GB of memory. For more information, see the Glue pricing page. When the WorkerType
field is set to a value other than Standard, the MaxCapacity field is set automatically and
becomes read-only.
- `"MaxRetries"`: The maximum number of times to retry a task for this transform after a
task run fails.
- `"Name"`: The unique name that you gave the transform when you created it.
- `"NumberOfWorkers"`: The number of workers of a defined workerType that are allocated
when this task runs.
- `"Parameters"`: The configuration parameters that are specific to the transform type
(algorithm) used. Conditionally dependent on the transform type.
- `"Role"`: The name or Amazon Resource Name (ARN) of the IAM role with the required
permissions.
- `"Timeout"`: The timeout for a task run for this transform in minutes. This is the
maximum time that a task run for this transform can consume resources before it is
terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
- `"WorkerType"`: The type of predefined worker that is allocated when this task runs.
Accepts a value of Standard, G.1X, or G.2X. For the Standard worker type, each worker
provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. For the
G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1
executor per worker. For the G.2X worker type, each worker provides 8 vCPU, 32 GB of
memory and a 128GB disk, and 1 executor per worker.
"""
function update_mltransform(TransformId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"UpdateMLTransform",
Dict{String,Any}("TransformId" => TransformId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_mltransform(
TransformId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateMLTransform",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("TransformId" => TransformId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_partition(database_name, partition_input, partition_value_list, table_name)
update_partition(database_name, partition_input, partition_value_list, table_name, params::Dict{String,<:Any})
Updates a partition.
# Arguments
- `database_name`: The name of the catalog database in which the table in question resides.
- `partition_input`: The new partition object to update the partition to. The Values
property can't be changed. If you want to change the partition key values for a partition,
delete and recreate the partition.
- `partition_value_list`: List of partition key values that define the partition to update.
- `table_name`: The name of the table in which the partition to be updated is located.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the partition to be updated resides. If
none is provided, the Amazon Web Services account ID is used by default.
"""
function update_partition(
DatabaseName,
PartitionInput,
PartitionValueList,
TableName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdatePartition",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionInput" => PartitionInput,
"PartitionValueList" => PartitionValueList,
"TableName" => TableName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_partition(
DatabaseName,
PartitionInput,
PartitionValueList,
TableName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdatePartition",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"PartitionInput" => PartitionInput,
"PartitionValueList" => PartitionValueList,
"TableName" => TableName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_registry(description, registry_id)
update_registry(description, registry_id, params::Dict{String,<:Any})
Updates an existing registry which is used to hold a collection of schemas. The updated
properties relate to the registry, and do not modify any of the schemas within the
registry.
# Arguments
- `description`: A description of the registry. If description is not provided, this field
will not be updated.
- `registry_id`: This is a wrapper structure that may contain the registry name and Amazon
Resource Name (ARN).
"""
function update_registry(
Description, RegistryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateRegistry",
Dict{String,Any}("Description" => Description, "RegistryId" => RegistryId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_registry(
Description,
RegistryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateRegistry",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Description" => Description, "RegistryId" => RegistryId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_schema(schema_id)
update_schema(schema_id, params::Dict{String,<:Any})
Updates the description, compatibility setting, or version checkpoint for a schema set. For
updating the compatibility setting, the call will not validate compatibility for the entire
set of schema versions with the new compatibility setting. If the value for Compatibility
is provided, the VersionNumber (a checkpoint) is also required. The API will validate the
checkpoint version number for consistency. If the value for the VersionNumber (checkpoint)
is provided, Compatibility is optional and this can be used to set/reset a checkpoint for
the schema. This update will happen only if the schema is in the AVAILABLE state.
# Arguments
- `schema_id`: This is a wrapper structure to contain schema identity fields. The structure
contains: SchemaIdSchemaArn: The Amazon Resource Name (ARN) of the schema. One of
SchemaArn or SchemaName has to be provided. SchemaIdSchemaName: The name of the schema.
One of SchemaArn or SchemaName has to be provided.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Compatibility"`: The new compatibility setting for the schema.
- `"Description"`: The new description for the schema.
- `"SchemaVersionNumber"`: Version number required for check pointing. One of VersionNumber
or Compatibility has to be provided.
"""
function update_schema(SchemaId; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"UpdateSchema",
Dict{String,Any}("SchemaId" => SchemaId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_schema(
SchemaId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateSchema",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SchemaId" => SchemaId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_source_control_from_job()
update_source_control_from_job(params::Dict{String,<:Any})
Synchronizes a job to the source control repository. This operation takes the job artifacts
from the Glue internal stores and makes a commit to the remote repository that is
configured on the job. This API supports optional parameters which take in the repository
information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthStrategy"`: The type of authentication, which can be an authentication token stored
in Amazon Web Services Secrets Manager, or a personal access token.
- `"AuthToken"`: The value of the authorization token.
- `"BranchName"`: An optional branch in the remote repository.
- `"CommitId"`: A commit ID for a commit in the remote repository.
- `"Folder"`: An optional folder in the remote repository.
- `"JobName"`: The name of the Glue job to be synchronized to or from the remote repository.
- `"Provider"`: The provider for the remote repository. Possible values: GITHUB,
AWS_CODE_COMMIT, GITLAB, BITBUCKET.
- `"RepositoryName"`: The name of the remote repository that contains the job artifacts.
For BitBucket providers, RepositoryName should include WorkspaceName. Use the format
<WorkspaceName>/<RepositoryName>.
- `"RepositoryOwner"`: The owner of the remote repository that contains the job artifacts.
"""
function update_source_control_from_job(; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"UpdateSourceControlFromJob"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_source_control_from_job(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateSourceControlFromJob",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_table(database_name, table_input)
update_table(database_name, table_input, params::Dict{String,<:Any})
Updates a metadata table in the Data Catalog.
# Arguments
- `database_name`: The name of the catalog database in which the table resides. For Hive
compatibility, this name is entirely lowercase.
- `table_input`: An updated TableInput object to define the metadata table in the catalog.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the table resides. If none is provided,
the Amazon Web Services account ID is used by default.
- `"Force"`: A flag that can be set to true to ignore matching storage descriptor and
subobject matching requirements.
- `"SkipArchive"`: By default, UpdateTable always creates an archived version of the table
before updating it. However, if skipArchive is set to true, UpdateTable does not create the
archived version.
- `"TransactionId"`: The transaction ID at which to update the table contents.
- `"VersionId"`: The version ID at which to update the table contents.
- `"ViewUpdateAction"`: The operation to be performed when updating the view.
"""
function update_table(
DatabaseName, TableInput; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateTable",
Dict{String,Any}("DatabaseName" => DatabaseName, "TableInput" => TableInput);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_table(
DatabaseName,
TableInput,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateTable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName, "TableInput" => TableInput
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_table_optimizer(catalog_id, database_name, table_name, table_optimizer_configuration, type)
update_table_optimizer(catalog_id, database_name, table_name, table_optimizer_configuration, type, params::Dict{String,<:Any})
Updates the configuration for an existing table optimizer.
# Arguments
- `catalog_id`: The Catalog ID of the table.
- `database_name`: The name of the database in the catalog in which the table resides.
- `table_name`: The name of the table.
- `table_optimizer_configuration`: A TableOptimizerConfiguration object representing the
configuration of a table optimizer.
- `type`: The type of table optimizer. Currently, the only valid value is compaction.
"""
function update_table_optimizer(
CatalogId,
DatabaseName,
TableName,
TableOptimizerConfiguration,
Type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateTableOptimizer",
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"TableOptimizerConfiguration" => TableOptimizerConfiguration,
"Type" => Type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_table_optimizer(
CatalogId,
DatabaseName,
TableName,
TableOptimizerConfiguration,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateTableOptimizer",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CatalogId" => CatalogId,
"DatabaseName" => DatabaseName,
"TableName" => TableName,
"TableOptimizerConfiguration" => TableOptimizerConfiguration,
"Type" => Type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_trigger(name, trigger_update)
update_trigger(name, trigger_update, params::Dict{String,<:Any})
Updates a trigger definition.
# Arguments
- `name`: The name of the trigger to update.
- `trigger_update`: The new values with which to update the trigger.
"""
function update_trigger(
Name, TriggerUpdate; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateTrigger",
Dict{String,Any}("Name" => Name, "TriggerUpdate" => TriggerUpdate);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_trigger(
Name,
TriggerUpdate,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateTrigger",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "TriggerUpdate" => TriggerUpdate),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_usage_profile(configuration, name)
update_usage_profile(configuration, name, params::Dict{String,<:Any})
Update an Glue usage profile.
# Arguments
- `configuration`: A ProfileConfiguration object specifying the job and session values for
the profile.
- `name`: The name of the usage profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the usage profile.
"""
function update_usage_profile(
Configuration, Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateUsageProfile",
Dict{String,Any}("Configuration" => Configuration, "Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_usage_profile(
Configuration,
Name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateUsageProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Configuration" => Configuration, "Name" => Name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user_defined_function(database_name, function_input, function_name)
update_user_defined_function(database_name, function_input, function_name, params::Dict{String,<:Any})
Updates an existing function definition in the Data Catalog.
# Arguments
- `database_name`: The name of the catalog database where the function to be updated is
located.
- `function_input`: A FunctionInput object that redefines the function in the Data Catalog.
- `function_name`: The name of the function.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CatalogId"`: The ID of the Data Catalog where the function to be updated is located. If
none is provided, the Amazon Web Services account ID is used by default.
"""
function update_user_defined_function(
DatabaseName,
FunctionInput,
FunctionName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateUserDefinedFunction",
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"FunctionInput" => FunctionInput,
"FunctionName" => FunctionName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user_defined_function(
DatabaseName,
FunctionInput,
FunctionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return glue(
"UpdateUserDefinedFunction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatabaseName" => DatabaseName,
"FunctionInput" => FunctionInput,
"FunctionName" => FunctionName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workflow(name)
update_workflow(name, params::Dict{String,<:Any})
Updates an existing workflow.
# Arguments
- `name`: Name of the workflow to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultRunProperties"`: A collection of properties to be used as part of each execution
of the workflow.
- `"Description"`: The description of the workflow.
- `"MaxConcurrentRuns"`: You can use this parameter to prevent unwanted multiple updates to
data, to control costs, or in some cases, to prevent exceeding the maximum number of
concurrent runs of any of the component jobs. If you leave this parameter blank, there is
no limit to the number of concurrent workflow runs.
"""
function update_workflow(Name; aws_config::AbstractAWSConfig=global_aws_config())
return glue(
"UpdateWorkflow",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workflow(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return glue(
"UpdateWorkflow",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => 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 | 44541 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: grafana
using AWS.Compat
using AWS.UUIDs
"""
associate_license(license_type, workspace_id)
associate_license(license_type, workspace_id, params::Dict{String,<:Any})
Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use ENTERPRISE
for the licenseType, and pass in a valid Grafana Labs token for the grafanaToken. Upgrading
to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace
to Grafana Enterprise.
# Arguments
- `license_type`: The type of license to associate with the workspace. Amazon Managed
Grafana workspaces no longer support Grafana Enterprise free trials.
- `workspace_id`: The ID of the workspace to associate the license with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Grafana-Token"`: A token from Grafana Labs that ties your Amazon Web Services account
with a Grafana Labs account. For more information, see Link your account with Grafana Labs.
"""
function associate_license(
licenseType, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"POST",
"/workspaces/$(workspaceId)/licenses/$(licenseType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_license(
licenseType,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"POST",
"/workspaces/$(workspaceId)/licenses/$(licenseType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workspace(account_access_type, authentication_providers, permission_type)
create_workspace(account_access_type, authentication_providers, permission_type, params::Dict{String,<:Any})
Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations
to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any
hardware to run the Grafana server. Don't use CreateWorkspace to modify an existing
workspace. Instead, use UpdateWorkspace.
# Arguments
- `account_access_type`: Specifies whether the workspace can access Amazon Web Services
resources in this Amazon Web Services account only, or whether it can also access Amazon
Web Services resources in other accounts in the same organization. If you specify
ORGANIZATION, you must specify which organizational units the workspace can access in the
workspaceOrganizationalUnits parameter.
- `authentication_providers`: Specifies whether this workspace uses SAML 2.0, IAM Identity
Center, or both to authenticate users for using the Grafana console within a workspace. For
more information, see User authentication in Amazon Managed Grafana.
- `permission_type`: When creating a workspace through the Amazon Web Services API, CLI or
Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions
that the workspace needs to use Amazon Web Services data sources and notification channels.
You must also specify a workspaceRoleArn for a role that you will manage for the workspace
to use when accessing those datasources and notification channels. The ability for Amazon
Managed Grafana to create and update IAM roles on behalf of the user is supported only in
the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED. Use
only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or
Amazon Web Services CloudFormation. For more information, see Amazon Managed Grafana
permissions and policies for Amazon Web Services data sources and notification channels.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A unique, case-sensitive, user-provided identifier to ensure the
idempotency of the request.
- `"configuration"`: The configuration string for the workspace that you create. For more
information about the format and configuration options available, see Working in your
Grafana workspace.
- `"grafanaVersion"`: Specifies the version of Grafana to support in the new workspace. If
not specified, defaults to the latest version (for example, 10.4). To get a list of
supported versions, use the ListVersions operation.
- `"networkAccessControl"`: Configuration for network access to your workspace. When this
is configured, only listed IP addresses and VPC endpoints will be able to access your
workspace. Standard Grafana authentication and authorization will still be required. If
this is not configured, or is removed, then all IP addresses and VPC endpoints will be
allowed. Standard Grafana authentication and authorization will still be required.
- `"organizationRoleName"`: The name of an IAM role that already exists to use with
Organizations to access Amazon Web Services data sources and notification channels in other
accounts in an organization.
- `"stackSetName"`: The name of the CloudFormation stack set to use to generate IAM roles
to be used for this workspace.
- `"tags"`: The list of tags associated with the workspace.
- `"vpcConfiguration"`: The configuration settings for an Amazon VPC that contains data
sources for your Grafana workspace to connect to. Connecting to a private VPC is not yet
available in the Asia Pacific (Seoul) Region (ap-northeast-2).
- `"workspaceDataSources"`: This parameter is for internal use only, and should not be used.
- `"workspaceDescription"`: A description for the workspace. This is used only to help you
identify this workspace. Pattern: ^[p{L}p{Z}p{N}p{P}]{0,2048}
- `"workspaceName"`: The name for the workspace. It does not have to be unique.
- `"workspaceNotificationDestinations"`: Specify the Amazon Web Services notification
channels that you plan to use in this workspace. Specifying these data sources here enables
Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed
Grafana to use these channels.
- `"workspaceOrganizationalUnits"`: Specifies the organizational units that this workspace
is allowed to use data sources from, if this workspace is in an account that is part of an
organization.
- `"workspaceRoleArn"`: Specified the IAM role that grants permissions to the Amazon Web
Services resources that the workspace will view data from, including both data sources and
notification channels. You are responsible for managing the permissions for this role as
new data sources or notification channels are added.
"""
function create_workspace(
accountAccessType,
authenticationProviders,
permissionType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"POST",
"/workspaces",
Dict{String,Any}(
"accountAccessType" => accountAccessType,
"authenticationProviders" => authenticationProviders,
"permissionType" => permissionType,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workspace(
accountAccessType,
authenticationProviders,
permissionType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"POST",
"/workspaces",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"accountAccessType" => accountAccessType,
"authenticationProviders" => authenticationProviders,
"permissionType" => permissionType,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workspace_api_key(key_name, key_role, seconds_to_live, workspace_id)
create_workspace_api_key(key_name, key_role, seconds_to_live, workspace_id, params::Dict{String,<:Any})
Creates a Grafana API key for the workspace. This key can be used to authenticate requests
sent to the workspace's HTTP API. See
https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available
APIs and example requests. In workspaces compatible with Grafana version 9 or above, use
workspace service accounts instead of API keys. API keys will be removed in a future
release.
# Arguments
- `key_name`: Specifies the name of the key. Keynames must be unique to the workspace.
- `key_role`: Specifies the permission level of the key. Valid values: ADMIN|EDITOR|VIEWER
- `seconds_to_live`: Specifies the time in seconds until the key expires. Keys can be valid
for up to 30 days.
- `workspace_id`: The ID of the workspace to create an API key.
"""
function create_workspace_api_key(
keyName,
keyRole,
secondsToLive,
workspaceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"POST",
"/workspaces/$(workspaceId)/apikeys",
Dict{String,Any}(
"keyName" => keyName, "keyRole" => keyRole, "secondsToLive" => secondsToLive
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workspace_api_key(
keyName,
keyRole,
secondsToLive,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"POST",
"/workspaces/$(workspaceId)/apikeys",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"keyName" => keyName,
"keyRole" => keyRole,
"secondsToLive" => secondsToLive,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workspace_service_account(grafana_role, name, workspace_id)
create_workspace_service_account(grafana_role, name, workspace_id, params::Dict{String,<:Any})
Creates a service account for the workspace. A service account can be used to call Grafana
HTTP APIs, and run automated workloads. After creating the service account with the correct
GrafanaRole for your use case, use CreateWorkspaceServiceAccountToken to create a token
that can be used to authenticate and authorize Grafana HTTP API calls. You can only create
service accounts for workspaces that are compatible with Grafana version 9 and above. For
more information about service accounts, see Service accounts in the Amazon Managed Grafana
User Guide. For more information about the Grafana HTTP APIs, see Using Grafana HTTP APIs
in the Amazon Managed Grafana User Guide.
# Arguments
- `grafana_role`: The permission level to use for this service account. For more
information about the roles and the permissions each has, see User roles in the Amazon
Managed Grafana User Guide.
- `name`: A name for the service account. The name must be unique within the workspace, as
it determines the ID associated with the service account.
- `workspace_id`: The ID of the workspace within which to create the service account.
"""
function create_workspace_service_account(
grafanaRole, name, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"POST",
"/workspaces/$(workspaceId)/serviceaccounts",
Dict{String,Any}("grafanaRole" => grafanaRole, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workspace_service_account(
grafanaRole,
name,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"POST",
"/workspaces/$(workspaceId)/serviceaccounts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("grafanaRole" => grafanaRole, "name" => name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workspace_service_account_token(name, seconds_to_live, service_account_id, workspace_id)
create_workspace_service_account_token(name, seconds_to_live, service_account_id, workspace_id, params::Dict{String,<:Any})
Creates a token that can be used to authenticate and authorize Grafana HTTP API operations
for the given workspace service account. The service account acts as a user for the API
operations, and defines the permissions that are used by the API. When you create the
service account token, you will receive a key that is used when calling Grafana APIs. Do
not lose this key, as it will not be retrievable again. If you do lose the key, you can
delete the token and recreate it to receive a new key. This will disable the initial key.
Service accounts are only available for workspaces that are compatible with Grafana version
9 and above.
# Arguments
- `name`: A name for the token to create.
- `seconds_to_live`: Sets how long the token will be valid, in seconds. You can set the
time up to 30 days in the future.
- `service_account_id`: The ID of the service account for which to create a token.
- `workspace_id`: The ID of the workspace the service account resides within.
"""
function create_workspace_service_account_token(
name,
secondsToLive,
serviceAccountId,
workspaceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"POST",
"/workspaces/$(workspaceId)/serviceaccounts/$(serviceAccountId)/tokens",
Dict{String,Any}("name" => name, "secondsToLive" => secondsToLive);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workspace_service_account_token(
name,
secondsToLive,
serviceAccountId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"POST",
"/workspaces/$(workspaceId)/serviceaccounts/$(serviceAccountId)/tokens",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("name" => name, "secondsToLive" => secondsToLive),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workspace(workspace_id)
delete_workspace(workspace_id, params::Dict{String,<:Any})
Deletes an Amazon Managed Grafana workspace.
# Arguments
- `workspace_id`: The ID of the workspace to delete.
"""
function delete_workspace(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return grafana(
"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 grafana(
"DELETE",
"/workspaces/$(workspaceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workspace_api_key(key_name, workspace_id)
delete_workspace_api_key(key_name, workspace_id, params::Dict{String,<:Any})
Deletes a Grafana API key for the workspace. In workspaces compatible with Grafana version
9 or above, use workspace service accounts instead of API keys. API keys will be removed in
a future release.
# Arguments
- `key_name`: The name of the API key to delete.
- `workspace_id`: The ID of the workspace to delete.
"""
function delete_workspace_api_key(
keyName, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"DELETE",
"/workspaces/$(workspaceId)/apikeys/$(keyName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workspace_api_key(
keyName,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"DELETE",
"/workspaces/$(workspaceId)/apikeys/$(keyName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workspace_service_account(service_account_id, workspace_id)
delete_workspace_service_account(service_account_id, workspace_id, params::Dict{String,<:Any})
Deletes a workspace service account from the workspace. This will delete any tokens created
for the service account, as well. If the tokens are currently in use, the will fail to
authenticate / authorize after they are deleted. Service accounts are only available for
workspaces that are compatible with Grafana version 9 and above.
# Arguments
- `service_account_id`: The ID of the service account to delete.
- `workspace_id`: The ID of the workspace where the service account resides.
"""
function delete_workspace_service_account(
serviceAccountId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"DELETE",
"/workspaces/$(workspaceId)/serviceaccounts/$(serviceAccountId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workspace_service_account(
serviceAccountId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"DELETE",
"/workspaces/$(workspaceId)/serviceaccounts/$(serviceAccountId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workspace_service_account_token(service_account_id, token_id, workspace_id)
delete_workspace_service_account_token(service_account_id, token_id, workspace_id, params::Dict{String,<:Any})
Deletes a token for the workspace service account. This will disable the key associated
with the token. If any automation is currently using the key, it will no longer be
authenticated or authorized to perform actions with the Grafana HTTP APIs. Service accounts
are only available for workspaces that are compatible with Grafana version 9 and above.
# Arguments
- `service_account_id`: The ID of the service account from which to delete the token.
- `token_id`: The ID of the token to delete.
- `workspace_id`: The ID of the workspace from which to delete the token.
"""
function delete_workspace_service_account_token(
serviceAccountId,
tokenId,
workspaceId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"DELETE",
"/workspaces/$(workspaceId)/serviceaccounts/$(serviceAccountId)/tokens/$(tokenId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workspace_service_account_token(
serviceAccountId,
tokenId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"DELETE",
"/workspaces/$(workspaceId)/serviceaccounts/$(serviceAccountId)/tokens/$(tokenId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_workspace(workspace_id)
describe_workspace(workspace_id, params::Dict{String,<:Any})
Displays information about one Amazon Managed Grafana workspace.
# Arguments
- `workspace_id`: The ID of the workspace to display information about.
"""
function describe_workspace(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return grafana(
"GET",
"/workspaces/$(workspaceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_workspace(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"GET",
"/workspaces/$(workspaceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_workspace_authentication(workspace_id)
describe_workspace_authentication(workspace_id, params::Dict{String,<:Any})
Displays information about the authentication methods used in one Amazon Managed Grafana
workspace.
# Arguments
- `workspace_id`: The ID of the workspace to return authentication information about.
"""
function describe_workspace_authentication(
workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"GET",
"/workspaces/$(workspaceId)/authentication";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_workspace_authentication(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"GET",
"/workspaces/$(workspaceId)/authentication",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_workspace_configuration(workspace_id)
describe_workspace_configuration(workspace_id, params::Dict{String,<:Any})
Gets the current configuration string for the given workspace.
# Arguments
- `workspace_id`: The ID of the workspace to get configuration information for.
"""
function describe_workspace_configuration(
workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"GET",
"/workspaces/$(workspaceId)/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_workspace_configuration(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"GET",
"/workspaces/$(workspaceId)/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_license(license_type, workspace_id)
disassociate_license(license_type, workspace_id, params::Dict{String,<:Any})
Removes the Grafana Enterprise license from a workspace.
# Arguments
- `license_type`: The type of license to remove from the workspace.
- `workspace_id`: The ID of the workspace to remove the Grafana Enterprise license from.
"""
function disassociate_license(
licenseType, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"DELETE",
"/workspaces/$(workspaceId)/licenses/$(licenseType)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_license(
licenseType,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"DELETE",
"/workspaces/$(workspaceId)/licenses/$(licenseType)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_permissions(workspace_id)
list_permissions(workspace_id, params::Dict{String,<:Any})
Lists the users and groups who have the Grafana Admin and Editor roles in this workspace.
If you use this operation without specifying userId or groupId, the operation returns the
roles of all users and groups. If you specify a userId or a groupId, only the roles for
that user or group are returned. If you do this, you can specify only one userId or one
groupId.
# Arguments
- `workspace_id`: The ID of the workspace to list permissions for. This parameter is
required.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"groupId"`: (Optional) Limits the results to only the group that matches this ID.
- `"maxResults"`: The maximum number of results to include in the response.
- `"nextToken"`: The token to use when requesting the next set of results. You received
this token from a previous ListPermissions operation.
- `"userId"`: (Optional) Limits the results to only the user that matches this ID.
- `"userType"`: (Optional) If you specify SSO_USER, then only the permissions of IAM
Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM
Identity Center groups are returned.
"""
function list_permissions(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return grafana(
"GET",
"/workspaces/$(workspaceId)/permissions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_permissions(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"GET",
"/workspaces/$(workspaceId)/permissions",
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})
The ListTagsForResource operation returns the tags that are associated with the Amazon
Managed Service for Grafana resource specified by the resourceArn. Currently, the only
resource that can be tagged is a workspace.
# Arguments
- `resource_arn`: The ARN of the resource the list of tags are associated with.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"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 grafana(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_versions()
list_versions(params::Dict{String,<:Any})
Lists available versions of Grafana. These are available when calling CreateWorkspace.
Optionally, include a workspace to list the versions to which it can be upgraded.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to include in the response.
- `"nextToken"`: The token to use when requesting the next set of results. You receive this
token from a previous ListVersions operation.
- `"workspace-id"`: The ID of the workspace to list the available upgrade versions. If not
included, lists all versions of Grafana that are supported for CreateWorkspace.
"""
function list_versions(; aws_config::AbstractAWSConfig=global_aws_config())
return grafana(
"GET", "/versions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_versions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"GET", "/versions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_workspace_service_account_tokens(service_account_id, workspace_id)
list_workspace_service_account_tokens(service_account_id, workspace_id, params::Dict{String,<:Any})
Returns a list of tokens for a workspace service account. This does not return the key for
each token. You cannot access keys after they are created. To create a new key, delete the
token and recreate it. Service accounts are only available for workspaces that are
compatible with Grafana version 9 and above.
# Arguments
- `service_account_id`: The ID of the service account for which to return tokens.
- `workspace_id`: The ID of the workspace for which to return tokens.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of tokens to include in the results.
- `"nextToken"`: The token for the next set of service accounts to return. (You receive
this token from a previous ListWorkspaceServiceAccountTokens operation.)
"""
function list_workspace_service_account_tokens(
serviceAccountId, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"GET",
"/workspaces/$(workspaceId)/serviceaccounts/$(serviceAccountId)/tokens";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workspace_service_account_tokens(
serviceAccountId,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"GET",
"/workspaces/$(workspaceId)/serviceaccounts/$(serviceAccountId)/tokens",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workspace_service_accounts(workspace_id)
list_workspace_service_accounts(workspace_id, params::Dict{String,<:Any})
Returns a list of service accounts for a workspace. Service accounts are only available for
workspaces that are compatible with Grafana version 9 and above.
# Arguments
- `workspace_id`: The workspace for which to list service accounts.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of service accounts to include in the results.
- `"nextToken"`: The token for the next set of service accounts to return. (You receive
this token from a previous ListWorkspaceServiceAccounts operation.)
"""
function list_workspace_service_accounts(
workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"GET",
"/workspaces/$(workspaceId)/serviceaccounts";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workspace_service_accounts(
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"GET",
"/workspaces/$(workspaceId)/serviceaccounts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workspaces()
list_workspaces(params::Dict{String,<:Any})
Returns a list of Amazon Managed Grafana workspaces in the account, with some information
about each workspace. For more complete information about one workspace, use
DescribeWorkspace.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of workspaces to include in the results.
- `"nextToken"`: The token for the next set of workspaces to return. (You receive this
token from a previous ListWorkspaces operation.)
"""
function list_workspaces(; aws_config::AbstractAWSConfig=global_aws_config())
return grafana(
"GET", "/workspaces"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_workspaces(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"GET", "/workspaces", 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 TagResource operation associates tags with an Amazon Managed Grafana resource.
Currently, the only resource that can be tagged is workspaces. 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 resource the tag is associated with.
- `tags`: The list of tag keys and values to associate with the resource. You can associate
tag keys only, tags (key and values) only or a combination of tag keys and tags.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return grafana(
"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 grafana(
"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 UntagResource operation removes the association of the tag with the Amazon Managed
Grafana resource.
# Arguments
- `resource_arn`: The ARN of the resource the tag association is removed from.
- `tag_keys`: The key values of the tag to be removed from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"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 grafana(
"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_permissions(update_instruction_batch, workspace_id)
update_permissions(update_instruction_batch, workspace_id, params::Dict{String,<:Any})
Updates which users in a workspace have the Grafana Admin or Editor roles.
# Arguments
- `update_instruction_batch`: An array of structures that contain the permission updates to
make.
- `workspace_id`: The ID of the workspace to update.
"""
function update_permissions(
updateInstructionBatch, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"PATCH",
"/workspaces/$(workspaceId)/permissions",
Dict{String,Any}("updateInstructionBatch" => updateInstructionBatch);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_permissions(
updateInstructionBatch,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"PATCH",
"/workspaces/$(workspaceId)/permissions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("updateInstructionBatch" => updateInstructionBatch),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workspace(workspace_id)
update_workspace(workspace_id, params::Dict{String,<:Any})
Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit
any optional parameters, the existing values of those parameters are not changed. To modify
the user authentication methods that the workspace uses, such as SAML or IAM Identity
Center, use UpdateWorkspaceAuthentication. To modify which users in the workspace have the
Admin and Editor Grafana roles, use UpdatePermissions.
# Arguments
- `workspace_id`: The ID of the workspace to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountAccessType"`: Specifies whether the workspace can access Amazon Web Services
resources in this Amazon Web Services account only, or whether it can also access Amazon
Web Services resources in other accounts in the same organization. If you specify
ORGANIZATION, you must specify which organizational units the workspace can access in the
workspaceOrganizationalUnits parameter.
- `"networkAccessControl"`: The configuration settings for network access to your
workspace. When this is configured, only listed IP addresses and VPC endpoints will be able
to access your workspace. Standard Grafana authentication and authorization will still be
required. If this is not configured, or is removed, then all IP addresses and VPC endpoints
will be allowed. Standard Grafana authentication and authorization will still be required.
- `"organizationRoleName"`: The name of an IAM role that already exists to use to access
resources through Organizations. This can only be used with a workspace that has the
permissionType set to CUSTOMER_MANAGED.
- `"permissionType"`: Use this parameter if you want to change a workspace from
SERVICE_MANAGED to CUSTOMER_MANAGED. This allows you to manage the permissions that the
workspace uses to access datasources and notification channels. If the workspace is in a
member Amazon Web Services account of an organization, and that account is not a delegated
administrator account, and you want the workspace to access data sources in other Amazon
Web Services accounts in the organization, you must choose CUSTOMER_MANAGED. If you specify
this as CUSTOMER_MANAGED, you must also specify a workspaceRoleArn that the workspace will
use for accessing Amazon Web Services resources. For more information on the role and
permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web
Services data sources and notification channels Do not use this to convert a
CUSTOMER_MANAGED workspace to SERVICE_MANAGED. Do not include this parameter if you want to
leave the workspace as SERVICE_MANAGED. You can convert a CUSTOMER_MANAGED workspace to
SERVICE_MANAGED using the Amazon Managed Grafana console. For more information, see
Managing permissions for data sources and notification channels.
- `"removeNetworkAccessConfiguration"`: Whether to remove the network access configuration
from the workspace. Setting this to true and providing a networkAccessControl to set will
return an error. If you remove this configuration by setting this to true, then all IP
addresses and VPC endpoints will be allowed. Standard Grafana authentication and
authorization will still be required.
- `"removeVpcConfiguration"`: Whether to remove the VPC configuration from the workspace.
Setting this to true and providing a vpcConfiguration to set will return an error.
- `"stackSetName"`: The name of the CloudFormation stack set to use to generate IAM roles
to be used for this workspace.
- `"vpcConfiguration"`: The configuration settings for an Amazon VPC that contains data
sources for your Grafana workspace to connect to.
- `"workspaceDataSources"`: This parameter is for internal use only, and should not be used.
- `"workspaceDescription"`: A description for the workspace. This is used only to help you
identify this workspace.
- `"workspaceName"`: A new name for the workspace to update.
- `"workspaceNotificationDestinations"`: Specify the Amazon Web Services notification
channels that you plan to use in this workspace. Specifying these data sources here enables
Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed
Grafana to use these channels.
- `"workspaceOrganizationalUnits"`: Specifies the organizational units that this workspace
is allowed to use data sources from, if this workspace is in an account that is part of an
organization.
- `"workspaceRoleArn"`: Specifies an IAM role that grants permissions to Amazon Web
Services resources that the workspace accesses, such as data sources and notification
channels. If this workspace has permissionType CUSTOMER_MANAGED, then this role is required.
"""
function update_workspace(workspaceId; aws_config::AbstractAWSConfig=global_aws_config())
return grafana(
"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 grafana(
"PUT",
"/workspaces/$(workspaceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workspace_authentication(authentication_providers, workspace_id)
update_workspace_authentication(authentication_providers, workspace_id, params::Dict{String,<:Any})
Use this operation to define the identity provider (IdP) that this workspace authenticates
users from, using SAML. You can also map SAML assertion attributes to workspace user
information and define which groups in the assertion attribute are to have the Admin and
Editor roles in the workspace. Changes to the authentication method for a workspace may
take a few minutes to take effect.
# Arguments
- `authentication_providers`: Specifies whether this workspace uses SAML 2.0, IAM Identity
Center, or both to authenticate users for using the Grafana console within a workspace. For
more information, see User authentication in Amazon Managed Grafana.
- `workspace_id`: The ID of the workspace to update the authentication for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"samlConfiguration"`: If the workspace uses SAML, use this structure to map SAML
assertion attributes to workspace user information and define which groups in the assertion
attribute are to have the Admin and Editor roles in the workspace.
"""
function update_workspace_authentication(
authenticationProviders, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"POST",
"/workspaces/$(workspaceId)/authentication",
Dict{String,Any}("authenticationProviders" => authenticationProviders);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workspace_authentication(
authenticationProviders,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"POST",
"/workspaces/$(workspaceId)/authentication",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("authenticationProviders" => authenticationProviders),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_workspace_configuration(configuration, workspace_id)
update_workspace_configuration(configuration, workspace_id, params::Dict{String,<:Any})
Updates the configuration string for the given workspace
# Arguments
- `configuration`: The new configuration string for the workspace. For more information
about the format and configuration options available, see Working in your Grafana workspace.
- `workspace_id`: The ID of the workspace to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"grafanaVersion"`: Specifies the version of Grafana to support in the workspace. If not
specified, keeps the current version of the workspace. Can only be used to upgrade (for
example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4). To know what
versions are available to upgrade to for a specific workspace, see the ListVersions
operation.
"""
function update_workspace_configuration(
configuration, workspaceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return grafana(
"PUT",
"/workspaces/$(workspaceId)/configuration",
Dict{String,Any}("configuration" => configuration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_workspace_configuration(
configuration,
workspaceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return grafana(
"PUT",
"/workspaces/$(workspaceId)/configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("configuration" => configuration), 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 | 106968 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: greengrass
using AWS.Compat
using AWS.UUIDs
"""
associate_role_to_group(group_id, role_arn)
associate_role_to_group(group_id, role_arn, params::Dict{String,<:Any})
Associates a role with a group. Your Greengrass core will use the role to access AWS cloud
services. The role's permissions should allow Greengrass core Lambda functions to perform
actions against the cloud.
# Arguments
- `group_id`: The ID of the Greengrass group.
- `role_arn`: The ARN of the role you wish to associate with this group. The existence of
the role is not validated.
"""
function associate_role_to_group(
GroupId, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/groups/$(GroupId)/role",
Dict{String,Any}("RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_role_to_group(
GroupId,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/groups/$(GroupId)/role",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RoleArn" => RoleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_service_role_to_account(role_arn)
associate_service_role_to_account(role_arn, params::Dict{String,<:Any})
Associates a role with your account. AWS IoT Greengrass will use the role to access your
Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The
role must have at least minimum permissions in the policy
''AWSGreengrassResourceAccessRolePolicy''.
# Arguments
- `role_arn`: The ARN of the service role you wish to associate with your account.
"""
function associate_service_role_to_account(
RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/servicerole",
Dict{String,Any}("RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_service_role_to_account(
RoleArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/servicerole",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RoleArn" => RoleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connector_definition()
create_connector_definition(params::Dict{String,<:Any})
Creates a connector definition. You may provide the initial version of the connector
definition now or use ''CreateConnectorDefinitionVersion'' at a later time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the connector definition.
- `"Name"`: The name of the connector definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_connector_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/connectors";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connector_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/connectors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connector_definition_version(connector_definition_id)
create_connector_definition_version(connector_definition_id, params::Dict{String,<:Any})
Creates a version of a connector definition which has already been defined.
# Arguments
- `connector_definition_id`: The ID of the connector definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Connectors"`: A list of references to connectors in this version, with their
corresponding configuration settings.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_connector_definition_version(
ConnectorDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connector_definition_version(
ConnectorDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_core_definition()
create_core_definition(params::Dict{String,<:Any})
Creates a core definition. You may provide the initial version of the core definition now
or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain
exactly one Greengrass core.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the core definition.
- `"Name"`: The name of the core definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_core_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/cores";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_core_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/cores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_core_definition_version(core_definition_id)
create_core_definition_version(core_definition_id, params::Dict{String,<:Any})
Creates a version of a core definition that has already been defined. Greengrass groups
must each contain exactly one Greengrass core.
# Arguments
- `core_definition_id`: The ID of the core definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Cores"`: A list of cores in the core definition version.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_core_definition_version(
CoreDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/cores/$(CoreDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_core_definition_version(
CoreDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/cores/$(CoreDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_deployment(deployment_type, group_id)
create_deployment(deployment_type, group_id, params::Dict{String,<:Any})
Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the
''X-Amzn-Client-Token'' token and the request parameters.
# Arguments
- `deployment_type`: The type of deployment. When used for ''CreateDeployment'', only
''NewDeployment'' and ''Redeployment'' are valid.
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeploymentId"`: The ID of the deployment if you wish to redeploy a previous deployment.
- `"GroupVersionId"`: The ID of the group version to be deployed.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_deployment(
DeploymentType, GroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/deployments",
Dict{String,Any}("DeploymentType" => DeploymentType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_deployment(
DeploymentType,
GroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/deployments",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DeploymentType" => DeploymentType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_device_definition()
create_device_definition(params::Dict{String,<:Any})
Creates a device definition. You may provide the initial version of the device definition
now or use ''CreateDeviceDefinitionVersion'' at a later time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the device definition.
- `"Name"`: The name of the device definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_device_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/devices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_device_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/devices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_device_definition_version(device_definition_id)
create_device_definition_version(device_definition_id, params::Dict{String,<:Any})
Creates a version of a device definition that has already been defined.
# Arguments
- `device_definition_id`: The ID of the device definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Devices"`: A list of devices in the definition version.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_device_definition_version(
DeviceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/devices/$(DeviceDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_device_definition_version(
DeviceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/devices/$(DeviceDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_function_definition()
create_function_definition(params::Dict{String,<:Any})
Creates a Lambda function definition which contains a list of Lambda functions and their
configurations to be used in a group. You can create an initial version of the definition
by providing a list of Lambda functions and their configurations now, or use
''CreateFunctionDefinitionVersion'' later.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the function definition.
- `"Name"`: The name of the function definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_function_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/functions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_function_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/functions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_function_definition_version(function_definition_id)
create_function_definition_version(function_definition_id, params::Dict{String,<:Any})
Creates a version of a Lambda function definition that has already been defined.
# Arguments
- `function_definition_id`: The ID of the Lambda function definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultConfig"`: The default configuration that applies to all Lambda functions in this
function definition version. Individual Lambda functions can override these settings.
- `"Functions"`: A list of Lambda functions in this function definition version.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_function_definition_version(
FunctionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/functions/$(FunctionDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_function_definition_version(
FunctionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/functions/$(FunctionDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group(name)
create_group(name, params::Dict{String,<:Any})
Creates a group. You may provide the initial version of the group or use
''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package
(https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line
application to create and deploy Greengrass groups.
# Arguments
- `name`: The name of the group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the group.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_group(Name; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/groups",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group_certificate_authority(group_id)
create_group_certificate_authority(group_id, params::Dict{String,<:Any})
Creates a CA for the group. If a CA already exists, it will rotate the existing CA.
# Arguments
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_group_certificate_authority(
GroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/certificateauthorities";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group_certificate_authority(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/certificateauthorities",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group_version(group_id)
create_group_version(group_id, params::Dict{String,<:Any})
Creates a version of a group which has already been defined.
# Arguments
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectorDefinitionVersionArn"`: The ARN of the connector definition version for this
group.
- `"CoreDefinitionVersionArn"`: The ARN of the core definition version for this group.
- `"DeviceDefinitionVersionArn"`: The ARN of the device definition version for this group.
- `"FunctionDefinitionVersionArn"`: The ARN of the function definition version for this
group.
- `"LoggerDefinitionVersionArn"`: The ARN of the logger definition version for this group.
- `"ResourceDefinitionVersionArn"`: The ARN of the resource definition version for this
group.
- `"SubscriptionDefinitionVersionArn"`: The ARN of the subscription definition version for
this group.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_group_version(GroupId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group_version(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_logger_definition()
create_logger_definition(params::Dict{String,<:Any})
Creates a logger definition. You may provide the initial version of the logger definition
now or use ''CreateLoggerDefinitionVersion'' at a later time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the logger definition.
- `"Name"`: The name of the logger definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_logger_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/loggers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_logger_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/loggers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_logger_definition_version(logger_definition_id)
create_logger_definition_version(logger_definition_id, params::Dict{String,<:Any})
Creates a version of a logger definition that has already been defined.
# Arguments
- `logger_definition_id`: The ID of the logger definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Loggers"`: A list of loggers.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_logger_definition_version(
LoggerDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/loggers/$(LoggerDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_logger_definition_version(
LoggerDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/loggers/$(LoggerDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resource_definition()
create_resource_definition(params::Dict{String,<:Any})
Creates a resource definition which contains a list of resources to be used in a group. You
can create an initial version of the definition by providing a list of resources now, or
use ''CreateResourceDefinitionVersion'' later.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the resource definition.
- `"Name"`: The name of the resource definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_resource_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resource_definition_version(resource_definition_id)
create_resource_definition_version(resource_definition_id, params::Dict{String,<:Any})
Creates a version of a resource definition that has already been defined.
# Arguments
- `resource_definition_id`: The ID of the resource definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Resources"`: A list of resources.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_resource_definition_version(
ResourceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/resources/$(ResourceDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_definition_version(
ResourceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/resources/$(ResourceDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_software_update_job(s3_url_signer_role, software_to_update, update_targets, update_targets_architecture, update_targets_operating_system)
create_software_update_job(s3_url_signer_role, software_to_update, update_targets, update_targets_architecture, update_targets_operating_system, params::Dict{String,<:Any})
Creates a software update for a core or group of cores (specified as an IoT thing group.)
Use this to update the OTA Agent as well as the Greengrass core software. It makes use of
the IoT Jobs feature which provides additional commands to manage a Greengrass core
software update job.
# Arguments
- `s3_url_signer_role`:
- `software_to_update`:
- `update_targets`:
- `update_targets_architecture`:
- `update_targets_operating_system`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UpdateAgentLogLevel"`:
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_software_update_job(
S3UrlSignerRole,
SoftwareToUpdate,
UpdateTargets,
UpdateTargetsArchitecture,
UpdateTargetsOperatingSystem;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/updates",
Dict{String,Any}(
"S3UrlSignerRole" => S3UrlSignerRole,
"SoftwareToUpdate" => SoftwareToUpdate,
"UpdateTargets" => UpdateTargets,
"UpdateTargetsArchitecture" => UpdateTargetsArchitecture,
"UpdateTargetsOperatingSystem" => UpdateTargetsOperatingSystem,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_software_update_job(
S3UrlSignerRole,
SoftwareToUpdate,
UpdateTargets,
UpdateTargetsArchitecture,
UpdateTargetsOperatingSystem,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/updates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"S3UrlSignerRole" => S3UrlSignerRole,
"SoftwareToUpdate" => SoftwareToUpdate,
"UpdateTargets" => UpdateTargets,
"UpdateTargetsArchitecture" => UpdateTargetsArchitecture,
"UpdateTargetsOperatingSystem" => UpdateTargetsOperatingSystem,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subscription_definition()
create_subscription_definition(params::Dict{String,<:Any})
Creates a subscription definition. You may provide the initial version of the subscription
definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the subscription definition.
- `"Name"`: The name of the subscription definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_subscription_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/subscriptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subscription_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/subscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subscription_definition_version(subscription_definition_id)
create_subscription_definition_version(subscription_definition_id, params::Dict{String,<:Any})
Creates a version of a subscription definition which has already been defined.
# Arguments
- `subscription_definition_id`: The ID of the subscription definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Subscriptions"`: A list of subscriptions.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_subscription_definition_version(
SubscriptionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subscription_definition_version(
SubscriptionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connector_definition(connector_definition_id)
delete_connector_definition(connector_definition_id, params::Dict{String,<:Any})
Deletes a connector definition.
# Arguments
- `connector_definition_id`: The ID of the connector definition.
"""
function delete_connector_definition(
ConnectorDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connector_definition(
ConnectorDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_core_definition(core_definition_id)
delete_core_definition(core_definition_id, params::Dict{String,<:Any})
Deletes a core definition.
# Arguments
- `core_definition_id`: The ID of the core definition.
"""
function delete_core_definition(
CoreDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/cores/$(CoreDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_core_definition(
CoreDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/cores/$(CoreDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_device_definition(device_definition_id)
delete_device_definition(device_definition_id, params::Dict{String,<:Any})
Deletes a device definition.
# Arguments
- `device_definition_id`: The ID of the device definition.
"""
function delete_device_definition(
DeviceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/devices/$(DeviceDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_device_definition(
DeviceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/devices/$(DeviceDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_function_definition(function_definition_id)
delete_function_definition(function_definition_id, params::Dict{String,<:Any})
Deletes a Lambda function definition.
# Arguments
- `function_definition_id`: The ID of the Lambda function definition.
"""
function delete_function_definition(
FunctionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/functions/$(FunctionDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_function_definition(
FunctionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/functions/$(FunctionDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group(group_id)
delete_group(group_id, params::Dict{String,<:Any})
Deletes a group.
# Arguments
- `group_id`: The ID of the Greengrass group.
"""
function delete_group(GroupId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"DELETE",
"/greengrass/groups/$(GroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/groups/$(GroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_logger_definition(logger_definition_id)
delete_logger_definition(logger_definition_id, params::Dict{String,<:Any})
Deletes a logger definition.
# Arguments
- `logger_definition_id`: The ID of the logger definition.
"""
function delete_logger_definition(
LoggerDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/loggers/$(LoggerDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_logger_definition(
LoggerDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/loggers/$(LoggerDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_resource_definition(resource_definition_id)
delete_resource_definition(resource_definition_id, params::Dict{String,<:Any})
Deletes a resource definition.
# Arguments
- `resource_definition_id`: The ID of the resource definition.
"""
function delete_resource_definition(
ResourceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/resources/$(ResourceDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_resource_definition(
ResourceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/resources/$(ResourceDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_subscription_definition(subscription_definition_id)
delete_subscription_definition(subscription_definition_id, params::Dict{String,<:Any})
Deletes a subscription definition.
# Arguments
- `subscription_definition_id`: The ID of the subscription definition.
"""
function delete_subscription_definition(
SubscriptionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_subscription_definition(
SubscriptionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_role_from_group(group_id)
disassociate_role_from_group(group_id, params::Dict{String,<:Any})
Disassociates the role from a group.
# Arguments
- `group_id`: The ID of the Greengrass group.
"""
function disassociate_role_from_group(
GroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/groups/$(GroupId)/role";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_role_from_group(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/groups/$(GroupId)/role",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_service_role_from_account()
disassociate_service_role_from_account(params::Dict{String,<:Any})
Disassociates the service role from your account. Without a service role, deployments will
not work.
"""
function disassociate_service_role_from_account(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/servicerole";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_service_role_from_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/servicerole",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_associated_role(group_id)
get_associated_role(group_id, params::Dict{String,<:Any})
Retrieves the role associated with a particular group.
# Arguments
- `group_id`: The ID of the Greengrass group.
"""
function get_associated_role(GroupId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/role";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_associated_role(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/role",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_bulk_deployment_status(bulk_deployment_id)
get_bulk_deployment_status(bulk_deployment_id, params::Dict{String,<:Any})
Returns the status of a bulk deployment.
# Arguments
- `bulk_deployment_id`: The ID of the bulk deployment.
"""
function get_bulk_deployment_status(
BulkDeploymentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/bulk/deployments/$(BulkDeploymentId)/status";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_bulk_deployment_status(
BulkDeploymentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/bulk/deployments/$(BulkDeploymentId)/status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connectivity_info(thing_name)
get_connectivity_info(thing_name, params::Dict{String,<:Any})
Retrieves the connectivity information for a core.
# Arguments
- `thing_name`: The thing name.
"""
function get_connectivity_info(ThingName; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/things/$(ThingName)/connectivityInfo";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connectivity_info(
ThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/things/$(ThingName)/connectivityInfo",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connector_definition(connector_definition_id)
get_connector_definition(connector_definition_id, params::Dict{String,<:Any})
Retrieves information about a connector definition.
# Arguments
- `connector_definition_id`: The ID of the connector definition.
"""
function get_connector_definition(
ConnectorDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connector_definition(
ConnectorDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connector_definition_version(connector_definition_id, connector_definition_version_id)
get_connector_definition_version(connector_definition_id, connector_definition_version_id, params::Dict{String,<:Any})
Retrieves information about a connector definition version, including the connectors that
the version contains. Connectors are prebuilt modules that interact with local
infrastructure, device protocols, AWS, and other cloud services.
# Arguments
- `connector_definition_id`: The ID of the connector definition.
- `connector_definition_version_id`: The ID of the connector definition version. This value
maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which
is returned by ''ListConnectorDefinitionVersions'' requests. If the version is the last one
that was associated with a connector definition, the value also maps to the
''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
# 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
additional results.
"""
function get_connector_definition_version(
ConnectorDefinitionId,
ConnectorDefinitionVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)/versions/$(ConnectorDefinitionVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connector_definition_version(
ConnectorDefinitionId,
ConnectorDefinitionVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)/versions/$(ConnectorDefinitionVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_core_definition(core_definition_id)
get_core_definition(core_definition_id, params::Dict{String,<:Any})
Retrieves information about a core definition version.
# Arguments
- `core_definition_id`: The ID of the core definition.
"""
function get_core_definition(
CoreDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/cores/$(CoreDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_core_definition(
CoreDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/cores/$(CoreDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_core_definition_version(core_definition_id, core_definition_version_id)
get_core_definition_version(core_definition_id, core_definition_version_id, params::Dict{String,<:Any})
Retrieves information about a core definition version.
# Arguments
- `core_definition_id`: The ID of the core definition.
- `core_definition_version_id`: The ID of the core definition version. This value maps to
the ''Version'' property of the corresponding ''VersionInformation'' object, which is
returned by ''ListCoreDefinitionVersions'' requests. If the version is the last one that
was associated with a core definition, the value also maps to the ''LatestVersion''
property of the corresponding ''DefinitionInformation'' object.
"""
function get_core_definition_version(
CoreDefinitionId,
CoreDefinitionVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/cores/$(CoreDefinitionId)/versions/$(CoreDefinitionVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_core_definition_version(
CoreDefinitionId,
CoreDefinitionVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/cores/$(CoreDefinitionId)/versions/$(CoreDefinitionVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deployment_status(deployment_id, group_id)
get_deployment_status(deployment_id, group_id, params::Dict{String,<:Any})
Returns the status of a deployment.
# Arguments
- `deployment_id`: The ID of the deployment.
- `group_id`: The ID of the Greengrass group.
"""
function get_deployment_status(
DeploymentId, GroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/deployments/$(DeploymentId)/status";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_deployment_status(
DeploymentId,
GroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/deployments/$(DeploymentId)/status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_definition(device_definition_id)
get_device_definition(device_definition_id, params::Dict{String,<:Any})
Retrieves information about a device definition.
# Arguments
- `device_definition_id`: The ID of the device definition.
"""
function get_device_definition(
DeviceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/devices/$(DeviceDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_definition(
DeviceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/devices/$(DeviceDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_definition_version(device_definition_id, device_definition_version_id)
get_device_definition_version(device_definition_id, device_definition_version_id, params::Dict{String,<:Any})
Retrieves information about a device definition version.
# Arguments
- `device_definition_id`: The ID of the device definition.
- `device_definition_version_id`: The ID of the device definition version. This value maps
to the ''Version'' property of the corresponding ''VersionInformation'' object, which is
returned by ''ListDeviceDefinitionVersions'' requests. If the version is the last one that
was associated with a device definition, the value also maps to the ''LatestVersion''
property of the corresponding ''DefinitionInformation'' object.
# 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
additional results.
"""
function get_device_definition_version(
DeviceDefinitionId,
DeviceDefinitionVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/devices/$(DeviceDefinitionId)/versions/$(DeviceDefinitionVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_definition_version(
DeviceDefinitionId,
DeviceDefinitionVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/devices/$(DeviceDefinitionId)/versions/$(DeviceDefinitionVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_function_definition(function_definition_id)
get_function_definition(function_definition_id, params::Dict{String,<:Any})
Retrieves information about a Lambda function definition, including its creation time and
latest version.
# Arguments
- `function_definition_id`: The ID of the Lambda function definition.
"""
function get_function_definition(
FunctionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/functions/$(FunctionDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_function_definition(
FunctionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/functions/$(FunctionDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_function_definition_version(function_definition_id, function_definition_version_id)
get_function_definition_version(function_definition_id, function_definition_version_id, params::Dict{String,<:Any})
Retrieves information about a Lambda function definition version, including which Lambda
functions are included in the version and their configurations.
# Arguments
- `function_definition_id`: The ID of the Lambda function definition.
- `function_definition_version_id`: The ID of the function definition version. This value
maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which
is returned by ''ListFunctionDefinitionVersions'' requests. If the version is the last one
that was associated with a function definition, the value also maps to the
''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
# 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
additional results.
"""
function get_function_definition_version(
FunctionDefinitionId,
FunctionDefinitionVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/functions/$(FunctionDefinitionId)/versions/$(FunctionDefinitionVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_function_definition_version(
FunctionDefinitionId,
FunctionDefinitionVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/functions/$(FunctionDefinitionId)/versions/$(FunctionDefinitionVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group(group_id)
get_group(group_id, params::Dict{String,<:Any})
Retrieves information about a group.
# Arguments
- `group_id`: The ID of the Greengrass group.
"""
function get_group(GroupId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group_certificate_authority(certificate_authority_id, group_id)
get_group_certificate_authority(certificate_authority_id, group_id, params::Dict{String,<:Any})
Retreives the CA associated with a group. Returns the public key of the CA.
# Arguments
- `certificate_authority_id`: The ID of the certificate authority.
- `group_id`: The ID of the Greengrass group.
"""
function get_group_certificate_authority(
CertificateAuthorityId, GroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/certificateauthorities/$(CertificateAuthorityId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group_certificate_authority(
CertificateAuthorityId,
GroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/certificateauthorities/$(CertificateAuthorityId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group_certificate_configuration(group_id)
get_group_certificate_configuration(group_id, params::Dict{String,<:Any})
Retrieves the current configuration for the CA used by the group.
# Arguments
- `group_id`: The ID of the Greengrass group.
"""
function get_group_certificate_configuration(
GroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/certificateauthorities/configuration/expiry";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group_certificate_configuration(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/certificateauthorities/configuration/expiry",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group_version(group_id, group_version_id)
get_group_version(group_id, group_version_id, params::Dict{String,<:Any})
Retrieves information about a group version.
# Arguments
- `group_id`: The ID of the Greengrass group.
- `group_version_id`: The ID of the group version. This value maps to the ''Version''
property of the corresponding ''VersionInformation'' object, which is returned by
''ListGroupVersions'' requests. If the version is the last one that was associated with a
group, the value also maps to the ''LatestVersion'' property of the corresponding
''GroupInformation'' object.
"""
function get_group_version(
GroupId, GroupVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/versions/$(GroupVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group_version(
GroupId,
GroupVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/versions/$(GroupVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_logger_definition(logger_definition_id)
get_logger_definition(logger_definition_id, params::Dict{String,<:Any})
Retrieves information about a logger definition.
# Arguments
- `logger_definition_id`: The ID of the logger definition.
"""
function get_logger_definition(
LoggerDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/loggers/$(LoggerDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_logger_definition(
LoggerDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/loggers/$(LoggerDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_logger_definition_version(logger_definition_id, logger_definition_version_id)
get_logger_definition_version(logger_definition_id, logger_definition_version_id, params::Dict{String,<:Any})
Retrieves information about a logger definition version.
# Arguments
- `logger_definition_id`: The ID of the logger definition.
- `logger_definition_version_id`: The ID of the logger definition version. This value maps
to the ''Version'' property of the corresponding ''VersionInformation'' object, which is
returned by ''ListLoggerDefinitionVersions'' requests. If the version is the last one that
was associated with a logger definition, the value also maps to the ''LatestVersion''
property of the corresponding ''DefinitionInformation'' object.
# 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
additional results.
"""
function get_logger_definition_version(
LoggerDefinitionId,
LoggerDefinitionVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/loggers/$(LoggerDefinitionId)/versions/$(LoggerDefinitionVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_logger_definition_version(
LoggerDefinitionId,
LoggerDefinitionVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/loggers/$(LoggerDefinitionId)/versions/$(LoggerDefinitionVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_definition(resource_definition_id)
get_resource_definition(resource_definition_id, params::Dict{String,<:Any})
Retrieves information about a resource definition, including its creation time and latest
version.
# Arguments
- `resource_definition_id`: The ID of the resource definition.
"""
function get_resource_definition(
ResourceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/resources/$(ResourceDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_definition(
ResourceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/resources/$(ResourceDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_definition_version(resource_definition_id, resource_definition_version_id)
get_resource_definition_version(resource_definition_id, resource_definition_version_id, params::Dict{String,<:Any})
Retrieves information about a resource definition version, including which resources are
included in the version.
# Arguments
- `resource_definition_id`: The ID of the resource definition.
- `resource_definition_version_id`: The ID of the resource definition version. This value
maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which
is returned by ''ListResourceDefinitionVersions'' requests. If the version is the last one
that was associated with a resource definition, the value also maps to the
''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
"""
function get_resource_definition_version(
ResourceDefinitionId,
ResourceDefinitionVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/resources/$(ResourceDefinitionId)/versions/$(ResourceDefinitionVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_definition_version(
ResourceDefinitionId,
ResourceDefinitionVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/resources/$(ResourceDefinitionId)/versions/$(ResourceDefinitionVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_role_for_account()
get_service_role_for_account(params::Dict{String,<:Any})
Retrieves the service role that is attached to your account.
"""
function get_service_role_for_account(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/servicerole";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_role_for_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/servicerole",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subscription_definition(subscription_definition_id)
get_subscription_definition(subscription_definition_id, params::Dict{String,<:Any})
Retrieves information about a subscription definition.
# Arguments
- `subscription_definition_id`: The ID of the subscription definition.
"""
function get_subscription_definition(
SubscriptionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_subscription_definition(
SubscriptionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_subscription_definition_version(subscription_definition_id, subscription_definition_version_id)
get_subscription_definition_version(subscription_definition_id, subscription_definition_version_id, params::Dict{String,<:Any})
Retrieves information about a subscription definition version.
# Arguments
- `subscription_definition_id`: The ID of the subscription definition.
- `subscription_definition_version_id`: The ID of the subscription definition version. This
value maps to the ''Version'' property of the corresponding ''VersionInformation'' object,
which is returned by ''ListSubscriptionDefinitionVersions'' requests. If the version is the
last one that was associated with a subscription definition, the value also maps to the
''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
# 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
additional results.
"""
function get_subscription_definition_version(
SubscriptionDefinitionId,
SubscriptionDefinitionVersionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)/versions/$(SubscriptionDefinitionVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_subscription_definition_version(
SubscriptionDefinitionId,
SubscriptionDefinitionVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)/versions/$(SubscriptionDefinitionVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_thing_runtime_configuration(thing_name)
get_thing_runtime_configuration(thing_name, params::Dict{String,<:Any})
Get the runtime configuration of a thing.
# Arguments
- `thing_name`: The thing name.
"""
function get_thing_runtime_configuration(
ThingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/things/$(ThingName)/runtimeconfig";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_thing_runtime_configuration(
ThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/things/$(ThingName)/runtimeconfig",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bulk_deployment_detailed_reports(bulk_deployment_id)
list_bulk_deployment_detailed_reports(bulk_deployment_id, params::Dict{String,<:Any})
Gets a paginated list of the deployments that have been started in a bulk deployment
operation, and their current deployment status.
# Arguments
- `bulk_deployment_id`: The ID of the bulk deployment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_bulk_deployment_detailed_reports(
BulkDeploymentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/bulk/deployments/$(BulkDeploymentId)/detailed-reports";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bulk_deployment_detailed_reports(
BulkDeploymentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/bulk/deployments/$(BulkDeploymentId)/detailed-reports",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_bulk_deployments()
list_bulk_deployments(params::Dict{String,<:Any})
Returns a list of bulk deployments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_bulk_deployments(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/bulk/deployments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_bulk_deployments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/bulk/deployments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_connector_definition_versions(connector_definition_id)
list_connector_definition_versions(connector_definition_id, params::Dict{String,<:Any})
Lists the versions of a connector definition, which are containers for connectors.
Connectors run on the Greengrass core and contain built-in integration with local
infrastructure, device protocols, AWS, and other cloud services.
# Arguments
- `connector_definition_id`: The ID of the connector definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_connector_definition_versions(
ConnectorDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_connector_definition_versions(
ConnectorDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_connector_definitions()
list_connector_definitions(params::Dict{String,<:Any})
Retrieves a list of connector definitions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_connector_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/definition/connectors";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_connector_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/connectors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_core_definition_versions(core_definition_id)
list_core_definition_versions(core_definition_id, params::Dict{String,<:Any})
Lists the versions of a core definition.
# Arguments
- `core_definition_id`: The ID of the core definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_core_definition_versions(
CoreDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/cores/$(CoreDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_core_definition_versions(
CoreDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/cores/$(CoreDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_core_definitions()
list_core_definitions(params::Dict{String,<:Any})
Retrieves a list of core definitions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_core_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/definition/cores";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_core_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/cores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_deployments(group_id)
list_deployments(group_id, params::Dict{String,<:Any})
Returns a history of deployments for the group.
# Arguments
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_deployments(GroupId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/deployments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_deployments(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/deployments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_device_definition_versions(device_definition_id)
list_device_definition_versions(device_definition_id, params::Dict{String,<:Any})
Lists the versions of a device definition.
# Arguments
- `device_definition_id`: The ID of the device definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_device_definition_versions(
DeviceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/devices/$(DeviceDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_device_definition_versions(
DeviceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/devices/$(DeviceDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_device_definitions()
list_device_definitions(params::Dict{String,<:Any})
Retrieves a list of device definitions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_device_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/definition/devices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_device_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/devices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_function_definition_versions(function_definition_id)
list_function_definition_versions(function_definition_id, params::Dict{String,<:Any})
Lists the versions of a Lambda function definition.
# Arguments
- `function_definition_id`: The ID of the Lambda function definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_function_definition_versions(
FunctionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/functions/$(FunctionDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_function_definition_versions(
FunctionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/functions/$(FunctionDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_function_definitions()
list_function_definitions(params::Dict{String,<:Any})
Retrieves a list of Lambda function definitions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_function_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/definition/functions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_function_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/functions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_group_certificate_authorities(group_id)
list_group_certificate_authorities(group_id, params::Dict{String,<:Any})
Retrieves the current CAs for a group.
# Arguments
- `group_id`: The ID of the Greengrass group.
"""
function list_group_certificate_authorities(
GroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/certificateauthorities";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_group_certificate_authorities(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/certificateauthorities",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_group_versions(group_id)
list_group_versions(group_id, params::Dict{String,<:Any})
Lists the versions of a group.
# Arguments
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_group_versions(GroupId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_group_versions(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups/$(GroupId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_groups()
list_groups(params::Dict{String,<:Any})
Retrieves a list of groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET", "/greengrass/groups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_logger_definition_versions(logger_definition_id)
list_logger_definition_versions(logger_definition_id, params::Dict{String,<:Any})
Lists the versions of a logger definition.
# Arguments
- `logger_definition_id`: The ID of the logger definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_logger_definition_versions(
LoggerDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/loggers/$(LoggerDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_logger_definition_versions(
LoggerDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/loggers/$(LoggerDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_logger_definitions()
list_logger_definitions(params::Dict{String,<:Any})
Retrieves a list of logger definitions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_logger_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/definition/loggers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_logger_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/loggers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_definition_versions(resource_definition_id)
list_resource_definition_versions(resource_definition_id, params::Dict{String,<:Any})
Lists the versions of a resource definition.
# Arguments
- `resource_definition_id`: The ID of the resource definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_resource_definition_versions(
ResourceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/resources/$(ResourceDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resource_definition_versions(
ResourceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/resources/$(ResourceDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_resource_definitions()
list_resource_definitions(params::Dict{String,<:Any})
Retrieves a list of resource definitions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_resource_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/definition/resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_resource_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscription_definition_versions(subscription_definition_id)
list_subscription_definition_versions(subscription_definition_id, params::Dict{String,<:Any})
Lists the versions of a subscription definition.
# Arguments
- `subscription_definition_id`: The ID of the subscription definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_subscription_definition_versions(
SubscriptionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_subscription_definition_versions(
SubscriptionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"GET",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_subscription_definitions()
list_subscription_definitions(params::Dict{String,<:Any})
Retrieves a list of subscription definitions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request.
- `"NextToken"`: The token for the next set of results, or ''null'' if there are no
additional results.
"""
function list_subscription_definitions(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"GET",
"/greengrass/definition/subscriptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_subscription_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"GET",
"/greengrass/definition/subscriptions",
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 resource tags for a resource arn.
# 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 greengrass(
"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 greengrass(
"GET",
"/tags/$(resource-arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_deployments(group_id)
reset_deployments(group_id, params::Dict{String,<:Any})
Resets a group's deployments.
# Arguments
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Force"`: If true, performs a best-effort only core reset.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function reset_deployments(GroupId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/deployments/$reset";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_deployments(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/deployments/$reset",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_bulk_deployment(execution_role_arn, input_file_uri)
start_bulk_deployment(execution_role_arn, input_file_uri, params::Dict{String,<:Any})
Deploys multiple groups in one operation. This action starts the bulk deployment of a
specified set of group versions. Each group version deployment will be triggered with an
adaptive rate that has a fixed upper limit. We recommend that you include an
''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are
idempotent with respect to the token and the request parameters.
# Arguments
- `execution_role_arn`: The ARN of the execution role to associate with the bulk deployment
operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all
group versions that are listed in the input file. This IAM role must have access to the S3
bucket containing the input file.
- `input_file_uri`: The URI of the input file contained in the S3 bucket. The execution
role must have ''getObject'' permissions on this bucket to access the input file. The input
file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of
group and version IDs and the deployment type. This file must be less than 100 MB.
Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function start_bulk_deployment(
ExecutionRoleArn, InputFileUri; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/bulk/deployments",
Dict{String,Any}(
"ExecutionRoleArn" => ExecutionRoleArn, "InputFileUri" => InputFileUri
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_bulk_deployment(
ExecutionRoleArn,
InputFileUri,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/bulk/deployments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ExecutionRoleArn" => ExecutionRoleArn, "InputFileUri" => InputFileUri
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_bulk_deployment(bulk_deployment_id)
stop_bulk_deployment(bulk_deployment_id, params::Dict{String,<:Any})
Stops the execution of a bulk deployment. This action returns a status of ''Stopping''
until the deployment is stopped. You cannot start a new bulk deployment while a previous
deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments
or cancel pending deployments.
# Arguments
- `bulk_deployment_id`: The ID of the bulk deployment.
"""
function stop_bulk_deployment(
BulkDeploymentId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/bulk/deployments/$(BulkDeploymentId)/$stop";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_bulk_deployment(
BulkDeploymentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/bulk/deployments/$(BulkDeploymentId)/$stop",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_resource(resource-arn)
tag_resource(resource-arn, params::Dict{String,<:Any})
Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition',
'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition',
'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.
# 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:
- `"tags"`:
"""
function tag_resource(resource_arn; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/tags/$(resource-arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_resource(
resource_arn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/tags/$(resource-arn)",
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 resource tags from a Greengrass Resource.
# Arguments
- `resource-arn`: The Amazon Resource Name (ARN) of the resource.
- `tag_keys`: An array of tag keys to delete
"""
function untag_resource(
resource_arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"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 greengrass(
"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_connectivity_info(thing_name)
update_connectivity_info(thing_name, params::Dict{String,<:Any})
Updates the connectivity information for the core. Any devices that belong to the group
which has this core will receive this information in order to find the location of the core
and connect to it.
# Arguments
- `thing_name`: The thing name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectivityInfo"`: A list of connectivity info.
"""
function update_connectivity_info(
ThingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/things/$(ThingName)/connectivityInfo";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connectivity_info(
ThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/things/$(ThingName)/connectivityInfo",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_connector_definition(connector_definition_id)
update_connector_definition(connector_definition_id, params::Dict{String,<:Any})
Updates a connector definition.
# Arguments
- `connector_definition_id`: The ID of the connector definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name of the definition.
"""
function update_connector_definition(
ConnectorDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connector_definition(
ConnectorDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_core_definition(core_definition_id)
update_core_definition(core_definition_id, params::Dict{String,<:Any})
Updates a core definition.
# Arguments
- `core_definition_id`: The ID of the core definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name of the definition.
"""
function update_core_definition(
CoreDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/definition/cores/$(CoreDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_core_definition(
CoreDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/definition/cores/$(CoreDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_device_definition(device_definition_id)
update_device_definition(device_definition_id, params::Dict{String,<:Any})
Updates a device definition.
# Arguments
- `device_definition_id`: The ID of the device definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name of the definition.
"""
function update_device_definition(
DeviceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/definition/devices/$(DeviceDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_device_definition(
DeviceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/definition/devices/$(DeviceDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_function_definition(function_definition_id)
update_function_definition(function_definition_id, params::Dict{String,<:Any})
Updates a Lambda function definition.
# Arguments
- `function_definition_id`: The ID of the Lambda function definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name of the definition.
"""
function update_function_definition(
FunctionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/definition/functions/$(FunctionDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_function_definition(
FunctionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/definition/functions/$(FunctionDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_group(group_id)
update_group(group_id, params::Dict{String,<:Any})
Updates a group.
# Arguments
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name of the definition.
"""
function update_group(GroupId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"PUT",
"/greengrass/groups/$(GroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_group(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/groups/$(GroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_group_certificate_configuration(group_id)
update_group_certificate_configuration(group_id, params::Dict{String,<:Any})
Updates the Certificate expiry time for a group.
# Arguments
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificateExpiryInMilliseconds"`: The amount of time remaining before the certificate
expires, in milliseconds.
"""
function update_group_certificate_configuration(
GroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/groups/$(GroupId)/certificateauthorities/configuration/expiry";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_group_certificate_configuration(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/groups/$(GroupId)/certificateauthorities/configuration/expiry",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_logger_definition(logger_definition_id)
update_logger_definition(logger_definition_id, params::Dict{String,<:Any})
Updates a logger definition.
# Arguments
- `logger_definition_id`: The ID of the logger definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name of the definition.
"""
function update_logger_definition(
LoggerDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/definition/loggers/$(LoggerDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_logger_definition(
LoggerDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/definition/loggers/$(LoggerDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_definition(resource_definition_id)
update_resource_definition(resource_definition_id, params::Dict{String,<:Any})
Updates a resource definition.
# Arguments
- `resource_definition_id`: The ID of the resource definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name of the definition.
"""
function update_resource_definition(
ResourceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/definition/resources/$(ResourceDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_definition(
ResourceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/definition/resources/$(ResourceDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_subscription_definition(subscription_definition_id)
update_subscription_definition(subscription_definition_id, params::Dict{String,<:Any})
Updates a subscription definition.
# Arguments
- `subscription_definition_id`: The ID of the subscription definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Name"`: The name of the definition.
"""
function update_subscription_definition(
SubscriptionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_subscription_definition(
SubscriptionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_thing_runtime_configuration(thing_name)
update_thing_runtime_configuration(thing_name, params::Dict{String,<:Any})
Updates the runtime configuration of a thing.
# Arguments
- `thing_name`: The thing name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"TelemetryConfiguration"`: Configuration for telemetry service.
"""
function update_thing_runtime_configuration(
ThingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/things/$(ThingName)/runtimeconfig";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_thing_runtime_configuration(
ThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/things/$(ThingName)/runtimeconfig",
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 | 44009 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: greengrassv2
using AWS.Compat
using AWS.UUIDs
"""
associate_service_role_to_account(role_arn)
associate_service_role_to_account(role_arn, params::Dict{String,<:Any})
Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services
account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the
identity of client devices and manage core device connectivity information. The role must
include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that
defines equivalent permissions for the IoT Greengrass features that you use. For more
information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
# Arguments
- `role_arn`: The Amazon Resource Name (ARN) of the service role to associate with IoT
Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
"""
function associate_service_role_to_account(
RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"PUT",
"/greengrass/servicerole",
Dict{String,Any}("RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_service_role_to_account(
RoleArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"PUT",
"/greengrass/servicerole",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RoleArn" => RoleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_associate_client_device_with_core_device(core_device_thing_name)
batch_associate_client_device_with_core_device(core_device_thing_name, params::Dict{String,<:Any})
Associates a list of client devices with a core device. Use this API operation to specify
which client devices can discover a core device through cloud discovery. With cloud
discovery, client devices connect to IoT Greengrass to retrieve associated core devices'
connectivity information and certificates. For more information, see Configure cloud
discovery in the IoT Greengrass V2 Developer Guide. Client devices are local IoT devices
that connect to and communicate with an IoT Greengrass core device over MQTT. You can
connect client devices to a core device to sync MQTT messages and data to Amazon Web
Services IoT Core and interact with client devices in Greengrass components. For more
information, see Interact with local IoT devices in the IoT Greengrass V2 Developer Guide.
# Arguments
- `core_device_thing_name`: The name of the core device. This is also the name of the IoT
thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"entries"`: The list of client devices to associate.
"""
function batch_associate_client_device_with_core_device(
coreDeviceThingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"POST",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)/associateClientDevices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_associate_client_device_with_core_device(
coreDeviceThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"POST",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)/associateClientDevices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_disassociate_client_device_from_core_device(core_device_thing_name)
batch_disassociate_client_device_from_core_device(core_device_thing_name, params::Dict{String,<:Any})
Disassociates a list of client devices from a core device. After you disassociate a client
device from a core device, the client device won't be able to use cloud discovery to
retrieve the core device's connectivity information and certificates.
# Arguments
- `core_device_thing_name`: The name of the core device. This is also the name of the IoT
thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"entries"`: The list of client devices to disassociate.
"""
function batch_disassociate_client_device_from_core_device(
coreDeviceThingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"POST",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)/disassociateClientDevices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_disassociate_client_device_from_core_device(
coreDeviceThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"POST",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)/disassociateClientDevices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_deployment(deployment_id)
cancel_deployment(deployment_id, params::Dict{String,<:Any})
Cancels a deployment. This operation cancels the deployment for devices that haven't yet
received it. If a device already received the deployment, this operation doesn't change
anything for that device.
# Arguments
- `deployment_id`: The ID of the deployment.
"""
function cancel_deployment(deploymentId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"POST",
"/greengrass/v2/deployments/$(deploymentId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_deployment(
deploymentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"POST",
"/greengrass/v2/deployments/$(deploymentId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_component_version()
create_component_version(params::Dict{String,<:Any})
Creates a component. Components are software that run on Greengrass core devices. After you
develop and test a component on your core device, you can use this operation to upload your
component to IoT Greengrass. Then, you can deploy the component to other core devices. You
can use this operation to do the following: Create components from recipes Create a
component from a recipe, which is a file that defines the component's metadata, parameters,
dependencies, lifecycle, artifacts, and platform capability. For more information, see IoT
Greengrass component recipe reference in the IoT Greengrass V2 Developer Guide. To create a
component from a recipe, specify inlineRecipe when you call this operation. Create
components from Lambda functions Create a component from an Lambda function that runs on
IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment
package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to
IoT Greengrass V2. This function accepts Lambda functions in all supported versions of
Python, Node.js, and Java runtimes. IoT Greengrass doesn't apply any additional
restrictions on deprecated Lambda runtime versions. To create a component from a Lambda
function, specify lambdaFunction when you call this operation. IoT Greengrass currently
supports Lambda functions on only Linux core devices.
# 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 that
the request is idempotent. Idempotency means that the request is successfully processed
only once, even if you send the request multiple times. When a request succeeds, and you
specify the same client token for subsequent successful requests, the IoT Greengrass V2
service returns the successful response that it caches from the previous request. IoT
Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
- `"inlineRecipe"`: The recipe to use to create the component. The recipe defines the
component's metadata, parameters, dependencies, lifecycle, artifacts, and platform
compatibility. You must specify either inlineRecipe or lambdaFunction.
- `"lambdaFunction"`: The parameters to create a component from a Lambda function. You must
specify either inlineRecipe or lambdaFunction.
- `"tags"`: A list of key-value pairs that contain metadata for the resource. For more
information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
"""
function create_component_version(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"POST",
"/greengrass/v2/createComponentVersion",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_component_version(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"POST",
"/greengrass/v2/createComponentVersion",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_deployment(target_arn)
create_deployment(target_arn, params::Dict{String,<:Any})
Creates a continuous deployment for a target, which is a Greengrass core device or group of
core devices. When you add a new core device to a group of core devices that has a
deployment, IoT Greengrass deploys that group's deployment to the new device. You can
define one deployment for each target. When you create a new deployment for a target that
has an existing deployment, you replace the previous deployment. IoT Greengrass applies the
new deployment to the target devices. Every deployment has a revision number that indicates
how many deployment revisions you define for a target. Use this operation to create a new
revision of an existing deployment. For more information, see the Create deployments in the
IoT Greengrass V2 Developer Guide.
# Arguments
- `target_arn`: The ARN of the target IoT thing or thing group. When creating a
subdeployment, the targetARN can only be a thing group.
# 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 that
the request is idempotent. Idempotency means that the request is successfully processed
only once, even if you send the request multiple times. When a request succeeds, and you
specify the same client token for subsequent successful requests, the IoT Greengrass V2
service returns the successful response that it caches from the previous request. IoT
Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
- `"components"`: The components to deploy. This is a dictionary, where each key is the
name of a component, and each key's value is the version and configuration to deploy for
that component.
- `"deploymentName"`: The name of the deployment.
- `"deploymentPolicies"`: The deployment policies for the deployment. These policies define
how the deployment updates components and handles failure.
- `"iotJobConfiguration"`: The job configuration for the deployment configuration. The job
configuration specifies the rollout, timeout, and stop configurations for the deployment
configuration.
- `"parentTargetArn"`: The parent deployment's target ARN within a subdeployment.
- `"tags"`: A list of key-value pairs that contain metadata for the resource. For more
information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
"""
function create_deployment(targetArn; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"POST",
"/greengrass/v2/deployments",
Dict{String,Any}("targetArn" => targetArn, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_deployment(
targetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"POST",
"/greengrass/v2/deployments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"targetArn" => targetArn, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_component(arn)
delete_component(arn, params::Dict{String,<:Any})
Deletes a version of a component from IoT Greengrass. This operation deletes the
component's recipe and artifacts. As a result, deployments that refer to this component
version will fail. If you have deployments that use this component version, you can remove
the component from the deployment or update the deployment to use a valid version.
# Arguments
- `arn`: The ARN of the component version.
"""
function delete_component(arn; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"DELETE",
"/greengrass/v2/components/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_component(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"DELETE",
"/greengrass/v2/components/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_core_device(core_device_thing_name)
delete_core_device(core_device_thing_name, params::Dict{String,<:Any})
Deletes a Greengrass core device, which is an IoT thing. This operation removes the core
device from the list of core devices. This operation doesn't delete the IoT thing. For more
information about how to delete the IoT thing, see DeleteThing in the IoT API Reference.
# Arguments
- `core_device_thing_name`: The name of the core device. This is also the name of the IoT
thing.
"""
function delete_core_device(
coreDeviceThingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"DELETE",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_core_device(
coreDeviceThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"DELETE",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)",
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. To delete an active deployment, you must first cancel it. For more
information, see CancelDeployment. Deleting a deployment doesn't affect core devices that
run that deployment, because core devices store the deployment's configuration on the
device. Additionally, core devices can roll back to a previous deployment that has been
deleted.
# Arguments
- `deployment_id`: The ID of the deployment.
"""
function delete_deployment(deploymentId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"DELETE",
"/greengrass/v2/deployments/$(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 greengrassv2(
"DELETE",
"/greengrass/v2/deployments/$(deploymentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_component(arn)
describe_component(arn, params::Dict{String,<:Any})
Retrieves metadata for a version of a component.
# Arguments
- `arn`: The ARN of the component version.
"""
function describe_component(arn; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"GET",
"/greengrass/v2/components/$(arn)/metadata";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_component(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/components/$(arn)/metadata",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_service_role_from_account()
disassociate_service_role_from_account(params::Dict{String,<:Any})
Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services
account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't
verify the identity of client devices or manage core device connectivity information. For
more information, see Greengrass service role in the IoT Greengrass Version 2 Developer
Guide.
"""
function disassociate_service_role_from_account(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"DELETE",
"/greengrass/servicerole";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_service_role_from_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"DELETE",
"/greengrass/servicerole",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_component(arn)
get_component(arn, params::Dict{String,<:Any})
Gets the recipe for a version of a component.
# Arguments
- `arn`: The ARN of the component version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"recipeOutputFormat"`: The format of the recipe.
"""
function get_component(arn; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"GET",
"/greengrass/v2/components/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_component(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/components/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_component_version_artifact(arn, artifact_name)
get_component_version_artifact(arn, artifact_name, params::Dict{String,<:Any})
Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices
call this operation to identify the URL that they can use to download an artifact to
install.
# Arguments
- `arn`: The ARN of the component version. Specify the ARN of a public or a Lambda
component version.
- `artifact_name`: The name of the artifact. You can use the GetComponent operation to
download the component recipe, which includes the URI of the artifact. The artifact name is
the section of the URI after the scheme. For example, in the artifact URI
greengrass:SomeArtifact.zip, the artifact name is SomeArtifact.zip.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"s3EndpointType"`: Specifies the endpoint to use when getting Amazon S3 pre-signed URLs.
All Amazon Web Services Regions except US East (N. Virginia) use REGIONAL in all cases. In
the US East (N. Virginia) Region the default is GLOBAL, but you can change it to REGIONAL
with this parameter.
- `"x-amz-iot-endpoint-type"`: Determines if the Amazon S3 URL returned is a FIPS
pre-signed URL endpoint. Specify fips if you want the returned Amazon S3 pre-signed URL to
point to an Amazon S3 FIPS endpoint. If you don't specify a value, the default is standard.
"""
function get_component_version_artifact(
arn, artifactName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/components/$(arn)/artifacts/$(artifactName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_component_version_artifact(
arn,
artifactName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"GET",
"/greengrass/v2/components/$(arn)/artifacts/$(artifactName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_connectivity_info(thing_name)
get_connectivity_info(thing_name, params::Dict{String,<:Any})
Retrieves connectivity information for a Greengrass core device. Connectivity information
includes endpoints and ports where client devices can connect to an MQTT broker on the core
device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns
connectivity information for all of the core devices where the client device can connect.
For more information, see Connect client devices to core devices in the IoT Greengrass
Version 2 Developer Guide.
# Arguments
- `thing_name`: The name of the core device. This is also the name of the IoT thing.
"""
function get_connectivity_info(thingName; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"GET",
"/greengrass/things/$(thingName)/connectivityInfo";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_connectivity_info(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"GET",
"/greengrass/things/$(thingName)/connectivityInfo",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_core_device(core_device_thing_name)
get_core_device(core_device_thing_name, params::Dict{String,<:Any})
Retrieves metadata for a Greengrass core device. IoT Greengrass relies on individual
devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core
software isn't running on the device, or if device isn't connected to the Amazon Web
Services Cloud, then the reported status of that device might not reflect its current
status. The status timestamp indicates when the device status was last updated. Core
devices send status updates at the following times: When the IoT Greengrass Core software
starts When the core device receives a deployment from the Amazon Web Services Cloud
When the status of any component on the core device becomes BROKEN At a regular interval
that you can configure, which defaults to 24 hours For IoT Greengrass Core v2.7.0, the
core device sends status updates upon local deployment and cloud deployment
# Arguments
- `core_device_thing_name`: The name of the core device. This is also the name of the IoT
thing.
"""
function get_core_device(
coreDeviceThingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_core_device(
coreDeviceThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"GET",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_deployment(deployment_id)
get_deployment(deployment_id, params::Dict{String,<:Any})
Gets a deployment. Deployments define the components that run on Greengrass core devices.
# Arguments
- `deployment_id`: The ID of the deployment.
"""
function get_deployment(deploymentId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"GET",
"/greengrass/v2/deployments/$(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 greengrassv2(
"GET",
"/greengrass/v2/deployments/$(deploymentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_role_for_account()
get_service_role_for_account(params::Dict{String,<:Any})
Gets the service role associated with IoT Greengrass for your Amazon Web Services account
in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of
client devices and manage core device connectivity information. For more information, see
Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
"""
function get_service_role_for_account(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"GET",
"/greengrass/servicerole";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_role_for_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/servicerole",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_client_devices_associated_with_core_device(core_device_thing_name)
list_client_devices_associated_with_core_device(core_device_thing_name, params::Dict{String,<:Any})
Retrieves a paginated list of client devices that are associated with a core device.
# Arguments
- `core_device_thing_name`: The name of the core device. This is also the name of the IoT
thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per paginated request.
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_client_devices_associated_with_core_device(
coreDeviceThingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)/associatedClientDevices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_client_devices_associated_with_core_device(
coreDeviceThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"GET",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)/associatedClientDevices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_component_versions(arn)
list_component_versions(arn, params::Dict{String,<:Any})
Retrieves a paginated list of all versions for a component. Greater versions are listed
first.
# Arguments
- `arn`: The ARN of the component.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per paginated request.
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_component_versions(arn; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"GET",
"/greengrass/v2/components/$(arn)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_component_versions(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/components/$(arn)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_components()
list_components(params::Dict{String,<:Any})
Retrieves a paginated list of component summaries. This list includes components that you
have permission 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 be returned per paginated request.
- `"nextToken"`: The token to be used for the next set of paginated results.
- `"scope"`: The scope of the components to list. Default: PRIVATE
"""
function list_components(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"GET",
"/greengrass/v2/components";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_components(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/components",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_core_devices()
list_core_devices(params::Dict{String,<:Any})
Retrieves a paginated list of Greengrass core devices. IoT Greengrass relies on individual
devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core
software isn't running on the device, or if device isn't connected to the Amazon Web
Services Cloud, then the reported status of that device might not reflect its current
status. The status timestamp indicates when the device status was last updated. Core
devices send status updates at the following times: When the IoT Greengrass Core software
starts When the core device receives a deployment from the Amazon Web Services Cloud
When the status of any component on the core device becomes BROKEN At a regular interval
that you can configure, which defaults to 24 hours For IoT Greengrass Core v2.7.0, the
core device sends status updates upon local deployment and cloud deployment
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per paginated request.
- `"nextToken"`: The token to be used for the next set of paginated results.
- `"status"`: The core device status by which to filter. If you specify this parameter, the
list includes only core devices that have this status. Choose one of the following options:
HEALTHY – The IoT Greengrass Core software and all components run on the core device
without issue. UNHEALTHY – The IoT Greengrass Core software or a component is in a
failed state on the core device.
- `"thingGroupArn"`: The ARN of the IoT thing group by which to filter. If you specify this
parameter, the list includes only core devices that have successfully deployed a deployment
that targets the thing group. When you remove a core device from a thing group, the list
continues to include that core device.
"""
function list_core_devices(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"GET",
"/greengrass/v2/coreDevices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_core_devices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/coreDevices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_deployments()
list_deployments(params::Dict{String,<:Any})
Retrieves a paginated list of deployments.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"historyFilter"`: The filter for the list of deployments. Choose one of the following
options: ALL – The list includes all deployments. LATEST_ONLY – The list includes
only the latest revision of each deployment. Default: LATEST_ONLY
- `"maxResults"`: The maximum number of results to be returned per paginated request.
Default: 50
- `"nextToken"`: The token to be used for the next set of paginated results.
- `"parentTargetArn"`: The parent deployment's target ARN within a subdeployment.
- `"targetArn"`: The ARN of the target IoT thing or thing group.
"""
function list_deployments(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"GET",
"/greengrass/v2/deployments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_deployments(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/deployments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_effective_deployments(core_device_thing_name)
list_effective_deployments(core_device_thing_name, params::Dict{String,<:Any})
Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core
devices.
# Arguments
- `core_device_thing_name`: The name of the core device. This is also the name of the IoT
thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per paginated request.
- `"nextToken"`: The token to be used for the next set of paginated results.
"""
function list_effective_deployments(
coreDeviceThingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)/effectiveDeployments";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_effective_deployments(
coreDeviceThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"GET",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)/effectiveDeployments",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_installed_components(core_device_thing_name)
list_installed_components(core_device_thing_name, params::Dict{String,<:Any})
Retrieves a paginated list of the components that a Greengrass core device runs. By
default, this list doesn't include components that are deployed as dependencies of other
components. To include dependencies in the response, set the topologyFilter parameter to
ALL. IoT Greengrass relies on individual devices to send status updates to the Amazon Web
Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if
device isn't connected to the Amazon Web Services Cloud, then the reported status of that
device might not reflect its current status. The status timestamp indicates when the device
status was last updated. Core devices send status updates at the following times: When
the IoT Greengrass Core software starts When the core device receives a deployment from
the Amazon Web Services Cloud When the status of any component on the core device becomes
BROKEN At a regular interval that you can configure, which defaults to 24 hours For
IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and
cloud deployment
# Arguments
- `core_device_thing_name`: The name of the core device. This is also the name of the IoT
thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per paginated request.
- `"nextToken"`: The token to be used for the next set of paginated results.
- `"topologyFilter"`: The filter for the list of components. Choose from the following
options: ALL – The list includes all components installed on the core device. ROOT
– The list includes only root components, which are components that you specify in a
deployment. When you choose this option, the list doesn't include components that the core
device installs as dependencies of other components. Default: ROOT
"""
function list_installed_components(
coreDeviceThingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"GET",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)/installedComponents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_installed_components(
coreDeviceThingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"GET",
"/greengrass/v2/coreDevices/$(coreDeviceThingName)/installedComponents",
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 Greengrass resource.
# Arguments
- `resource_arn`: The ARN of the resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"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 greengrassv2(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resolve_component_candidates()
resolve_component_candidates(params::Dict{String,<:Any})
Retrieves a list of components that meet the component, version, and platform requirements
of a deployment. Greengrass core devices call this operation when they receive a deployment
to identify the components to install. This operation identifies components that meet all
dependency requirements for a deployment. If the requirements conflict, then this operation
returns an error and the deployment fails. For example, this occurs if component A requires
version >2.0.0 and component B requires version <2.0.0 of a component dependency.
When you specify the component candidates to resolve, IoT Greengrass compares each
component's digest from the core device with the component's digest in the Amazon Web
Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the
version from the Amazon Web Services Cloud. To use this operation, you must use the data
plane API endpoint and authenticate with an IoT device certificate. For more information,
see IoT Greengrass endpoints and quotas.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"componentCandidates"`: The list of components to resolve.
- `"platform"`: The platform to use to resolve compatible components.
"""
function resolve_component_candidates(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"POST",
"/greengrass/v2/resolveComponentCandidates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resolve_component_candidates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"POST",
"/greengrass/v2/resolveComponentCandidates",
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 Greengrass 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 Tag your resources in the IoT Greengrass V2 Developer Guide.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return greengrassv2(
"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 greengrassv2(
"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 tag from an IoT Greengrass 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 greengrassv2(
"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 greengrassv2(
"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_connectivity_info(connectivity_info, thing_name)
update_connectivity_info(connectivity_info, thing_name, params::Dict{String,<:Any})
Updates connectivity information for a Greengrass core device. Connectivity information
includes endpoints and ports where client devices can connect to an MQTT broker on the core
device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns
connectivity information for all of the core devices where the client device can connect.
For more information, see Connect client devices to core devices in the IoT Greengrass
Version 2 Developer Guide.
# Arguments
- `connectivity_info`: The connectivity information for the core device.
- `thing_name`: The name of the core device. This is also the name of the IoT thing.
"""
function update_connectivity_info(
ConnectivityInfo, thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrassv2(
"PUT",
"/greengrass/things/$(thingName)/connectivityInfo",
Dict{String,Any}("ConnectivityInfo" => ConnectivityInfo);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_connectivity_info(
ConnectivityInfo,
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrassv2(
"PUT",
"/greengrass/things/$(thingName)/connectivityInfo",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ConnectivityInfo" => ConnectivityInfo), 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 | 40076 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: groundstation
using AWS.Compat
using AWS.UUIDs
"""
cancel_contact(contact_id)
cancel_contact(contact_id, params::Dict{String,<:Any})
Cancels a contact with a specified contact ID.
# Arguments
- `contact_id`: UUID of a contact.
"""
function cancel_contact(contactId; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"DELETE",
"/contact/$(contactId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_contact(
contactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"DELETE",
"/contact/$(contactId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_config(config_data, name)
create_config(config_data, name, params::Dict{String,<:Any})
Creates a Config with the specified configData parameters. Only one type of configData can
be specified.
# Arguments
- `config_data`: Parameters of a Config.
- `name`: Name of a Config.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: Tags assigned to a Config.
"""
function create_config(configData, name; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"POST",
"/config",
Dict{String,Any}("configData" => configData, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_config(
configData,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/config",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("configData" => configData, "name" => name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataflow_endpoint_group(endpoint_details)
create_dataflow_endpoint_group(endpoint_details, params::Dict{String,<:Any})
Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.
The name field in each endpoint is used in your mission profile DataflowEndpointConfig to
specify which endpoints to use during a contact. When a contact uses multiple
DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.
# Arguments
- `endpoint_details`: Endpoint details of each endpoint in the dataflow endpoint group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contactPostPassDurationSeconds"`: Amount of time, in seconds, after a contact ends that
the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station
Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group
enters and exits the POSTPASS state.
- `"contactPrePassDurationSeconds"`: Amount of time, in seconds, before a contact starts
that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground
Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow
Endpoint Group enters and exits the PREPASS state.
- `"tags"`: Tags of a dataflow endpoint group.
"""
function create_dataflow_endpoint_group(
endpointDetails; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"POST",
"/dataflowEndpointGroup",
Dict{String,Any}("endpointDetails" => endpointDetails);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataflow_endpoint_group(
endpointDetails,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/dataflowEndpointGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("endpointDetails" => endpointDetails), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ephemeris(name, satellite_id)
create_ephemeris(name, satellite_id, params::Dict{String,<:Any})
Creates an Ephemeris with the specified EphemerisData.
# Arguments
- `name`: A name string associated with the ephemeris. Used as a human-readable identifier
for the ephemeris.
- `satellite_id`: AWS Ground Station satellite ID for this ephemeris.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enabled"`: Whether to set the ephemeris status to ENABLED after validation. Setting
this to false will set the ephemeris status to DISABLED after validation.
- `"ephemeris"`: Ephemeris data.
- `"expirationTime"`: An overall expiration time for the ephemeris in UTC, after which it
will become EXPIRED.
- `"kmsKeyArn"`: The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
- `"priority"`: Customer-provided priority score to establish the order in which
overlapping ephemerides should be used. The default for customer-provided ephemeris
priority is 1, and higher numbers take precedence. Priority must be 1 or greater
- `"tags"`: Tags assigned to an ephemeris.
"""
function create_ephemeris(
name, satelliteId; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"POST",
"/ephemeris",
Dict{String,Any}("name" => name, "satelliteId" => satelliteId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ephemeris(
name,
satelliteId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/ephemeris",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("name" => name, "satelliteId" => satelliteId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_mission_profile(dataflow_edges, minimum_viable_contact_duration_seconds, name, tracking_config_arn)
create_mission_profile(dataflow_edges, minimum_viable_contact_duration_seconds, name, tracking_config_arn, params::Dict{String,<:Any})
Creates a mission profile. dataflowEdges is a list of lists of strings. Each lower level
list of strings has two elements: a from ARN and a to ARN.
# Arguments
- `dataflow_edges`: A list of lists of ARNs. Each list of ARNs is an edge, with a from
Config and a to Config.
- `minimum_viable_contact_duration_seconds`: Smallest amount of time in seconds that
you’d like to see for an available contact. AWS Ground Station will not present you with
contacts shorter than this duration.
- `name`: Name of a mission profile.
- `tracking_config_arn`: ARN of a tracking Config.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contactPostPassDurationSeconds"`: Amount of time after a contact ends that you’d like
to receive a Ground Station Contact State Change event indicating the pass has finished.
- `"contactPrePassDurationSeconds"`: Amount of time prior to contact start you’d like to
receive a Ground Station Contact State Change event indicating an upcoming pass.
- `"streamsKmsKey"`: KMS key to use for encrypting streams.
- `"streamsKmsRole"`: Role to use for encrypting streams with KMS key.
- `"tags"`: Tags assigned to a mission profile.
"""
function create_mission_profile(
dataflowEdges,
minimumViableContactDurationSeconds,
name,
trackingConfigArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/missionprofile",
Dict{String,Any}(
"dataflowEdges" => dataflowEdges,
"minimumViableContactDurationSeconds" => minimumViableContactDurationSeconds,
"name" => name,
"trackingConfigArn" => trackingConfigArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_mission_profile(
dataflowEdges,
minimumViableContactDurationSeconds,
name,
trackingConfigArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/missionprofile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"dataflowEdges" => dataflowEdges,
"minimumViableContactDurationSeconds" =>
minimumViableContactDurationSeconds,
"name" => name,
"trackingConfigArn" => trackingConfigArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_config(config_id, config_type)
delete_config(config_id, config_type, params::Dict{String,<:Any})
Deletes a Config.
# Arguments
- `config_id`: UUID of a Config.
- `config_type`: Type of a Config.
"""
function delete_config(
configId, configType; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"DELETE",
"/config/$(configType)/$(configId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_config(
configId,
configType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"DELETE",
"/config/$(configType)/$(configId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataflow_endpoint_group(dataflow_endpoint_group_id)
delete_dataflow_endpoint_group(dataflow_endpoint_group_id, params::Dict{String,<:Any})
Deletes a dataflow endpoint group.
# Arguments
- `dataflow_endpoint_group_id`: UUID of a dataflow endpoint group.
"""
function delete_dataflow_endpoint_group(
dataflowEndpointGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"DELETE",
"/dataflowEndpointGroup/$(dataflowEndpointGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dataflow_endpoint_group(
dataflowEndpointGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"DELETE",
"/dataflowEndpointGroup/$(dataflowEndpointGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ephemeris(ephemeris_id)
delete_ephemeris(ephemeris_id, params::Dict{String,<:Any})
Deletes an ephemeris
# Arguments
- `ephemeris_id`: The AWS Ground Station ephemeris ID.
"""
function delete_ephemeris(ephemerisId; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"DELETE",
"/ephemeris/$(ephemerisId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ephemeris(
ephemerisId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"DELETE",
"/ephemeris/$(ephemerisId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_mission_profile(mission_profile_id)
delete_mission_profile(mission_profile_id, params::Dict{String,<:Any})
Deletes a mission profile.
# Arguments
- `mission_profile_id`: UUID of a mission profile.
"""
function delete_mission_profile(
missionProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"DELETE",
"/missionprofile/$(missionProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_mission_profile(
missionProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"DELETE",
"/missionprofile/$(missionProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_contact(contact_id)
describe_contact(contact_id, params::Dict{String,<:Any})
Describes an existing contact.
# Arguments
- `contact_id`: UUID of a contact.
"""
function describe_contact(contactId; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"GET",
"/contact/$(contactId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_contact(
contactId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"GET",
"/contact/$(contactId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_ephemeris(ephemeris_id)
describe_ephemeris(ephemeris_id, params::Dict{String,<:Any})
Describes an existing ephemeris.
# Arguments
- `ephemeris_id`: The AWS Ground Station ephemeris ID.
"""
function describe_ephemeris(ephemerisId; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"GET",
"/ephemeris/$(ephemerisId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_ephemeris(
ephemerisId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"GET",
"/ephemeris/$(ephemerisId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_agent_configuration(agent_id)
get_agent_configuration(agent_id, params::Dict{String,<:Any})
For use by AWS Ground Station Agent and shouldn't be called directly. Gets the latest
configuration information for a registered agent.
# Arguments
- `agent_id`: UUID of agent to get configuration information for.
"""
function get_agent_configuration(agentId; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"GET",
"/agent/$(agentId)/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_agent_configuration(
agentId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"GET",
"/agent/$(agentId)/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_config(config_id, config_type)
get_config(config_id, config_type, params::Dict{String,<:Any})
Returns Config information. Only one Config response can be returned.
# Arguments
- `config_id`: UUID of a Config.
- `config_type`: Type of a Config.
"""
function get_config(configId, configType; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"GET",
"/config/$(configType)/$(configId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_config(
configId,
configType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"GET",
"/config/$(configType)/$(configId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dataflow_endpoint_group(dataflow_endpoint_group_id)
get_dataflow_endpoint_group(dataflow_endpoint_group_id, params::Dict{String,<:Any})
Returns the dataflow endpoint group.
# Arguments
- `dataflow_endpoint_group_id`: UUID of a dataflow endpoint group.
"""
function get_dataflow_endpoint_group(
dataflowEndpointGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"GET",
"/dataflowEndpointGroup/$(dataflowEndpointGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dataflow_endpoint_group(
dataflowEndpointGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"GET",
"/dataflowEndpointGroup/$(dataflowEndpointGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_minute_usage(month, year)
get_minute_usage(month, year, params::Dict{String,<:Any})
Returns the number of reserved minutes used by account.
# Arguments
- `month`: The month being requested, with a value of 1-12.
- `year`: The year being requested, in the format of YYYY.
"""
function get_minute_usage(month, year; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"POST",
"/minute-usage",
Dict{String,Any}("month" => month, "year" => year);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_minute_usage(
month,
year,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/minute-usage",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("month" => month, "year" => year), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mission_profile(mission_profile_id)
get_mission_profile(mission_profile_id, params::Dict{String,<:Any})
Returns a mission profile.
# Arguments
- `mission_profile_id`: UUID of a mission profile.
"""
function get_mission_profile(
missionProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"GET",
"/missionprofile/$(missionProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mission_profile(
missionProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"GET",
"/missionprofile/$(missionProfileId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_satellite(satellite_id)
get_satellite(satellite_id, params::Dict{String,<:Any})
Returns a satellite.
# Arguments
- `satellite_id`: UUID of a satellite.
"""
function get_satellite(satelliteId; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"GET",
"/satellite/$(satelliteId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_satellite(
satelliteId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"GET",
"/satellite/$(satelliteId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_configs()
list_configs(params::Dict{String,<:Any})
Returns a list of Config objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of Configs returned.
- `"nextToken"`: Next token returned in the request of a previous ListConfigs call. Used to
get the next page of results.
"""
function list_configs(; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"GET", "/config"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_configs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"GET", "/config", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_contacts(end_time, start_time, status_list)
list_contacts(end_time, start_time, status_list, params::Dict{String,<:Any})
Returns a list of contacts. If statusList contains AVAILABLE, the request must include
groundStation, missionprofileArn, and satelliteArn.
# Arguments
- `end_time`: End time of a contact in UTC.
- `start_time`: Start time of a contact in UTC.
- `status_list`: Status of a contact reservation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"groundStation"`: Name of a ground station.
- `"maxResults"`: Maximum number of contacts returned.
- `"missionProfileArn"`: ARN of a mission profile.
- `"nextToken"`: Next token returned in the request of a previous ListContacts call. Used
to get the next page of results.
- `"satelliteArn"`: ARN of a satellite.
"""
function list_contacts(
endTime, startTime, statusList; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"POST",
"/contacts",
Dict{String,Any}(
"endTime" => endTime, "startTime" => startTime, "statusList" => statusList
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_contacts(
endTime,
startTime,
statusList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/contacts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"startTime" => startTime,
"statusList" => statusList,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dataflow_endpoint_groups()
list_dataflow_endpoint_groups(params::Dict{String,<:Any})
Returns a list of DataflowEndpoint groups.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of dataflow endpoint groups returned.
- `"nextToken"`: Next token returned in the request of a previous
ListDataflowEndpointGroups call. Used to get the next page of results.
"""
function list_dataflow_endpoint_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"GET",
"/dataflowEndpointGroup";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dataflow_endpoint_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"GET",
"/dataflowEndpointGroup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_ephemerides(end_time, satellite_id, start_time)
list_ephemerides(end_time, satellite_id, start_time, params::Dict{String,<:Any})
List existing ephemerides.
# Arguments
- `end_time`: The end time to list in UTC. The operation will return an ephemeris if its
expiration time is within the time range defined by the startTime and endTime.
- `satellite_id`: The AWS Ground Station satellite ID to list ephemeris for.
- `start_time`: The start time to list in UTC. The operation will return an ephemeris if
its expiration time is within the time range defined by the startTime and endTime.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of ephemerides to return.
- `"nextToken"`: Pagination token.
- `"statusList"`: The list of ephemeris status to return.
"""
function list_ephemerides(
endTime, satelliteId, startTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"POST",
"/ephemerides",
Dict{String,Any}(
"endTime" => endTime, "satelliteId" => satelliteId, "startTime" => startTime
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_ephemerides(
endTime,
satelliteId,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/ephemerides",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"satelliteId" => satelliteId,
"startTime" => startTime,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_ground_stations()
list_ground_stations(params::Dict{String,<:Any})
Returns a list of ground stations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of ground stations returned.
- `"nextToken"`: Next token that can be supplied in the next call to get the next page of
ground stations.
- `"satelliteId"`: Satellite ID to retrieve on-boarded ground stations.
"""
function list_ground_stations(; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"GET", "/groundstation"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_ground_stations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"GET",
"/groundstation",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_mission_profiles()
list_mission_profiles(params::Dict{String,<:Any})
Returns a list of mission profiles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of mission profiles returned.
- `"nextToken"`: Next token returned in the request of a previous ListMissionProfiles call.
Used to get the next page of results.
"""
function list_mission_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"GET", "/missionprofile"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_mission_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"GET",
"/missionprofile",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_satellites()
list_satellites(params::Dict{String,<:Any})
Returns a list of satellites.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of satellites returned.
- `"nextToken"`: Next token that can be supplied in the next call to get the next page of
satellites.
"""
function list_satellites(; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"GET", "/satellite"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_satellites(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"GET", "/satellite", 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 specified resource.
# Arguments
- `resource_arn`: ARN of a resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"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 groundstation(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_agent(agent_details, discovery_data)
register_agent(agent_details, discovery_data, params::Dict{String,<:Any})
For use by AWS Ground Station Agent and shouldn't be called directly. Registers a new
agent with AWS Ground Station.
# Arguments
- `agent_details`: Detailed information about the agent being registered.
- `discovery_data`: Data for associating an agent with the capabilities it is managing.
"""
function register_agent(
agentDetails, discoveryData; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"POST",
"/agent",
Dict{String,Any}("agentDetails" => agentDetails, "discoveryData" => discoveryData);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_agent(
agentDetails,
discoveryData,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/agent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"agentDetails" => agentDetails, "discoveryData" => discoveryData
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reserve_contact(end_time, ground_station, mission_profile_arn, satellite_arn, start_time)
reserve_contact(end_time, ground_station, mission_profile_arn, satellite_arn, start_time, params::Dict{String,<:Any})
Reserves a contact using specified parameters.
# Arguments
- `end_time`: End time of a contact in UTC.
- `ground_station`: Name of a ground station.
- `mission_profile_arn`: ARN of a mission profile.
- `satellite_arn`: ARN of a satellite
- `start_time`: Start time of a contact in UTC.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: Tags assigned to a contact.
"""
function reserve_contact(
endTime,
groundStation,
missionProfileArn,
satelliteArn,
startTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/contact",
Dict{String,Any}(
"endTime" => endTime,
"groundStation" => groundStation,
"missionProfileArn" => missionProfileArn,
"satelliteArn" => satelliteArn,
"startTime" => startTime,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reserve_contact(
endTime,
groundStation,
missionProfileArn,
satelliteArn,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"POST",
"/contact",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"groundStation" => groundStation,
"missionProfileArn" => missionProfileArn,
"satelliteArn" => satelliteArn,
"startTime" => startTime,
),
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 a tag to a resource.
# Arguments
- `resource_arn`: ARN of a resource tag.
- `tags`: Tags assigned to a resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return groundstation(
"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 groundstation(
"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})
Deassigns a resource tag.
# Arguments
- `resource_arn`: ARN of a resource.
- `tag_keys`: Keys of a resource tag.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"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 groundstation(
"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_agent_status(agent_id, aggregate_status, component_statuses, task_id)
update_agent_status(agent_id, aggregate_status, component_statuses, task_id, params::Dict{String,<:Any})
For use by AWS Ground Station Agent and shouldn't be called directly. Update the status
of the agent.
# Arguments
- `agent_id`: UUID of agent to update.
- `aggregate_status`: Aggregate status for agent.
- `component_statuses`: List of component statuses for agent.
- `task_id`: GUID of agent task.
"""
function update_agent_status(
agentId,
aggregateStatus,
componentStatuses,
taskId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"PUT",
"/agent/$(agentId)",
Dict{String,Any}(
"aggregateStatus" => aggregateStatus,
"componentStatuses" => componentStatuses,
"taskId" => taskId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_agent_status(
agentId,
aggregateStatus,
componentStatuses,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"PUT",
"/agent/$(agentId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"aggregateStatus" => aggregateStatus,
"componentStatuses" => componentStatuses,
"taskId" => taskId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_config(config_data, config_id, config_type, name)
update_config(config_data, config_id, config_type, name, params::Dict{String,<:Any})
Updates the Config used when scheduling contacts. Updating a Config will not update the
execution parameters for existing future contacts scheduled with this Config.
# Arguments
- `config_data`: Parameters of a Config.
- `config_id`: UUID of a Config.
- `config_type`: Type of a Config.
- `name`: Name of a Config.
"""
function update_config(
configData,
configId,
configType,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"PUT",
"/config/$(configType)/$(configId)",
Dict{String,Any}("configData" => configData, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_config(
configData,
configId,
configType,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"PUT",
"/config/$(configType)/$(configId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("configData" => configData, "name" => name), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ephemeris(enabled, ephemeris_id)
update_ephemeris(enabled, ephemeris_id, params::Dict{String,<:Any})
Updates an existing ephemeris
# Arguments
- `enabled`: Whether the ephemeris is enabled or not. Changing this value will not require
the ephemeris to be re-validated.
- `ephemeris_id`: The AWS Ground Station ephemeris ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: A name string associated with the ephemeris. Used as a human-readable
identifier for the ephemeris.
- `"priority"`: Customer-provided priority score to establish the order in which
overlapping ephemerides should be used. The default for customer-provided ephemeris
priority is 1, and higher numbers take precedence. Priority must be 1 or greater
"""
function update_ephemeris(
enabled, ephemerisId; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"PUT",
"/ephemeris/$(ephemerisId)",
Dict{String,Any}("enabled" => enabled);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ephemeris(
enabled,
ephemerisId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"PUT",
"/ephemeris/$(ephemerisId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("enabled" => enabled), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_mission_profile(mission_profile_id)
update_mission_profile(mission_profile_id, params::Dict{String,<:Any})
Updates a mission profile. Updating a mission profile will not update the execution
parameters for existing future contacts.
# Arguments
- `mission_profile_id`: UUID of a mission profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contactPostPassDurationSeconds"`: Amount of time after a contact ends that you’d like
to receive a Ground Station Contact State Change event indicating the pass has finished.
- `"contactPrePassDurationSeconds"`: Amount of time after a contact ends that you’d like
to receive a Ground Station Contact State Change event indicating the pass has finished.
- `"dataflowEdges"`: A list of lists of ARNs. Each list of ARNs is an edge, with a from
Config and a to Config.
- `"minimumViableContactDurationSeconds"`: Smallest amount of time in seconds that you’d
like to see for an available contact. AWS Ground Station will not present you with contacts
shorter than this duration.
- `"name"`: Name of a mission profile.
- `"streamsKmsKey"`: KMS key to use for encrypting streams.
- `"streamsKmsRole"`: Role to use for encrypting streams with KMS key.
- `"trackingConfigArn"`: ARN of a tracking Config.
"""
function update_mission_profile(
missionProfileId; aws_config::AbstractAWSConfig=global_aws_config()
)
return groundstation(
"PUT",
"/missionprofile/$(missionProfileId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_mission_profile(
missionProfileId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return groundstation(
"PUT",
"/missionprofile/$(missionProfileId)",
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 | 119670 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: guardduty
using AWS.Compat
using AWS.UUIDs
"""
accept_administrator_invitation(administrator_id, detector_id, invitation_id)
accept_administrator_invitation(administrator_id, detector_id, invitation_id, params::Dict{String,<:Any})
Accepts the invitation to be a member account and get monitored by a GuardDuty
administrator account that sent the invitation.
# Arguments
- `administrator_id`: The account ID of the GuardDuty administrator account whose
invitation you're accepting.
- `detector_id`: The unique ID of the detector of the GuardDuty member account.
- `invitation_id`: The value that is used to validate the administrator account to the
member account.
"""
function accept_administrator_invitation(
administratorId,
detectorId,
invitationId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/administrator",
Dict{String,Any}(
"administratorId" => administratorId, "invitationId" => invitationId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_administrator_invitation(
administratorId,
detectorId,
invitationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/administrator",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"administratorId" => administratorId, "invitationId" => invitationId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
accept_invitation(detector_id, invitation_id, master_id)
accept_invitation(detector_id, invitation_id, master_id, params::Dict{String,<:Any})
Accepts the invitation to be monitored by a GuardDuty administrator account.
# Arguments
- `detector_id`: The unique ID of the detector of the GuardDuty member account.
- `invitation_id`: The value that is used to validate the administrator account to the
member account.
- `master_id`: The account ID of the GuardDuty administrator account whose invitation
you're accepting.
"""
function accept_invitation(
detectorId, invitationId, masterId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/master",
Dict{String,Any}("invitationId" => invitationId, "masterId" => masterId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_invitation(
detectorId,
invitationId,
masterId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/master",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("invitationId" => invitationId, "masterId" => masterId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
archive_findings(detector_id, finding_ids)
archive_findings(detector_id, finding_ids, params::Dict{String,<:Any})
Archives GuardDuty findings that are specified by the list of finding IDs. Only the
administrator account can archive findings. Member accounts don't have permission to
archive findings from their accounts.
# Arguments
- `detector_id`: The ID of the detector that specifies the GuardDuty service whose findings
you want to archive.
- `finding_ids`: The IDs of the findings that you want to archive.
"""
function archive_findings(
detectorId, findingIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/archive",
Dict{String,Any}("findingIds" => findingIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function archive_findings(
detectorId,
findingIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/archive",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("findingIds" => findingIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_detector(enable)
create_detector(enable, params::Dict{String,<:Any})
Creates a single GuardDuty detector. A detector is a resource that represents the GuardDuty
service. To start using GuardDuty, you must create a detector in each Region where you
enable the service. You can have only one detector per account per Region. All data sources
are enabled in a new detector by default. When you don't specify any features, with an
exception to RUNTIME_MONITORING, all the optional features are enabled by default. When
you specify some of the features, any feature that is not specified in the API call gets
enabled by default, with an exception to RUNTIME_MONITORING. Specifying both EKS Runtime
Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring (RUNTIME_MONITORING) will cause
an error. You can add only one of these two features because Runtime Monitoring already
includes the threat detection for Amazon EKS resources. For more information, see Runtime
Monitoring. There might be regional differences because some data sources might not be
available in all the Amazon Web Services Regions where GuardDuty is presently supported.
For more information, see Regions and endpoints.
# Arguments
- `enable`: A Boolean value that specifies whether the detector is to be enabled.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The idempotency token for the create request.
- `"dataSources"`: Describes which data sources will be enabled for the detector. There
might be regional differences because some data sources might not be available in all the
Amazon Web Services Regions where GuardDuty is presently supported. For more information,
see Regions and endpoints.
- `"features"`: A list of features that will be configured for the detector.
- `"findingPublishingFrequency"`: A value that specifies how frequently updated findings
are exported.
- `"tags"`: The tags to be added to a new detector resource.
"""
function create_detector(enable; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"POST",
"/detector",
Dict{String,Any}("enable" => enable, "clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_detector(
enable, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("enable" => enable, "clientToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_filter(detector_id, finding_criteria, name)
create_filter(detector_id, finding_criteria, name, params::Dict{String,<:Any})
Creates a filter using the specified finding criteria. The maximum number of saved filters
per Amazon Web Services account per Region is 100. For more information, see Quotas for
GuardDuty.
# Arguments
- `detector_id`: The ID of the detector belonging to the GuardDuty account that you want to
create a filter for.
- `finding_criteria`: Represents the criteria to be used in the filter for querying
findings. You can only use the following attributes to query findings: accountId id
region severity To filter on the basis of severity, the API and CLI use the following
input list for the FindingCriteria condition: Low: [\"1\", \"2\", \"3\"] Medium:
[\"4\", \"5\", \"6\"] High: [\"7\", \"8\", \"9\"] For more information, see Severity
levels for GuardDuty findings. type updatedAt Type: ISO 8601 string format:
YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains
milliseconds. resource.accessKeyDetails.accessKeyId
resource.accessKeyDetails.principalId resource.accessKeyDetails.userName
resource.accessKeyDetails.userType resource.instanceDetails.iamInstanceProfile.id
resource.instanceDetails.imageId resource.instanceDetails.instanceId
resource.instanceDetails.tags.key resource.instanceDetails.tags.value
resource.instanceDetails.networkInterfaces.ipv6Addresses
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
resource.instanceDetails.networkInterfaces.publicDnsName
resource.instanceDetails.networkInterfaces.publicIp
resource.instanceDetails.networkInterfaces.securityGroups.groupId
resource.instanceDetails.networkInterfaces.securityGroups.groupName
resource.instanceDetails.networkInterfaces.subnetId
resource.instanceDetails.networkInterfaces.vpcId resource.instanceDetails.outpostArn
resource.resourceType resource.s3BucketDetails.publicAccess.effectivePermissions
resource.s3BucketDetails.name resource.s3BucketDetails.tags.key
resource.s3BucketDetails.tags.value resource.s3BucketDetails.type
service.action.actionType service.action.awsApiCallAction.api
service.action.awsApiCallAction.callerType service.action.awsApiCallAction.errorCode
service.action.awsApiCallAction.remoteIpDetails.city.cityName
service.action.awsApiCallAction.remoteIpDetails.country.countryName
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
service.action.awsApiCallAction.remoteIpDetails.ipAddressV6
service.action.awsApiCallAction.remoteIpDetails.organization.asn
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
service.action.awsApiCallAction.serviceName service.action.dnsRequestAction.domain
service.action.dnsRequestAction.domainWithSuffix
service.action.networkConnectionAction.blocked
service.action.networkConnectionAction.connectionDirection
service.action.networkConnectionAction.localPortDetails.port
service.action.networkConnectionAction.protocol
service.action.networkConnectionAction.remoteIpDetails.city.cityName
service.action.networkConnectionAction.remoteIpDetails.country.countryName
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
service.action.networkConnectionAction.remoteIpDetails.ipAddressV6
service.action.networkConnectionAction.remoteIpDetails.organization.asn
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
service.action.networkConnectionAction.remotePortDetails.port
service.action.awsApiCallAction.remoteAccountDetails.affiliated
service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6
service.action.kubernetesApiCallAction.namespace
service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn
service.action.kubernetesApiCallAction.requestUri
service.action.kubernetesApiCallAction.statusCode
service.action.networkConnectionAction.localIpDetails.ipAddressV4
service.action.networkConnectionAction.localIpDetails.ipAddressV6
service.action.networkConnectionAction.protocol
service.action.awsApiCallAction.serviceName
service.action.awsApiCallAction.remoteAccountDetails.accountId
service.additionalInfo.threatListName service.resourceRole
resource.eksClusterDetails.name resource.kubernetesDetails.kubernetesWorkloadDetails.name
resource.kubernetesDetails.kubernetesWorkloadDetails.namespace
resource.kubernetesDetails.kubernetesUserDetails.username
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
service.ebsVolumeScanDetails.scanId
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
resource.ecsClusterDetails.name resource.ecsClusterDetails.taskDetails.containers.image
resource.ecsClusterDetails.taskDetails.definitionArn resource.containerDetails.image
resource.rdsDbInstanceDetails.dbInstanceIdentifier
resource.rdsDbInstanceDetails.dbClusterIdentifier resource.rdsDbInstanceDetails.engine
resource.rdsDbUserDetails.user resource.rdsDbInstanceDetails.tags.key
resource.rdsDbInstanceDetails.tags.value service.runtimeDetails.process.executableSha256
service.runtimeDetails.process.name service.runtimeDetails.process.name
resource.lambdaDetails.functionName resource.lambdaDetails.functionArn
resource.lambdaDetails.tags.key resource.lambdaDetails.tags.value
- `name`: The name of the filter. Valid characters include period (.), underscore (_), dash
(-), and alphanumeric characters. A whitespace is considered to be an invalid character.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"action"`: Specifies the action that is to be applied to the findings that match the
filter.
- `"clientToken"`: The idempotency token for the create request.
- `"description"`: The description of the filter. Valid characters include alphanumeric
characters, and special characters such as hyphen, period, colon, underscore, parentheses
({ }, [ ], and ( )), forward slash, horizontal tab, vertical tab, newline, form feed,
return, and whitespace.
- `"rank"`: Specifies the position of the filter in the list of current filters. Also
specifies the order in which this filter is applied to the findings.
- `"tags"`: The tags to be added to a new filter resource.
"""
function create_filter(
detectorId, findingCriteria, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/filter",
Dict{String,Any}(
"findingCriteria" => findingCriteria,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_filter(
detectorId,
findingCriteria,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/filter",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"findingCriteria" => findingCriteria,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_ipset(activate, detector_id, format, location, name)
create_ipset(activate, detector_id, format, location, name, params::Dict{String,<:Any})
Creates a new IPSet, which is called a trusted IP list in the console user interface. An
IPSet is a list of IP addresses that are trusted for secure communication with Amazon Web
Services infrastructure and applications. GuardDuty doesn't generate findings for IP
addresses that are included in IPSets. Only users from the administrator account can use
this operation.
# Arguments
- `activate`: A Boolean value that indicates whether GuardDuty is to start using the
uploaded IPSet.
- `detector_id`: The unique ID of the detector of the GuardDuty account that you want to
create an IPSet for.
- `format`: The format of the file that contains the IPSet.
- `location`: The URI of the file that contains the IPSet.
- `name`: The user-friendly name to identify the IPSet. Allowed characters are
alphanumeric, whitespace, dash (-), and underscores (_).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The idempotency token for the create request.
- `"tags"`: The tags to be added to a new IP set resource.
"""
function create_ipset(
activate,
detectorId,
format,
location,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/ipset",
Dict{String,Any}(
"activate" => activate,
"format" => format,
"location" => location,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_ipset(
activate,
detectorId,
format,
location,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/ipset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"activate" => activate,
"format" => format,
"location" => location,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_malware_protection_plan(protected_resource, role)
create_malware_protection_plan(protected_resource, role, params::Dict{String,<:Any})
Creates a new Malware Protection plan for the protected resource. When you create a Malware
Protection plan, the Amazon Web Services service terms for GuardDuty Malware Protection
apply. For more information, see Amazon Web Services service terms for GuardDuty Malware
Protection.
# Arguments
- `protected_resource`: Information about the protected resource that is associated with
the created Malware Protection plan. Presently, S3Bucket is the only supported protected
resource.
- `role`: IAM role with permissions required to scan and add tags to the associated
protected resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"actions"`: Information about whether the tags will be added to the S3 object after
scanning.
- `"clientToken"`: The idempotency token for the create request.
- `"tags"`: Tags added to the Malware Protection plan resource.
"""
function create_malware_protection_plan(
protectedResource, role; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/malware-protection-plan",
Dict{String,Any}(
"protectedResource" => protectedResource,
"role" => role,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_malware_protection_plan(
protectedResource,
role,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/malware-protection-plan",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"protectedResource" => protectedResource,
"role" => role,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_members(account_details, detector_id)
create_members(account_details, detector_id, params::Dict{String,<:Any})
Creates member accounts of the current Amazon Web Services account by specifying a list of
Amazon Web Services account IDs. This step is a prerequisite for managing the associated
member accounts either by invitation or through an organization. As a delegated
administrator, using CreateMembers will enable GuardDuty in the added member accounts, with
the exception of the organization delegated administrator account. A delegated
administrator must enable GuardDuty prior to being added as a member. When you use
CreateMembers as an Organizations delegated administrator, GuardDuty applies your
organization's auto-enable settings to the member accounts in this request, irrespective of
the accounts being new or existing members. For more information about the existing
auto-enable settings for your organization, see DescribeOrganizationConfiguration. If you
disassociate a member account that was added by invitation, the member account details
obtained from this API, including the associated email addresses, will be retained. This is
done so that the delegated administrator can invoke the InviteMembers API without the need
to invoke the CreateMembers API again. To remove the details associated with a member
account, the delegated administrator must invoke the DeleteMembers API. When the member
accounts added through Organizations are later disassociated, you (administrator) can't
invite them by calling the InviteMembers API. You can create an association with these
member accounts again only by calling the CreateMembers API.
# Arguments
- `account_details`: A list of account ID and email address pairs of the accounts that you
want to associate with the GuardDuty administrator account.
- `detector_id`: The unique ID of the detector of the GuardDuty account that you want to
associate member accounts with.
"""
function create_members(
accountDetails, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/member",
Dict{String,Any}("accountDetails" => accountDetails);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_members(
accountDetails,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/member",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountDetails" => accountDetails), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_publishing_destination(destination_properties, destination_type, detector_id)
create_publishing_destination(destination_properties, destination_type, detector_id, params::Dict{String,<:Any})
Creates a publishing destination to export findings to. The resource to export findings to
must exist before you use this operation.
# Arguments
- `destination_properties`: The properties of the publishing destination, including the
ARNs for the destination and the KMS key used for encryption.
- `destination_type`: The type of resource for the publishing destination. Currently only
Amazon S3 buckets are supported.
- `detector_id`: The ID of the GuardDuty detector associated with the publishing
destination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The idempotency token for the request.
"""
function create_publishing_destination(
destinationProperties,
destinationType,
detectorId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/publishingDestination",
Dict{String,Any}(
"destinationProperties" => destinationProperties,
"destinationType" => destinationType,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_publishing_destination(
destinationProperties,
destinationType,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/publishingDestination",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"destinationProperties" => destinationProperties,
"destinationType" => destinationType,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sample_findings(detector_id)
create_sample_findings(detector_id, params::Dict{String,<:Any})
Generates sample findings of types specified by the list of finding types. If 'NULL' is
specified for findingTypes, the API generates sample findings of all supported finding
types.
# Arguments
- `detector_id`: The ID of the detector to create sample findings for.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"findingTypes"`: The types of sample findings to generate.
"""
function create_sample_findings(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/create";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sample_findings(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/create",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_threat_intel_set(activate, detector_id, format, location, name)
create_threat_intel_set(activate, detector_id, format, location, name, params::Dict{String,<:Any})
Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses.
GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator
account can use this operation.
# Arguments
- `activate`: A Boolean value that indicates whether GuardDuty is to start using the
uploaded ThreatIntelSet.
- `detector_id`: The unique ID of the detector of the GuardDuty account that you want to
create a threatIntelSet for.
- `format`: The format of the file that contains the ThreatIntelSet.
- `location`: The URI of the file that contains the ThreatIntelSet.
- `name`: A user-friendly ThreatIntelSet name displayed in all findings that are generated
by activity that involves IP addresses included in this ThreatIntelSet.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The idempotency token for the create request.
- `"tags"`: The tags to be added to a new threat list resource.
"""
function create_threat_intel_set(
activate,
detectorId,
format,
location,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/threatintelset",
Dict{String,Any}(
"activate" => activate,
"format" => format,
"location" => location,
"name" => name,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_threat_intel_set(
activate,
detectorId,
format,
location,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/threatintelset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"activate" => activate,
"format" => format,
"location" => location,
"name" => name,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
decline_invitations(account_ids)
decline_invitations(account_ids, params::Dict{String,<:Any})
Declines invitations sent to the current member account by Amazon Web Services accounts
specified by their account IDs.
# Arguments
- `account_ids`: A list of account IDs of the Amazon Web Services accounts that sent
invitations to the current member account that you want to decline invitations from.
"""
function decline_invitations(accountIds; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"POST",
"/invitation/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 guardduty(
"POST",
"/invitation/decline",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_detector(detector_id)
delete_detector(detector_id, params::Dict{String,<:Any})
Deletes an Amazon GuardDuty detector that is specified by the detector ID.
# Arguments
- `detector_id`: The unique ID of the detector that you want to delete.
"""
function delete_detector(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"DELETE",
"/detector/$(detectorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_detector(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"DELETE",
"/detector/$(detectorId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_filter(detector_id, filter_name)
delete_filter(detector_id, filter_name, params::Dict{String,<:Any})
Deletes the filter specified by the filter name.
# Arguments
- `detector_id`: The unique ID of the detector that the filter is associated with.
- `filter_name`: The name of the filter that you want to delete.
"""
function delete_filter(
detectorId, filterName; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"DELETE",
"/detector/$(detectorId)/filter/$(filterName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_filter(
detectorId,
filterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"DELETE",
"/detector/$(detectorId)/filter/$(filterName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_invitations(account_ids)
delete_invitations(account_ids, params::Dict{String,<:Any})
Deletes invitations sent to the current member account by Amazon Web Services accounts
specified by their account IDs.
# Arguments
- `account_ids`: A list of account IDs of the Amazon Web Services accounts that sent
invitations to the current member account that you want to delete invitations from.
"""
function delete_invitations(accountIds; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"POST",
"/invitation/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 guardduty(
"POST",
"/invitation/delete",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_ipset(detector_id, ip_set_id)
delete_ipset(detector_id, ip_set_id, params::Dict{String,<:Any})
Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the
console user interface.
# Arguments
- `detector_id`: The unique ID of the detector associated with the IPSet.
- `ip_set_id`: The unique ID of the IPSet to delete.
"""
function delete_ipset(
detectorId, ipSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"DELETE",
"/detector/$(detectorId)/ipset/$(ipSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_ipset(
detectorId,
ipSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"DELETE",
"/detector/$(detectorId)/ipset/$(ipSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_malware_protection_plan(malware_protection_plan_id)
delete_malware_protection_plan(malware_protection_plan_id, params::Dict{String,<:Any})
Deletes the Malware Protection plan ID associated with the Malware Protection plan
resource. Use this API only when you no longer want to protect the resource associated with
this Malware Protection plan ID.
# Arguments
- `malware_protection_plan_id`: A unique identifier associated with Malware Protection plan
resource.
"""
function delete_malware_protection_plan(
malwareProtectionPlanId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"DELETE",
"/malware-protection-plan/$(malwareProtectionPlanId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_malware_protection_plan(
malwareProtectionPlanId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"DELETE",
"/malware-protection-plan/$(malwareProtectionPlanId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_members(account_ids, detector_id)
delete_members(account_ids, detector_id, params::Dict{String,<:Any})
Deletes GuardDuty member accounts (to the current GuardDuty administrator account)
specified by the account IDs. With autoEnableOrganizationMembers configuration for your
organization set to ALL, you'll receive an error if you attempt to disable GuardDuty for a
member account in your organization.
# Arguments
- `account_ids`: A list of account IDs of the GuardDuty member accounts that you want to
delete.
- `detector_id`: The unique ID of the detector of the GuardDuty account whose members you
want to delete.
"""
function delete_members(
accountIds, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/delete",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_members(
accountIds,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/delete",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_publishing_destination(destination_id, detector_id)
delete_publishing_destination(destination_id, detector_id, params::Dict{String,<:Any})
Deletes the publishing definition with the specified destinationId.
# Arguments
- `destination_id`: The ID of the publishing destination to delete.
- `detector_id`: The unique ID of the detector associated with the publishing destination
to delete.
"""
function delete_publishing_destination(
destinationId, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"DELETE",
"/detector/$(detectorId)/publishingDestination/$(destinationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_publishing_destination(
destinationId,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"DELETE",
"/detector/$(detectorId)/publishingDestination/$(destinationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_threat_intel_set(detector_id, threat_intel_set_id)
delete_threat_intel_set(detector_id, threat_intel_set_id, params::Dict{String,<:Any})
Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
# Arguments
- `detector_id`: The unique ID of the detector that the threatIntelSet is associated with.
- `threat_intel_set_id`: The unique ID of the threatIntelSet that you want to delete.
"""
function delete_threat_intel_set(
detectorId, threatIntelSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"DELETE",
"/detector/$(detectorId)/threatintelset/$(threatIntelSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_threat_intel_set(
detectorId,
threatIntelSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"DELETE",
"/detector/$(detectorId)/threatintelset/$(threatIntelSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_malware_scans(detector_id)
describe_malware_scans(detector_id, params::Dict{String,<:Any})
Returns a list of malware scans. Each member account can view the malware scans for their
own accounts. An administrator can view the malware scans for all the member accounts.
There might be regional differences because some data sources might not be available in all
the Amazon Web Services Regions where GuardDuty is presently supported. For more
information, see Regions and endpoints.
# Arguments
- `detector_id`: The unique ID of the detector that the request is associated with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: Represents the criteria to be used in the filter for describing scan
entries.
- `"maxResults"`: You can use this parameter to indicate the maximum number of items that
you want in the response. The default value is 50. The maximum value is 50.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the list action. For subsequent calls to the
action, fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
- `"sortCriteria"`: Represents the criteria used for sorting scan entries. The
attributeName is required and it must be scanStartTime.
"""
function describe_malware_scans(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/malware-scans";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_malware_scans(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/malware-scans",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_configuration(detector_id)
describe_organization_configuration(detector_id, params::Dict{String,<:Any})
Returns information about the account selected as the delegated administrator for
GuardDuty. There might be regional differences because some data sources might not be
available in all the Amazon Web Services Regions where GuardDuty is presently supported.
For more information, see Regions and endpoints.
# Arguments
- `detector_id`: The ID of the detector to retrieve information about the delegated
administrator from.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items that
you want in the response.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the list action. For subsequent calls to the
action, fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
"""
function describe_organization_configuration(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/detector/$(detectorId)/admin";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_configuration(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/admin",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_publishing_destination(destination_id, detector_id)
describe_publishing_destination(destination_id, detector_id, params::Dict{String,<:Any})
Returns information about the publishing destination specified by the provided
destinationId.
# Arguments
- `destination_id`: The ID of the publishing destination to retrieve.
- `detector_id`: The unique ID of the detector associated with the publishing destination
to retrieve.
"""
function describe_publishing_destination(
destinationId, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/detector/$(detectorId)/publishingDestination/$(destinationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_publishing_destination(
destinationId,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/publishingDestination/$(destinationId)",
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})
Removes the existing GuardDuty delegated administrator of the organization. Only the
organization's management account can run this API operation.
# Arguments
- `admin_account_id`: The Amazon Web Services Account ID for the organizations account to
be disabled as a GuardDuty delegated administrator.
"""
function disable_organization_admin_account(
adminAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/admin/disable",
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 guardduty(
"POST",
"/admin/disable",
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(detector_id)
disassociate_from_administrator_account(detector_id, params::Dict{String,<:Any})
Disassociates the current GuardDuty member account from its administrator account. When you
disassociate an invited member from a GuardDuty delegated administrator, the member account
details obtained from the CreateMembers API, including the associated email addresses, are
retained. This is done so that the delegated administrator can invoke the InviteMembers API
without the need to invoke the CreateMembers API again. To remove the details associated
with a member account, the delegated administrator must invoke the DeleteMembers API. With
autoEnableOrganizationMembers configuration for your organization set to ALL, you'll
receive an error if you attempt to disable GuardDuty in a member account.
# Arguments
- `detector_id`: The unique ID of the detector of the GuardDuty member account.
"""
function disassociate_from_administrator_account(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/administrator/disassociate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_from_administrator_account(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/administrator/disassociate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_from_master_account(detector_id)
disassociate_from_master_account(detector_id, params::Dict{String,<:Any})
Disassociates the current GuardDuty member account from its administrator account. When you
disassociate an invited member from a GuardDuty delegated administrator, the member account
details obtained from the CreateMembers API, including the associated email addresses, are
retained. This is done so that the delegated administrator can invoke the InviteMembers API
without the need to invoke the CreateMembers API again. To remove the details associated
with a member account, the delegated administrator must invoke the DeleteMembers API.
# Arguments
- `detector_id`: The unique ID of the detector of the GuardDuty member account.
"""
function disassociate_from_master_account(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/master/disassociate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_from_master_account(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/master/disassociate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_members(account_ids, detector_id)
disassociate_members(account_ids, detector_id, params::Dict{String,<:Any})
Disassociates GuardDuty member accounts (from the current administrator account) specified
by the account IDs. When you disassociate an invited member from a GuardDuty delegated
administrator, the member account details obtained from the CreateMembers API, including
the associated email addresses, are retained. This is done so that the delegated
administrator can invoke the InviteMembers API without the need to invoke the CreateMembers
API again. To remove the details associated with a member account, the delegated
administrator must invoke the DeleteMembers API. With autoEnableOrganizationMembers
configuration for your organization set to ALL, you'll receive an error if you attempt to
disassociate a member account before removing them from your organization. If you
disassociate a member account that was added by invitation, the member account details
obtained from this API, including the associated email addresses, will be retained. This is
done so that the delegated administrator can invoke the InviteMembers API without the need
to invoke the CreateMembers API again. To remove the details associated with a member
account, the delegated administrator must invoke the DeleteMembers API. When the member
accounts added through Organizations are later disassociated, you (administrator) can't
invite them by calling the InviteMembers API. You can create an association with these
member accounts again only by calling the CreateMembers API.
# Arguments
- `account_ids`: A list of account IDs of the GuardDuty member accounts that you want to
disassociate from the administrator account.
- `detector_id`: The unique ID of the detector of the GuardDuty account whose members you
want to disassociate from the administrator account.
"""
function disassociate_members(
accountIds, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/disassociate",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_members(
accountIds,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/disassociate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), 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 Amazon Web Services account within the organization as your GuardDuty
delegated administrator. Only the organization's management account can run this API
operation.
# Arguments
- `admin_account_id`: The Amazon Web Services account ID for the organization account to be
enabled as a GuardDuty delegated administrator.
"""
function enable_organization_admin_account(
adminAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/admin/enable",
Dict{String,Any}("adminAccountId" => adminAccountId);
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 guardduty(
"POST",
"/admin/enable",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("adminAccountId" => adminAccountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_administrator_account(detector_id)
get_administrator_account(detector_id, params::Dict{String,<:Any})
Provides the details of the GuardDuty administrator account associated with the current
GuardDuty member account. If the organization's management account or a delegated
administrator runs this API, it will return success (HTTP 200) but no content.
# Arguments
- `detector_id`: The unique ID of the detector of the GuardDuty member account.
"""
function get_administrator_account(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/detector/$(detectorId)/administrator";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_administrator_account(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/administrator",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_coverage_statistics(detector_id, statistics_type)
get_coverage_statistics(detector_id, statistics_type, params::Dict{String,<:Any})
Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you
can retrieve the statistics for all the resources associated with the active member
accounts in your organization who have enabled Runtime Monitoring and have the GuardDuty
security agent running on their resources.
# Arguments
- `detector_id`: The unique ID of the GuardDuty detector associated to the coverage
statistics.
- `statistics_type`: Represents the statistics type used to aggregate the coverage details.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: Represents the criteria used to filter the coverage statistics
"""
function get_coverage_statistics(
detectorId, statisticsType; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/coverage/statistics",
Dict{String,Any}("statisticsType" => statisticsType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_coverage_statistics(
detectorId,
statisticsType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/coverage/statistics",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("statisticsType" => statisticsType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_detector(detector_id)
get_detector(detector_id, params::Dict{String,<:Any})
Retrieves an Amazon GuardDuty detector specified by the detectorId. There might be regional
differences because some data sources might not be available in all the Amazon Web Services
Regions where GuardDuty is presently supported. For more information, see Regions and
endpoints.
# Arguments
- `detector_id`: The unique ID of the detector that you want to get.
"""
function get_detector(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET",
"/detector/$(detectorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_detector(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_filter(detector_id, filter_name)
get_filter(detector_id, filter_name, params::Dict{String,<:Any})
Returns the details of the filter specified by the filter name.
# Arguments
- `detector_id`: The unique ID of the detector that the filter is associated with.
- `filter_name`: The name of the filter you want to get.
"""
function get_filter(
detectorId, filterName; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/detector/$(detectorId)/filter/$(filterName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_filter(
detectorId,
filterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/filter/$(filterName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_findings(detector_id, finding_ids)
get_findings(detector_id, finding_ids, params::Dict{String,<:Any})
Describes Amazon GuardDuty findings specified by finding IDs.
# Arguments
- `detector_id`: The ID of the detector that specifies the GuardDuty service whose findings
you want to retrieve.
- `finding_ids`: The IDs of the findings that you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"sortCriteria"`: Represents the criteria used for sorting findings.
"""
function get_findings(
detectorId, findingIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/get",
Dict{String,Any}("findingIds" => findingIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_findings(
detectorId,
findingIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/get",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("findingIds" => findingIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_findings_statistics(detector_id, finding_statistic_types)
get_findings_statistics(detector_id, finding_statistic_types, params::Dict{String,<:Any})
Lists Amazon GuardDuty findings statistics for the specified detector ID. There might be
regional differences because some flags might not be available in all the Regions where
GuardDuty is currently supported. For more information, see Regions and endpoints.
# Arguments
- `detector_id`: The ID of the detector that specifies the GuardDuty service whose
findings' statistics you want to retrieve.
- `finding_statistic_types`: The types of finding statistics to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"findingCriteria"`: Represents the criteria that is used for querying findings.
"""
function get_findings_statistics(
detectorId, findingStatisticTypes; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/statistics",
Dict{String,Any}("findingStatisticTypes" => findingStatisticTypes);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_findings_statistics(
detectorId,
findingStatisticTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/statistics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("findingStatisticTypes" => findingStatisticTypes),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_invitations_count()
get_invitations_count(params::Dict{String,<:Any})
Returns the count of all GuardDuty membership invitations that were sent to the current
member account except the currently accepted invitation.
"""
function get_invitations_count(; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET", "/invitation/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 guardduty(
"GET",
"/invitation/count",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ipset(detector_id, ip_set_id)
get_ipset(detector_id, ip_set_id, params::Dict{String,<:Any})
Retrieves the IPSet specified by the ipSetId.
# Arguments
- `detector_id`: The unique ID of the detector that the IPSet is associated with.
- `ip_set_id`: The unique ID of the IPSet to retrieve.
"""
function get_ipset(detectorId, ipSetId; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET",
"/detector/$(detectorId)/ipset/$(ipSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ipset(
detectorId,
ipSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/ipset/$(ipSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_malware_protection_plan(malware_protection_plan_id)
get_malware_protection_plan(malware_protection_plan_id, params::Dict{String,<:Any})
Retrieves the Malware Protection plan details associated with a Malware Protection plan ID.
# Arguments
- `malware_protection_plan_id`: A unique identifier associated with Malware Protection plan
resource.
"""
function get_malware_protection_plan(
malwareProtectionPlanId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/malware-protection-plan/$(malwareProtectionPlanId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_malware_protection_plan(
malwareProtectionPlanId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/malware-protection-plan/$(malwareProtectionPlanId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_malware_scan_settings(detector_id)
get_malware_scan_settings(detector_id, params::Dict{String,<:Any})
Returns the details of the malware scan settings. There might be regional differences
because some data sources might not be available in all the Amazon Web Services Regions
where GuardDuty is presently supported. For more information, see Regions and endpoints.
# Arguments
- `detector_id`: The unique ID of the detector that the scan setting is associated with.
"""
function get_malware_scan_settings(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/detector/$(detectorId)/malware-scan-settings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_malware_scan_settings(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/malware-scan-settings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_master_account(detector_id)
get_master_account(detector_id, params::Dict{String,<:Any})
Provides the details for the GuardDuty administrator account associated with the current
GuardDuty member account.
# Arguments
- `detector_id`: The unique ID of the detector of the GuardDuty member account.
"""
function get_master_account(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET",
"/detector/$(detectorId)/master";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_master_account(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/master",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_member_detectors(account_ids, detector_id)
get_member_detectors(account_ids, detector_id, params::Dict{String,<:Any})
Describes which data sources are enabled for the member account's detector. There might be
regional differences because some data sources might not be available in all the Amazon Web
Services Regions where GuardDuty is presently supported. For more information, see Regions
and endpoints.
# Arguments
- `account_ids`: The account ID of the member account.
- `detector_id`: The detector ID for the administrator account.
"""
function get_member_detectors(
accountIds, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/detector/get",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_member_detectors(
accountIds,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/detector/get",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_members(account_ids, detector_id)
get_members(account_ids, detector_id, params::Dict{String,<:Any})
Retrieves GuardDuty member accounts (of the current GuardDuty administrator account)
specified by the account IDs.
# Arguments
- `account_ids`: A list of account IDs of the GuardDuty member accounts that you want to
describe.
- `detector_id`: The unique ID of the detector of the GuardDuty account whose members you
want to retrieve.
"""
function get_members(
accountIds, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/get",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_members(
accountIds,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/get",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_organization_statistics()
get_organization_statistics(params::Dict{String,<:Any})
Retrieves how many active member accounts have each feature enabled within GuardDuty. Only
a delegated GuardDuty administrator of an organization can run this API. When you create a
new organization, it might take up to 24 hours to generate the statistics for the entire
organization.
"""
function get_organization_statistics(; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET",
"/organization/statistics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_organization_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/organization/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_remaining_free_trial_days(detector_id)
get_remaining_free_trial_days(detector_id, params::Dict{String,<:Any})
Provides the number of days left for each data source used in the free trial period.
# Arguments
- `detector_id`: The unique ID of the detector of the GuardDuty member account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: A list of account identifiers of the GuardDuty member account.
"""
function get_remaining_free_trial_days(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/freeTrial/daysRemaining";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_remaining_free_trial_days(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/freeTrial/daysRemaining",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_threat_intel_set(detector_id, threat_intel_set_id)
get_threat_intel_set(detector_id, threat_intel_set_id, params::Dict{String,<:Any})
Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
# Arguments
- `detector_id`: The unique ID of the detector that the threatIntelSet is associated with.
- `threat_intel_set_id`: The unique ID of the threatIntelSet that you want to get.
"""
function get_threat_intel_set(
detectorId, threatIntelSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/detector/$(detectorId)/threatintelset/$(threatIntelSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_threat_intel_set(
detectorId,
threatIntelSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/threatintelset/$(threatIntelSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_usage_statistics(detector_id, usage_criteria, usage_statistics_type)
get_usage_statistics(detector_id, usage_criteria, usage_statistics_type, params::Dict{String,<:Any})
Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector
ID. For newly enabled detectors or data sources, the cost returned will include only the
usage so far under 30 days. This may differ from the cost metrics in the console, which
project usage over 30 days to provide a monthly cost estimate. For more information, see
Understanding How Usage Costs are Calculated.
# Arguments
- `detector_id`: The ID of the detector that specifies the GuardDuty service whose usage
statistics you want to retrieve.
- `usage_criteria`: Represents the criteria used for querying usage.
- `usage_statistics_type`: The type of usage statistics to retrieve.
# 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"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. For
subsequent calls, use the NextToken value returned from the previous request to continue
listing results after the first page.
- `"unit"`: The currency unit you would like to view your usage statistics in. Current
valid values are USD.
"""
function get_usage_statistics(
detectorId,
usageCriteria,
usageStatisticsType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/usage/statistics",
Dict{String,Any}(
"usageCriteria" => usageCriteria, "usageStatisticsType" => usageStatisticsType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_usage_statistics(
detectorId,
usageCriteria,
usageStatisticsType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/usage/statistics",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"usageCriteria" => usageCriteria,
"usageStatisticsType" => usageStatisticsType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
invite_members(account_ids, detector_id)
invite_members(account_ids, detector_id, params::Dict{String,<:Any})
Invites Amazon Web Services accounts to become members of an organization administered by
the Amazon Web Services account that invokes this API. If you are using Amazon Web Services
Organizations to manage your GuardDuty environment, this step is not needed. For more
information, see Managing accounts with organizations. To invite Amazon Web Services
accounts, the first step is to ensure that GuardDuty has been enabled in the potential
member accounts. You can now invoke this API to add accounts by invitation. The invited
accounts can either accept or decline the invitation from their GuardDuty accounts. Each
invited Amazon Web Services account can choose to accept the invitation from only one
Amazon Web Services account. For more information, see Managing GuardDuty accounts by
invitation. After the invite has been accepted and you choose to disassociate a member
account (by using DisassociateMembers) from your account, the details of the member account
obtained by invoking CreateMembers, including the associated email addresses, will be
retained. This is done so that you can invoke InviteMembers without the need to invoke
CreateMembers again. To remove the details associated with a member account, you must also
invoke DeleteMembers. If you disassociate a member account that was added by invitation,
the member account details obtained from this API, including the associated email
addresses, will be retained. This is done so that the delegated administrator can invoke
the InviteMembers API without the need to invoke the CreateMembers API again. To remove the
details associated with a member account, the delegated administrator must invoke the
DeleteMembers API. When the member accounts added through Organizations are later
disassociated, you (administrator) can't invite them by calling the InviteMembers API. You
can create an association with these member accounts again only by calling the
CreateMembers API.
# Arguments
- `account_ids`: A list of account IDs of the accounts that you want to invite to GuardDuty
as members.
- `detector_id`: The unique ID of the detector of the GuardDuty account that you want to
invite members with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"disableEmailNotification"`: A Boolean value that specifies whether you want to disable
email notification to the accounts that you are inviting to GuardDuty as members.
- `"message"`: The invitation message that you want to send to the accounts that you're
inviting to GuardDuty as members.
"""
function invite_members(
accountIds, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/invite",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function invite_members(
accountIds,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/invite",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_coverage(detector_id)
list_coverage(detector_id, params::Dict{String,<:Any})
Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you
can retrieve all resources associated with the active member accounts in your organization.
Make sure the accounts have Runtime Monitoring enabled and GuardDuty agent running on their
resources.
# Arguments
- `detector_id`: The unique ID of the detector whose coverage details you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: Represents the criteria used to filter the coverage details.
- `"maxResults"`: The maximum number of results to return in the response.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. For
subsequent calls, use the NextToken value returned from the previous request to continue
listing results after the first page.
- `"sortCriteria"`: Represents the criteria used to sort the coverage details.
"""
function list_coverage(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"POST",
"/detector/$(detectorId)/coverage";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_coverage(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/coverage",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_detectors()
list_detectors(params::Dict{String,<:Any})
Lists detectorIds of all the existing Amazon GuardDuty detector resources.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items that
you want in the response. The default value is 50. The maximum value is 50.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the list action. For subsequent calls to the
action, fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
"""
function list_detectors(; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET", "/detector"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_detectors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET", "/detector", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_filters(detector_id)
list_filters(detector_id, params::Dict{String,<:Any})
Returns a paginated list of the current filters.
# Arguments
- `detector_id`: The unique ID of the detector that the filter is associated with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items that
you want in the response. The default value is 50. The maximum value is 50.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the list action. For subsequent calls to the
action, fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
"""
function list_filters(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET",
"/detector/$(detectorId)/filter";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_filters(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/filter",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_findings(detector_id)
list_findings(detector_id, params::Dict{String,<:Any})
Lists GuardDuty findings for the specified detector ID. There might be regional differences
because some flags might not be available in all the Regions where GuardDuty is currently
supported. For more information, see Regions and endpoints.
# Arguments
- `detector_id`: The ID of the detector that specifies the GuardDuty service whose findings
you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"findingCriteria"`: Represents the criteria used for querying findings. Valid values
include: JSON field name accountId region confidence id
resource.accessKeyDetails.accessKeyId resource.accessKeyDetails.principalId
resource.accessKeyDetails.userName resource.accessKeyDetails.userType
resource.instanceDetails.iamInstanceProfile.id resource.instanceDetails.imageId
resource.instanceDetails.instanceId
resource.instanceDetails.networkInterfaces.ipv6Addresses
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
resource.instanceDetails.networkInterfaces.publicDnsName
resource.instanceDetails.networkInterfaces.publicIp
resource.instanceDetails.networkInterfaces.securityGroups.groupId
resource.instanceDetails.networkInterfaces.securityGroups.groupName
resource.instanceDetails.networkInterfaces.subnetId
resource.instanceDetails.networkInterfaces.vpcId resource.instanceDetails.tags.key
resource.instanceDetails.tags.value resource.resourceType service.action.actionType
service.action.awsApiCallAction.api service.action.awsApiCallAction.callerType
service.action.awsApiCallAction.remoteIpDetails.city.cityName
service.action.awsApiCallAction.remoteIpDetails.country.countryName
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
service.action.awsApiCallAction.remoteIpDetails.organization.asn
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
service.action.awsApiCallAction.serviceName service.action.dnsRequestAction.domain
service.action.dnsRequestAction.domainWithSuffix
service.action.networkConnectionAction.blocked
service.action.networkConnectionAction.connectionDirection
service.action.networkConnectionAction.localPortDetails.port
service.action.networkConnectionAction.protocol
service.action.networkConnectionAction.remoteIpDetails.country.countryName
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
service.action.networkConnectionAction.remoteIpDetails.organization.asn
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
service.action.networkConnectionAction.remotePortDetails.port
service.additionalInfo.threatListName service.archived When this attribute is set to
'true', only archived findings are listed. When it's set to 'false', only unarchived
findings are listed. When this attribute is not set, all existing findings are listed.
service.resourceRole severity type updatedAt Type: Timestamp in Unix Epoch
millisecond format: 1486685375000
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 50. The maximum value is 50.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the list action. For subsequent calls to the
action, fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
- `"sortCriteria"`: Represents the criteria used for sorting findings.
"""
function list_findings(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"POST",
"/detector/$(detectorId)/findings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_findings(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_invitations()
list_invitations(params::Dict{String,<:Any})
Lists all GuardDuty membership invitations that were sent to the current Amazon Web
Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items that
you want in the response. The default value is 50. The maximum value is 50.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the list action. For subsequent calls to the
action, fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
"""
function list_invitations(; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET", "/invitation"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_invitations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET", "/invitation", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_ipsets(detector_id)
list_ipsets(detector_id, params::Dict{String,<:Any})
Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this
operation from a member account, the IPSets returned are the IPSets from the associated
administrator account.
# Arguments
- `detector_id`: The unique ID of the detector that the IPSet is associated with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 50. The maximum value is 50.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the list action. For subsequent calls to the
action, fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
"""
function list_ipsets(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET",
"/detector/$(detectorId)/ipset";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_ipsets(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/ipset",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_malware_protection_plans()
list_malware_protection_plans(params::Dict{String,<:Any})
Lists the Malware Protection plan IDs associated with the protected resources in your
Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the list action. For subsequent calls to the
action, fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
"""
function list_malware_protection_plans(; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET",
"/malware-protection-plan";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_malware_protection_plans(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/malware-protection-plan",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_members(detector_id)
list_members(detector_id, params::Dict{String,<:Any})
Lists details about all member accounts for the current GuardDuty administrator account.
# Arguments
- `detector_id`: The unique ID of the detector the member is associated with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 50. The maximum value is 50.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the list action. For subsequent calls to the
action, fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
- `"onlyAssociated"`: Specifies whether to only return associated members or to return all
members (including members who haven't been invited yet or have been disassociated). Member
accounts must have been previously associated with the GuardDuty administrator account
using Create Members .
"""
function list_members(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"GET",
"/detector/$(detectorId)/member";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_members(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/member",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_organization_admin_accounts()
list_organization_admin_accounts(params::Dict{String,<:Any})
Lists the accounts designated as GuardDuty delegated administrators. Only the
organization's management account can run this API 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 the response.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. For
subsequent calls, use the NextToken value returned from the previous request to continue
listing results after the first page.
"""
function list_organization_admin_accounts(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"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 guardduty(
"GET", "/admin", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_publishing_destinations(detector_id)
list_publishing_destinations(detector_id, params::Dict{String,<:Any})
Returns a list of publishing destinations associated with the specified detectorId.
# Arguments
- `detector_id`: The ID of the detector to retrieve publishing destinations for.
# 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"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. For
subsequent calls, use the NextToken value returned from the previous request to continue
listing results after the first page.
"""
function list_publishing_destinations(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/detector/$(detectorId)/publishingDestination";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_publishing_destinations(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/publishingDestination",
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 tags for a resource. Tagging is currently supported for detectors, finding filters,
IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per
resource. When invoked, this operation returns all assigned tags for a given resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for the given GuardDuty resource.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"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 guardduty(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_threat_intel_sets(detector_id)
list_threat_intel_sets(detector_id, params::Dict{String,<:Any})
Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use
this operation from a member account, the ThreatIntelSets associated with the administrator
account are returned.
# Arguments
- `detector_id`: The unique ID of the detector that the threatIntelSet is associated with.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items that
you want in the response. The default value is 50. The maximum value is 50.
- `"nextToken"`: You can use this parameter to paginate results in the response. Set the
value of this parameter to null on your first call to the list action. For subsequent calls
to the action, fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
"""
function list_threat_intel_sets(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"GET",
"/detector/$(detectorId)/threatintelset";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_threat_intel_sets(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"GET",
"/detector/$(detectorId)/threatintelset",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_malware_scan(resource_arn)
start_malware_scan(resource_arn, params::Dict{String,<:Any})
Initiates the malware scan. Invoking this API will automatically create the Service-linked
role in the corresponding account. When the malware scan starts, you can use the associated
scan ID to track the status of the scan. For more information, see DescribeMalwareScans.
# Arguments
- `resource_arn`: Amazon Resource Name (ARN) of the resource for which you invoked the API.
"""
function start_malware_scan(resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"POST",
"/malware-scan/start",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_malware_scan(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/malware-scan/start",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_monitoring_members(account_ids, detector_id)
start_monitoring_members(account_ids, detector_id, params::Dict{String,<:Any})
Turns on GuardDuty monitoring of the specified member accounts. Use this operation to
restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers
operation.
# Arguments
- `account_ids`: A list of account IDs of the GuardDuty member accounts to start monitoring.
- `detector_id`: The unique ID of the detector of the GuardDuty administrator account
associated with the member accounts to monitor.
"""
function start_monitoring_members(
accountIds, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/start",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_monitoring_members(
accountIds,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/start",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_monitoring_members(account_ids, detector_id)
stop_monitoring_members(account_ids, detector_id, params::Dict{String,<:Any})
Stops GuardDuty monitoring for the specified member accounts. Use the
StartMonitoringMembers operation to restart monitoring for those accounts. With
autoEnableOrganizationMembers configuration for your organization set to ALL, you'll
receive an error if you attempt to stop monitoring the member accounts in your organization.
# Arguments
- `account_ids`: A list of account IDs for the member accounts to stop monitoring.
- `detector_id`: The unique ID of the detector associated with the GuardDuty administrator
account that is monitoring member accounts.
"""
function stop_monitoring_members(
accountIds, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/stop",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_monitoring_members(
accountIds,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/stop",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), 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 Amazon Resource Name (ARN) for the GuardDuty resource to apply a tag
to.
- `tags`: The tags to be added to a resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"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 guardduty(
"POST",
"/tags/$(resourceArn)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("tags" => tags), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unarchive_findings(detector_id, finding_ids)
unarchive_findings(detector_id, finding_ids, params::Dict{String,<:Any})
Unarchives GuardDuty findings specified by the findingIds.
# Arguments
- `detector_id`: The ID of the detector associated with the findings to unarchive.
- `finding_ids`: The IDs of the findings to unarchive.
"""
function unarchive_findings(
detectorId, findingIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/unarchive",
Dict{String,Any}("findingIds" => findingIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unarchive_findings(
detectorId,
findingIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/unarchive",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("findingIds" => findingIds), 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 Amazon Resource Name (ARN) for the resource to remove tags from.
- `tag_keys`: The tag keys to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"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 guardduty(
"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_detector(detector_id)
update_detector(detector_id, params::Dict{String,<:Any})
Updates the GuardDuty detector specified by the detector ID. Specifying both EKS Runtime
Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring (RUNTIME_MONITORING) will cause
an error. You can add only one of these two features because Runtime Monitoring already
includes the threat detection for Amazon EKS resources. For more information, see Runtime
Monitoring. There might be regional differences because some data sources might not be
available in all the Amazon Web Services Regions where GuardDuty is presently supported.
For more information, see Regions and endpoints.
# Arguments
- `detector_id`: The unique ID of the detector to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSources"`: Describes which data sources will be updated. There might be regional
differences because some data sources might not be available in all the Amazon Web Services
Regions where GuardDuty is presently supported. For more information, see Regions and
endpoints.
- `"enable"`: Specifies whether the detector is enabled or not enabled.
- `"features"`: Provides the features that will be updated for the detector.
- `"findingPublishingFrequency"`: An enum value that specifies how frequently findings are
exported, such as to CloudWatch Events.
"""
function update_detector(detectorId; aws_config::AbstractAWSConfig=global_aws_config())
return guardduty(
"POST",
"/detector/$(detectorId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_detector(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_filter(detector_id, filter_name)
update_filter(detector_id, filter_name, params::Dict{String,<:Any})
Updates the filter specified by the filter name.
# Arguments
- `detector_id`: The unique ID of the detector that specifies the GuardDuty service where
you want to update a filter.
- `filter_name`: The name of the filter.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"action"`: Specifies the action that is to be applied to the findings that match the
filter.
- `"description"`: The description of the filter. Valid characters include alphanumeric
characters, and special characters such as hyphen, period, colon, underscore, parentheses
({ }, [ ], and ( )), forward slash, horizontal tab, vertical tab, newline, form feed,
return, and whitespace.
- `"findingCriteria"`: Represents the criteria to be used in the filter for querying
findings.
- `"rank"`: Specifies the position of the filter in the list of current filters. Also
specifies the order in which this filter is applied to the findings.
"""
function update_filter(
detectorId, filterName; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/filter/$(filterName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_filter(
detectorId,
filterName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/filter/$(filterName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_findings_feedback(detector_id, feedback, finding_ids)
update_findings_feedback(detector_id, feedback, finding_ids, params::Dict{String,<:Any})
Marks the specified GuardDuty findings as useful or not useful.
# Arguments
- `detector_id`: The ID of the detector associated with the findings to update feedback for.
- `feedback`: The feedback for the finding.
- `finding_ids`: The IDs of the findings that you want to mark as useful or not useful.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"comments"`: Additional feedback about the GuardDuty findings.
"""
function update_findings_feedback(
detectorId, feedback, findingIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/feedback",
Dict{String,Any}("feedback" => feedback, "findingIds" => findingIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_findings_feedback(
detectorId,
feedback,
findingIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/findings/feedback",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("feedback" => feedback, "findingIds" => findingIds),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ipset(detector_id, ip_set_id)
update_ipset(detector_id, ip_set_id, params::Dict{String,<:Any})
Updates the IPSet specified by the IPSet ID.
# Arguments
- `detector_id`: The detectorID that specifies the GuardDuty service whose IPSet you want
to update.
- `ip_set_id`: The unique ID that specifies the IPSet that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"activate"`: The updated Boolean value that specifies whether the IPSet is active or not.
- `"location"`: The updated URI of the file that contains the IPSet.
- `"name"`: The unique ID that specifies the IPSet that you want to update.
"""
function update_ipset(
detectorId, ipSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/ipset/$(ipSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ipset(
detectorId,
ipSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/ipset/$(ipSetId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_malware_protection_plan(malware_protection_plan_id)
update_malware_protection_plan(malware_protection_plan_id, params::Dict{String,<:Any})
Updates an existing Malware Protection plan resource.
# Arguments
- `malware_protection_plan_id`: A unique identifier associated with the Malware Protection
plan.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"actions"`: Information about whether the tags will be added to the S3 object after
scanning.
- `"protectedResource"`: Information about the protected resource that is associated with
the created Malware Protection plan. Presently, S3Bucket is the only supported protected
resource.
- `"role"`: IAM role with permissions required to scan and add tags to the associated
protected resource.
"""
function update_malware_protection_plan(
malwareProtectionPlanId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"PATCH",
"/malware-protection-plan/$(malwareProtectionPlanId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_malware_protection_plan(
malwareProtectionPlanId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"PATCH",
"/malware-protection-plan/$(malwareProtectionPlanId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_malware_scan_settings(detector_id)
update_malware_scan_settings(detector_id, params::Dict{String,<:Any})
Updates the malware scan settings. There might be regional differences because some data
sources might not be available in all the Amazon Web Services Regions where GuardDuty is
presently supported. For more information, see Regions and endpoints.
# Arguments
- `detector_id`: The unique ID of the detector that specifies the GuardDuty service where
you want to update scan settings.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ebsSnapshotPreservation"`: An enum value representing possible snapshot preservation
settings.
- `"scanResourceCriteria"`: Represents the criteria to be used in the filter for selecting
resources to scan.
"""
function update_malware_scan_settings(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/malware-scan-settings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_malware_scan_settings(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/malware-scan-settings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_member_detectors(account_ids, detector_id)
update_member_detectors(account_ids, detector_id, params::Dict{String,<:Any})
Contains information on member accounts to be updated. Specifying both EKS Runtime
Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring (RUNTIME_MONITORING) will cause
an error. You can add only one of these two features because Runtime Monitoring already
includes the threat detection for Amazon EKS resources. For more information, see Runtime
Monitoring. There might be regional differences because some data sources might not be
available in all the Amazon Web Services Regions where GuardDuty is presently supported.
For more information, see Regions and endpoints.
# Arguments
- `account_ids`: A list of member account IDs to be updated.
- `detector_id`: The detector ID of the administrator account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dataSources"`: Describes which data sources will be updated.
- `"features"`: A list of features that will be updated for the specified member accounts.
"""
function update_member_detectors(
accountIds, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/detector/update",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_member_detectors(
accountIds,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/member/detector/update",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_organization_configuration(detector_id)
update_organization_configuration(detector_id, params::Dict{String,<:Any})
Configures the delegated administrator account with the provided values. You must provide a
value for either autoEnableOrganizationMembers or autoEnable, but not both. Specifying
both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring
(RUNTIME_MONITORING) will cause an error. You can add only one of these two features
because Runtime Monitoring already includes the threat detection for Amazon EKS resources.
For more information, see Runtime Monitoring. There might be regional differences because
some data sources might not be available in all the Amazon Web Services Regions where
GuardDuty is presently supported. For more information, see Regions and endpoints.
# Arguments
- `detector_id`: The ID of the detector that configures the delegated administrator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"autoEnable"`: Represents whether or not to automatically enable member accounts in the
organization. Even though this is still supported, we recommend using
AutoEnableOrganizationMembers to achieve the similar results. You must provide a value for
either autoEnableOrganizationMembers or autoEnable.
- `"autoEnableOrganizationMembers"`: Indicates the auto-enablement configuration of
GuardDuty for the member accounts in the organization. You must provide a value for either
autoEnableOrganizationMembers or autoEnable. Use one of the following configuration values
for autoEnableOrganizationMembers: NEW: Indicates that when a new account joins the
organization, they will have GuardDuty enabled automatically. ALL: Indicates that all
accounts in the organization have GuardDuty enabled automatically. This includes NEW
accounts that join the organization and accounts that may have been suspended or removed
from the organization in GuardDuty. It may take up to 24 hours to update the configuration
for all the member accounts. NONE: Indicates that GuardDuty will not be automatically
enabled for any account in the organization. The administrator must manage GuardDuty for
each account in the organization individually. When you update the auto-enable setting from
ALL or NEW to NONE, this action doesn't disable the corresponding option for your existing
accounts. This configuration will apply to the new accounts that join the organization.
After you update the auto-enable settings, no new account will have the corresponding
option as enabled.
- `"dataSources"`: Describes which data sources will be updated.
- `"features"`: A list of features that will be configured for the organization.
"""
function update_organization_configuration(
detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/admin";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_organization_configuration(
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/admin",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_publishing_destination(destination_id, detector_id)
update_publishing_destination(destination_id, detector_id, params::Dict{String,<:Any})
Updates information about the publishing destination specified by the destinationId.
# Arguments
- `destination_id`: The ID of the publishing destination to update.
- `detector_id`: The ID of the detector associated with the publishing destinations to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinationProperties"`: A DestinationProperties object that includes the
DestinationArn and KmsKeyArn of the publishing destination.
"""
function update_publishing_destination(
destinationId, detectorId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/publishingDestination/$(destinationId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_publishing_destination(
destinationId,
detectorId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/publishingDestination/$(destinationId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_threat_intel_set(detector_id, threat_intel_set_id)
update_threat_intel_set(detector_id, threat_intel_set_id, params::Dict{String,<:Any})
Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
# Arguments
- `detector_id`: The detectorID that specifies the GuardDuty service whose ThreatIntelSet
you want to update.
- `threat_intel_set_id`: The unique ID that specifies the ThreatIntelSet that you want to
update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"activate"`: The updated Boolean value that specifies whether the ThreateIntelSet is
active or not.
- `"location"`: The updated URI of the file that contains the ThreateIntelSet.
- `"name"`: The unique ID that specifies the ThreatIntelSet that you want to update.
"""
function update_threat_intel_set(
detectorId, threatIntelSetId; aws_config::AbstractAWSConfig=global_aws_config()
)
return guardduty(
"POST",
"/detector/$(detectorId)/threatintelset/$(threatIntelSetId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_threat_intel_set(
detectorId,
threatIntelSetId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return guardduty(
"POST",
"/detector/$(detectorId)/threatintelset/$(threatIntelSetId)",
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 | 28215 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: health
using AWS.Compat
using AWS.UUIDs
"""
describe_affected_accounts_for_organization(event_arn)
describe_affected_accounts_for_organization(event_arn, params::Dict{String,<:Any})
Returns a list of accounts in the organization from Organizations that are affected by the
provided event. For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with
Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from
your organization's management account. This API operation uses pagination. Specify the
nextToken parameter in the next request to return more results.
# Arguments
- `event_arn`: The unique identifier for the event. The event ARN has the
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format. For
example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMEN
T_SCHEDULED_ABC123-DEF456
# 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 one batch, between 10 and 100,
inclusive.
- `"nextToken"`: 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 batch 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 describe_affected_accounts_for_organization(
eventArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeAffectedAccountsForOrganization",
Dict{String,Any}("eventArn" => eventArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_affected_accounts_for_organization(
eventArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return health(
"DescribeAffectedAccountsForOrganization",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("eventArn" => eventArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_affected_entities(filter)
describe_affected_entities(filter, params::Dict{String,<:Any})
Returns a list of entities that have been affected by the specified events, based on the
specified filter criteria. Entities can refer to individual customer resources, groups of
customer resources, or any other construct, depending on the Amazon Web Service. Events
that have impact beyond that of the affected entities, or where the extent of impact is
unknown, include at least one entity indicating this. At least one event ARN is required.
This API operation uses pagination. Specify the nextToken parameter in the next request to
return more results. This operation supports resource-level permissions. You can use this
operation to allow or deny access to specific Health events. For more information, see
Resource- and action-based conditions in the Health User Guide.
# Arguments
- `filter`: Values to narrow the results returned. At least one event ARN is required.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: The locale (language) to return information in. English (en) is the default
and the only supported value at this time.
- `"maxResults"`: The maximum number of items to return in one batch, between 10 and 100,
inclusive.
- `"nextToken"`: 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 batch 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 describe_affected_entities(
filter; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeAffectedEntities",
Dict{String,Any}("filter" => filter);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_affected_entities(
filter, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeAffectedEntities",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("filter" => filter), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_affected_entities_for_organization()
describe_affected_entities_for_organization(params::Dict{String,<:Any})
Returns a list of entities that have been affected by one or more events for one or more
accounts in your organization in Organizations, based on the filter criteria. Entities can
refer to individual customer resources, groups of customer resources, or any other
construct, depending on the Amazon Web Service. At least one event Amazon Resource Name
(ARN) and account ID are required. Before you can call this operation, you must first
enable Health to work with Organizations. To do this, call the
EnableHealthServiceAccessForOrganization operation from your organization's management
account. This API operation uses pagination. Specify the nextToken parameter in the next
request to return more results. This operation doesn't support resource-level
permissions. You can't use this operation to allow or deny access to specific Health
events. For more information, see Resource- and action-based conditions in the Health User
Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: The locale (language) to return information in. English (en) is the default
and the only supported value at this time.
- `"maxResults"`: The maximum number of items to return in one batch, between 10 and 100,
inclusive.
- `"nextToken"`: 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 batch 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.
- `"organizationEntityAccountFilters"`: A JSON set of elements including the awsAccountId,
eventArn and a set of statusCodes.
- `"organizationEntityFilters"`: A JSON set of elements including the awsAccountId and the
eventArn.
"""
function describe_affected_entities_for_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeAffectedEntitiesForOrganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_affected_entities_for_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeAffectedEntitiesForOrganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_entity_aggregates()
describe_entity_aggregates(params::Dict{String,<:Any})
Returns the number of entities that are affected by each of the specified events.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"eventArns"`: A list of event ARNs (unique identifiers). For example:
\"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREM
ENT_SCHEDULED_ABC123-CDE456\",
\"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101
\"
"""
function describe_entity_aggregates(; aws_config::AbstractAWSConfig=global_aws_config())
return health(
"DescribeEntityAggregates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_entity_aggregates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeEntityAggregates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_entity_aggregates_for_organization(event_arns)
describe_entity_aggregates_for_organization(event_arns, params::Dict{String,<:Any})
Returns a list of entity aggregates for your Organizations that are affected by each of the
specified events.
# Arguments
- `event_arns`: A list of event ARNs (unique identifiers). For example:
\"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREM
ENT_SCHEDULED_ABC123-CDE456\",
\"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101
\"
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"awsAccountIds"`: A list of 12-digit Amazon Web Services account numbers that contains
the affected entities.
"""
function describe_entity_aggregates_for_organization(
eventArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeEntityAggregatesForOrganization",
Dict{String,Any}("eventArns" => eventArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_entity_aggregates_for_organization(
eventArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return health(
"DescribeEntityAggregatesForOrganization",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("eventArns" => eventArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_aggregates(aggregate_field)
describe_event_aggregates(aggregate_field, params::Dict{String,<:Any})
Returns the number of events of each event type (issue, scheduled change, and account
notification). If no filter is specified, the counts of all events in each category are
returned. This API operation uses pagination. Specify the nextToken parameter in the next
request to return more results.
# Arguments
- `aggregate_field`: The only currently supported value is eventTypeCategory.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: Values to narrow the results returned.
- `"maxResults"`: The maximum number of items to return in one batch, between 10 and 100,
inclusive.
- `"nextToken"`: 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 batch 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 describe_event_aggregates(
aggregateField; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeEventAggregates",
Dict{String,Any}("aggregateField" => aggregateField);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_event_aggregates(
aggregateField,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return health(
"DescribeEventAggregates",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("aggregateField" => aggregateField), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_details(event_arns)
describe_event_details(event_arns, params::Dict{String,<:Any})
Returns detailed information about one or more specified events. Information includes
standard event data (Amazon Web Services Region, service, and so on, as returned by
DescribeEvents), a detailed event description, and possible additional metadata that
depends upon the nature of the event. Affected entities are not included. To retrieve the
entities, use the DescribeAffectedEntities operation. If a specified event can't be
retrieved, an error message is returned for that event. This operation supports
resource-level permissions. You can use this operation to allow or deny access to specific
Health events. For more information, see Resource- and action-based conditions in the
Health User Guide.
# Arguments
- `event_arns`: A list of event ARNs (unique identifiers). For example:
\"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREM
ENT_SCHEDULED_ABC123-CDE456\",
\"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101
\"
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: The locale (language) to return information in. English (en) is the default
and the only supported value at this time.
"""
function describe_event_details(
eventArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeEventDetails",
Dict{String,Any}("eventArns" => eventArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_event_details(
eventArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return health(
"DescribeEventDetails",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("eventArns" => eventArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_details_for_organization(organization_event_detail_filters)
describe_event_details_for_organization(organization_event_detail_filters, params::Dict{String,<:Any})
Returns detailed information about one or more specified events for one or more Amazon Web
Services accounts in your organization. This information includes standard event data (such
as the Amazon Web Services Region and service), an event description, and (depending on the
event) possible metadata. This operation doesn't return affected entities, such as the
resources related to the event. To return affected entities, use the
DescribeAffectedEntitiesForOrganization operation. Before you can call this operation, you
must first enable Health to work with Organizations. To do this, call the
EnableHealthServiceAccessForOrganization operation from your organization's management
account. When you call the DescribeEventDetailsForOrganization operation, specify the
organizationEventDetailFilters object in the request. Depending on the Health event type,
note the following differences: To return event details for a public event, you must
specify a null value for the awsAccountId parameter. If you specify an account ID for a
public event, Health returns an error message because public events aren't specific to an
account. To return event details for an event that is specific to an account in your
organization, you must specify the awsAccountId parameter in the request. If you don't
specify an account ID, Health returns an error message because the event is specific to an
account in your organization. For more information, see Event. This operation doesn't
support resource-level permissions. You can't use this operation to allow or deny access to
specific Health events. For more information, see Resource- and action-based conditions in
the Health User Guide.
# Arguments
- `organization_event_detail_filters`: A set of JSON elements that includes the
awsAccountId and the eventArn.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: The locale (language) to return information in. English (en) is the default
and the only supported value at this time.
"""
function describe_event_details_for_organization(
organizationEventDetailFilters; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeEventDetailsForOrganization",
Dict{String,Any}(
"organizationEventDetailFilters" => organizationEventDetailFilters
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_event_details_for_organization(
organizationEventDetailFilters,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return health(
"DescribeEventDetailsForOrganization",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"organizationEventDetailFilters" => organizationEventDetailFilters
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_event_types()
describe_event_types(params::Dict{String,<:Any})
Returns the event types that meet the specified filter criteria. You can use this API
operation to find information about the Health event, such as the category, Amazon Web
Service, and event code. The metadata for each event appears in the EventType object. If
you don't specify a filter criteria, the API operation returns all event types, in no
particular order. This API operation uses pagination. Specify the nextToken parameter in
the next request to return more results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: Values to narrow the results returned.
- `"locale"`: The locale (language) to return information in. English (en) is the default
and the only supported value at this time.
- `"maxResults"`: The maximum number of items to return in one batch, between 10 and 100,
inclusive. If you don't specify the maxResults parameter, this operation returns a maximum
of 30 items by default.
- `"nextToken"`: 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 batch 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 describe_event_types(; aws_config::AbstractAWSConfig=global_aws_config())
return health(
"DescribeEventTypes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_event_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeEventTypes", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_events()
describe_events(params::Dict{String,<:Any})
Returns information about events that meet the specified filter criteria. Events are
returned in a summary form and do not include the detailed description, any additional
metadata that depends on the event type, or any affected resources. To retrieve that
information, use the DescribeEventDetails and DescribeAffectedEntities operations. If no
filter criteria are specified, all events are returned. Results are sorted by
lastModifiedTime, starting with the most recent event. When you call the DescribeEvents
operation and specify an entity for the entityValues parameter, Health might return public
events that aren't specific to that resource. For example, if you call DescribeEvents and
specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might
return events that aren't specific to that resource or service. To get events that are
specific to a service, use the services parameter in the filter object. For more
information, see Event. This API operation uses pagination. Specify the nextToken
parameter in the next request to return more results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: Values to narrow the results returned.
- `"locale"`: The locale (language) to return information in. English (en) is the default
and the only supported value at this time.
- `"maxResults"`: The maximum number of items to return in one batch, between 10 and 100,
inclusive.
- `"nextToken"`: 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 batch 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 describe_events(; aws_config::AbstractAWSConfig=global_aws_config())
return health("DescribeEvents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeEvents", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_events_for_organization()
describe_events_for_organization(params::Dict{String,<:Any})
Returns information about events across your organization in Organizations. You can use
thefilters parameter to specify the events that you want to return. Events are returned in
a summary form and don't include the affected accounts, detailed description, any
additional metadata that depends on the event type, or any affected resources. To retrieve
that information, use the following operations: DescribeAffectedAccountsForOrganization
DescribeEventDetailsForOrganization DescribeAffectedEntitiesForOrganization If
you don't specify a filter, the DescribeEventsForOrganizations returns all events across
your organization. Results are sorted by lastModifiedTime, starting with the most recent
event. For more information about the different types of Health events, see Event. Before
you can call this operation, you must first enable Health to work with Organizations. To do
this, call the EnableHealthServiceAccessForOrganization operation from your organization's
management account. This API operation uses pagination. Specify the nextToken parameter in
the next request to return more results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: Values to narrow the results returned.
- `"locale"`: The locale (language) to return information in. English (en) is the default
and the only supported value at this time.
- `"maxResults"`: The maximum number of items to return in one batch, between 10 and 100,
inclusive.
- `"nextToken"`: 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 batch 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 describe_events_for_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeEventsForOrganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_events_for_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeEventsForOrganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_health_service_status_for_organization()
describe_health_service_status_for_organization(params::Dict{String,<:Any})
This operation provides status information on enabling or disabling Health to work with
your organization. To call this operation, you must use the organization's management
account.
"""
function describe_health_service_status_for_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeHealthServiceStatusForOrganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_health_service_status_for_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DescribeHealthServiceStatusForOrganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_health_service_access_for_organization()
disable_health_service_access_for_organization(params::Dict{String,<:Any})
Disables Health from working with Organizations. To call this operation, you must sign in
to the organization's management account. For more information, see Aggregating Health
events in the Health User Guide. This operation doesn't remove the service-linked role from
the management account in your organization. You must use the IAM console, API, or Command
Line Interface (CLI) to remove the service-linked role. For more information, see Deleting
a Service-Linked Role in the IAM User Guide. You can also disable the organizational
feature by using the Organizations DisableAWSServiceAccess API operation. After you call
this operation, Health stops aggregating events for all other Amazon Web Services accounts
in your organization. If you call the Health API operations for organizational view, Health
returns an error. Health continues to aggregate health events for your Amazon Web Services
account.
"""
function disable_health_service_access_for_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DisableHealthServiceAccessForOrganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_health_service_access_for_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"DisableHealthServiceAccessForOrganization",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_health_service_access_for_organization()
enable_health_service_access_for_organization(params::Dict{String,<:Any})
Enables Health to work with Organizations. You can use the organizational view feature to
aggregate events from all Amazon Web Services accounts in your organization in a
centralized location. This operation also creates a service-linked role for the management
account in the organization. To call this operation, you must meet the following
requirements: You must have a Business, Enterprise On-Ramp, or Enterprise Support plan
from Amazon Web Services Support to use the Health API. If you call the Health API from an
Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise
Support plan, you receive a SubscriptionRequiredException error. You must have permission
to call this operation from the organization's management account. For example IAM
policies, see Health identity-based policy examples. If you don't have the required
support plan, you can instead use the Health console to enable the organizational view
feature. For more information, see Aggregating Health events in the Health User Guide.
"""
function enable_health_service_access_for_organization(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"EnableHealthServiceAccessForOrganization";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_health_service_access_for_organization(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return health(
"EnableHealthServiceAccessForOrganization",
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 | 18970 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: healthlake
using AWS.Compat
using AWS.UUIDs
"""
create_fhirdatastore(datastore_type_version)
create_fhirdatastore(datastore_type_version, params::Dict{String,<:Any})
Creates a data store that can ingest and export FHIR formatted data.
# Arguments
- `datastore_type_version`: The FHIR version of the data store. The only supported version
is R4.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: Optional user provided token used for ensuring idempotency.
- `"DatastoreName"`: The user generated name for the data store.
- `"IdentityProviderConfiguration"`: The configuration of the identity provider that you
want to use for your data store.
- `"PreloadDataConfig"`: Optional parameter to preload data upon creation of the data
store. Currently, the only supported preloaded data is synthetic data generated from
Synthea.
- `"SseConfiguration"`: The server-side encryption key configuration for a customer
provided encryption key specified for creating a data store.
- `"Tags"`: Resource tags that are applied to a data store when it is created.
"""
function create_fhirdatastore(
DatastoreTypeVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return healthlake(
"CreateFHIRDatastore",
Dict{String,Any}(
"DatastoreTypeVersion" => DatastoreTypeVersion, "ClientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fhirdatastore(
DatastoreTypeVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"CreateFHIRDatastore",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DatastoreTypeVersion" => DatastoreTypeVersion,
"ClientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fhirdatastore(datastore_id)
delete_fhirdatastore(datastore_id, params::Dict{String,<:Any})
Deletes a data store.
# Arguments
- `datastore_id`: The AWS-generated ID for the data store to be deleted.
"""
function delete_fhirdatastore(
DatastoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return healthlake(
"DeleteFHIRDatastore",
Dict{String,Any}("DatastoreId" => DatastoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fhirdatastore(
DatastoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"DeleteFHIRDatastore",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatastoreId" => DatastoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fhirdatastore(datastore_id)
describe_fhirdatastore(datastore_id, params::Dict{String,<:Any})
Gets the properties associated with the FHIR data store, including the data store ID, data
store ARN, data store name, data store status, when the data store was created, data store
type version, and the data store's endpoint.
# Arguments
- `datastore_id`: The AWS-generated data store ID.
"""
function describe_fhirdatastore(
DatastoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return healthlake(
"DescribeFHIRDatastore",
Dict{String,Any}("DatastoreId" => DatastoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fhirdatastore(
DatastoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"DescribeFHIRDatastore",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatastoreId" => DatastoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fhirexport_job(datastore_id, job_id)
describe_fhirexport_job(datastore_id, job_id, params::Dict{String,<:Any})
Displays the properties of a FHIR export job, including the ID, ARN, name, and the status
of the job.
# Arguments
- `datastore_id`: The AWS generated ID for the data store from which files are being
exported from for an export job.
- `job_id`: The AWS generated ID for an export job.
"""
function describe_fhirexport_job(
DatastoreId, JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return healthlake(
"DescribeFHIRExportJob",
Dict{String,Any}("DatastoreId" => DatastoreId, "JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fhirexport_job(
DatastoreId,
JobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"DescribeFHIRExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatastoreId" => DatastoreId, "JobId" => JobId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fhirimport_job(datastore_id, job_id)
describe_fhirimport_job(datastore_id, job_id, params::Dict{String,<:Any})
Displays the properties of a FHIR import job, including the ID, ARN, name, and the status
of the job.
# Arguments
- `datastore_id`: The AWS-generated ID of the data store.
- `job_id`: The AWS-generated job ID.
"""
function describe_fhirimport_job(
DatastoreId, JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return healthlake(
"DescribeFHIRImportJob",
Dict{String,Any}("DatastoreId" => DatastoreId, "JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fhirimport_job(
DatastoreId,
JobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"DescribeFHIRImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DatastoreId" => DatastoreId, "JobId" => JobId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fhirdatastores()
list_fhirdatastores(params::Dict{String,<:Any})
Lists all FHIR data stores that are in the user’s account, regardless of data store
status.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: Lists all filters associated with a FHIR data store request.
- `"MaxResults"`: The maximum number of data stores returned in a single page of a
ListFHIRDatastoresRequest call.
- `"NextToken"`: Fetches the next page of data stores when results are paginated.
"""
function list_fhirdatastores(; aws_config::AbstractAWSConfig=global_aws_config())
return healthlake(
"ListFHIRDatastores"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_fhirdatastores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return healthlake(
"ListFHIRDatastores", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_fhirexport_jobs(datastore_id)
list_fhirexport_jobs(datastore_id, params::Dict{String,<:Any})
Lists all FHIR export jobs associated with an account and their statuses.
# Arguments
- `datastore_id`: This parameter limits the response to the export job with the specified
data store ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobName"`: This parameter limits the response to the export job with the specified job
name.
- `"JobStatus"`: This parameter limits the response to the export jobs with the specified
job status.
- `"MaxResults"`: This parameter limits the number of results returned for a
ListFHIRExportJobs to a maximum quantity specified by the user.
- `"NextToken"`: A pagination token used to identify the next page of results to return
for a ListFHIRExportJobs query.
- `"SubmittedAfter"`: This parameter limits the response to FHIR export jobs submitted
after a user specified date.
- `"SubmittedBefore"`: This parameter limits the response to FHIR export jobs submitted
before a user specified date.
"""
function list_fhirexport_jobs(
DatastoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return healthlake(
"ListFHIRExportJobs",
Dict{String,Any}("DatastoreId" => DatastoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_fhirexport_jobs(
DatastoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"ListFHIRExportJobs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatastoreId" => DatastoreId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fhirimport_jobs(datastore_id)
list_fhirimport_jobs(datastore_id, params::Dict{String,<:Any})
Lists all FHIR import jobs associated with an account and their statuses.
# Arguments
- `datastore_id`: This parameter limits the response to the import job with the specified
data store ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobName"`: This parameter limits the response to the import job with the specified job
name.
- `"JobStatus"`: This parameter limits the response to the import job with the specified
job status.
- `"MaxResults"`: This parameter limits the number of results returned for a
ListFHIRImportJobs to a maximum quantity specified by the user.
- `"NextToken"`: A pagination token used to identify the next page of results to return
for a ListFHIRImportJobs query.
- `"SubmittedAfter"`: This parameter limits the response to FHIR import jobs submitted
after a user specified date.
- `"SubmittedBefore"`: This parameter limits the response to FHIR import jobs submitted
before a user specified date.
"""
function list_fhirimport_jobs(
DatastoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return healthlake(
"ListFHIRImportJobs",
Dict{String,Any}("DatastoreId" => DatastoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_fhirimport_jobs(
DatastoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"ListFHIRImportJobs",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DatastoreId" => DatastoreId), 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 existing tags associated with a data store.
# Arguments
- `resource_arn`: The Amazon Resource Name(ARN) of the data store for which tags are being
added.
"""
function list_tags_for_resource(
ResourceARN; aws_config::AbstractAWSConfig=global_aws_config()
)
return healthlake(
"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 healthlake(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ResourceARN" => ResourceARN), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_fhirexport_job(client_token, data_access_role_arn, datastore_id, output_data_config)
start_fhirexport_job(client_token, data_access_role_arn, datastore_id, output_data_config, params::Dict{String,<:Any})
Begins a FHIR export job.
# Arguments
- `client_token`: An optional user provided token used for ensuring idempotency.
- `data_access_role_arn`: The Amazon Resource Name used during the initiation of the job.
- `datastore_id`: The AWS generated ID for the data store from which files are being
exported for an export job.
- `output_data_config`: The output data configuration that was supplied when the export job
was created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobName"`: The user generated name for an export job.
"""
function start_fhirexport_job(
ClientToken,
DataAccessRoleArn,
DatastoreId,
OutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"StartFHIRExportJob",
Dict{String,Any}(
"ClientToken" => ClientToken,
"DataAccessRoleArn" => DataAccessRoleArn,
"DatastoreId" => DatastoreId,
"OutputDataConfig" => OutputDataConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_fhirexport_job(
ClientToken,
DataAccessRoleArn,
DatastoreId,
OutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"StartFHIRExportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"DataAccessRoleArn" => DataAccessRoleArn,
"DatastoreId" => DatastoreId,
"OutputDataConfig" => OutputDataConfig,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_fhirimport_job(client_token, data_access_role_arn, datastore_id, input_data_config, job_output_data_config)
start_fhirimport_job(client_token, data_access_role_arn, datastore_id, input_data_config, job_output_data_config, params::Dict{String,<:Any})
Begins a FHIR Import job.
# Arguments
- `client_token`: Optional user provided token used for ensuring idempotency.
- `data_access_role_arn`: The Amazon Resource Name (ARN) that gives AWS HealthLake access
permission.
- `datastore_id`: The AWS-generated data store ID.
- `input_data_config`: The input properties of the FHIR Import job in the StartFHIRImport
job request.
- `job_output_data_config`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"JobName"`: The name of the FHIR Import job in the StartFHIRImport job request.
"""
function start_fhirimport_job(
ClientToken,
DataAccessRoleArn,
DatastoreId,
InputDataConfig,
JobOutputDataConfig;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"StartFHIRImportJob",
Dict{String,Any}(
"ClientToken" => ClientToken,
"DataAccessRoleArn" => DataAccessRoleArn,
"DatastoreId" => DatastoreId,
"InputDataConfig" => InputDataConfig,
"JobOutputDataConfig" => JobOutputDataConfig,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_fhirimport_job(
ClientToken,
DataAccessRoleArn,
DatastoreId,
InputDataConfig,
JobOutputDataConfig,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return healthlake(
"StartFHIRImportJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientToken" => ClientToken,
"DataAccessRoleArn" => DataAccessRoleArn,
"DatastoreId" => DatastoreId,
"InputDataConfig" => InputDataConfig,
"JobOutputDataConfig" => JobOutputDataConfig,
),
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 specified key and value tag to a data store.
# Arguments
- `resource_arn`: The Amazon Resource Name(ARN)that gives AWS HealthLake access to the
data store which tags are being added to.
- `tags`: The user specified key and value pair tags being added to a data store.
"""
function tag_resource(ResourceARN, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return healthlake(
"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 healthlake(
"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 tags from a data store.
# Arguments
- `resource_arn`: The Amazon Resource Name(ARN) of the data store for which tags are being
removed.
- `tag_keys`: The keys for the tags to be removed from the HealthLake data store.
"""
function untag_resource(
ResourceARN, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return healthlake(
"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 healthlake(
"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 | 393621 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iam
using AWS.Compat
using AWS.UUIDs
"""
add_client_idto_open_idconnect_provider(client_id, open_idconnect_provider_arn)
add_client_idto_open_idconnect_provider(client_id, open_idconnect_provider_arn, params::Dict{String,<:Any})
Adds a new client ID (also known as audience) to the list of client IDs already registered
for the specified IAM OpenID Connect (OIDC) provider resource. This operation is
idempotent; it does not fail or return an error if you add an existing client ID to the
provider.
# Arguments
- `client_id`: The client ID (also known as audience) to add to the IAM OpenID Connect
provider resource.
- `open_idconnect_provider_arn`: The Amazon Resource Name (ARN) of the IAM OpenID Connect
(OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs
by using the ListOpenIDConnectProviders operation.
"""
function add_client_idto_open_idconnect_provider(
ClientID, OpenIDConnectProviderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"AddClientIDToOpenIDConnectProvider",
Dict{String,Any}(
"ClientID" => ClientID, "OpenIDConnectProviderArn" => OpenIDConnectProviderArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_client_idto_open_idconnect_provider(
ClientID,
OpenIDConnectProviderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"AddClientIDToOpenIDConnectProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientID" => ClientID,
"OpenIDConnectProviderArn" => OpenIDConnectProviderArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_role_to_instance_profile(instance_profile_name, role_name)
add_role_to_instance_profile(instance_profile_name, role_name, params::Dict{String,<:Any})
Adds the specified IAM role to the specified instance profile. An instance profile can
contain only one role, and this quota cannot be increased. You can remove the existing role
and then add a different role to an instance profile. You must then wait for the change to
appear across all of Amazon Web Services because of eventual consistency. To force the
change, you must disassociate the instance profile and then associate the instance profile,
or you can stop your instance and then restart it. The caller of this operation must be
granted the PassRole permission on the IAM role by a permissions policy. For more
information about roles, see IAM roles in the IAM User Guide. For more information about
instance profiles, see Using instance profiles in the IAM User Guide.
# Arguments
- `instance_profile_name`: The name of the instance profile to update. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
- `role_name`: The name of the role to add. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
"""
function add_role_to_instance_profile(
InstanceProfileName, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"AddRoleToInstanceProfile",
Dict{String,Any}(
"InstanceProfileName" => InstanceProfileName, "RoleName" => RoleName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_role_to_instance_profile(
InstanceProfileName,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"AddRoleToInstanceProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceProfileName" => InstanceProfileName, "RoleName" => RoleName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_user_to_group(group_name, user_name)
add_user_to_group(group_name, user_name, params::Dict{String,<:Any})
Adds the specified user to the specified group.
# Arguments
- `group_name`: The name of the group to update. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
- `user_name`: The name of the user to add. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
"""
function add_user_to_group(
GroupName, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"AddUserToGroup",
Dict{String,Any}("GroupName" => GroupName, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_user_to_group(
GroupName,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"AddUserToGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_group_policy(group_name, policy_arn)
attach_group_policy(group_name, policy_arn, params::Dict{String,<:Any})
Attaches the specified managed policy to the specified IAM group. You use this operation to
attach a managed policy to a group. To embed an inline policy in a group, use
PutGroupPolicy . As a best practice, you can validate your IAM policies. To learn more, see
Validating IAM policies in the IAM User Guide. For more information about policies, see
Managed policies and inline policies in the IAM User Guide.
# Arguments
- `group_name`: The name (friendly name, not ARN) of the group to attach the policy to.
This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy you want to attach. For
more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
"""
function attach_group_policy(
GroupName, PolicyArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"AttachGroupPolicy",
Dict{String,Any}("GroupName" => GroupName, "PolicyArn" => PolicyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_group_policy(
GroupName,
PolicyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"AttachGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "PolicyArn" => PolicyArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_role_policy(policy_arn, role_name)
attach_role_policy(policy_arn, role_name, params::Dict{String,<:Any})
Attaches the specified managed policy to the specified IAM role. When you attach a managed
policy to a role, the managed policy becomes part of the role's permission (access) policy.
You cannot use a managed policy as the role's trust policy. The role's trust policy is
created at the same time as the role, using CreateRole . You can update a role's trust
policy using UpdateAssumerolePolicy . Use this operation to attach a managed policy to a
role. To embed an inline policy in a role, use PutRolePolicy . For more information about
policies, see Managed policies and inline policies in the IAM User Guide. As a best
practice, you can validate your IAM policies. To learn more, see Validating IAM policies in
the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy you want to attach. For
more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
- `role_name`: The name (friendly name, not ARN) of the role to attach the policy to. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function attach_role_policy(
PolicyArn, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"AttachRolePolicy",
Dict{String,Any}("PolicyArn" => PolicyArn, "RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_role_policy(
PolicyArn,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"AttachRolePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyArn" => PolicyArn, "RoleName" => RoleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_user_policy(policy_arn, user_name)
attach_user_policy(policy_arn, user_name, params::Dict{String,<:Any})
Attaches the specified managed policy to the specified user. You use this operation to
attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy
. As a best practice, you can validate your IAM policies. To learn more, see Validating IAM
policies in the IAM User Guide. For more information about policies, see Managed policies
and inline policies in the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy you want to attach. For
more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
- `user_name`: The name (friendly name, not ARN) of the IAM user to attach the policy to.
This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
"""
function attach_user_policy(
PolicyArn, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"AttachUserPolicy",
Dict{String,Any}("PolicyArn" => PolicyArn, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_user_policy(
PolicyArn,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"AttachUserPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyArn" => PolicyArn, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
change_password(new_password, old_password)
change_password(new_password, old_password, params::Dict{String,<:Any})
Changes the password of the IAM user who is calling this operation. This operation can be
performed using the CLI, the Amazon Web Services API, or the My Security Credentials page
in the Amazon Web Services Management Console. The Amazon Web Services account root user
password is not affected by this operation. Use UpdateLoginProfile to use the CLI, the
Amazon Web Services API, or the Users page in the IAM console to change the password for
any IAM user. For more information about modifying passwords, see Managing passwords in the
IAM User Guide.
# Arguments
- `new_password`: The new password. The new password must conform to the Amazon Web
Services account's password policy, if one exists. The regex pattern that is used to
validate this parameter is a string of characters. That string can include almost any
printable ASCII character from the space (u0020) through the end of the ASCII character
range (u00FF). You can also include the tab (u0009), line feed (u000A), and carriage return
(u000D) characters. Any of these characters are valid in a password. However, many tools,
such as the Amazon Web Services Management Console, might restrict the ability to type
certain characters because they have special meaning within that tool.
- `old_password`: The IAM user's current password.
"""
function change_password(
NewPassword, OldPassword; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ChangePassword",
Dict{String,Any}("NewPassword" => NewPassword, "OldPassword" => OldPassword);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function change_password(
NewPassword,
OldPassword,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ChangePassword",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"NewPassword" => NewPassword, "OldPassword" => OldPassword
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_access_key()
create_access_key(params::Dict{String,<:Any})
Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services
access key ID for the specified user. The default status for new keys is Active. If you do
not specify a user name, IAM determines the user name implicitly based on the Amazon Web
Services access key ID signing the request. This operation works for access keys under the
Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web
Services account root user credentials. This is true even if the Amazon Web Services
account has no associated users. For information about quotas on the number of keys you
can create, see IAM and STS quotas in the IAM User Guide. To ensure the security of your
Amazon Web Services account, the secret access key is accessible only during key and user
creation. You must save the key (for example, in a text file) if you want to be able to
access it again. If a secret key is lost, you can delete the access keys for the associated
user and then create new keys.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The name of the IAM user that the new key will belong to. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function create_access_key(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("CreateAccessKey"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function create_access_key(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateAccessKey", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
create_account_alias(account_alias)
create_account_alias(account_alias, params::Dict{String,<:Any})
Creates an alias for your Amazon Web Services account. For information about using an
Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web
Services account alias in the Amazon Web Services Sign-In User Guide.
# Arguments
- `account_alias`: The account alias to create. This parameter allows (through its regex
pattern) a string of characters consisting of lowercase letters, digits, and dashes. You
cannot start or finish with a dash, nor can you have two dashes in a row.
"""
function create_account_alias(
AccountAlias; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateAccountAlias",
Dict{String,Any}("AccountAlias" => AccountAlias);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_account_alias(
AccountAlias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreateAccountAlias",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountAlias" => AccountAlias), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group(group_name)
create_group(group_name, params::Dict{String,<:Any})
Creates a new group. For information about the number of groups you can create, see IAM
and STS quotas in the IAM User Guide.
# Arguments
- `group_name`: The name of the group to create. Do not include the path in this value. IAM
user, group, role, and policy names must be unique within the account. Names are not
distinguished by case. For example, you cannot create resources named both \"MyResource\"
and \"myresource\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Path"`: The path to the group. For more information about paths, see IAM identifiers
in the IAM User Guide. This parameter is optional. If it is not included, it defaults to a
slash (/). This parameter allows (through its regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that must begin and end with
forward slashes. In addition, it can contain any ASCII character from the ! (u0021) through
the DEL character (u007F), including most punctuation characters, digits, and upper and
lowercased letters.
"""
function create_group(GroupName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"CreateGroup",
Dict{String,Any}("GroupName" => GroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group(
GroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreateGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GroupName" => GroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_instance_profile(instance_profile_name)
create_instance_profile(instance_profile_name, params::Dict{String,<:Any})
Creates a new instance profile. For information about instance profiles, see Using roles
for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon
EC2 User Guide. For information about the number of instance profiles you can create, see
IAM object quotas in the IAM User Guide.
# Arguments
- `instance_profile_name`: The name of the instance profile to create. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Path"`: The path to the instance profile. For more information about paths, see IAM
Identifiers in the IAM User Guide. This parameter is optional. If it is not included, it
defaults to a slash (/). This parameter allows (through its regex pattern) a string of
characters consisting of either a forward slash (/) by itself or a string that must begin
and end with forward slashes. In addition, it can contain any ASCII character from the !
(u0021) through the DEL character (u007F), including most punctuation characters, digits,
and upper and lowercased letters.
- `"Tags"`: A list of tags that you want to attach to the newly created IAM instance
profile. Each tag consists of a key name and an associated value. For more information
about tagging, see Tagging IAM resources in the IAM User Guide. If any one of the tags is
invalid or if you exceed the allowed maximum number of tags, then the entire request fails
and the resource is not created.
"""
function create_instance_profile(
InstanceProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateInstanceProfile",
Dict{String,Any}("InstanceProfileName" => InstanceProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_instance_profile(
InstanceProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreateInstanceProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceProfileName" => InstanceProfileName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_login_profile(password, user_name)
create_login_profile(password, user_name, params::Dict{String,<:Any})
Creates a password for the specified IAM user. A password allows an IAM user to access
Amazon Web Services services through the Amazon Web Services Management Console. You can
use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a
password for any IAM user. Use ChangePassword to update your own existing password in the
My Security Credentials page in the Amazon Web Services Management Console. For more
information about managing passwords, see Managing passwords in the IAM User Guide.
# Arguments
- `password`: The new password for the user. The regex pattern that is used to validate
this parameter is a string of characters. That string can include almost any printable
ASCII character from the space (u0020) through the end of the ASCII character range
(u00FF). You can also include the tab (u0009), line feed (u000A), and carriage return
(u000D) characters. Any of these characters are valid in a password. However, many tools,
such as the Amazon Web Services Management Console, might restrict the ability to type
certain characters because they have special meaning within that tool.
- `user_name`: The name of the IAM user to create a password for. The user must already
exist. This parameter allows (through its regex pattern) a string of characters consisting
of upper and lowercase alphanumeric characters with no spaces. You can also include any of
the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PasswordResetRequired"`: Specifies whether the user is required to set a new password
on next sign-in.
"""
function create_login_profile(
Password, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateLoginProfile",
Dict{String,Any}("Password" => Password, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_login_profile(
Password,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreateLoginProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Password" => Password, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_open_idconnect_provider(url)
create_open_idconnect_provider(url, params::Dict{String,<:Any})
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect
(OIDC). The OIDC provider that you create with this operation can be used as a principal in
a role's trust policy. Such a policy establishes a trust relationship between Amazon Web
Services and the OIDC provider. If you are using an OIDC identity provider from Google,
Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider.
These OIDC identity providers are already built-in to Amazon Web Services and are available
for your use. Instead, you can move directly to creating new roles using your identity
provider. To learn more, see Creating a role for web identity or OpenID connect federation
in the IAM User Guide. When you create the IAM OIDC provider, you specify the following:
The URL of the OIDC identity provider (IdP) to trust A list of client IDs (also known as
audiences) that identify the application or applications allowed to authenticate using the
OIDC provider A list of tags that are attached to the specified IAM OIDC provider A
list of thumbprints of one or more server certificates that the IdP uses You get all of
this information from the OIDC IdP you want to use to access Amazon Web Services. Amazon
Web Services secures communication with some OIDC identity providers (IdPs) through our
library of trusted root certificate authorities (CAs) instead of using a certificate
thumbprint to verify your IdP server certificate. In these cases, your legacy thumbprint
remains in your configuration, but is no longer used for validation. These OIDC IdPs
include Auth0, GitHub, GitLab, Google, and those that use an Amazon S3 bucket to host a
JSON Web Key Set (JWKS) endpoint. The trust for the OIDC provider is derived from the IAM
provider that this operation creates. Therefore, it is best to limit access to the
CreateOpenIDConnectProvider operation to highly privileged users.
# Arguments
- `url`: The URL of the identity provider. The URL must begin with https:// and should
correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC
standard, path components are allowed but query parameters are not. Typically the URL
consists of only a hostname, like https://server.example.org or https://example.com. The
URL should not contain a port number. You cannot register the same provider multiple times
in a single Amazon Web Services account. If you try to submit a URL that has already been
used for an OpenID Connect provider in the Amazon Web Services account, you will get an
error.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientIDList"`: Provides a list of client IDs, also known as audiences. When a mobile
or web app registers with an OpenID Connect provider, they establish a value that
identifies the application. This is the value that's sent as the client_id parameter on
OAuth requests. You can register multiple client IDs with the same provider. For example,
you might have multiple applications that use the same OIDC provider. You cannot register
more than 100 client IDs with a single IAM OIDC provider. There is no defined format for a
client ID. The CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255
characters long.
- `"Tags"`: A list of tags that you want to attach to the new IAM OpenID Connect (OIDC)
provider. Each tag consists of a key name and an associated value. For more information
about tagging, see Tagging IAM resources in the IAM User Guide. If any one of the tags is
invalid or if you exceed the allowed maximum number of tags, then the entire request fails
and the resource is not created.
- `"ThumbprintList"`: A list of server certificate thumbprints for the OpenID Connect
(OIDC) identity provider's server certificates. Typically this list includes only one
entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets
you maintain multiple thumbprints if the identity provider is rotating certificates. This
parameter is optional. If it is not included, IAM will retrieve and use the top
intermediate certificate authority (CA) thumbprint of the OpenID Connect identity provider
server certificate. The server certificate thumbprint is the hex-encoded SHA-1 hash value
of the X.509 certificate used by the domain where the OpenID Connect provider makes its
keys available. It is always a 40-character string. For example, assume that the OIDC
provider is server.example.com and the provider stores its keys at
https://keys.server.example.com/openid-connect. In that case, the thumbprint string would
be the hex-encoded SHA-1 hash value of the certificate used by
https://keys.server.example.com. For more information about obtaining the OIDC provider
thumbprint, see Obtaining the thumbprint for an OpenID Connect provider in the IAM user
Guide.
"""
function create_open_idconnect_provider(
Url; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateOpenIDConnectProvider",
Dict{String,Any}("Url" => Url);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_open_idconnect_provider(
Url, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateOpenIDConnectProvider",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Url" => Url), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_policy(policy_document, policy_name)
create_policy(policy_document, policy_name, params::Dict{String,<:Any})
Creates a new managed policy for your Amazon Web Services account. This operation creates a
policy version with a version identifier of v1 and sets v1 as the policy's default version.
For more information about policy versions, see Versioning for managed policies in the IAM
User Guide. As a best practice, you can validate your IAM policies. To learn more, see
Validating IAM policies in the IAM User Guide. For more information about managed policies
in general, see Managed policies and inline policies in the IAM User Guide.
# Arguments
- `policy_document`: The JSON policy document that you want to use as the content for the
new policy. You must provide policies in JSON format in IAM. However, for CloudFormation
templates formatted in YAML, you can provide the policy in JSON or YAML format.
CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The maximum length of the policy document that you can pass in this operation, including
whitespace, is listed below. To view the maximum character counts of a managed policy with
no whitespaces, see IAM and STS character quotas. To learn more about JSON policy grammar,
see Grammar of the IAM JSON policy language in the IAM User Guide. The regex pattern used
to validate this parameter is a string of characters consisting of the following: Any
printable ASCII character ranging from the space character (u0020) through the end of the
ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement
character set (through u00FF) The special characters tab (u0009), line feed (u000A), and
carriage return (u000D)
- `policy_name`: The friendly name of the policy. IAM user, group, role, and policy names
must be unique within the account. Names are not distinguished by case. For example, you
cannot create resources named both \"MyResource\" and \"myresource\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A friendly description of the policy. Typically used to store
information about the permissions defined in the policy. For example, \"Grants access to
production DynamoDB tables.\" The policy description is immutable. After a value is
assigned, it cannot be changed.
- `"Path"`: The path for the policy. For more information about paths, see IAM identifiers
in the IAM User Guide. This parameter is optional. If it is not included, it defaults to a
slash (/). This parameter allows (through its regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that must begin and end with
forward slashes. In addition, it can contain any ASCII character from the ! (u0021) through
the DEL character (u007F), including most punctuation characters, digits, and upper and
lowercased letters. You cannot use an asterisk (*) in the path name.
- `"Tags"`: A list of tags that you want to attach to the new IAM customer managed policy.
Each tag consists of a key name and an associated value. For more information about
tagging, see Tagging IAM resources in the IAM User Guide. If any one of the tags is
invalid or if you exceed the allowed maximum number of tags, then the entire request fails
and the resource is not created.
"""
function create_policy(
PolicyDocument, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreatePolicy",
Dict{String,Any}("PolicyDocument" => PolicyDocument, "PolicyName" => PolicyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_policy(
PolicyDocument,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreatePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PolicyDocument" => PolicyDocument, "PolicyName" => PolicyName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_policy_version(policy_arn, policy_document)
create_policy_version(policy_arn, policy_document, params::Dict{String,<:Any})
Creates a new version of the specified managed policy. To update a managed policy, you
create a new policy version. A managed policy can have up to five versions. If the policy
has five versions, you must delete an existing version using DeletePolicyVersion before you
create a new version. Optionally, you can set the new version as the policy's default
version. The default version is the version that is in effect for the IAM users, groups,
and roles to which the policy is attached. For more information about managed policy
versions, see Versioning for managed policies in the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy to which you want to add a
new version. For more information about ARNs, see Amazon Resource Names (ARNs) in the
Amazon Web Services General Reference.
- `policy_document`: The JSON policy document that you want to use as the content for this
new version of the policy. You must provide policies in JSON format in IAM. However, for
CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML
format. CloudFormation always converts a YAML policy to JSON format before submitting it to
IAM. The maximum length of the policy document that you can pass in this operation,
including whitespace, is listed below. To view the maximum character counts of a managed
policy with no whitespaces, see IAM and STS character quotas. The regex pattern used to
validate this parameter is a string of characters consisting of the following: Any
printable ASCII character ranging from the space character (u0020) through the end of the
ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement
character set (through u00FF) The special characters tab (u0009), line feed (u000A), and
carriage return (u000D)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SetAsDefault"`: Specifies whether to set this version as the policy's default version.
When this parameter is true, the new policy version becomes the operative version. That is,
it becomes the version that is in effect for the IAM users, groups, and roles that the
policy is attached to. For more information about managed policy versions, see Versioning
for managed policies in the IAM User Guide.
"""
function create_policy_version(
PolicyArn, PolicyDocument; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreatePolicyVersion",
Dict{String,Any}("PolicyArn" => PolicyArn, "PolicyDocument" => PolicyDocument);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_policy_version(
PolicyArn,
PolicyDocument,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreatePolicyVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PolicyArn" => PolicyArn, "PolicyDocument" => PolicyDocument
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_role(assume_role_policy_document, role_name)
create_role(assume_role_policy_document, role_name, params::Dict{String,<:Any})
Creates a new role for your Amazon Web Services account. For more information about roles,
see IAM roles in the IAM User Guide. For information about quotas for role names and the
number of roles you can create, see IAM and STS quotas in the IAM User Guide.
# Arguments
- `assume_role_policy_document`: The trust relationship policy document that grants an
entity permission to assume the role. In IAM, you must provide a JSON policy that has been
converted to a string. However, for CloudFormation templates formatted in YAML, you can
provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to
JSON format before submitting it to IAM. The regex pattern used to validate this parameter
is a string of characters consisting of the following: Any printable ASCII character
ranging from the space character (u0020) through the end of the ASCII character range The
printable characters in the Basic Latin and Latin-1 Supplement character set (through
u00FF) The special characters tab (u0009), line feed (u000A), and carriage return (u000D)
Upon success, the response includes the same trust policy in JSON format.
- `role_name`: The name of the role to create. IAM user, group, role, and policy names must
be unique within the account. Names are not distinguished by case. For example, you cannot
create resources named both \"MyResource\" and \"myresource\". This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A description of the role.
- `"MaxSessionDuration"`: The maximum session duration (in seconds) that you want to set
for the specified role. If you do not specify a value for this setting, the default value
of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who
assumes the role from the CLI or API can use the DurationSeconds API parameter or the
duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting
determines the maximum duration that can be requested using the DurationSeconds parameter.
If users don't specify a value for the DurationSeconds parameter, their security
credentials are valid for one hour by default. This applies when you use the AssumeRole*
API operations or the assume-role* CLI operations but does not apply when you use those
operations to create a console URL. For more information, see Using IAM roles in the IAM
User Guide.
- `"Path"`: The path to the role. For more information about paths, see IAM Identifiers in
the IAM User Guide. This parameter is optional. If it is not included, it defaults to a
slash (/). This parameter allows (through its regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that must begin and end with
forward slashes. In addition, it can contain any ASCII character from the ! (u0021) through
the DEL character (u007F), including most punctuation characters, digits, and upper and
lowercased letters.
- `"PermissionsBoundary"`: The ARN of the managed policy that is used to set the
permissions boundary for the role. A permissions boundary policy defines the maximum
permissions that identity-based policies can grant to an entity, but does not grant
permissions. Permissions boundaries do not define the maximum permissions that a
resource-based policy can grant to an entity. To learn more, see Permissions boundaries for
IAM entities in the IAM User Guide. For more information about policy types, see Policy
types in the IAM User Guide.
- `"Tags"`: A list of tags that you want to attach to the new role. Each tag consists of a
key name and an associated value. For more information about tagging, see Tagging IAM
resources in the IAM User Guide. If any one of the tags is invalid or if you exceed the
allowed maximum number of tags, then the entire request fails and the resource is not
created.
"""
function create_role(
AssumeRolePolicyDocument, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateRole",
Dict{String,Any}(
"AssumeRolePolicyDocument" => AssumeRolePolicyDocument, "RoleName" => RoleName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_role(
AssumeRolePolicyDocument,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreateRole",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AssumeRolePolicyDocument" => AssumeRolePolicyDocument,
"RoleName" => RoleName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_samlprovider(name, samlmetadata_document)
create_samlprovider(name, samlmetadata_document, params::Dict{String,<:Any})
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
The SAML provider resource that you create with this operation can be used as a principal
in an IAM role's trust policy. Such a policy can enable federated users who sign in using
the SAML IdP to assume the role. You can create an IAM role that supports Web-based single
sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access
to Amazon Web Services. When you create the SAML provider resource, you upload a SAML
metadata document that you get from your IdP. That document includes the issuer's name,
expiration information, and keys that can be used to validate the SAML authentication
response (assertions) that the IdP sends. You must generate the metadata document using the
identity management software that is used as your organization's IdP. This operation
requires Signature Version 4. For more information, see Enabling SAML 2.0 federated users
to access the Amazon Web Services Management Console and About SAML 2.0-based federation in
the IAM User Guide.
# Arguments
- `name`: The name of the provider to create. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
- `samlmetadata_document`: An XML document generated by an identity provider (IdP) that
supports SAML 2.0. The document includes the issuer's name, expiration information, and
keys that can be used to validate the SAML authentication response (assertions) that are
received from the IdP. You must generate the metadata document using the identity
management software that is used as your organization's IdP. For more information, see
About SAML 2.0-based federation in the IAM 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 new IAM SAML provider. Each tag
consists of a key name and an associated value. For more information about tagging, see
Tagging IAM resources in the IAM User Guide. If any one of the tags is invalid or if you
exceed the allowed maximum number of tags, then the entire request fails and the resource
is not created.
"""
function create_samlprovider(
Name, SAMLMetadataDocument; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateSAMLProvider",
Dict{String,Any}("Name" => Name, "SAMLMetadataDocument" => SAMLMetadataDocument);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_samlprovider(
Name,
SAMLMetadataDocument,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreateSAMLProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Name" => Name, "SAMLMetadataDocument" => SAMLMetadataDocument
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service_linked_role(awsservice_name)
create_service_linked_role(awsservice_name, params::Dict{String,<:Any})
Creates an IAM role that is linked to a specific Amazon Web Services service. The service
controls the attached policies and when the role can be deleted. This helps ensure that the
service is not broken by an unexpectedly changed or deleted role, which could put your
Amazon Web Services resources into an unknown state. Allowing the service to control the
role helps improve service stability and proper cleanup when a service and its role are no
longer needed. For more information, see Using service-linked roles in the IAM User Guide.
To attach a policy to this service-linked role, you must make the request using the Amazon
Web Services service that depends on this role.
# Arguments
- `awsservice_name`: The service principal for the Amazon Web Services service to which
this role is attached. You use a string similar to a URL but without the http:// in front.
For example: elasticbeanstalk.amazonaws.com. Service principals are unique and
case-sensitive. To find the exact service principal for your service-linked role, see
Amazon Web Services services that work with IAM in the IAM User Guide. Look for the
services that have Yes in the Service-Linked Role column. Choose the Yes link to view the
service-linked role documentation for that service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CustomSuffix"`: A string that you provide, which is combined with the service-provided
prefix to form the complete role name. If you make multiple requests for the same service,
then you must supply a different CustomSuffix for each request. Otherwise the request fails
with a duplicate role name error. For example, you could add -1 or -debug to the suffix.
Some services do not support the CustomSuffix parameter. If you provide an optional suffix
and the operation fails, try the operation again without the suffix.
- `"Description"`: The description of the role.
"""
function create_service_linked_role(
AWSServiceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateServiceLinkedRole",
Dict{String,Any}("AWSServiceName" => AWSServiceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_linked_role(
AWSServiceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreateServiceLinkedRole",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AWSServiceName" => AWSServiceName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service_specific_credential(service_name, user_name)
create_service_specific_credential(service_name, user_name, params::Dict{String,<:Any})
Generates a set of credentials consisting of a user name and password that can be used to
access the service specified in the request. These credentials are generated by IAM, and
can be used only for the specified service. You can have a maximum of two sets of
service-specific credentials for each supported service per user. You can create
service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).
You can reset the password to a new service-generated value by calling
ResetServiceSpecificCredential. For more information about service-specific credentials,
see Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access
keys in the IAM User Guide.
# Arguments
- `service_name`: The name of the Amazon Web Services service that is to be associated with
the credentials. The service you specify here is the only service that can be accessed
using these credentials.
- `user_name`: The name of the IAM user that is to be associated with the credentials. The
new service-specific credentials have the same permissions as the associated user except
that they can be used only to access the specified service. This parameter allows (through
its regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: _+=,.@-
"""
function create_service_specific_credential(
ServiceName, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateServiceSpecificCredential",
Dict{String,Any}("ServiceName" => ServiceName, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_specific_credential(
ServiceName,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreateServiceSpecificCredential",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServiceName" => ServiceName, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(user_name)
create_user(user_name, params::Dict{String,<:Any})
Creates a new IAM user for your Amazon Web Services account. For information about quotas
for the number of IAM users you can create, see IAM and STS quotas in the IAM User Guide.
# Arguments
- `user_name`: The name of the user to create. IAM user, group, role, and policy names must
be unique within the account. Names are not distinguished by case. For example, you cannot
create resources named both \"MyResource\" and \"myresource\".
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Path"`: The path for the user name. For more information about paths, see IAM
identifiers in the IAM User Guide. This parameter is optional. If it is not included, it
defaults to a slash (/). This parameter allows (through its regex pattern) a string of
characters consisting of either a forward slash (/) by itself or a string that must begin
and end with forward slashes. In addition, it can contain any ASCII character from the !
(u0021) through the DEL character (u007F), including most punctuation characters, digits,
and upper and lowercased letters.
- `"PermissionsBoundary"`: The ARN of the managed policy that is used to set the
permissions boundary for the user. A permissions boundary policy defines the maximum
permissions that identity-based policies can grant to an entity, but does not grant
permissions. Permissions boundaries do not define the maximum permissions that a
resource-based policy can grant to an entity. To learn more, see Permissions boundaries for
IAM entities in the IAM User Guide. For more information about policy types, see Policy
types in the IAM User Guide.
- `"Tags"`: A list of tags that you want to attach to the new user. Each tag consists of a
key name and an associated value. For more information about tagging, see Tagging IAM
resources in the IAM User Guide. If any one of the tags is invalid or if you exceed the
allowed maximum number of tags, then the entire request fails and the resource is not
created.
"""
function create_user(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"CreateUser",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreateUser",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_virtual_mfadevice(virtual_mfadevice_name)
create_virtual_mfadevice(virtual_mfadevice_name, params::Dict{String,<:Any})
Creates a new virtual MFA device for the Amazon Web Services account. After creating the
virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more
information about creating and working with virtual MFA devices, see Using a virtual MFA
device in the IAM User Guide. For information about the maximum number of MFA devices you
can create, see IAM and STS quotas in the IAM User Guide. The seed information contained
in the QR code and the Base32 string should be treated like any other secret access
information. In other words, protect the seed information as you would your Amazon Web
Services access keys or your passwords. After you provision your virtual device, you should
ensure that the information is destroyed following secure procedures.
# Arguments
- `virtual_mfadevice_name`: The name of the virtual MFA device, which must be unique. Use
with path to uniquely identify a virtual MFA device. This parameter allows (through its
regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Path"`: The path for the virtual MFA device. For more information about paths, see IAM
identifiers in the IAM User Guide. This parameter is optional. If it is not included, it
defaults to a slash (/). This parameter allows (through its regex pattern) a string of
characters consisting of either a forward slash (/) by itself or a string that must begin
and end with forward slashes. In addition, it can contain any ASCII character from the !
(u0021) through the DEL character (u007F), including most punctuation characters, digits,
and upper and lowercased letters.
- `"Tags"`: A list of tags that you want to attach to the new IAM virtual MFA device. Each
tag consists of a key name and an associated value. For more information about tagging, see
Tagging IAM resources in the IAM User Guide. If any one of the tags is invalid or if you
exceed the allowed maximum number of tags, then the entire request fails and the resource
is not created.
"""
function create_virtual_mfadevice(
VirtualMFADeviceName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"CreateVirtualMFADevice",
Dict{String,Any}("VirtualMFADeviceName" => VirtualMFADeviceName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_virtual_mfadevice(
VirtualMFADeviceName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"CreateVirtualMFADevice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("VirtualMFADeviceName" => VirtualMFADeviceName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deactivate_mfadevice(serial_number, user_name)
deactivate_mfadevice(serial_number, user_name, params::Dict{String,<:Any})
Deactivates the specified MFA device and removes it from association with the user name for
which it was originally enabled. For more information about creating and working with
virtual MFA devices, see Enabling a virtual multi-factor authentication (MFA) device in the
IAM User Guide.
# Arguments
- `serial_number`: The serial number that uniquely identifies the MFA device. For virtual
MFA devices, the serial number is the device ARN. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: =,.@:/-
- `user_name`: The name of the user whose MFA device you want to deactivate. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function deactivate_mfadevice(
SerialNumber, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeactivateMFADevice",
Dict{String,Any}("SerialNumber" => SerialNumber, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deactivate_mfadevice(
SerialNumber,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeactivateMFADevice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SerialNumber" => SerialNumber, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_access_key(access_key_id)
delete_access_key(access_key_id, params::Dict{String,<:Any})
Deletes the access key pair associated with the specified IAM user. If you do not specify a
user name, IAM determines the user name implicitly based on the Amazon Web Services access
key ID signing the request. This operation works for access keys under the Amazon Web
Services account. Consequently, you can use this operation to manage Amazon Web Services
account root user credentials even if the Amazon Web Services account has no associated
users.
# Arguments
- `access_key_id`: The access key ID for the access key ID and secret access key you want
to delete. This parameter allows (through its regex pattern) a string of characters that
can consist of any upper or lowercased letter or digit.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The name of the user whose access key pair you want to delete. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function delete_access_key(AccessKeyId; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"DeleteAccessKey",
Dict{String,Any}("AccessKeyId" => AccessKeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_access_key(
AccessKeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteAccessKey",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccessKeyId" => AccessKeyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_account_alias(account_alias)
delete_account_alias(account_alias, params::Dict{String,<:Any})
Deletes the specified Amazon Web Services account alias. For information about using an
Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web
Services account alias in the Amazon Web Services Sign-In User Guide.
# Arguments
- `account_alias`: The name of the account alias to delete. This parameter allows (through
its regex pattern) a string of characters consisting of lowercase letters, digits, and
dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.
"""
function delete_account_alias(
AccountAlias; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteAccountAlias",
Dict{String,Any}("AccountAlias" => AccountAlias);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_account_alias(
AccountAlias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteAccountAlias",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccountAlias" => AccountAlias), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_account_password_policy()
delete_account_password_policy(params::Dict{String,<:Any})
Deletes the password policy for the Amazon Web Services account. There are no parameters.
"""
function delete_account_password_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"DeleteAccountPasswordPolicy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_account_password_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteAccountPasswordPolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group(group_name)
delete_group(group_name, params::Dict{String,<:Any})
Deletes the specified IAM group. The group must not contain any users or have any attached
policies.
# Arguments
- `group_name`: The name of the IAM group to delete. This parameter allows (through its
regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: _+=,.@-
"""
function delete_group(GroupName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"DeleteGroup",
Dict{String,Any}("GroupName" => GroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group(
GroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GroupName" => GroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group_policy(group_name, policy_name)
delete_group_policy(group_name, policy_name, params::Dict{String,<:Any})
Deletes the specified inline policy that is embedded in the specified IAM group. A group
can also have managed policies attached to it. To detach a managed policy from a group, use
DetachGroupPolicy. For more information about policies, refer to Managed policies and
inline policies in the IAM User Guide.
# Arguments
- `group_name`: The name (friendly name, not ARN) identifying the group that the policy is
embedded in. This parameter allows (through its regex pattern) a string of characters
consisting of upper and lowercase alphanumeric characters with no spaces. You can also
include any of the following characters: _+=,.@-
- `policy_name`: The name identifying the policy document to delete. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function delete_group_policy(
GroupName, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteGroupPolicy",
Dict{String,Any}("GroupName" => GroupName, "PolicyName" => PolicyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group_policy(
GroupName,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "PolicyName" => PolicyName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_instance_profile(instance_profile_name)
delete_instance_profile(instance_profile_name, params::Dict{String,<:Any})
Deletes the specified instance profile. The instance profile must not have an associated
role. Make sure that you do not have any Amazon EC2 instances running with the instance
profile you are about to delete. Deleting a role or instance profile that is associated
with a running instance will break any applications running on the instance. For more
information about instance profiles, see Using instance profiles in the IAM User Guide.
# Arguments
- `instance_profile_name`: The name of the instance profile to delete. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function delete_instance_profile(
InstanceProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteInstanceProfile",
Dict{String,Any}("InstanceProfileName" => InstanceProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_instance_profile(
InstanceProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteInstanceProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceProfileName" => InstanceProfileName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_login_profile(user_name)
delete_login_profile(user_name, params::Dict{String,<:Any})
Deletes the password for the specified IAM user, For more information, see Managing
passwords for IAM users. You can use the CLI, the Amazon Web Services API, or the Users
page in the IAM console to delete a password for any IAM user. You can use ChangePassword
to update, but not delete, your own password in the My Security Credentials page in the
Amazon Web Services Management Console. Deleting a user's password does not prevent a user
from accessing Amazon Web Services through the command line interface or the API. To
prevent all user access, you must also either make any access keys inactive or delete them.
For more information about making keys inactive or deleting them, see UpdateAccessKey and
DeleteAccessKey.
# Arguments
- `user_name`: The name of the user whose password you want to delete. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function delete_login_profile(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"DeleteLoginProfile",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_login_profile(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteLoginProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_open_idconnect_provider(open_idconnect_provider_arn)
delete_open_idconnect_provider(open_idconnect_provider_arn, params::Dict{String,<:Any})
Deletes an OpenID Connect identity provider (IdP) resource object in IAM. Deleting an IAM
OIDC provider resource does not update any roles that reference the provider as a principal
in their trust policies. Any attempt to assume a role that references a deleted provider
fails. This operation is idempotent; it does not fail or return an error if you call the
operation for a provider that does not exist.
# Arguments
- `open_idconnect_provider_arn`: The Amazon Resource Name (ARN) of the IAM OpenID Connect
provider resource object to delete. You can get a list of OpenID Connect provider resource
ARNs by using the ListOpenIDConnectProviders operation.
"""
function delete_open_idconnect_provider(
OpenIDConnectProviderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteOpenIDConnectProvider",
Dict{String,Any}("OpenIDConnectProviderArn" => OpenIDConnectProviderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_open_idconnect_provider(
OpenIDConnectProviderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteOpenIDConnectProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("OpenIDConnectProviderArn" => OpenIDConnectProviderArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy(policy_arn)
delete_policy(policy_arn, params::Dict{String,<:Any})
Deletes the specified managed policy. Before you can delete a managed policy, you must
first detach the policy from all users, groups, and roles that it is attached to. In
addition, you must delete all the policy's versions. The following steps describe the
process for deleting a managed policy: Detach the policy from all users, groups, and
roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or
DetachRolePolicy. To list all the users, groups, and roles that a policy is attached to,
use ListEntitiesForPolicy. Delete all versions of the policy using DeletePolicyVersion.
To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion
to delete the version that is marked as the default version. You delete the policy's
default version in the next step of the process. Delete the policy (this automatically
deletes the policy's default version) using this operation. For information about managed
policies, see Managed policies and inline policies in the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy you want to delete. For
more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
"""
function delete_policy(PolicyArn; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"DeletePolicy",
Dict{String,Any}("PolicyArn" => PolicyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_policy(
PolicyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeletePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyArn" => PolicyArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy_version(policy_arn, version_id)
delete_policy_version(policy_arn, version_id, params::Dict{String,<:Any})
Deletes the specified version from the specified managed policy. You cannot delete the
default version from a policy using this operation. To delete the default version from a
policy, use DeletePolicy. To find out which version of a policy is marked as the default
version, use ListPolicyVersions. For information about versions for managed policies, see
Versioning for managed policies in the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy from which you want to
delete a version. For more information about ARNs, see Amazon Resource Names (ARNs) in the
Amazon Web Services General Reference.
- `version_id`: The policy version to delete. This parameter allows (through its regex
pattern) a string of characters that consists of the lowercase letter 'v' followed by one
or two digits, and optionally followed by a period '.' and a string of letters and digits.
For more information about managed policy versions, see Versioning for managed policies in
the IAM User Guide.
"""
function delete_policy_version(
PolicyArn, VersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeletePolicyVersion",
Dict{String,Any}("PolicyArn" => PolicyArn, "VersionId" => VersionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_policy_version(
PolicyArn,
VersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeletePolicyVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyArn" => PolicyArn, "VersionId" => VersionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_role(role_name)
delete_role(role_name, params::Dict{String,<:Any})
Deletes the specified role. Unlike the Amazon Web Services Management Console, when you
delete a role programmatically, you must delete the items attached to the role manually, or
the deletion fails. For more information, see Deleting an IAM role. Before attempting to
delete a role, remove the following attached items: Inline policies (DeleteRolePolicy)
Attached managed policies (DetachRolePolicy) Instance profile
(RemoveRoleFromInstanceProfile) Optional – Delete instance profile after detaching from
role for resource clean up (DeleteInstanceProfile) Make sure that you do not have any
Amazon EC2 instances running with the role you are about to delete. Deleting a role or
instance profile that is associated with a running instance will break any applications
running on the instance.
# Arguments
- `role_name`: The name of the role to delete. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
"""
function delete_role(RoleName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"DeleteRole",
Dict{String,Any}("RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_role(
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteRole",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RoleName" => RoleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_role_permissions_boundary(role_name)
delete_role_permissions_boundary(role_name, params::Dict{String,<:Any})
Deletes the permissions boundary for the specified IAM role. You cannot set the boundary
for a service-linked role. Deleting the permissions boundary for a role might increase its
permissions. For example, it might allow anyone who assumes the role to perform all the
actions granted in its permissions policies.
# Arguments
- `role_name`: The name (friendly name, not ARN) of the IAM role from which you want to
remove the permissions boundary.
"""
function delete_role_permissions_boundary(
RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteRolePermissionsBoundary",
Dict{String,Any}("RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_role_permissions_boundary(
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteRolePermissionsBoundary",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RoleName" => RoleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_role_policy(policy_name, role_name)
delete_role_policy(policy_name, role_name, params::Dict{String,<:Any})
Deletes the specified inline policy that is embedded in the specified IAM role. A role can
also have managed policies attached to it. To detach a managed policy from a role, use
DetachRolePolicy. For more information about policies, refer to Managed policies and inline
policies in the IAM User Guide.
# Arguments
- `policy_name`: The name of the inline policy to delete from the specified IAM role. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
- `role_name`: The name (friendly name, not ARN) identifying the role that the policy is
embedded in. This parameter allows (through its regex pattern) a string of characters
consisting of upper and lowercase alphanumeric characters with no spaces. You can also
include any of the following characters: _+=,.@-
"""
function delete_role_policy(
PolicyName, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteRolePolicy",
Dict{String,Any}("PolicyName" => PolicyName, "RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_role_policy(
PolicyName,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteRolePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyName" => PolicyName, "RoleName" => RoleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_samlprovider(samlprovider_arn)
delete_samlprovider(samlprovider_arn, params::Dict{String,<:Any})
Deletes a SAML provider resource in IAM. Deleting the provider resource from IAM does not
update any roles that reference the SAML provider resource's ARN as a principal in their
trust policies. Any attempt to assume a role that references a non-existent provider
resource ARN fails. This operation requires Signature Version 4.
# Arguments
- `samlprovider_arn`: The Amazon Resource Name (ARN) of the SAML provider to delete.
"""
function delete_samlprovider(
SAMLProviderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteSAMLProvider",
Dict{String,Any}("SAMLProviderArn" => SAMLProviderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_samlprovider(
SAMLProviderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteSAMLProvider",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SAMLProviderArn" => SAMLProviderArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_server_certificate(server_certificate_name)
delete_server_certificate(server_certificate_name, params::Dict{String,<:Any})
Deletes the specified server certificate. For more information about working with server
certificates, see Working with server certificates in the IAM User Guide. This topic also
includes a list of Amazon Web Services services that can use the server certificates that
you manage with IAM. If you are using a server certificate with Elastic Load Balancing,
deleting the certificate could have implications for your application. If Elastic Load
Balancing doesn't detect the deletion of bound certificates, it may continue to use the
certificates. This could cause Elastic Load Balancing to stop accepting traffic. We
recommend that you remove the reference to the certificate from Elastic Load Balancing
before using this command to delete the certificate. For more information, see
DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.
# Arguments
- `server_certificate_name`: The name of the server certificate you want to delete. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function delete_server_certificate(
ServerCertificateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteServerCertificate",
Dict{String,Any}("ServerCertificateName" => ServerCertificateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_server_certificate(
ServerCertificateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteServerCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerCertificateName" => ServerCertificateName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_linked_role(role_name)
delete_service_linked_role(role_name, params::Dict{String,<:Any})
Submits a service-linked role deletion request and returns a DeletionTaskId, which you can
use to check the status of the deletion. Before you call this operation, confirm that the
role has no active sessions and that any resources used by the role in the linked service
are deleted. If you call this operation more than once for the same service-linked role and
an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is
returned. If you submit a deletion request for a service-linked role whose linked service
is still accessing a resource, then the deletion task fails. If it fails, the
GetServiceLinkedRoleDeletionStatus operation returns the reason for the failure, usually
including the resources that must be deleted. To delete the service-linked role, you must
first remove those resources from the linked service and then submit the deletion request
again. Resources are specific to the service that is linked to the role. For more
information about removing resources from a service, see the Amazon Web Services
documentation for your service. For more information about service-linked roles, see Roles
terms and concepts: Amazon Web Services service-linked role in the IAM User Guide.
# Arguments
- `role_name`: The name of the service-linked role to be deleted.
"""
function delete_service_linked_role(
RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteServiceLinkedRole",
Dict{String,Any}("RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_linked_role(
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteServiceLinkedRole",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RoleName" => RoleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_specific_credential(service_specific_credential_id)
delete_service_specific_credential(service_specific_credential_id, params::Dict{String,<:Any})
Deletes the specified service-specific credential.
# Arguments
- `service_specific_credential_id`: The unique identifier of the service-specific
credential. You can get this value by calling ListServiceSpecificCredentials. This
parameter allows (through its regex pattern) a string of characters that can consist of any
upper or lowercased letter or digit.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The name of the IAM user associated with the service-specific credential.
If this value is not specified, then the operation assumes the user whose credentials are
used to call the operation. This parameter allows (through its regex pattern) a string of
characters consisting of upper and lowercase alphanumeric characters with no spaces. You
can also include any of the following characters: _+=,.@-
"""
function delete_service_specific_credential(
ServiceSpecificCredentialId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteServiceSpecificCredential",
Dict{String,Any}("ServiceSpecificCredentialId" => ServiceSpecificCredentialId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_specific_credential(
ServiceSpecificCredentialId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteServiceSpecificCredential",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServiceSpecificCredentialId" => ServiceSpecificCredentialId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_signing_certificate(certificate_id)
delete_signing_certificate(certificate_id, params::Dict{String,<:Any})
Deletes a signing certificate associated with the specified IAM user. If you do not specify
a user name, IAM determines the user name implicitly based on the Amazon Web Services
access key ID signing the request. This operation works for access keys under the Amazon
Web Services account. Consequently, you can use this operation to manage Amazon Web
Services account root user credentials even if the Amazon Web Services account has no
associated IAM users.
# Arguments
- `certificate_id`: The ID of the signing certificate to delete. The format of this
parameter, as described by its regex pattern, is a string of characters that can be upper-
or lower-cased letters or digits.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The name of the user the signing certificate belongs to. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function delete_signing_certificate(
CertificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteSigningCertificate",
Dict{String,Any}("CertificateId" => CertificateId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_signing_certificate(
CertificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteSigningCertificate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("CertificateId" => CertificateId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_sshpublic_key(sshpublic_key_id, user_name)
delete_sshpublic_key(sshpublic_key_id, user_name, params::Dict{String,<:Any})
Deletes the specified SSH public key. The SSH public key deleted by this operation is used
only for authenticating the associated IAM user to an CodeCommit repository. For more
information about using SSH keys to authenticate to an CodeCommit repository, see Set up
CodeCommit for SSH connections in the CodeCommit User Guide.
# Arguments
- `sshpublic_key_id`: The unique identifier for the SSH public key. This parameter allows
(through its regex pattern) a string of characters that can consist of any upper or
lowercased letter or digit.
- `user_name`: The name of the IAM user associated with the SSH public key. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function delete_sshpublic_key(
SSHPublicKeyId, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteSSHPublicKey",
Dict{String,Any}("SSHPublicKeyId" => SSHPublicKeyId, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_sshpublic_key(
SSHPublicKeyId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteSSHPublicKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SSHPublicKeyId" => SSHPublicKeyId, "UserName" => UserName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(user_name)
delete_user(user_name, params::Dict{String,<:Any})
Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you
delete a user programmatically, you must delete the items attached to the user manually, or
the deletion fails. For more information, see Deleting an IAM user. Before attempting to
delete a user, remove the following items: Password (DeleteLoginProfile) Access keys
(DeleteAccessKey) Signing certificate (DeleteSigningCertificate) SSH public key
(DeleteSSHPublicKey) Git credentials (DeleteServiceSpecificCredential) Multi-factor
authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice) Inline policies
(DeleteUserPolicy) Attached managed policies (DetachUserPolicy) Group memberships
(RemoveUserFromGroup)
# Arguments
- `user_name`: The name of the user to delete. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
"""
function delete_user(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"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 iam(
"DeleteUser",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_permissions_boundary(user_name)
delete_user_permissions_boundary(user_name, params::Dict{String,<:Any})
Deletes the permissions boundary for the specified IAM user. Deleting the permissions
boundary for a user might increase its permissions by allowing the user to perform all the
actions granted in its permissions policies.
# Arguments
- `user_name`: The name (friendly name, not ARN) of the IAM user from which you want to
remove the permissions boundary.
"""
function delete_user_permissions_boundary(
UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteUserPermissionsBoundary",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_permissions_boundary(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteUserPermissionsBoundary",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user_policy(policy_name, user_name)
delete_user_policy(policy_name, user_name, params::Dict{String,<:Any})
Deletes the specified inline policy that is embedded in the specified IAM user. A user can
also have managed policies attached to it. To detach a managed policy from a user, use
DetachUserPolicy. For more information about policies, refer to Managed policies and inline
policies in the IAM User Guide.
# Arguments
- `policy_name`: The name identifying the policy document to delete. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
- `user_name`: The name (friendly name, not ARN) identifying the user that the policy is
embedded in. This parameter allows (through its regex pattern) a string of characters
consisting of upper and lowercase alphanumeric characters with no spaces. You can also
include any of the following characters: _+=,.@-
"""
function delete_user_policy(
PolicyName, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteUserPolicy",
Dict{String,Any}("PolicyName" => PolicyName, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user_policy(
PolicyName,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteUserPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyName" => PolicyName, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_virtual_mfadevice(serial_number)
delete_virtual_mfadevice(serial_number, params::Dict{String,<:Any})
Deletes a virtual MFA device. You must deactivate a user's virtual MFA device before you
can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.
# Arguments
- `serial_number`: The serial number that uniquely identifies the MFA device. For virtual
MFA devices, the serial number is the same as the ARN. This parameter allows (through its
regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: =,.@:/-
"""
function delete_virtual_mfadevice(
SerialNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DeleteVirtualMFADevice",
Dict{String,Any}("SerialNumber" => SerialNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_virtual_mfadevice(
SerialNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DeleteVirtualMFADevice",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SerialNumber" => SerialNumber), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_group_policy(group_name, policy_arn)
detach_group_policy(group_name, policy_arn, params::Dict{String,<:Any})
Removes the specified managed policy from the specified IAM group. A group can also have
inline policies embedded with it. To delete an inline policy, use DeleteGroupPolicy. For
information about policies, see Managed policies and inline policies in the IAM User Guide.
# Arguments
- `group_name`: The name (friendly name, not ARN) of the IAM group to detach the policy
from. This parameter allows (through its regex pattern) a string of characters consisting
of upper and lowercase alphanumeric characters with no spaces. You can also include any of
the following characters: _+=,.@-
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy you want to detach. For
more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
"""
function detach_group_policy(
GroupName, PolicyArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DetachGroupPolicy",
Dict{String,Any}("GroupName" => GroupName, "PolicyArn" => PolicyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_group_policy(
GroupName,
PolicyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DetachGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "PolicyArn" => PolicyArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_role_policy(policy_arn, role_name)
detach_role_policy(policy_arn, role_name, params::Dict{String,<:Any})
Removes the specified managed policy from the specified role. A role can also have inline
policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For
information about policies, see Managed policies and inline policies in the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy you want to detach. For
more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
- `role_name`: The name (friendly name, not ARN) of the IAM role to detach the policy from.
This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
"""
function detach_role_policy(
PolicyArn, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DetachRolePolicy",
Dict{String,Any}("PolicyArn" => PolicyArn, "RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_role_policy(
PolicyArn,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DetachRolePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyArn" => PolicyArn, "RoleName" => RoleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_user_policy(policy_arn, user_name)
detach_user_policy(policy_arn, user_name, params::Dict{String,<:Any})
Removes the specified managed policy from the specified user. A user can also have inline
policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For
information about policies, see Managed policies and inline policies in the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy you want to detach. For
more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
- `user_name`: The name (friendly name, not ARN) of the IAM user to detach the policy from.
This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
"""
function detach_user_policy(
PolicyArn, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"DetachUserPolicy",
Dict{String,Any}("PolicyArn" => PolicyArn, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_user_policy(
PolicyArn,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"DetachUserPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyArn" => PolicyArn, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_mfadevice(authentication_code1, authentication_code2, serial_number, user_name)
enable_mfadevice(authentication_code1, authentication_code2, serial_number, user_name, params::Dict{String,<:Any})
Enables the specified MFA device and associates it with the specified IAM user. When
enabled, the MFA device is required for every subsequent login by the IAM user associated
with the device.
# Arguments
- `authentication_code1`: An authentication code emitted by the device. The format for
this parameter is a string of six digits. Submit your request immediately after generating
the authentication codes. If you generate the codes and then wait too long to submit the
request, the MFA device successfully associates with the user but the MFA device becomes
out of sync. This happens because time-based one-time passwords (TOTP) expire after a short
period of time. If this happens, you can resync the device.
- `authentication_code2`: A subsequent authentication code emitted by the device. The
format for this parameter is a string of six digits. Submit your request immediately after
generating the authentication codes. If you generate the codes and then wait too long to
submit the request, the MFA device successfully associates with the user but the MFA device
becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after
a short period of time. If this happens, you can resync the device.
- `serial_number`: The serial number that uniquely identifies the MFA device. For virtual
MFA devices, the serial number is the device ARN. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: =,.@:/-
- `user_name`: The name of the IAM user for whom you want to enable the MFA device. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function enable_mfadevice(
AuthenticationCode1,
AuthenticationCode2,
SerialNumber,
UserName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"EnableMFADevice",
Dict{String,Any}(
"AuthenticationCode1" => AuthenticationCode1,
"AuthenticationCode2" => AuthenticationCode2,
"SerialNumber" => SerialNumber,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_mfadevice(
AuthenticationCode1,
AuthenticationCode2,
SerialNumber,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"EnableMFADevice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthenticationCode1" => AuthenticationCode1,
"AuthenticationCode2" => AuthenticationCode2,
"SerialNumber" => SerialNumber,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_credential_report()
generate_credential_report(params::Dict{String,<:Any})
Generates a credential report for the Amazon Web Services account. For more information
about the credential report, see Getting credential reports in the IAM User Guide.
"""
function generate_credential_report(; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"GenerateCredentialReport"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function generate_credential_report(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GenerateCredentialReport",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_organizations_access_report(entity_path)
generate_organizations_access_report(entity_path, params::Dict{String,<:Any})
Generates a report for service last accessed data for Organizations. You can generate a
report for any entities (organization root, organizational unit, or account) or policies in
your organization. To call this operation, you must be signed in using your Organizations
management account credentials. You can use your long-term IAM user or root user
credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for
your organization root. You must have the required IAM and Organizations permissions. For
more information, see Refining permissions using service last accessed data in the IAM User
Guide. You can generate a service last accessed data report for entities by specifying only
the entity's path. This data includes a list of services that are allowed by any service
control policies (SCPs) that apply to the entity. You can generate a service last accessed
data report for a policy by specifying an entity's path and an optional Organizations
policy ID. This data includes a list of services that are allowed by the specified SCP. For
each service in both report types, the data includes the most recent account activity that
the policy allows to account principals in the entity or the entity's children. For
important information about the data, reporting period, permissions required,
troubleshooting, and supported Regions see Reducing permissions using service last accessed
data in the IAM User Guide. The data includes all attempts to access Amazon Web
Services, not just the successful ones. This includes all attempts that were made using the
Amazon Web Services Management Console, the Amazon Web Services API through any of the
SDKs, or any of the command line tools. An unexpected entry in the service last accessed
data does not mean that an account has been compromised, because the request might have
been denied. Refer to your CloudTrail logs as the authoritative source for information
about all API calls and whether they were successful or denied access. For more
information, see Logging IAM events with CloudTrail in the IAM User Guide. This operation
returns a JobId. Use this parameter in the GetOrganizationsAccessReport operation to
check the status of the report generation. To check the status of this request, use the
JobId parameter in the GetOrganizationsAccessReport operation and test the JobStatus
response parameter. When the job is complete, you can retrieve the report. To generate a
service last accessed data report for entities, specify an entity path without specifying
the optional Organizations policy ID. The type of entity that you specify determines the
data returned in the report. Root – When you specify the organizations root as the
entity, the resulting report lists all of the services allowed by SCPs that are attached to
your root. For each service, the report includes data for all accounts in your organization
except the management account, because the management account is not limited by SCPs. OU
– When you specify an organizational unit (OU) as the entity, the resulting report lists
all of the services allowed by SCPs that are attached to the OU and its parents. For each
service, the report includes data for all accounts in the OU or its children. This data
excludes the management account, because the management account is not limited by SCPs.
management account – When you specify the management account, the resulting report lists
all Amazon Web Services services, because the management account is not limited by SCPs.
For each service, the report includes data for only the management account. Account –
When you specify another account as the entity, the resulting report lists all of the
services allowed by SCPs that are attached to the account and its parents. For each
service, the report includes data for only the specified account. To generate a service
last accessed data report for policies, specify an entity path and the optional
Organizations policy ID. The type of entity that you specify determines the data returned
for each service. Root – When you specify the root entity and a policy ID, the
resulting report lists all of the services that are allowed by the specified SCP. For each
service, the report includes data for all accounts in your organization to which the SCP
applies. This data excludes the management account, because the management account is not
limited by SCPs. If the SCP is not attached to any entities in the organization, then the
report will return a list of services with no data. OU – When you specify an OU entity
and a policy ID, the resulting report lists all of the services that are allowed by the
specified SCP. For each service, the report includes data for all accounts in the OU or its
children to which the SCP applies. This means that other accounts outside the OU that are
affected by the SCP might not be included in the data. This data excludes the management
account, because the management account is not limited by SCPs. If the SCP is not attached
to the OU or one of its children, the report will return a list of services with no data.
management account – When you specify the management account, the resulting report lists
all Amazon Web Services services, because the management account is not limited by SCPs. If
you specify a policy ID in the CLI or API, the policy is ignored. For each service, the
report includes data for only the management account. Account – When you specify
another account entity and a policy ID, the resulting report lists all of the services that
are allowed by the specified SCP. For each service, the report includes data for only the
specified account. This means that other accounts in the organization that are affected by
the SCP might not be included in the data. If the SCP is not attached to the account, the
report will return a list of services with no data. Service last accessed data does not
use other policy types when determining whether a principal could access a service. These
other policy types include identity-based policies, resource-based policies, access control
lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic.
For more about the evaluation of policy types, see Evaluating policies in the IAM User
Guide. For more information about service last accessed data, see Reducing policy scope by
viewing user activity in the IAM User Guide.
# Arguments
- `entity_path`: The path of the Organizations entity (root, OU, or account). You can build
an entity path using the known structure of your organization. For example, assume that
your account ID is 123456789012 and its parent OU ID is ou-rge0-awsabcde. The organization
root ID is r-f6g7h8i9j0example and your organization ID is o-a1b2c3d4e5. Your entity path
is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"OrganizationsPolicyId"`: The identifier of the Organizations service control policy
(SCP). This parameter is optional. This ID is used to generate information about when an
account principal that is limited by the SCP attempted to access an Amazon Web Services
service.
"""
function generate_organizations_access_report(
EntityPath; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GenerateOrganizationsAccessReport",
Dict{String,Any}("EntityPath" => EntityPath);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_organizations_access_report(
EntityPath,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GenerateOrganizationsAccessReport",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("EntityPath" => EntityPath), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
generate_service_last_accessed_details(arn)
generate_service_last_accessed_details(arn, params::Dict{String,<:Any})
Generates a report that includes details about when an IAM resource (user, group, role, or
policy) was last used in an attempt to access Amazon Web Services services. Recent activity
usually appears within four hours. IAM reports activity for at least the last 400 days, or
less if your Region began supporting this feature within the last year. For more
information, see Regions where data is tracked. For more information about services and
actions for which action last accessed information is displayed, see IAM action last
accessed information services and actions. The service last accessed data
includes all attempts to access an Amazon Web Services API, not just the successful ones.
This includes all attempts that were made using the Amazon Web Services Management Console,
the Amazon Web Services API through any of the SDKs, or any of the command line tools. An
unexpected entry in the service last accessed data does not mean that your account has been
compromised, because the request might have been denied. Refer to your CloudTrail logs as
the authoritative source for information about all API calls and whether they were
successful or denied access. For more information, see Logging IAM events with CloudTrail
in the IAM User Guide. The GenerateServiceLastAccessedDetails operation returns a JobId.
Use this parameter in the following operations to retrieve the following details from your
report: GetServiceLastAccessedDetails – Use this operation for users, groups, roles,
or policies to list every Amazon Web Services service that the resource could access using
permissions policies. For each service, the response includes information about the most
recent access attempt. The JobId returned by GenerateServiceLastAccessedDetail must be used
by the same role within a session, or by the same user when used to call
GetServiceLastAccessedDetail. GetServiceLastAccessedDetailsWithEntities – Use this
operation for groups and policies to list information about the associated entities (users
or roles) that attempted to access a specific Amazon Web Services service. To check the
status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the
same operations and test the JobStatus response parameter. For additional information about
the permissions policies that allow an identity (user, group, or role) to access specific
services, use the ListPoliciesGrantingServiceAccess operation. Service last accessed data
does not use other policy types when determining whether a resource could access a service.
These other policy types include resource-based policies, access control lists,
Organizations policies, IAM permissions boundaries, and STS assume role policies. It only
applies permissions policy logic. For more about the evaluation of policy types, see
Evaluating policies in the IAM User Guide. For more information about service and action
last accessed data, see Reducing permissions using service last accessed data in the IAM
User Guide.
# Arguments
- `arn`: The ARN of the IAM resource (user, group, role, or managed policy) used to
generate information about when the resource was last used in an attempt to access an
Amazon Web Services service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Granularity"`: The level of detail that you want to generate. You can specify whether
you want to generate information about the last attempt to access services or actions. If
you specify service-level granularity, this operation generates only service data. If you
specify action-level granularity, it generates service and action data. If you don't
include this optional parameter, the operation generates service data.
"""
function generate_service_last_accessed_details(
Arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GenerateServiceLastAccessedDetails",
Dict{String,Any}("Arn" => Arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function generate_service_last_accessed_details(
Arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GenerateServiceLastAccessedDetails",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Arn" => Arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_access_key_last_used(access_key_id)
get_access_key_last_used(access_key_id, params::Dict{String,<:Any})
Retrieves information about when the specified access key was last used. The information
includes the date and time of last use, along with the Amazon Web Services service and
Region that were specified in the last request made with that key.
# Arguments
- `access_key_id`: The identifier of an access key. This parameter allows (through its
regex pattern) a string of characters that can consist of any upper or lowercased letter or
digit.
"""
function get_access_key_last_used(
AccessKeyId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetAccessKeyLastUsed",
Dict{String,Any}("AccessKeyId" => AccessKeyId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_access_key_last_used(
AccessKeyId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetAccessKeyLastUsed",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("AccessKeyId" => AccessKeyId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_authorization_details()
get_account_authorization_details(params::Dict{String,<:Any})
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web
Services account, including their relationships to one another. Use this operation to
obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and
policies) in your account. Policies returned by this operation are URL-encoded compliant
with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON
text. For example, if you use Java, you can use the decode method of the
java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar
functionality. You can optionally filter the results using the Filter parameter. You can
paginate the results using the MaxItems and Marker parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filter"`: A list of entity types used to filter the results. Only the entities that
match the types you specify are included in the output. Use the value LocalManagedPolicy to
include customer managed policies. The format for this parameter is a comma-separated (if
more than one) list of strings. Each string value in the list must be one of the valid
values listed below.
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function get_account_authorization_details(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetAccountAuthorizationDetails";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_account_authorization_details(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetAccountAuthorizationDetails",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_password_policy()
get_account_password_policy(params::Dict{String,<:Any})
Retrieves the password policy for the Amazon Web Services account. This tells you the
complexity requirements and mandatory rotation periods for the IAM user passwords in your
account. For more information about using a password policy, see Managing an IAM password
policy.
"""
function get_account_password_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"GetAccountPasswordPolicy"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_account_password_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetAccountPasswordPolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_summary()
get_account_summary(params::Dict{String,<:Any})
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services
account. For information about IAM quotas, see IAM and STS quotas in the IAM User Guide.
"""
function get_account_summary(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("GetAccountSummary"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_account_summary(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetAccountSummary", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_context_keys_for_custom_policy(policy_input_list)
get_context_keys_for_custom_policy(policy_input_list, params::Dict{String,<:Any})
Gets a list of all of the context keys referenced in the input policies. The policies are
supplied as a list of one or more strings. To get the context keys from policies associated
with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy. Context keys are
variables maintained by Amazon Web Services and its services that provide details about the
context of an API query request. Context keys can be evaluated by testing against a value
specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names
and values you must supply when you call SimulateCustomPolicy. Note that all parameters are
shown in unencoded form here for clarity but must be URL encoded to be included as a part
of a real HTML request.
# Arguments
- `policy_input_list`: A list of policies for which you want the list of context keys
referenced in those policies. Each document is specified as a string containing the
complete, valid JSON text of an IAM policy. The regex pattern used to validate this
parameter is a string of characters consisting of the following: Any printable ASCII
character ranging from the space character (u0020) through the end of the ASCII character
range The printable characters in the Basic Latin and Latin-1 Supplement character set
(through u00FF) The special characters tab (u0009), line feed (u000A), and carriage
return (u000D)
"""
function get_context_keys_for_custom_policy(
PolicyInputList; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetContextKeysForCustomPolicy",
Dict{String,Any}("PolicyInputList" => PolicyInputList);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_context_keys_for_custom_policy(
PolicyInputList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetContextKeysForCustomPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("PolicyInputList" => PolicyInputList), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_context_keys_for_principal_policy(policy_source_arn)
get_context_keys_for_principal_policy(policy_source_arn, params::Dict{String,<:Any})
Gets a list of all of the context keys referenced in all the IAM policies that are attached
to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify
a user, then the request also includes all of the policies attached to groups that the user
is a member of. You can optionally include a list of one or more additional policies,
specified as strings. If you want to include only a list of policies by string, use
GetContextKeysForCustomPolicy instead. Note: This operation discloses information about
the permissions granted to other users. If you do not want users to see other user's
permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
Context keys are variables maintained by Amazon Web Services and its services that provide
details about the context of an API query request. Context keys can be evaluated by testing
against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what
key names and values you must supply when you call SimulatePrincipalPolicy.
# Arguments
- `policy_source_arn`: The ARN of a user, group, or role whose policies contain the context
keys that you want listed. If you specify a user, the list includes context keys that are
found in all policies that are attached to the user. The list also includes all groups that
the user is a member of. If you pick a group or a role, then it includes only those context
keys that are found in policies attached to that entity. Note that all parameters are shown
in unencoded form here for clarity, but must be URL encoded to be included as a part of a
real HTML request. For more information about ARNs, see Amazon Resource Names (ARNs) in the
Amazon Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"PolicyInputList"`: An optional list of additional policies for which you want the list
of context keys that are referenced. The regex pattern used to validate this parameter is a
string of characters consisting of the following: Any printable ASCII character ranging
from the space character (u0020) through the end of the ASCII character range The
printable characters in the Basic Latin and Latin-1 Supplement character set (through
u00FF) The special characters tab (u0009), line feed (u000A), and carriage return (u000D)
"""
function get_context_keys_for_principal_policy(
PolicySourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetContextKeysForPrincipalPolicy",
Dict{String,Any}("PolicySourceArn" => PolicySourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_context_keys_for_principal_policy(
PolicySourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetContextKeysForPrincipalPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("PolicySourceArn" => PolicySourceArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_credential_report()
get_credential_report(params::Dict{String,<:Any})
Retrieves a credential report for the Amazon Web Services account. For more information
about the credential report, see Getting credential reports in the IAM User Guide.
"""
function get_credential_report(; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"GetCredentialReport"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_credential_report(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetCredentialReport",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group(group_name)
get_group(group_name, params::Dict{String,<:Any})
Returns a list of IAM users that are in the specified IAM group. You can paginate the
results using the MaxItems and Marker parameters.
# Arguments
- `group_name`: The name of the group. This parameter allows (through its regex pattern) a
string of characters consisting of upper and lowercase alphanumeric characters with no
spaces. You can also include any of the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function get_group(GroupName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"GetGroup",
Dict{String,Any}("GroupName" => GroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group(
GroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GroupName" => GroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group_policy(group_name, policy_name)
get_group_policy(group_name, policy_name, params::Dict{String,<:Any})
Retrieves the specified inline policy document that is embedded in the specified IAM group.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a
URL decoding method to convert the policy back to plain JSON text. For example, if you use
Java, you can use the decode method of the java.net.URLDecoder utility class in the Java
SDK. Other languages and SDKs provide similar functionality. An IAM group can also have
managed policies attached to it. To retrieve a managed policy document that is attached to
a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion
to retrieve the policy document. For more information about policies, see Managed policies
and inline policies in the IAM User Guide.
# Arguments
- `group_name`: The name of the group the policy is associated with. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
- `policy_name`: The name of the policy document to get. This parameter allows (through its
regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: _+=,.@-
"""
function get_group_policy(
GroupName, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetGroupPolicy",
Dict{String,Any}("GroupName" => GroupName, "PolicyName" => PolicyName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group_policy(
GroupName,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "PolicyName" => PolicyName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_instance_profile(instance_profile_name)
get_instance_profile(instance_profile_name, params::Dict{String,<:Any})
Retrieves information about the specified instance profile, including the instance
profile's path, GUID, ARN, and role. For more information about instance profiles, see
Using instance profiles in the IAM User Guide.
# Arguments
- `instance_profile_name`: The name of the instance profile to get information about. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function get_instance_profile(
InstanceProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetInstanceProfile",
Dict{String,Any}("InstanceProfileName" => InstanceProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_instance_profile(
InstanceProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetInstanceProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceProfileName" => InstanceProfileName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_login_profile(user_name)
get_login_profile(user_name, params::Dict{String,<:Any})
Retrieves the user name for the specified IAM user. A login profile is created when you
create a password for the user to access the Amazon Web Services Management Console. If the
user does not exist or does not have a password, the operation returns a 404 (NoSuchEntity)
error. If you create an IAM user with access to the console, the CreateDate reflects the
date you created the initial password for the user. If you create an IAM user with
programmatic access, and then later add a password for the user to access the Amazon Web
Services Management Console, the CreateDate reflects the initial password creation date. A
user with programmatic access does not have a login profile unless you create a password
for the user to access the Amazon Web Services Management Console.
# Arguments
- `user_name`: The name of the user whose login profile you want to retrieve. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function get_login_profile(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"GetLoginProfile",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_login_profile(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetLoginProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_mfadevice(serial_number)
get_mfadevice(serial_number, params::Dict{String,<:Any})
Retrieves information about an MFA device for a specified user.
# Arguments
- `serial_number`: Serial number that uniquely identifies the MFA device. For this API, we
only accept FIDO security key ARNs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The friendly name identifying the user.
"""
function get_mfadevice(SerialNumber; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"GetMFADevice",
Dict{String,Any}("SerialNumber" => SerialNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_mfadevice(
SerialNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetMFADevice",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SerialNumber" => SerialNumber), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_open_idconnect_provider(open_idconnect_provider_arn)
get_open_idconnect_provider(open_idconnect_provider_arn, params::Dict{String,<:Any})
Returns information about the specified OpenID Connect (OIDC) provider resource object in
IAM.
# Arguments
- `open_idconnect_provider_arn`: The Amazon Resource Name (ARN) of the OIDC provider
resource object in IAM to get information for. You can get a list of OIDC provider resource
ARNs by using the ListOpenIDConnectProviders operation. For more information about ARNs,
see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
"""
function get_open_idconnect_provider(
OpenIDConnectProviderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetOpenIDConnectProvider",
Dict{String,Any}("OpenIDConnectProviderArn" => OpenIDConnectProviderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_open_idconnect_provider(
OpenIDConnectProviderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetOpenIDConnectProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("OpenIDConnectProviderArn" => OpenIDConnectProviderArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_organizations_access_report(job_id)
get_organizations_access_report(job_id, params::Dict{String,<:Any})
Retrieves the service last accessed data report for Organizations that was previously
generated using the GenerateOrganizationsAccessReport operation. This operation retrieves
the status of your report job and the report contents. Depending on the parameters that you
passed when you generated the report, the data returned could include different
information. For details, see GenerateOrganizationsAccessReport. To call this operation,
you must be signed in to the management account in your organization. SCPs must be enabled
for your organization root. You must have permissions to perform this operation. For more
information, see Refining permissions using service last accessed data in the IAM User
Guide. For each service that principals in an account (root user, IAM users, or IAM roles)
could access using SCPs, the operation returns details about the most recent access
attempt. If there was no attempt, the service is listed without details about the most
recent attempt to access the service. If the operation fails, it returns the reason that it
failed. By default, the list is sorted by service namespace.
# Arguments
- `job_id`: The identifier of the request generated by the
GenerateOrganizationsAccessReport operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"SortKey"`: The key that is used to sort the results. If you choose the namespace key,
the results are returned in alphabetical order. If you choose the time key, the results are
sorted numerically by the date and time.
"""
function get_organizations_access_report(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetOrganizationsAccessReport",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_organizations_access_report(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetOrganizationsAccessReport",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy(policy_arn)
get_policy(policy_arn, params::Dict{String,<:Any})
Retrieves information about the specified managed policy, including the policy's default
version and the total number of IAM users, groups, and roles to which the policy is
attached. To retrieve the list of the specific users, groups, and roles that the policy is
attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy.
To retrieve the actual policy document for a specific version of the policy, use
GetPolicyVersion. This operation retrieves information about managed policies. To retrieve
information about an inline policy that is embedded with an IAM user, group, or role, use
GetUserPolicy, GetGroupPolicy, or GetRolePolicy. For more information about policies, see
Managed policies and inline policies in the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the managed policy that you want
information about. For more information about ARNs, see Amazon Resource Names (ARNs) in the
Amazon Web Services General Reference.
"""
function get_policy(PolicyArn; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"GetPolicy",
Dict{String,Any}("PolicyArn" => PolicyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_policy(
PolicyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyArn" => PolicyArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy_version(policy_arn, version_id)
get_policy_version(policy_arn, version_id, params::Dict{String,<:Any})
Retrieves information about the specified version of the specified managed policy,
including the policy document. Policies returned by this operation are URL-encoded
compliant with RFC 3986. You can use a URL decoding method to convert the policy back to
plain JSON text. For example, if you use Java, you can use the decode method of the
java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar
functionality. To list the available versions for a policy, use ListPolicyVersions. This
operation retrieves information about managed policies. To retrieve information about an
inline policy that is embedded in a user, group, or role, use GetUserPolicy,
GetGroupPolicy, or GetRolePolicy. For more information about the types of policies, see
Managed policies and inline policies in the IAM User Guide. For more information about
managed policy versions, see Versioning for managed policies in the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the managed policy that you want
information about. For more information about ARNs, see Amazon Resource Names (ARNs) in the
Amazon Web Services General Reference.
- `version_id`: Identifies the policy version to retrieve. This parameter allows (through
its regex pattern) a string of characters that consists of the lowercase letter 'v'
followed by one or two digits, and optionally followed by a period '.' and a string of
letters and digits.
"""
function get_policy_version(
PolicyArn, VersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetPolicyVersion",
Dict{String,Any}("PolicyArn" => PolicyArn, "VersionId" => VersionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_policy_version(
PolicyArn,
VersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetPolicyVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyArn" => PolicyArn, "VersionId" => VersionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_role(role_name)
get_role(role_name, params::Dict{String,<:Any})
Retrieves information about the specified role, including the role's path, GUID, ARN, and
the role's trust policy that grants permission to assume the role. For more information
about roles, see IAM roles in the IAM User Guide. Policies returned by this operation are
URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the
policy back to plain JSON text. For example, if you use Java, you can use the decode method
of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide
similar functionality.
# Arguments
- `role_name`: The name of the IAM role to get information about. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function get_role(RoleName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"GetRole",
Dict{String,Any}("RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_role(
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetRole",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RoleName" => RoleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_role_policy(policy_name, role_name)
get_role_policy(policy_name, role_name, params::Dict{String,<:Any})
Retrieves the specified inline policy document that is embedded with the specified IAM
role. Policies returned by this operation are URL-encoded compliant with RFC 3986. You can
use a URL decoding method to convert the policy back to plain JSON text. For example, if
you use Java, you can use the decode method of the java.net.URLDecoder utility class in the
Java SDK. Other languages and SDKs provide similar functionality. An IAM role can also
have managed policies attached to it. To retrieve a managed policy document that is
attached to a role, use GetPolicy to determine the policy's default version, then use
GetPolicyVersion to retrieve the policy document. For more information about policies, see
Managed policies and inline policies in the IAM User Guide. For more information about
roles, see IAM roles in the IAM User Guide.
# Arguments
- `policy_name`: The name of the policy document to get. This parameter allows (through its
regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: _+=,.@-
- `role_name`: The name of the role associated with the policy. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function get_role_policy(
PolicyName, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetRolePolicy",
Dict{String,Any}("PolicyName" => PolicyName, "RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_role_policy(
PolicyName,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetRolePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyName" => PolicyName, "RoleName" => RoleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_samlprovider(samlprovider_arn)
get_samlprovider(samlprovider_arn, params::Dict{String,<:Any})
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider
resource object was created or updated. This operation requires Signature Version 4.
# Arguments
- `samlprovider_arn`: The Amazon Resource Name (ARN) of the SAML provider resource object
in IAM to get information about. For more information about ARNs, see Amazon Resource Names
(ARNs) in the Amazon Web Services General Reference.
"""
function get_samlprovider(
SAMLProviderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetSAMLProvider",
Dict{String,Any}("SAMLProviderArn" => SAMLProviderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_samlprovider(
SAMLProviderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetSAMLProvider",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SAMLProviderArn" => SAMLProviderArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_server_certificate(server_certificate_name)
get_server_certificate(server_certificate_name, params::Dict{String,<:Any})
Retrieves information about the specified server certificate stored in IAM. For more
information about working with server certificates, see Working with server certificates in
the IAM User Guide. This topic includes a list of Amazon Web Services services that can use
the server certificates that you manage with IAM.
# Arguments
- `server_certificate_name`: The name of the server certificate you want to retrieve
information about. This parameter allows (through its regex pattern) a string of characters
consisting of upper and lowercase alphanumeric characters with no spaces. You can also
include any of the following characters: _+=,.@-
"""
function get_server_certificate(
ServerCertificateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetServerCertificate",
Dict{String,Any}("ServerCertificateName" => ServerCertificateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_server_certificate(
ServerCertificateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetServerCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerCertificateName" => ServerCertificateName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_last_accessed_details(job_id)
get_service_last_accessed_details(job_id, params::Dict{String,<:Any})
Retrieves a service last accessed report that was created using the
GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in
GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is
complete, you can retrieve the generated report. The report includes a list of Amazon Web
Services services that the resource (user, group, role, or managed policy) can access.
Service last accessed data does not use other policy types when determining whether a
resource could access a service. These other policy types include resource-based policies,
access control lists, Organizations policies, IAM permissions boundaries, and STS assume
role policies. It only applies permissions policy logic. For more about the evaluation of
policy types, see Evaluating policies in the IAM User Guide. For each service that the
resource could access using permissions policies, the operation returns details about the
most recent access attempt. If there was no attempt, the service is listed without details
about the most recent attempt to access the service. If the operation fails, the
GetServiceLastAccessedDetails operation returns the reason that it failed. The
GetServiceLastAccessedDetails operation returns a list of services. This list includes the
number of entities that have attempted to access the service and the date and time of the
last attempt. It also returns the ARN of the following entity, depending on the resource
ARN that you used to generate the report: User – Returns the user ARN that you used to
generate the report Group – Returns the ARN of the group member (user) that last
attempted to access the service Role – Returns the role ARN that you used to generate
the report Policy – Returns the ARN of the user or role that last used the policy to
attempt to access the service By default, the list is sorted by service namespace. If you
specified ACTION_LEVEL granularity when you generated the report, this operation returns
service and action last accessed data. This includes the most recent access attempt for
each tracked action within a service. Otherwise, this operation returns only service data.
For more information about service and action last accessed data, see Reducing permissions
using service last accessed data in the IAM User Guide.
# Arguments
- `job_id`: The ID of the request generated by the GenerateServiceLastAccessedDetails
operation. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same
role within a session, or by the same user when used to call GetServiceLastAccessedDetail.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function get_service_last_accessed_details(
JobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetServiceLastAccessedDetails",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_last_accessed_details(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetServiceLastAccessedDetails",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_last_accessed_details_with_entities(job_id, service_namespace)
get_service_last_accessed_details_with_entities(job_id, service_namespace, params::Dict{String,<:Any})
After you generate a group or policy report using the GenerateServiceLastAccessedDetails
operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities.
This operation retrieves the status of your report job and a list of entities that could
have used group or policy permissions to access the specified service. Group – For a
group report, this operation returns a list of users in the group that could have used the
group’s policies in an attempt to access the service. Policy – For a policy report,
this operation returns a list of entities (users or roles) that could have used the policy
in an attempt to access the service. You can also use this operation for user or role
reports to retrieve details about those entities. If the operation fails, the
GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed. By
default, the list of associated entities is sorted by date, with the most recent access
listed first.
# Arguments
- `job_id`: The ID of the request generated by the GenerateServiceLastAccessedDetails
operation.
- `service_namespace`: The service namespace for an Amazon Web Services service. Provide
the service namespace to learn when the IAM entity last attempted to access the specified
service. To learn the service namespace for a service, see Actions, resources, and
condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of
the service to view details for that service. In the first paragraph, find the service
prefix. For example, (service prefix: a4b). For more information about service namespaces,
see Amazon Web Services service namespaces in the Amazon Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function get_service_last_accessed_details_with_entities(
JobId, ServiceNamespace; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetServiceLastAccessedDetailsWithEntities",
Dict{String,Any}("JobId" => JobId, "ServiceNamespace" => ServiceNamespace);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_last_accessed_details_with_entities(
JobId,
ServiceNamespace,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetServiceLastAccessedDetailsWithEntities",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("JobId" => JobId, "ServiceNamespace" => ServiceNamespace),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_linked_role_deletion_status(deletion_task_id)
get_service_linked_role_deletion_status(deletion_task_id, params::Dict{String,<:Any})
Retrieves the status of your service-linked role deletion. After you use
DeleteServiceLinkedRole to submit a service-linked role for deletion, you can use the
DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the
deletion. If the deletion fails, this operation returns the reason that it failed, if that
information is returned by the service.
# Arguments
- `deletion_task_id`: The deletion task identifier. This identifier is returned by the
DeleteServiceLinkedRole operation in the format
task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
"""
function get_service_linked_role_deletion_status(
DeletionTaskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetServiceLinkedRoleDeletionStatus",
Dict{String,Any}("DeletionTaskId" => DeletionTaskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_linked_role_deletion_status(
DeletionTaskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetServiceLinkedRoleDeletionStatus",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DeletionTaskId" => DeletionTaskId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sshpublic_key(encoding, sshpublic_key_id, user_name)
get_sshpublic_key(encoding, sshpublic_key_id, user_name, params::Dict{String,<:Any})
Retrieves the specified SSH public key, including metadata about the key. The SSH public
key retrieved by this operation is used only for authenticating the associated IAM user to
an CodeCommit repository. For more information about using SSH keys to authenticate to an
CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User
Guide.
# Arguments
- `encoding`: Specifies the public key encoding format to use in the response. To retrieve
the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use
PEM.
- `sshpublic_key_id`: The unique identifier for the SSH public key. This parameter allows
(through its regex pattern) a string of characters that can consist of any upper or
lowercased letter or digit.
- `user_name`: The name of the IAM user associated with the SSH public key. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function get_sshpublic_key(
Encoding, SSHPublicKeyId, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetSSHPublicKey",
Dict{String,Any}(
"Encoding" => Encoding,
"SSHPublicKeyId" => SSHPublicKeyId,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sshpublic_key(
Encoding,
SSHPublicKeyId,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetSSHPublicKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Encoding" => Encoding,
"SSHPublicKeyId" => SSHPublicKeyId,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user()
get_user(params::Dict{String,<:Any})
Retrieves information about the specified IAM user, including the user's creation date,
path, unique ID, and ARN. If you do not specify a user name, IAM determines the user name
implicitly based on the Amazon Web Services access key ID used to sign the request to this
operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The name of the user to get information about. This parameter is optional.
If it is not included, it defaults to the user making the request. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function get_user(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("GetUser"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function get_user(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam("GetUser", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
get_user_policy(policy_name, user_name)
get_user_policy(policy_name, user_name, params::Dict{String,<:Any})
Retrieves the specified inline policy document that is embedded in the specified IAM user.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a
URL decoding method to convert the policy back to plain JSON text. For example, if you use
Java, you can use the decode method of the java.net.URLDecoder utility class in the Java
SDK. Other languages and SDKs provide similar functionality. An IAM user can also have
managed policies attached to it. To retrieve a managed policy document that is attached to
a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion
to retrieve the policy document. For more information about policies, see Managed policies
and inline policies in the IAM User Guide.
# Arguments
- `policy_name`: The name of the policy document to get. This parameter allows (through its
regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: _+=,.@-
- `user_name`: The name of the user who the policy is associated with. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function get_user_policy(
PolicyName, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"GetUserPolicy",
Dict{String,Any}("PolicyName" => PolicyName, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_user_policy(
PolicyName,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"GetUserPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyName" => PolicyName, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_access_keys()
list_access_keys(params::Dict{String,<:Any})
Returns information about the access key IDs associated with the specified IAM user. If
there is none, the operation returns an empty list. Although each user is limited to a
small number of keys, you can still paginate the results using the MaxItems and Marker
parameters. If the UserName is not specified, the user name is determined implicitly based
on the Amazon Web Services access key ID used to sign the request. If a temporary access
key is used, then UserName is required. If a long-term key is assigned to the user, then
UserName is not required. This operation works for access keys under the Amazon Web
Services account. If the Amazon Web Services account has no associated users, the root user
returns it's own access key IDs by running this command. To ensure the security of your
Amazon Web Services account, the secret access key is accessible only during key and user
creation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"UserName"`: The name of the user. This parameter allows (through its regex pattern) a
string of characters consisting of upper and lowercase alphanumeric characters with no
spaces. You can also include any of the following characters: _+=,.@-
"""
function list_access_keys(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("ListAccessKeys"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_access_keys(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListAccessKeys", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_account_aliases()
list_account_aliases(params::Dict{String,<:Any})
Lists the account alias associated with the Amazon Web Services account (Note: you can have
only one). For information about using an Amazon Web Services account alias, see Creating,
deleting, and listing an Amazon Web Services account alias in the Amazon Web Services
Sign-In User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_account_aliases(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("ListAccountAliases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_account_aliases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListAccountAliases", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_attached_group_policies(group_name)
list_attached_group_policies(group_name, params::Dict{String,<:Any})
Lists all managed policies that are attached to the specified IAM group. An IAM group can
also have inline policies embedded with it. To list the inline policies for a group, use
ListGroupPolicies. For information about policies, see Managed policies and inline policies
in the IAM User Guide. You can paginate the results using the MaxItems and Marker
parameters. You can use the PathPrefix parameter to limit the list of policies to only
those matching the specified path prefix. If there are no policies attached to the
specified group (or none that match the specified path prefix), the operation returns an
empty list.
# Arguments
- `group_name`: The name (friendly name, not ARN) of the group to list attached policies
for. This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PathPrefix"`: The path prefix for filtering the results. This parameter is optional. If
it is not included, it defaults to a slash (/), listing all policies. This parameter allows
(through its regex pattern) a string of characters consisting of either a forward slash (/)
by itself or a string that must begin and end with forward slashes. In addition, it can
contain any ASCII character from the ! (u0021) through the DEL character (u007F), including
most punctuation characters, digits, and upper and lowercased letters.
"""
function list_attached_group_policies(
GroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListAttachedGroupPolicies",
Dict{String,Any}("GroupName" => GroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_attached_group_policies(
GroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListAttachedGroupPolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GroupName" => GroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_attached_role_policies(role_name)
list_attached_role_policies(role_name, params::Dict{String,<:Any})
Lists all managed policies that are attached to the specified IAM role. An IAM role can
also have inline policies embedded with it. To list the inline policies for a role, use
ListRolePolicies. For information about policies, see Managed policies and inline policies
in the IAM User Guide. You can paginate the results using the MaxItems and Marker
parameters. You can use the PathPrefix parameter to limit the list of policies to only
those matching the specified path prefix. If there are no policies attached to the
specified role (or none that match the specified path prefix), the operation returns an
empty list.
# Arguments
- `role_name`: The name (friendly name, not ARN) of the role to list attached policies for.
This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PathPrefix"`: The path prefix for filtering the results. This parameter is optional. If
it is not included, it defaults to a slash (/), listing all policies. This parameter allows
(through its regex pattern) a string of characters consisting of either a forward slash (/)
by itself or a string that must begin and end with forward slashes. In addition, it can
contain any ASCII character from the ! (u0021) through the DEL character (u007F), including
most punctuation characters, digits, and upper and lowercased letters.
"""
function list_attached_role_policies(
RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListAttachedRolePolicies",
Dict{String,Any}("RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_attached_role_policies(
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListAttachedRolePolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RoleName" => RoleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_attached_user_policies(user_name)
list_attached_user_policies(user_name, params::Dict{String,<:Any})
Lists all managed policies that are attached to the specified IAM user. An IAM user can
also have inline policies embedded with it. To list the inline policies for a user, use
ListUserPolicies. For information about policies, see Managed policies and inline policies
in the IAM User Guide. You can paginate the results using the MaxItems and Marker
parameters. You can use the PathPrefix parameter to limit the list of policies to only
those matching the specified path prefix. If there are no policies attached to the
specified group (or none that match the specified path prefix), the operation returns an
empty list.
# Arguments
- `user_name`: The name (friendly name, not ARN) of the user to list attached policies for.
This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PathPrefix"`: The path prefix for filtering the results. This parameter is optional. If
it is not included, it defaults to a slash (/), listing all policies. This parameter allows
(through its regex pattern) a string of characters consisting of either a forward slash (/)
by itself or a string that must begin and end with forward slashes. In addition, it can
contain any ASCII character from the ! (u0021) through the DEL character (u007F), including
most punctuation characters, digits, and upper and lowercased letters.
"""
function list_attached_user_policies(
UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListAttachedUserPolicies",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_attached_user_policies(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListAttachedUserPolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_entities_for_policy(policy_arn)
list_entities_for_policy(policy_arn, params::Dict{String,<:Any})
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
You can use the optional EntityFilter parameter to limit the results to a particular type
of entity (users, groups, or roles). For example, to list only the roles that are attached
to the specified policy, set EntityFilter to Role. You can paginate the results using the
MaxItems and Marker parameters.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy for which you want the
versions. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon
Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EntityFilter"`: The entity type to use for filtering the results. For example, when
EntityFilter is Role, only the roles that are attached to the specified policy are
returned. This parameter is optional. If it is not included, all attached entities (users,
groups, and roles) are returned. The argument for this parameter must be one of the valid
values listed below.
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PathPrefix"`: The path prefix for filtering the results. This parameter is optional. If
it is not included, it defaults to a slash (/), listing all entities. This parameter allows
(through its regex pattern) a string of characters consisting of either a forward slash (/)
by itself or a string that must begin and end with forward slashes. In addition, it can
contain any ASCII character from the ! (u0021) through the DEL character (u007F), including
most punctuation characters, digits, and upper and lowercased letters.
- `"PolicyUsageFilter"`: The policy usage method to use for filtering the results. To list
only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the
policies used to set permissions boundaries, set the value to PermissionsBoundary. This
parameter is optional. If it is not included, all policies are returned.
"""
function list_entities_for_policy(
PolicyArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListEntitiesForPolicy",
Dict{String,Any}("PolicyArn" => PolicyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_entities_for_policy(
PolicyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListEntitiesForPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyArn" => PolicyArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_group_policies(group_name)
list_group_policies(group_name, params::Dict{String,<:Any})
Lists the names of the inline policies that are embedded in the specified IAM group. An IAM
group can also have managed policies attached to it. To list the managed policies that are
attached to a group, use ListAttachedGroupPolicies. For more information about policies,
see Managed policies and inline policies in the IAM User Guide. You can paginate the
results using the MaxItems and Marker parameters. If there are no inline policies embedded
with the specified group, the operation returns an empty list.
# Arguments
- `group_name`: The name of the group to list policies for. This parameter allows (through
its regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_group_policies(GroupName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListGroupPolicies",
Dict{String,Any}("GroupName" => GroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_group_policies(
GroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListGroupPolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GroupName" => GroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_groups()
list_groups(params::Dict{String,<:Any})
Lists the IAM groups that have the specified path prefix. You can paginate the results
using the MaxItems and Marker parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PathPrefix"`: The path prefix for filtering the results. For example, the prefix
/division_abc/subdivision_xyz/ gets all groups whose path starts with
/division_abc/subdivision_xyz/. This parameter is optional. If it is not included, it
defaults to a slash (/), listing all groups. This parameter allows (through its regex
pattern) a string of characters consisting of either a forward slash (/) by itself or a
string that must begin and end with forward slashes. In addition, it can contain any ASCII
character from the ! (u0021) through the DEL character (u007F), including most punctuation
characters, digits, and upper and lowercased letters.
"""
function list_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("ListGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam("ListGroups", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_groups_for_user(user_name)
list_groups_for_user(user_name, params::Dict{String,<:Any})
Lists the IAM groups that the specified IAM user belongs to. You can paginate the results
using the MaxItems and Marker parameters.
# Arguments
- `user_name`: The name of the user to list groups for. This parameter allows (through its
regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_groups_for_user(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListGroupsForUser",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_groups_for_user(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListGroupsForUser",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instance_profile_tags(instance_profile_name)
list_instance_profile_tags(instance_profile_name, params::Dict{String,<:Any})
Lists the tags that are attached to the specified IAM instance profile. The returned list
of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources
in the IAM User Guide.
# Arguments
- `instance_profile_name`: The name of the IAM instance profile whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_instance_profile_tags(
InstanceProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListInstanceProfileTags",
Dict{String,Any}("InstanceProfileName" => InstanceProfileName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_instance_profile_tags(
InstanceProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListInstanceProfileTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("InstanceProfileName" => InstanceProfileName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instance_profiles()
list_instance_profiles(params::Dict{String,<:Any})
Lists the instance profiles that have the specified path prefix. If there are none, the
operation returns an empty list. For more information about instance profiles, see Using
instance profiles in the IAM User Guide. IAM resource-listing operations return a subset
of the available attributes for the resource. For example, this operation does not return
tags, even though they are an attribute of the returned object. To view all of the
information for an instance profile, see GetInstanceProfile. You can paginate the results
using the MaxItems and Marker parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PathPrefix"`: The path prefix for filtering the results. For example, the prefix
/application_abc/component_xyz/ gets all instance profiles whose path starts with
/application_abc/component_xyz/. This parameter is optional. If it is not included, it
defaults to a slash (/), listing all instance profiles. This parameter allows (through its
regex pattern) a string of characters consisting of either a forward slash (/) by itself or
a string that must begin and end with forward slashes. In addition, it can contain any
ASCII character from the ! (u0021) through the DEL character (u007F), including most
punctuation characters, digits, and upper and lowercased letters.
"""
function list_instance_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListInstanceProfiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_instance_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListInstanceProfiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_instance_profiles_for_role(role_name)
list_instance_profiles_for_role(role_name, params::Dict{String,<:Any})
Lists the instance profiles that have the specified associated IAM role. If there are none,
the operation returns an empty list. For more information about instance profiles, go to
Using instance profiles in the IAM User Guide. You can paginate the results using the
MaxItems and Marker parameters.
# Arguments
- `role_name`: The name of the role to list instance profiles for. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_instance_profiles_for_role(
RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListInstanceProfilesForRole",
Dict{String,Any}("RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_instance_profiles_for_role(
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListInstanceProfilesForRole",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RoleName" => RoleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_mfadevice_tags(serial_number)
list_mfadevice_tags(serial_number, params::Dict{String,<:Any})
Lists the tags that are attached to the specified IAM virtual multi-factor authentication
(MFA) device. The returned list of tags is sorted by tag key. For more information about
tagging, see Tagging IAM resources in the IAM User Guide.
# Arguments
- `serial_number`: The unique identifier for the IAM virtual MFA device whose tags you want
to see. For virtual MFA devices, the serial number is the same as the ARN. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_mfadevice_tags(
SerialNumber; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListMFADeviceTags",
Dict{String,Any}("SerialNumber" => SerialNumber);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_mfadevice_tags(
SerialNumber,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListMFADeviceTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("SerialNumber" => SerialNumber), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_mfadevices()
list_mfadevices(params::Dict{String,<:Any})
Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this
operation lists all the MFA devices associated with the specified user. If you do not
specify a user name, IAM determines the user name implicitly based on the Amazon Web
Services access key ID signing the request for this operation. You can paginate the results
using the MaxItems and Marker parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"UserName"`: The name of the user whose MFA devices you want to list. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function list_mfadevices(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("ListMFADevices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_mfadevices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListMFADevices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_open_idconnect_provider_tags(open_idconnect_provider_arn)
list_open_idconnect_provider_tags(open_idconnect_provider_arn, params::Dict{String,<:Any})
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity
provider. The returned list of tags is sorted by tag key. For more information, see About
web identity federation. For more information about tagging, see Tagging IAM resources in
the IAM User Guide.
# Arguments
- `open_idconnect_provider_arn`: The ARN of the OpenID Connect (OIDC) identity provider
whose tags you want to see. This parameter allows (through its regex pattern) a string of
characters consisting of upper and lowercase alphanumeric characters with no spaces. You
can also include any of the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_open_idconnect_provider_tags(
OpenIDConnectProviderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListOpenIDConnectProviderTags",
Dict{String,Any}("OpenIDConnectProviderArn" => OpenIDConnectProviderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_open_idconnect_provider_tags(
OpenIDConnectProviderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListOpenIDConnectProviderTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("OpenIDConnectProviderArn" => OpenIDConnectProviderArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_open_idconnect_providers()
list_open_idconnect_providers(params::Dict{String,<:Any})
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in
the Amazon Web Services account. IAM resource-listing operations return a subset of the
available attributes for the resource. For example, this operation does not return tags,
even though they are an attribute of the returned object. To view all of the information
for an OIDC provider, see GetOpenIDConnectProvider.
"""
function list_open_idconnect_providers(; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListOpenIDConnectProviders"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_open_idconnect_providers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListOpenIDConnectProviders",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_policies()
list_policies(params::Dict{String,<:Any})
Lists all the managed policies that are available in your Amazon Web Services account,
including your own customer-defined managed policies and all Amazon Web Services managed
policies. You can filter the list of policies that is returned using the optional
OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer
managed policies in your Amazon Web Services account, set Scope to Local. To list only
Amazon Web Services managed policies, set Scope to AWS. You can paginate the results using
the MaxItems and Marker parameters. For more information about managed policies, see
Managed policies and inline policies in the IAM User Guide. IAM resource-listing
operations return a subset of the available attributes for the resource. For example, this
operation does not return tags, even though they are an attribute of the returned object.
To view all of the information for a customer manged policy, see GetPolicy.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"OnlyAttached"`: A flag to filter the results to only the attached policies. When
OnlyAttached is true, the returned list contains only the policies that are attached to an
IAM user, group, or role. When OnlyAttached is false, or when the parameter is not
included, all policies are returned.
- `"PathPrefix"`: The path prefix for filtering the results. This parameter is optional. If
it is not included, it defaults to a slash (/), listing all policies. This parameter allows
(through its regex pattern) a string of characters consisting of either a forward slash (/)
by itself or a string that must begin and end with forward slashes. In addition, it can
contain any ASCII character from the ! (u0021) through the DEL character (u007F), including
most punctuation characters, digits, and upper and lowercased letters.
- `"PolicyUsageFilter"`: The policy usage method to use for filtering the results. To list
only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the
policies used to set permissions boundaries, set the value to PermissionsBoundary. This
parameter is optional. If it is not included, all policies are returned.
- `"Scope"`: The scope to use for filtering the results. To list only Amazon Web Services
managed policies, set Scope to AWS. To list only the customer managed policies in your
Amazon Web Services account, set Scope to Local. This parameter is optional. If it is not
included, or if it is set to All, all policies are returned.
"""
function list_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("ListPolicies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListPolicies", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_policies_granting_service_access(arn, service_namespaces)
list_policies_granting_service_access(arn, service_namespaces, params::Dict{String,<:Any})
Retrieves a list of policies that the IAM identity (user, group, or role) can use to access
each specified service. This operation does not use other policy types when determining
whether a resource could access a service. These other policy types include resource-based
policies, access control lists, Organizations policies, IAM permissions boundaries, and STS
assume role policies. It only applies permissions policy logic. For more about the
evaluation of policy types, see Evaluating policies in the IAM User Guide. The list of
policies returned by the operation depends on the ARN of the identity that you provide.
User – The list of policies includes the managed and inline policies that are attached to
the user directly. The list also includes any additional managed and inline policies that
are attached to the group to which the user belongs. Group – The list of policies
includes only the managed and inline policies that are attached to the group directly.
Policies that are attached to the group’s user are not included. Role – The list of
policies includes only the managed and inline policies that are attached to the role. For
each managed policy, this operation returns the ARN and policy name. For each inline
policy, it returns the policy name and the entity to which it is attached. Inline policies
do not have an ARN. For more information about these policy types, see Managed policies and
inline policies in the IAM User Guide. Policies that are attached to users and roles as
permissions boundaries are not returned. To view which managed policy is currently used to
set the permissions boundary for a user or role, use the GetUser or GetRole operations.
# Arguments
- `arn`: The ARN of the IAM identity (user, group, or role) whose policies you want to list.
- `service_namespaces`: The service namespace for the Amazon Web Services services whose
policies you want to list. To learn the service namespace for a service, see Actions,
resources, and condition keys for Amazon Web Services services in the IAM User Guide.
Choose the name of the service to view details for that service. In the first paragraph,
find the service prefix. For example, (service prefix: a4b). For more information about
service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services
General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
"""
function list_policies_granting_service_access(
Arn, ServiceNamespaces; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListPoliciesGrantingServiceAccess",
Dict{String,Any}("Arn" => Arn, "ServiceNamespaces" => ServiceNamespaces);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_policies_granting_service_access(
Arn,
ServiceNamespaces,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListPoliciesGrantingServiceAccess",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Arn" => Arn, "ServiceNamespaces" => ServiceNamespaces),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_policy_tags(policy_arn)
list_policy_tags(policy_arn, params::Dict{String,<:Any})
Lists the tags that are attached to the specified IAM customer managed policy. The returned
list of tags is sorted by tag key. For more information about tagging, see Tagging IAM
resources in the IAM User Guide.
# Arguments
- `policy_arn`: The ARN of the IAM customer managed policy whose tags you want to see. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_policy_tags(PolicyArn; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListPolicyTags",
Dict{String,Any}("PolicyArn" => PolicyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_policy_tags(
PolicyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListPolicyTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyArn" => PolicyArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_policy_versions(policy_arn)
list_policy_versions(policy_arn, params::Dict{String,<:Any})
Lists information about the versions of the specified managed policy, including the version
that is currently set as the policy's default version. For more information about managed
policies, see Managed policies and inline policies in the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy for which you want the
versions. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon
Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_policy_versions(PolicyArn; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListPolicyVersions",
Dict{String,Any}("PolicyArn" => PolicyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_policy_versions(
PolicyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListPolicyVersions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("PolicyArn" => PolicyArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_role_policies(role_name)
list_role_policies(role_name, params::Dict{String,<:Any})
Lists the names of the inline policies that are embedded in the specified IAM role. An IAM
role can also have managed policies attached to it. To list the managed policies that are
attached to a role, use ListAttachedRolePolicies. For more information about policies, see
Managed policies and inline policies in the IAM User Guide. You can paginate the results
using the MaxItems and Marker parameters. If there are no inline policies embedded with the
specified role, the operation returns an empty list.
# Arguments
- `role_name`: The name of the role to list policies for. This parameter allows (through
its regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_role_policies(RoleName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListRolePolicies",
Dict{String,Any}("RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_role_policies(
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListRolePolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RoleName" => RoleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_role_tags(role_name)
list_role_tags(role_name, params::Dict{String,<:Any})
Lists the tags that are attached to the specified role. The returned list of tags is sorted
by tag key. For more information about tagging, see Tagging IAM resources in the IAM User
Guide.
# Arguments
- `role_name`: The name of the IAM role for which you want to see the list of tags. This
parameter accepts (through its regex pattern) a string of characters that consist of upper
and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_role_tags(RoleName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListRoleTags",
Dict{String,Any}("RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_role_tags(
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListRoleTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RoleName" => RoleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_roles()
list_roles(params::Dict{String,<:Any})
Lists the IAM roles that have the specified path prefix. If there are none, the operation
returns an empty list. For more information about roles, see IAM roles in the IAM User
Guide. IAM resource-listing operations return a subset of the available attributes for the
resource. This operation does not return the following attributes, even though they are an
attribute of the returned object: PermissionsBoundary RoleLastUsed Tags To view all
of the information for a role, see GetRole. You can paginate the results using the
MaxItems and Marker parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PathPrefix"`: The path prefix for filtering the results. For example, the prefix
/application_abc/component_xyz/ gets all roles whose path starts with
/application_abc/component_xyz/. This parameter is optional. If it is not included, it
defaults to a slash (/), listing all roles. This parameter allows (through its regex
pattern) a string of characters consisting of either a forward slash (/) by itself or a
string that must begin and end with forward slashes. In addition, it can contain any ASCII
character from the ! (u0021) through the DEL character (u007F), including most punctuation
characters, digits, and upper and lowercased letters.
"""
function list_roles(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("ListRoles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_roles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam("ListRoles", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_samlprovider_tags(samlprovider_arn)
list_samlprovider_tags(samlprovider_arn, params::Dict{String,<:Any})
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML)
identity provider. The returned list of tags is sorted by tag key. For more information,
see About SAML 2.0-based federation. For more information about tagging, see Tagging IAM
resources in the IAM User Guide.
# Arguments
- `samlprovider_arn`: The ARN of the Security Assertion Markup Language (SAML) identity
provider whose tags you want to see. This parameter allows (through its regex pattern) a
string of characters consisting of upper and lowercase alphanumeric characters with no
spaces. You can also include any of the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_samlprovider_tags(
SAMLProviderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListSAMLProviderTags",
Dict{String,Any}("SAMLProviderArn" => SAMLProviderArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_samlprovider_tags(
SAMLProviderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListSAMLProviderTags",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("SAMLProviderArn" => SAMLProviderArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_samlproviders()
list_samlproviders(params::Dict{String,<:Any})
Lists the SAML provider resource objects defined in IAM in the account. IAM
resource-listing operations return a subset of the available attributes for the resource.
For example, this operation does not return tags, even though they are an attribute of the
returned object. To view all of the information for a SAML provider, see GetSAMLProvider.
This operation requires Signature Version 4.
"""
function list_samlproviders(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("ListSAMLProviders"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_samlproviders(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListSAMLProviders", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_server_certificate_tags(server_certificate_name)
list_server_certificate_tags(server_certificate_name, params::Dict{String,<:Any})
Lists the tags that are attached to the specified IAM server certificate. The returned list
of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources
in the IAM User Guide. For certificates in a Region supported by Certificate Manager
(ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to
provision, manage, and deploy your server certificates. For more information about IAM
server certificates, Working with server certificates in the IAM User Guide.
# Arguments
- `server_certificate_name`: The name of the IAM server certificate whose tags you want to
see. This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_server_certificate_tags(
ServerCertificateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListServerCertificateTags",
Dict{String,Any}("ServerCertificateName" => ServerCertificateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_server_certificate_tags(
ServerCertificateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListServerCertificateTags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerCertificateName" => ServerCertificateName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_server_certificates()
list_server_certificates(params::Dict{String,<:Any})
Lists the server certificates stored in IAM that have the specified path prefix. If none
exist, the operation returns an empty list. You can paginate the results using the
MaxItems and Marker parameters. For more information about working with server
certificates, see Working with server certificates in the IAM User Guide. This topic also
includes a list of Amazon Web Services services that can use the server certificates that
you manage with IAM. IAM resource-listing operations return a subset of the available
attributes for the resource. For example, this operation does not return tags, even though
they are an attribute of the returned object. To view all of the information for a
servercertificate, see GetServerCertificate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PathPrefix"`: The path prefix for filtering the results. For example:
/company/servercerts would get all server certificates for which the path starts with
/company/servercerts. This parameter is optional. If it is not included, it defaults to a
slash (/), listing all server certificates. This parameter allows (through its regex
pattern) a string of characters consisting of either a forward slash (/) by itself or a
string that must begin and end with forward slashes. In addition, it can contain any ASCII
character from the ! (u0021) through the DEL character (u007F), including most punctuation
characters, digits, and upper and lowercased letters.
"""
function list_server_certificates(; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListServerCertificates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_server_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListServerCertificates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_specific_credentials()
list_service_specific_credentials(params::Dict{String,<:Any})
Returns information about the service-specific credentials associated with the specified
IAM user. If none exists, the operation returns an empty list. The service-specific
credentials returned by this operation are used only for authenticating the IAM user to a
specific service. For more information about using service-specific credentials to
authenticate to an Amazon Web Services service, see Set up service-specific credentials in
the CodeCommit User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ServiceName"`: Filters the returned results to only those for the specified Amazon Web
Services service. If not specified, then Amazon Web Services returns service-specific
credentials for all services.
- `"UserName"`: The name of the user whose service-specific credentials you want
information about. If this value is not specified, then the operation assumes the user
whose credentials are used to call the operation. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
"""
function list_service_specific_credentials(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListServiceSpecificCredentials";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_service_specific_credentials(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListServiceSpecificCredentials",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_signing_certificates()
list_signing_certificates(params::Dict{String,<:Any})
Returns information about the signing certificates associated with the specified IAM user.
If none exists, the operation returns an empty list. Although each user is limited to a
small number of signing certificates, you can still paginate the results using the MaxItems
and Marker parameters. If the UserName field is not specified, the user name is determined
implicitly based on the Amazon Web Services access key ID used to sign the request for this
operation. This operation works for access keys under the Amazon Web Services account.
Consequently, you can use this operation to manage Amazon Web Services account root user
credentials even if the Amazon Web Services account has no associated users.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"UserName"`: The name of the IAM user whose signing certificates you want to examine.
This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
"""
function list_signing_certificates(; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListSigningCertificates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_signing_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListSigningCertificates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_sshpublic_keys()
list_sshpublic_keys(params::Dict{String,<:Any})
Returns information about the SSH public keys associated with the specified IAM user. If
none exists, the operation returns an empty list. The SSH public keys returned by this
operation are used only for authenticating the IAM user to an CodeCommit repository. For
more information about using SSH keys to authenticate to an CodeCommit repository, see Set
up CodeCommit for SSH connections in the CodeCommit User Guide. Although each user is
limited to a small number of keys, you can still paginate the results using the MaxItems
and Marker parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"UserName"`: The name of the IAM user to list SSH public keys for. If none is specified,
the UserName field is determined implicitly based on the Amazon Web Services access key
used to sign the request. This parameter allows (through its regex pattern) a string of
characters consisting of upper and lowercase alphanumeric characters with no spaces. You
can also include any of the following characters: _+=,.@-
"""
function list_sshpublic_keys(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("ListSSHPublicKeys"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_sshpublic_keys(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListSSHPublicKeys", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_user_policies(user_name)
list_user_policies(user_name, params::Dict{String,<:Any})
Lists the names of the inline policies embedded in the specified IAM user. An IAM user can
also have managed policies attached to it. To list the managed policies that are attached
to a user, use ListAttachedUserPolicies. For more information about policies, see Managed
policies and inline policies in the IAM User Guide. You can paginate the results using the
MaxItems and Marker parameters. If there are no inline policies embedded with the specified
user, the operation returns an empty list.
# Arguments
- `user_name`: The name of the user to list policies for. This parameter allows (through
its regex pattern) a string of characters consisting of upper and lowercase alphanumeric
characters with no spaces. You can also include any of the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_user_policies(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListUserPolicies",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_user_policies(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListUserPolicies",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_user_tags(user_name)
list_user_tags(user_name, params::Dict{String,<:Any})
Lists the tags that are attached to the specified IAM user. The returned list of tags is
sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM
User Guide.
# Arguments
- `user_name`: The name of the IAM user whose tags you want to see. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_user_tags(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListUserTags",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_user_tags(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ListUserTags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users()
list_users(params::Dict{String,<:Any})
Lists the IAM users that have the specified path prefix. If no path prefix is specified,
the operation returns all users in the Amazon Web Services account. If there are none, the
operation returns an empty list. IAM resource-listing operations return a subset of the
available attributes for the resource. This operation does not return the following
attributes, even though they are an attribute of the returned object: PermissionsBoundary
Tags To view all of the information for a user, see GetUser. You can paginate the
results using the MaxItems and Marker parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PathPrefix"`: The path prefix for filtering the results. For example:
/division_abc/subdivision_xyz/, which would get all user names whose path starts with
/division_abc/subdivision_xyz/. This parameter is optional. If it is not included, it
defaults to a slash (/), listing all user names. This parameter allows (through its regex
pattern) a string of characters consisting of either a forward slash (/) by itself or a
string that must begin and end with forward slashes. In addition, it can contain any ASCII
character from the ! (u0021) through the DEL character (u007F), including most punctuation
characters, digits, and upper and lowercased letters.
"""
function list_users(; aws_config::AbstractAWSConfig=global_aws_config())
return iam("ListUsers"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_users(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam("ListUsers", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
"""
list_virtual_mfadevices()
list_virtual_mfadevices(params::Dict{String,<:Any})
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment
status. If you do not specify an assignment status, the operation returns a list of all
virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any. IAM
resource-listing operations return a subset of the available attributes for the resource.
For example, this operation does not return tags, even though they are an attribute of the
returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.
You can paginate the results using the MaxItems and Marker parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AssignmentStatus"`: The status (Unassigned or Assigned) of the devices to list. If you
do not specify an AssignmentStatus, the operation defaults to Any, which lists both
assigned and unassigned virtual MFA devices.,
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
"""
function list_virtual_mfadevices(; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"ListVirtualMFADevices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_virtual_mfadevices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ListVirtualMFADevices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_group_policy(group_name, policy_document, policy_name)
put_group_policy(group_name, policy_document, policy_name, params::Dict{String,<:Any})
Adds or updates an inline policy document that is embedded in the specified IAM group. A
user can also have managed policies attached to it. To attach a managed policy to a group,
use AttachGroupPolicy . To create a new managed policy, use CreatePolicy . For
information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed in a group,
see IAM and STS quotas in the IAM User Guide. Because policy documents can be large, you
should use POST rather than GET when calling PutGroupPolicy. For general information about
using the Query API with IAM, see Making query requests in the IAM User Guide.
# Arguments
- `group_name`: The name of the group to associate the policy with. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-.
- `policy_document`: The policy document. You must provide policies in JSON format in IAM.
However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON
or YAML format. CloudFormation always converts a YAML policy to JSON format before
submitting it to IAM. The regex pattern used to validate this parameter is a string of
characters consisting of the following: Any printable ASCII character ranging from the
space character (u0020) through the end of the ASCII character range The printable
characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) The
special characters tab (u0009), line feed (u000A), and carriage return (u000D)
- `policy_name`: The name of the policy document. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
"""
function put_group_policy(
GroupName, PolicyDocument, PolicyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"PutGroupPolicy",
Dict{String,Any}(
"GroupName" => GroupName,
"PolicyDocument" => PolicyDocument,
"PolicyName" => PolicyName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_group_policy(
GroupName,
PolicyDocument,
PolicyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"PutGroupPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupName" => GroupName,
"PolicyDocument" => PolicyDocument,
"PolicyName" => PolicyName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_role_permissions_boundary(permissions_boundary, role_name)
put_role_permissions_boundary(permissions_boundary, role_name, params::Dict{String,<:Any})
Adds or updates the policy that is specified as the IAM role's permissions boundary. You
can use an Amazon Web Services managed policy or a customer managed policy to set the
boundary for a role. Use the boundary to control the maximum permissions that the role can
have. Setting a permissions boundary is an advanced feature that can affect the permissions
for the role. You cannot set the boundary for a service-linked role. Policies used as
permissions boundaries do not provide permissions. You must also attach a permissions
policy to the role. To learn how the effective permissions for a role are evaluated, see
IAM JSON policy evaluation logic in the IAM User Guide.
# Arguments
- `permissions_boundary`: The ARN of the managed policy that is used to set the permissions
boundary for the role. A permissions boundary policy defines the maximum permissions that
identity-based policies can grant to an entity, but does not grant permissions. Permissions
boundaries do not define the maximum permissions that a resource-based policy can grant to
an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User
Guide. For more information about policy types, see Policy types in the IAM User Guide.
- `role_name`: The name (friendly name, not ARN) of the IAM role for which you want to set
the permissions boundary.
"""
function put_role_permissions_boundary(
PermissionsBoundary, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"PutRolePermissionsBoundary",
Dict{String,Any}(
"PermissionsBoundary" => PermissionsBoundary, "RoleName" => RoleName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_role_permissions_boundary(
PermissionsBoundary,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"PutRolePermissionsBoundary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PermissionsBoundary" => PermissionsBoundary, "RoleName" => RoleName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_role_policy(policy_document, policy_name, role_name)
put_role_policy(policy_document, policy_name, role_name, params::Dict{String,<:Any})
Adds or updates an inline policy document that is embedded in the specified IAM role. When
you embed an inline policy in a role, the inline policy is used as part of the role's
access (permissions) policy. The role's trust policy is created at the same time as the
role, using CreateRole . You can update a role's trust policy using
UpdateAssumeRolePolicy . For more information about roles, see IAM roles in the IAM User
Guide. A role can also have a managed policy attached to it. To attach a managed policy to
a role, use AttachRolePolicy . To create a new managed policy, use CreatePolicy . For
information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed with a role,
see IAM and STS quotas in the IAM User Guide. Because policy documents can be large, you
should use POST rather than GET when calling PutRolePolicy. For general information about
using the Query API with IAM, see Making query requests in the IAM User Guide.
# Arguments
- `policy_document`: The policy document. You must provide policies in JSON format in IAM.
However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON
or YAML format. CloudFormation always converts a YAML policy to JSON format before
submitting it to IAM. The regex pattern used to validate this parameter is a string of
characters consisting of the following: Any printable ASCII character ranging from the
space character (u0020) through the end of the ASCII character range The printable
characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) The
special characters tab (u0009), line feed (u000A), and carriage return (u000D)
- `policy_name`: The name of the policy document. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
- `role_name`: The name of the role to associate the policy with. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function put_role_policy(
PolicyDocument, PolicyName, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"PutRolePolicy",
Dict{String,Any}(
"PolicyDocument" => PolicyDocument,
"PolicyName" => PolicyName,
"RoleName" => RoleName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_role_policy(
PolicyDocument,
PolicyName,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"PutRolePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PolicyDocument" => PolicyDocument,
"PolicyName" => PolicyName,
"RoleName" => RoleName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_user_permissions_boundary(permissions_boundary, user_name)
put_user_permissions_boundary(permissions_boundary, user_name, params::Dict{String,<:Any})
Adds or updates the policy that is specified as the IAM user's permissions boundary. You
can use an Amazon Web Services managed policy or a customer managed policy to set the
boundary for a user. Use the boundary to control the maximum permissions that the user can
have. Setting a permissions boundary is an advanced feature that can affect the permissions
for the user. Policies that are used as permissions boundaries do not provide permissions.
You must also attach a permissions policy to the user. To learn how the effective
permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User
Guide.
# Arguments
- `permissions_boundary`: The ARN of the managed policy that is used to set the permissions
boundary for the user. A permissions boundary policy defines the maximum permissions that
identity-based policies can grant to an entity, but does not grant permissions. Permissions
boundaries do not define the maximum permissions that a resource-based policy can grant to
an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User
Guide. For more information about policy types, see Policy types in the IAM User Guide.
- `user_name`: The name (friendly name, not ARN) of the IAM user for which you want to set
the permissions boundary.
"""
function put_user_permissions_boundary(
PermissionsBoundary, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"PutUserPermissionsBoundary",
Dict{String,Any}(
"PermissionsBoundary" => PermissionsBoundary, "UserName" => UserName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_user_permissions_boundary(
PermissionsBoundary,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"PutUserPermissionsBoundary",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PermissionsBoundary" => PermissionsBoundary, "UserName" => UserName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_user_policy(policy_document, policy_name, user_name)
put_user_policy(policy_document, policy_name, user_name, params::Dict{String,<:Any})
Adds or updates an inline policy document that is embedded in the specified IAM user. An
IAM user can also have a managed policy attached to it. To attach a managed policy to a
user, use AttachUserPolicy . To create a new managed policy, use CreatePolicy . For
information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed in a user,
see IAM and STS quotas in the IAM User Guide. Because policy documents can be large, you
should use POST rather than GET when calling PutUserPolicy. For general information about
using the Query API with IAM, see Making query requests in the IAM User Guide.
# Arguments
- `policy_document`: The policy document. You must provide policies in JSON format in IAM.
However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON
or YAML format. CloudFormation always converts a YAML policy to JSON format before
submitting it to IAM. The regex pattern used to validate this parameter is a string of
characters consisting of the following: Any printable ASCII character ranging from the
space character (u0020) through the end of the ASCII character range The printable
characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) The
special characters tab (u0009), line feed (u000A), and carriage return (u000D)
- `policy_name`: The name of the policy document. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
- `user_name`: The name of the user to associate the policy with. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function put_user_policy(
PolicyDocument, PolicyName, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"PutUserPolicy",
Dict{String,Any}(
"PolicyDocument" => PolicyDocument,
"PolicyName" => PolicyName,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_user_policy(
PolicyDocument,
PolicyName,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"PutUserPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PolicyDocument" => PolicyDocument,
"PolicyName" => PolicyName,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_client_idfrom_open_idconnect_provider(client_id, open_idconnect_provider_arn)
remove_client_idfrom_open_idconnect_provider(client_id, open_idconnect_provider_arn, params::Dict{String,<:Any})
Removes the specified client ID (also known as audience) from the list of client IDs
registered for the specified IAM OpenID Connect (OIDC) provider resource object. This
operation is idempotent; it does not fail or return an error if you try to remove a client
ID that does not exist.
# Arguments
- `client_id`: The client ID (also known as audience) to remove from the IAM OIDC provider
resource. For more information about client IDs, see CreateOpenIDConnectProvider.
- `open_idconnect_provider_arn`: The Amazon Resource Name (ARN) of the IAM OIDC provider
resource to remove the client ID from. You can get a list of OIDC provider ARNs by using
the ListOpenIDConnectProviders operation. For more information about ARNs, see Amazon
Resource Names (ARNs) in the Amazon Web Services General Reference.
"""
function remove_client_idfrom_open_idconnect_provider(
ClientID, OpenIDConnectProviderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"RemoveClientIDFromOpenIDConnectProvider",
Dict{String,Any}(
"ClientID" => ClientID, "OpenIDConnectProviderArn" => OpenIDConnectProviderArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_client_idfrom_open_idconnect_provider(
ClientID,
OpenIDConnectProviderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"RemoveClientIDFromOpenIDConnectProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ClientID" => ClientID,
"OpenIDConnectProviderArn" => OpenIDConnectProviderArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_role_from_instance_profile(instance_profile_name, role_name)
remove_role_from_instance_profile(instance_profile_name, role_name, params::Dict{String,<:Any})
Removes the specified IAM role from the specified Amazon EC2 instance profile. Make sure
that you do not have any Amazon EC2 instances running with the role you are about to remove
from the instance profile. Removing a role from an instance profile that is associated with
a running instance might break any applications running on the instance. For more
information about roles, see IAM roles in the IAM User Guide. For more information about
instance profiles, see Using instance profiles in the IAM User Guide.
# Arguments
- `instance_profile_name`: The name of the instance profile to update. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
- `role_name`: The name of the role to remove. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
"""
function remove_role_from_instance_profile(
InstanceProfileName, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"RemoveRoleFromInstanceProfile",
Dict{String,Any}(
"InstanceProfileName" => InstanceProfileName, "RoleName" => RoleName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_role_from_instance_profile(
InstanceProfileName,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"RemoveRoleFromInstanceProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceProfileName" => InstanceProfileName, "RoleName" => RoleName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_user_from_group(group_name, user_name)
remove_user_from_group(group_name, user_name, params::Dict{String,<:Any})
Removes the specified user from the specified group.
# Arguments
- `group_name`: The name of the group to update. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
- `user_name`: The name of the user to remove. This parameter allows (through its regex
pattern) a string of characters consisting of upper and lowercase alphanumeric characters
with no spaces. You can also include any of the following characters: _+=,.@-
"""
function remove_user_from_group(
GroupName, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"RemoveUserFromGroup",
Dict{String,Any}("GroupName" => GroupName, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_user_from_group(
GroupName,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"RemoveUserFromGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("GroupName" => GroupName, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_service_specific_credential(service_specific_credential_id)
reset_service_specific_credential(service_specific_credential_id, params::Dict{String,<:Any})
Resets the password for a service-specific credential. The new password is Amazon Web
Services generated and cryptographically strong. It cannot be configured by the user.
Resetting the password immediately invalidates the previous password associated with this
user.
# Arguments
- `service_specific_credential_id`: The unique identifier of the service-specific
credential. This parameter allows (through its regex pattern) a string of characters that
can consist of any upper or lowercased letter or digit.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The name of the IAM user associated with the service-specific credential.
If this value is not specified, then the operation assumes the user whose credentials are
used to call the operation. This parameter allows (through its regex pattern) a string of
characters consisting of upper and lowercase alphanumeric characters with no spaces. You
can also include any of the following characters: _+=,.@-
"""
function reset_service_specific_credential(
ServiceSpecificCredentialId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"ResetServiceSpecificCredential",
Dict{String,Any}("ServiceSpecificCredentialId" => ServiceSpecificCredentialId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_service_specific_credential(
ServiceSpecificCredentialId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ResetServiceSpecificCredential",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServiceSpecificCredentialId" => ServiceSpecificCredentialId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
resync_mfadevice(authentication_code1, authentication_code2, serial_number, user_name)
resync_mfadevice(authentication_code1, authentication_code2, serial_number, user_name, params::Dict{String,<:Any})
Synchronizes the specified MFA device with its IAM resource object on the Amazon Web
Services servers. For more information about creating and working with virtual MFA devices,
see Using a virtual MFA device in the IAM User Guide.
# Arguments
- `authentication_code1`: An authentication code emitted by the device. The format for this
parameter is a sequence of six digits.
- `authentication_code2`: A subsequent authentication code emitted by the device. The
format for this parameter is a sequence of six digits.
- `serial_number`: Serial number that uniquely identifies the MFA device. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
- `user_name`: The name of the user whose MFA device you want to resynchronize. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function resync_mfadevice(
AuthenticationCode1,
AuthenticationCode2,
SerialNumber,
UserName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ResyncMFADevice",
Dict{String,Any}(
"AuthenticationCode1" => AuthenticationCode1,
"AuthenticationCode2" => AuthenticationCode2,
"SerialNumber" => SerialNumber,
"UserName" => UserName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function resync_mfadevice(
AuthenticationCode1,
AuthenticationCode2,
SerialNumber,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"ResyncMFADevice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AuthenticationCode1" => AuthenticationCode1,
"AuthenticationCode2" => AuthenticationCode2,
"SerialNumber" => SerialNumber,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_default_policy_version(policy_arn, version_id)
set_default_policy_version(policy_arn, version_id, params::Dict{String,<:Any})
Sets the specified version of the specified policy as the policy's default (operative)
version. This operation affects all users, groups, and roles that the policy is attached
to. To list the users, groups, and roles that the policy is attached to, use
ListEntitiesForPolicy. For information about managed policies, see Managed policies and
inline policies in the IAM User Guide.
# Arguments
- `policy_arn`: The Amazon Resource Name (ARN) of the IAM policy whose default version you
want to set. For more information about ARNs, see Amazon Resource Names (ARNs) in the
Amazon Web Services General Reference.
- `version_id`: The version of the policy to set as the default (operative) version. For
more information about managed policy versions, see Versioning for managed policies in the
IAM User Guide.
"""
function set_default_policy_version(
PolicyArn, VersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"SetDefaultPolicyVersion",
Dict{String,Any}("PolicyArn" => PolicyArn, "VersionId" => VersionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_default_policy_version(
PolicyArn,
VersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"SetDefaultPolicyVersion",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyArn" => PolicyArn, "VersionId" => VersionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_security_token_service_preferences(global_endpoint_token_version)
set_security_token_service_preferences(global_endpoint_token_version, params::Dict{String,<:Any})
Sets the specified version of the global endpoint token as the token version used for the
Amazon Web Services account. By default, Security Token Service (STS) is available as a
global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com.
Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in
redundancy, and increase session token availability. For information about Regional
endpoints for STS, see Security Token Service endpoints and quotas in the Amazon Web
Services General Reference. If you make an STS call to the global endpoint, the resulting
session tokens might be valid in some Regions but not others. It depends on the version
that is set in this operation. Version 1 tokens are valid only in Amazon Web Services
Regions that are available by default. These tokens do not work in manually enabled
Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions.
However, version 2 tokens are longer and might affect systems where you temporarily store
tokens. For information, see Activating and deactivating STS in an Amazon Web Services
Region in the IAM User Guide. To view the current session token version, see the
GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.
# Arguments
- `global_endpoint_token_version`: The version of the global endpoint token. Version 1
tokens are valid only in Amazon Web Services Regions that are available by default. These
tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2
tokens are valid in all Regions. However, version 2 tokens are longer and might affect
systems where you temporarily store tokens. For information, see Activating and
deactivating STS in an Amazon Web Services Region in the IAM User Guide.
"""
function set_security_token_service_preferences(
GlobalEndpointTokenVersion; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"SetSecurityTokenServicePreferences",
Dict{String,Any}("GlobalEndpointTokenVersion" => GlobalEndpointTokenVersion);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_security_token_service_preferences(
GlobalEndpointTokenVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"SetSecurityTokenServicePreferences",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GlobalEndpointTokenVersion" => GlobalEndpointTokenVersion
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
simulate_custom_policy(action_names, policy_input_list)
simulate_custom_policy(action_names, policy_input_list, params::Dict{String,<:Any})
Simulate how a set of IAM policies and optionally a resource-based policy works with a list
of API operations and Amazon Web Services resources to determine the policies' effective
permissions. The policies are provided as strings. The simulation does not perform the API
operations; it only checks the authorization to determine if the simulated policies allow
or deny the operations. You can simulate resources that don't exist in your account. If you
want to simulate existing policies that are attached to an IAM user, group, or role, use
SimulatePrincipalPolicy instead. Context keys are variables that are maintained by Amazon
Web Services and its services and which provide details about the context of an API query
request. You can use the Condition element of an IAM policy to evaluate context keys. To
get the list of context keys that the policies require for correct simulation, use
GetContextKeysForCustomPolicy. If the output is long, you can use MaxItems and Marker
parameters to paginate the results. The IAM policy simulator evaluates statements in the
identity-based policy and the inputs that you provide during simulation. The policy
simulator results can differ from your live Amazon Web Services environment. We recommend
that you check your policies against your live Amazon Web Services environment after
testing using the policy simulator to confirm that you have the desired results. For more
information about using the policy simulator, see Testing IAM policies with the IAM policy
simulator in the IAM User Guide.
# Arguments
- `action_names`: A list of names of API operations to evaluate in the simulation. Each
operation is evaluated against each resource. Each operation must include the service
identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in
an action name.
- `policy_input_list`: A list of policy documents to include in the simulation. Each
document is specified as a string containing the complete, valid JSON text of an IAM
policy. Do not include any resource-based policies in this parameter. Any resource-based
policy must be submitted with the ResourcePolicy parameter. The policies cannot be
\"scope-down\" policies, such as you could include in a call to GetFederationToken or one
of the AssumeRole API operations. In other words, do not use policies designed to restrict
what a user can do while using the temporary credentials. The maximum length of the policy
document that you can pass in this operation, including whitespace, is listed below. To
view the maximum character counts of a managed policy with no whitespaces, see IAM and STS
character quotas. The regex pattern used to validate this parameter is a string of
characters consisting of the following: Any printable ASCII character ranging from the
space character (u0020) through the end of the ASCII character range The printable
characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) The
special characters tab (u0009), line feed (u000A), and carriage return (u000D)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CallerArn"`: The ARN of the IAM user that you want to use as the simulated caller of
the API operations. CallerArn is required if you include a ResourcePolicy so that the
policy's Principal element has a value to use in evaluating the policy. You can specify
only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user,
or a service principal.
- `"ContextEntries"`: A list of context keys and corresponding values for the simulation to
use. Whenever a context key is evaluated in one of the simulated IAM permissions policies,
the corresponding value is supplied.
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PermissionsBoundaryPolicyInputList"`: The IAM permissions boundary policy to simulate.
The permissions boundary sets the maximum permissions that an IAM entity can have. You can
input only one permissions boundary when you pass a policy to this operation. For more
information about permissions boundaries, see Permissions boundaries for IAM entities in
the IAM User Guide. The policy input is specified as a string that contains the complete,
valid JSON text of a permissions boundary policy. The maximum length of the policy document
that you can pass in this operation, including whitespace, is listed below. To view the
maximum character counts of a managed policy with no whitespaces, see IAM and STS character
quotas. The regex pattern used to validate this parameter is a string of characters
consisting of the following: Any printable ASCII character ranging from the space
character (u0020) through the end of the ASCII character range The printable characters
in the Basic Latin and Latin-1 Supplement character set (through u00FF) The special
characters tab (u0009), line feed (u000A), and carriage return (u000D)
- `"ResourceArns"`: A list of ARNs of Amazon Web Services resources to include in the
simulation. If this parameter is not provided, then the value defaults to * (all
resources). Each API in the ActionNames parameter is evaluated for each resource in this
list. The simulation determines the access result (allowed or denied) of each combination
and reports it in the response. You can simulate resources that don't exist in your
account. The simulation does not automatically retrieve policies for the specified
resources. If you want to include a resource policy in the simulation, then you must
include the policy as a string in the ResourcePolicy parameter. If you include a
ResourcePolicy, then it must be applicable to all of the resources included in the
simulation or you receive an invalid input error. For more information about ARNs, see
Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. Simulation of
resource-based policies isn't supported for IAM roles.
- `"ResourceHandlingOption"`: Specifies the type of simulation to run. Different API
operations that support resource-based policies require different combinations of
resources. By specifying the type of simulation to run, you enable the policy simulator to
enforce the presence of the required resources to ensure reliable simulation results. If
your simulation does not match one of the following scenarios, then you can omit this
parameter. The following list shows each of the supported scenario values and the resources
that you must define to run the simulation. Each of the Amazon EC2 scenarios requires that
you specify instance, image, and security group resources. If your scenario includes an EBS
volume, then you must specify that volume as a resource. If the Amazon EC2 scenario
includes VPC, then you must supply the network interface resource. If it includes an IP
subnet, then you must specify the subnet resource. For more information on the Amazon EC2
scenario options, see Supported platforms in the Amazon EC2 User Guide.
EC2-VPC-InstanceStore instance, image, security group, network interface
EC2-VPC-InstanceStore-Subnet instance, image, security group, network interface, subnet
EC2-VPC-EBS instance, image, security group, network interface, volume
EC2-VPC-EBS-Subnet instance, image, security group, network interface, subnet, volume
- `"ResourceOwner"`: An ARN representing the Amazon Web Services account ID that specifies
the owner of any simulated resource that does not identify its owner in the resource ARN.
Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it
is also used as the account owner of any ResourcePolicy included in the simulation. If the
ResourceOwner parameter is not specified, then the owner of the resources and the resource
policy defaults to the account of the identity provided in CallerArn. This parameter is
required only if you specify a resource-based policy and account that owns the resource is
different from the account that owns the simulated calling user CallerArn. The ARN for an
account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to
represent the account with the 112233445566 ID, use the following ARN:
arn:aws:iam::112233445566-ID:root.
- `"ResourcePolicy"`: A resource-based policy to include in the simulation provided as a
string. Each resource in the simulation is treated as if it had this policy attached. You
can include only one resource-based policy in a simulation. The maximum length of the
policy document that you can pass in this operation, including whitespace, is listed below.
To view the maximum character counts of a managed policy with no whitespaces, see IAM and
STS character quotas. The regex pattern used to validate this parameter is a string of
characters consisting of the following: Any printable ASCII character ranging from the
space character (u0020) through the end of the ASCII character range The printable
characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) The
special characters tab (u0009), line feed (u000A), and carriage return (u000D)
Simulation of resource-based policies isn't supported for IAM roles.
"""
function simulate_custom_policy(
ActionNames, PolicyInputList; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"SimulateCustomPolicy",
Dict{String,Any}(
"ActionNames" => ActionNames, "PolicyInputList" => PolicyInputList
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function simulate_custom_policy(
ActionNames,
PolicyInputList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"SimulateCustomPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ActionNames" => ActionNames, "PolicyInputList" => PolicyInputList
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
simulate_principal_policy(action_names, policy_source_arn)
simulate_principal_policy(action_names, policy_source_arn, params::Dict{String,<:Any})
Simulate how a set of IAM policies attached to an IAM entity works with a list of API
operations and Amazon Web Services resources to determine the policies' effective
permissions. The entity can be an IAM user, group, or role. If you specify a user, then the
simulation also includes all of the policies that are attached to groups that the user
belongs to. You can simulate resources that don't exist in your account. You can optionally
include a list of one or more additional policies specified as strings to include in the
simulation. If you want to simulate only policies specified as strings, use
SimulateCustomPolicy instead. You can also optionally include one resource-based policy to
be evaluated with each of the resources included in the simulation for IAM users only. The
simulation does not perform the API operations; it only checks the authorization to
determine if the simulated policies allow or deny the operations. Note: This operation
discloses information about the permissions granted to other users. If you do not want
users to see other user's permissions, then consider allowing them to use
SimulateCustomPolicy instead. Context keys are variables maintained by Amazon Web Services
and its services that provide details about the context of an API query request. You can
use the Condition element of an IAM policy to evaluate context keys. To get the list of
context keys that the policies require for correct simulation, use
GetContextKeysForPrincipalPolicy. If the output is long, you can use the MaxItems and
Marker parameters to paginate the results. The IAM policy simulator evaluates statements
in the identity-based policy and the inputs that you provide during simulation. The policy
simulator results can differ from your live Amazon Web Services environment. We recommend
that you check your policies against your live Amazon Web Services environment after
testing using the policy simulator to confirm that you have the desired results. For more
information about using the policy simulator, see Testing IAM policies with the IAM policy
simulator in the IAM User Guide.
# Arguments
- `action_names`: A list of names of API operations to evaluate in the simulation. Each
operation is evaluated for each resource. Each operation must include the service
identifier, such as iam:CreateUser.
- `policy_source_arn`: The Amazon Resource Name (ARN) of a user, group, or role whose
policies you want to include in the simulation. If you specify a user, group, or role, the
simulation includes all policies that are associated with that entity. If you specify a
user, the simulation also includes all policies that are attached to any groups the user
belongs to. The maximum length of the policy document that you can pass in this operation,
including whitespace, is listed below. To view the maximum character counts of a managed
policy with no whitespaces, see IAM and STS character quotas. For more information about
ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CallerArn"`: The ARN of the IAM user that you want to specify as the simulated caller
of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the
user that you specify in PolicySourceArn, if you specified a user. If you include both a
PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for
example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the
API operations as Bob, as if Bob had David's policies. You can specify only the ARN of an
IAM user. You cannot specify the ARN of an assumed role, federated user, or a service
principal. CallerArn is required if you include a ResourcePolicy and the PolicySourceArn
is not the ARN for an IAM user. This is required so that the resource-based policy's
Principal element has a value to use in evaluating the policy. For more information about
ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
- `"ContextEntries"`: A list of context keys and corresponding values for the simulation to
use. Whenever a context key is evaluated in one of the simulated IAM permissions policies,
the corresponding value is supplied.
- `"Marker"`: Use this parameter only when paginating results and only after you receive a
response indicating that the results are truncated. Set it to the value of the Marker
element in the response that you received to indicate where the next call should start.
- `"MaxItems"`: Use this only when paginating results to indicate the maximum number of
items you want in the response. If additional items exist beyond the maximum you specify,
the IsTruncated response element is true. If you do not include this parameter, the number
of items defaults to 100. Note that IAM might return fewer results, even when there are
more results available. In that case, the IsTruncated response element returns true, and
Marker contains a value to include in the subsequent call that tells the service where to
continue from.
- `"PermissionsBoundaryPolicyInputList"`: The IAM permissions boundary policy to simulate.
The permissions boundary sets the maximum permissions that the entity can have. You can
input only one permissions boundary when you pass a policy to this operation. An IAM entity
can only have one permissions boundary in effect at a time. For example, if a permissions
boundary is attached to an entity and you pass in a different permissions boundary policy
using this parameter, then the new permissions boundary policy is used for the simulation.
For more information about permissions boundaries, see Permissions boundaries for IAM
entities in the IAM User Guide. The policy input is specified as a string containing the
complete, valid JSON text of a permissions boundary policy. The maximum length of the
policy document that you can pass in this operation, including whitespace, is listed below.
To view the maximum character counts of a managed policy with no whitespaces, see IAM and
STS character quotas. The regex pattern used to validate this parameter is a string of
characters consisting of the following: Any printable ASCII character ranging from the
space character (u0020) through the end of the ASCII character range The printable
characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) The
special characters tab (u0009), line feed (u000A), and carriage return (u000D)
- `"PolicyInputList"`: An optional list of additional policy documents to include in the
simulation. Each document is specified as a string containing the complete, valid JSON text
of an IAM policy. The regex pattern used to validate this parameter is a string of
characters consisting of the following: Any printable ASCII character ranging from the
space character (u0020) through the end of the ASCII character range The printable
characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) The
special characters tab (u0009), line feed (u000A), and carriage return (u000D)
- `"ResourceArns"`: A list of ARNs of Amazon Web Services resources to include in the
simulation. If this parameter is not provided, then the value defaults to * (all
resources). Each API in the ActionNames parameter is evaluated for each resource in this
list. The simulation determines the access result (allowed or denied) of each combination
and reports it in the response. You can simulate resources that don't exist in your
account. The simulation does not automatically retrieve policies for the specified
resources. If you want to include a resource policy in the simulation, then you must
include the policy as a string in the ResourcePolicy parameter. For more information about
ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Simulation of resource-based policies isn't supported for IAM roles.
- `"ResourceHandlingOption"`: Specifies the type of simulation to run. Different API
operations that support resource-based policies require different combinations of
resources. By specifying the type of simulation to run, you enable the policy simulator to
enforce the presence of the required resources to ensure reliable simulation results. If
your simulation does not match one of the following scenarios, then you can omit this
parameter. The following list shows each of the supported scenario values and the resources
that you must define to run the simulation. Each of the Amazon EC2 scenarios requires that
you specify instance, image, and security group resources. If your scenario includes an EBS
volume, then you must specify that volume as a resource. If the Amazon EC2 scenario
includes VPC, then you must supply the network interface resource. If it includes an IP
subnet, then you must specify the subnet resource. For more information on the Amazon EC2
scenario options, see Supported platforms in the Amazon EC2 User Guide.
EC2-VPC-InstanceStore instance, image, security group, network interface
EC2-VPC-InstanceStore-Subnet instance, image, security group, network interface, subnet
EC2-VPC-EBS instance, image, security group, network interface, volume
EC2-VPC-EBS-Subnet instance, image, security group, network interface, subnet, volume
- `"ResourceOwner"`: An Amazon Web Services account ID that specifies the owner of any
simulated resource that does not identify its owner in the resource ARN. Examples of
resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also
used as the account owner of any ResourcePolicy included in the simulation. If the
ResourceOwner parameter is not specified, then the owner of the resources and the resource
policy defaults to the account of the identity provided in CallerArn. This parameter is
required only if you specify a resource-based policy and account that owns the resource is
different from the account that owns the simulated calling user CallerArn.
- `"ResourcePolicy"`: A resource-based policy to include in the simulation provided as a
string. Each resource in the simulation is treated as if it had this policy attached. You
can include only one resource-based policy in a simulation. The maximum length of the
policy document that you can pass in this operation, including whitespace, is listed below.
To view the maximum character counts of a managed policy with no whitespaces, see IAM and
STS character quotas. The regex pattern used to validate this parameter is a string of
characters consisting of the following: Any printable ASCII character ranging from the
space character (u0020) through the end of the ASCII character range The printable
characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) The
special characters tab (u0009), line feed (u000A), and carriage return (u000D)
Simulation of resource-based policies isn't supported for IAM roles.
"""
function simulate_principal_policy(
ActionNames, PolicySourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"SimulatePrincipalPolicy",
Dict{String,Any}(
"ActionNames" => ActionNames, "PolicySourceArn" => PolicySourceArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function simulate_principal_policy(
ActionNames,
PolicySourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"SimulatePrincipalPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ActionNames" => ActionNames, "PolicySourceArn" => PolicySourceArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_instance_profile(instance_profile_name, tags)
tag_instance_profile(instance_profile_name, tags, params::Dict{String,<:Any})
Adds one or more tags to an IAM instance profile. If a tag with the same key name already
exists, then that tag is overwritten with the new value. Each tag consists of a key name
and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and
search. For example, you could search for all resources with the key name Project and the
value MyImportantProject. Or search for all resources with the key name Cost Center and the
value 41200. Access control - Include tags in IAM user-based and resource-based
policies. You can use tags to restrict access to only an IAM instance profile that has a
specified tag attached. For examples of policies that show how to use tags to control
access, see Control access using IAM tags in the IAM User Guide. If any one of the
tags is invalid or if you exceed the allowed maximum number of tags, then the entire
request fails and the resource is not created. For more information about tagging, see
Tagging IAM resources in the IAM User Guide. Amazon Web Services always interprets the
tag Value as a single string. If you need to store an array, you can store comma-separated
values in the string. However, you must interpret the value in your code.
# Arguments
- `instance_profile_name`: The name of the IAM instance profile to which you want to add
tags. This parameter allows (through its regex pattern) a string of characters consisting
of upper and lowercase alphanumeric characters with no spaces. You can also include any of
the following characters: _+=,.@-
- `tags`: The list of tags that you want to attach to the IAM instance profile. Each tag
consists of a key name and an associated value.
"""
function tag_instance_profile(
InstanceProfileName, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"TagInstanceProfile",
Dict{String,Any}("InstanceProfileName" => InstanceProfileName, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_instance_profile(
InstanceProfileName,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"TagInstanceProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceProfileName" => InstanceProfileName, "Tags" => Tags
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_mfadevice(serial_number, tags)
tag_mfadevice(serial_number, tags, params::Dict{String,<:Any})
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag
with the same key name already exists, then that tag is overwritten with the new value. A
tag consists of a key name and an associated value. By assigning tags to your resources,
you can do the following: Administrative grouping and discovery - Attach tags to
resources to aid in organization and search. For example, you could search for all
resources with the key name Project and the value MyImportantProject. Or search for all
resources with the key name Cost Center and the value 41200. Access control - Include
tags in IAM user-based and resource-based policies. You can use tags to restrict access to
only an IAM virtual MFA device that has a specified tag attached. For examples of policies
that show how to use tags to control access, see Control access using IAM tags in the IAM
User Guide. If any one of the tags is invalid or if you exceed the allowed maximum
number of tags, then the entire request fails and the resource is not created. For more
information about tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web
Services always interprets the tag Value as a single string. If you need to store an array,
you can store comma-separated values in the string. However, you must interpret the value
in your code.
# Arguments
- `serial_number`: The unique identifier for the IAM virtual MFA device to which you want
to add tags. For virtual MFA devices, the serial number is the same as the ARN. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
- `tags`: The list of tags that you want to attach to the IAM virtual MFA device. Each tag
consists of a key name and an associated value.
"""
function tag_mfadevice(
SerialNumber, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"TagMFADevice",
Dict{String,Any}("SerialNumber" => SerialNumber, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_mfadevice(
SerialNumber,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"TagMFADevice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SerialNumber" => SerialNumber, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_open_idconnect_provider(open_idconnect_provider_arn, tags)
tag_open_idconnect_provider(open_idconnect_provider_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more
information about these providers, see About web identity federation. If a tag with the
same key name already exists, then that tag is overwritten with the new value. A tag
consists of a key name and an associated value. By assigning tags to your resources, you
can do the following: Administrative grouping and discovery - Attach tags to resources
to aid in organization and search. For example, you could search for all resources with the
key name Project and the value MyImportantProject. Or search for all resources with the key
name Cost Center and the value 41200. Access control - Include tags in IAM
identity-based and resource-based policies. You can use tags to restrict access to only an
OIDC provider that has a specified tag attached. For examples of policies that show how to
use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then
the entire request fails and the resource is not created. For more information about
tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always
interprets the tag Value as a single string. If you need to store an array, you can store
comma-separated values in the string. However, you must interpret the value in your code.
# Arguments
- `open_idconnect_provider_arn`: The ARN of the OIDC identity provider in IAM to which you
want to add tags. This parameter allows (through its regex pattern) a string of characters
consisting of upper and lowercase alphanumeric characters with no spaces. You can also
include any of the following characters: _+=,.@-
- `tags`: The list of tags that you want to attach to the OIDC identity provider in IAM.
Each tag consists of a key name and an associated value.
"""
function tag_open_idconnect_provider(
OpenIDConnectProviderArn, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"TagOpenIDConnectProvider",
Dict{String,Any}(
"OpenIDConnectProviderArn" => OpenIDConnectProviderArn, "Tags" => Tags
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_open_idconnect_provider(
OpenIDConnectProviderArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"TagOpenIDConnectProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OpenIDConnectProviderArn" => OpenIDConnectProviderArn, "Tags" => Tags
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_policy(policy_arn, tags)
tag_policy(policy_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to an IAM customer managed policy. If a tag with the same key name
already exists, then that tag is overwritten with the new value. A tag consists of a key
name and an associated value. By assigning tags to your resources, you can do the
following: Administrative grouping and discovery - Attach tags to resources to aid in
organization and search. For example, you could search for all resources with the key name
Project and the value MyImportantProject. Or search for all resources with the key name
Cost Center and the value 41200. Access control - Include tags in IAM user-based and
resource-based policies. You can use tags to restrict access to only an IAM customer
managed policy that has a specified tag attached. For examples of policies that show how to
use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then
the entire request fails and the resource is not created. For more information about
tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always
interprets the tag Value as a single string. If you need to store an array, you can store
comma-separated values in the string. However, you must interpret the value in your code.
# Arguments
- `policy_arn`: The ARN of the IAM customer managed policy to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
- `tags`: The list of tags that you want to attach to the IAM customer managed policy. Each
tag consists of a key name and an associated value.
"""
function tag_policy(PolicyArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"TagPolicy",
Dict{String,Any}("PolicyArn" => PolicyArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_policy(
PolicyArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"TagPolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("PolicyArn" => PolicyArn, "Tags" => Tags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_role(role_name, tags)
tag_role(role_name, tags, params::Dict{String,<:Any})
Adds one or more tags to an IAM role. The role can be a regular role or a service-linked
role. If a tag with the same key name already exists, then that tag is overwritten with the
new value. A tag consists of a key name and an associated value. By assigning tags to your
resources, you can do the following: Administrative grouping and discovery - Attach tags
to resources to aid in organization and search. For example, you could search for all
resources with the key name Project and the value MyImportantProject. Or search for all
resources with the key name Cost Center and the value 41200. Access control - Include
tags in IAM user-based and resource-based policies. You can use tags to restrict access to
only an IAM role that has a specified tag attached. You can also restrict access to only
those resources that have a certain tag attached. For examples of policies that show how to
use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon
Web Services resources. If any one of the tags is invalid or if you exceed the allowed
maximum number of tags, then the entire request fails and the resource is not created. For
more information about tagging, see Tagging IAM resources in the IAM User Guide. Amazon
Web Services always interprets the tag Value as a single string. If you need to store an
array, you can store comma-separated values in the string. However, you must interpret the
value in your code. For more information about tagging, see Tagging IAM identities in
the IAM User Guide.
# Arguments
- `role_name`: The name of the IAM role to which you want to add tags. This parameter
accepts (through its regex pattern) a string of characters that consist of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
- `tags`: The list of tags that you want to attach to the IAM role. Each tag consists of a
key name and an associated value.
"""
function tag_role(RoleName, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"TagRole",
Dict{String,Any}("RoleName" => RoleName, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_role(
RoleName,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"TagRole",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("RoleName" => RoleName, "Tags" => Tags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_samlprovider(samlprovider_arn, tags)
tag_samlprovider(samlprovider_arn, tags, params::Dict{String,<:Any})
Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For
more information about these providers, see About SAML 2.0-based federation . If a tag with
the same key name already exists, then that tag is overwritten with the new value. A tag
consists of a key name and an associated value. By assigning tags to your resources, you
can do the following: Administrative grouping and discovery - Attach tags to resources
to aid in organization and search. For example, you could search for all resources with the
key name Project and the value MyImportantProject. Or search for all resources with the key
name Cost Center and the value 41200. Access control - Include tags in IAM user-based
and resource-based policies. You can use tags to restrict access to only a SAML identity
provider that has a specified tag attached. For examples of policies that show how to use
tags to control access, see Control access using IAM tags in the IAM User Guide. If
any one of the tags is invalid or if you exceed the allowed maximum number of tags, then
the entire request fails and the resource is not created. For more information about
tagging, see Tagging IAM resources in the IAM User Guide. Amazon Web Services always
interprets the tag Value as a single string. If you need to store an array, you can store
comma-separated values in the string. However, you must interpret the value in your code.
# Arguments
- `samlprovider_arn`: The ARN of the SAML identity provider in IAM to which you want to add
tags. This parameter allows (through its regex pattern) a string of characters consisting
of upper and lowercase alphanumeric characters with no spaces. You can also include any of
the following characters: _+=,.@-
- `tags`: The list of tags that you want to attach to the SAML identity provider in IAM.
Each tag consists of a key name and an associated value.
"""
function tag_samlprovider(
SAMLProviderArn, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"TagSAMLProvider",
Dict{String,Any}("SAMLProviderArn" => SAMLProviderArn, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_samlprovider(
SAMLProviderArn,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"TagSAMLProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SAMLProviderArn" => SAMLProviderArn, "Tags" => Tags),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_server_certificate(server_certificate_name, tags)
tag_server_certificate(server_certificate_name, tags, params::Dict{String,<:Any})
Adds one or more tags to an IAM server certificate. If a tag with the same key name already
exists, then that tag is overwritten with the new value. For certificates in a Region
supported by Certificate Manager (ACM), we recommend that you don't use IAM server
certificates. Instead, use ACM to provision, manage, and deploy your server certificates.
For more information about IAM server certificates, Working with server certificates in the
IAM User Guide. A tag consists of a key name and an associated value. By assigning tags to
your resources, you can do the following: Administrative grouping and discovery - Attach
tags to resources to aid in organization and search. For example, you could search for all
resources with the key name Project and the value MyImportantProject. Or search for all
resources with the key name Cost Center and the value 41200. Access control - Include
tags in IAM user-based and resource-based policies. You can use tags to restrict access to
only a server certificate that has a specified tag attached. For examples of policies that
show how to use tags to control access, see Control access using IAM tags in the IAM User
Guide. Cost allocation - Use tags to help track which individuals and teams are using
which Amazon Web Services resources. If any one of the tags is invalid or if you
exceed the allowed maximum number of tags, then the entire request fails and the resource
is not created. For more information about tagging, see Tagging IAM resources in the IAM
User Guide. Amazon Web Services always interprets the tag Value as a single string. If
you need to store an array, you can store comma-separated values in the string. However,
you must interpret the value in your code.
# Arguments
- `server_certificate_name`: The name of the IAM server certificate to which you want to
add tags. This parameter allows (through its regex pattern) a string of characters
consisting of upper and lowercase alphanumeric characters with no spaces. You can also
include any of the following characters: _+=,.@-
- `tags`: The list of tags that you want to attach to the IAM server certificate. Each tag
consists of a key name and an associated value.
"""
function tag_server_certificate(
ServerCertificateName, Tags; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"TagServerCertificate",
Dict{String,Any}("ServerCertificateName" => ServerCertificateName, "Tags" => Tags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_server_certificate(
ServerCertificateName,
Tags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"TagServerCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServerCertificateName" => ServerCertificateName, "Tags" => Tags
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
tag_user(tags, user_name)
tag_user(tags, user_name, params::Dict{String,<:Any})
Adds one or more tags to an IAM user. If a tag with the same key name already exists, then
that tag is overwritten with the new value. A tag consists of a key name and an associated
value. By assigning tags to your resources, you can do the following: Administrative
grouping and discovery - Attach tags to resources to aid in organization and search. For
example, you could search for all resources with the key name Project and the value
MyImportantProject. Or search for all resources with the key name Cost Center and the value
41200. Access control - Include tags in IAM identity-based and resource-based policies.
You can use tags to restrict access to only an IAM requesting user that has a specified tag
attached. You can also restrict access to only those resources that have a certain tag
attached. For examples of policies that show how to use tags to control access, see Control
access using IAM tags in the IAM User Guide. Cost allocation - Use tags to help track
which individuals and teams are using which Amazon Web Services resources. If any one
of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
request fails and the resource is not created. For more information about tagging, see
Tagging IAM resources in the IAM User Guide. Amazon Web Services always interprets the
tag Value as a single string. If you need to store an array, you can store comma-separated
values in the string. However, you must interpret the value in your code. For more
information about tagging, see Tagging IAM identities in the IAM User Guide.
# Arguments
- `tags`: The list of tags that you want to attach to the IAM user. Each tag consists of a
key name and an associated value.
- `user_name`: The name of the IAM user to which you want to add tags. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function tag_user(Tags, UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"TagUser",
Dict{String,Any}("Tags" => Tags, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function tag_user(
Tags,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"TagUser",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("Tags" => Tags, "UserName" => UserName), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_instance_profile(instance_profile_name, tag_keys)
untag_instance_profile(instance_profile_name, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the IAM instance profile. For more information about
tagging, see Tagging IAM resources in the IAM User Guide.
# Arguments
- `instance_profile_name`: The name of the IAM instance profile from which you want to
remove tags. This parameter allows (through its regex pattern) a string of characters
consisting of upper and lowercase alphanumeric characters with no spaces. You can also
include any of the following characters: _+=,.@-
- `tag_keys`: A list of key names as a simple array of strings. The tags with matching keys
are removed from the specified instance profile.
"""
function untag_instance_profile(
InstanceProfileName, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UntagInstanceProfile",
Dict{String,Any}(
"InstanceProfileName" => InstanceProfileName, "TagKeys" => TagKeys
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_instance_profile(
InstanceProfileName,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UntagInstanceProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"InstanceProfileName" => InstanceProfileName, "TagKeys" => TagKeys
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_mfadevice(serial_number, tag_keys)
untag_mfadevice(serial_number, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
# Arguments
- `serial_number`: The unique identifier for the IAM virtual MFA device from which you want
to remove tags. For virtual MFA devices, the serial number is the same as the ARN. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
- `tag_keys`: A list of key names as a simple array of strings. The tags with matching keys
are removed from the specified instance profile.
"""
function untag_mfadevice(
SerialNumber, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UntagMFADevice",
Dict{String,Any}("SerialNumber" => SerialNumber, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_mfadevice(
SerialNumber,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UntagMFADevice",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("SerialNumber" => SerialNumber, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_open_idconnect_provider(open_idconnect_provider_arn, tag_keys)
untag_open_idconnect_provider(open_idconnect_provider_arn, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity
provider in IAM. For more information about OIDC providers, see About web identity
federation. For more information about tagging, see Tagging IAM resources in the IAM User
Guide.
# Arguments
- `open_idconnect_provider_arn`: The ARN of the OIDC provider in IAM from which you want to
remove tags. This parameter allows (through its regex pattern) a string of characters
consisting of upper and lowercase alphanumeric characters with no spaces. You can also
include any of the following characters: _+=,.@-
- `tag_keys`: A list of key names as a simple array of strings. The tags with matching keys
are removed from the specified OIDC provider.
"""
function untag_open_idconnect_provider(
OpenIDConnectProviderArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UntagOpenIDConnectProvider",
Dict{String,Any}(
"OpenIDConnectProviderArn" => OpenIDConnectProviderArn, "TagKeys" => TagKeys
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_open_idconnect_provider(
OpenIDConnectProviderArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UntagOpenIDConnectProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OpenIDConnectProviderArn" => OpenIDConnectProviderArn,
"TagKeys" => TagKeys,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_policy(policy_arn, tag_keys)
untag_policy(policy_arn, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the customer managed policy. For more information about
tagging, see Tagging IAM resources in the IAM User Guide.
# Arguments
- `policy_arn`: The ARN of the IAM customer managed policy from which you want to remove
tags. This parameter allows (through its regex pattern) a string of characters consisting
of upper and lowercase alphanumeric characters with no spaces. You can also include any of
the following characters: _+=,.@-
- `tag_keys`: A list of key names as a simple array of strings. The tags with matching keys
are removed from the specified policy.
"""
function untag_policy(PolicyArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"UntagPolicy",
Dict{String,Any}("PolicyArn" => PolicyArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_policy(
PolicyArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UntagPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("PolicyArn" => PolicyArn, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_role(role_name, tag_keys)
untag_role(role_name, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the role. For more information about tagging, see Tagging
IAM resources in the IAM User Guide.
# Arguments
- `role_name`: The name of the IAM role from which you want to remove tags. This parameter
accepts (through its regex pattern) a string of characters that consist of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
- `tag_keys`: A list of key names as a simple array of strings. The tags with matching keys
are removed from the specified role.
"""
function untag_role(RoleName, TagKeys; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"UntagRole",
Dict{String,Any}("RoleName" => RoleName, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_role(
RoleName,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UntagRole",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("RoleName" => RoleName, "TagKeys" => TagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_samlprovider(samlprovider_arn, tag_keys)
untag_samlprovider(samlprovider_arn, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the specified Security Assertion Markup Language (SAML)
identity provider in IAM. For more information about these providers, see About web
identity federation. For more information about tagging, see Tagging IAM resources in the
IAM User Guide.
# Arguments
- `samlprovider_arn`: The ARN of the SAML identity provider in IAM from which you want to
remove tags. This parameter allows (through its regex pattern) a string of characters
consisting of upper and lowercase alphanumeric characters with no spaces. You can also
include any of the following characters: _+=,.@-
- `tag_keys`: A list of key names as a simple array of strings. The tags with matching keys
are removed from the specified SAML identity provider.
"""
function untag_samlprovider(
SAMLProviderArn, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UntagSAMLProvider",
Dict{String,Any}("SAMLProviderArn" => SAMLProviderArn, "TagKeys" => TagKeys);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_samlprovider(
SAMLProviderArn,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UntagSAMLProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SAMLProviderArn" => SAMLProviderArn, "TagKeys" => TagKeys
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_server_certificate(server_certificate_name, tag_keys)
untag_server_certificate(server_certificate_name, tag_keys, params::Dict{String,<:Any})
Removes the specified tags from the IAM server certificate. For more information about
tagging, see Tagging IAM resources in the IAM User Guide. For certificates in a Region
supported by Certificate Manager (ACM), we recommend that you don't use IAM server
certificates. Instead, use ACM to provision, manage, and deploy your server certificates.
For more information about IAM server certificates, Working with server certificates in the
IAM User Guide.
# Arguments
- `server_certificate_name`: The name of the IAM server certificate from which you want to
remove tags. This parameter allows (through its regex pattern) a string of characters
consisting of upper and lowercase alphanumeric characters with no spaces. You can also
include any of the following characters: _+=,.@-
- `tag_keys`: A list of key names as a simple array of strings. The tags with matching keys
are removed from the specified IAM server certificate.
"""
function untag_server_certificate(
ServerCertificateName, TagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UntagServerCertificate",
Dict{String,Any}(
"ServerCertificateName" => ServerCertificateName, "TagKeys" => TagKeys
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_server_certificate(
ServerCertificateName,
TagKeys,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UntagServerCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServerCertificateName" => ServerCertificateName, "TagKeys" => TagKeys
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
untag_user(tag_keys, user_name)
untag_user(tag_keys, user_name, params::Dict{String,<:Any})
Removes the specified tags from the user. For more information about tagging, see Tagging
IAM resources in the IAM User Guide.
# Arguments
- `tag_keys`: A list of key names as a simple array of strings. The tags with matching keys
are removed from the specified user.
- `user_name`: The name of the IAM user from which you want to remove tags. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function untag_user(TagKeys, UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"UntagUser",
Dict{String,Any}("TagKeys" => TagKeys, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function untag_user(
TagKeys,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UntagUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("TagKeys" => TagKeys, "UserName" => UserName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_access_key(access_key_id, status)
update_access_key(access_key_id, status, params::Dict{String,<:Any})
Changes the status of the specified access key from Active to Inactive, or vice versa. This
operation can be used to disable a user's key as part of a key rotation workflow. If the
UserName is not specified, the user name is determined implicitly based on the Amazon Web
Services access key ID used to sign the request. If a temporary access key is used, then
UserName is required. If a long-term key is assigned to the user, then UserName is not
required. This operation works for access keys under the Amazon Web Services account.
Consequently, you can use this operation to manage Amazon Web Services account root user
credentials even if the Amazon Web Services account has no associated users. For
information about rotating keys, see Managing keys and certificates in the IAM User Guide.
# Arguments
- `access_key_id`: The access key ID of the secret access key you want to update. This
parameter allows (through its regex pattern) a string of characters that can consist of any
upper or lowercased letter or digit.
- `status`: The status you want to assign to the secret access key. Active means that the
key can be used for programmatic calls to Amazon Web Services, while Inactive means that
the key cannot be used.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The name of the user whose key you want to update. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function update_access_key(
AccessKeyId, Status; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UpdateAccessKey",
Dict{String,Any}("AccessKeyId" => AccessKeyId, "Status" => Status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_access_key(
AccessKeyId,
Status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateAccessKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("AccessKeyId" => AccessKeyId, "Status" => Status),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_account_password_policy()
update_account_password_policy(params::Dict{String,<:Any})
Updates the password policy settings for the Amazon Web Services account. This operation
does not support partial updates. No parameters are required, but if you do not specify a
parameter, that parameter's value reverts to its default value. See the Request Parameters
section for each parameter's default value. Also note that some parameters do not allow the
default parameter to be explicitly set. Instead, to invoke the default value, do not
include that parameter when you invoke the operation. For more information about using a
password policy, see Managing an IAM password policy in the IAM User Guide.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AllowUsersToChangePassword"`: Allows all IAM users in your account to use the Amazon
Web Services Management Console to change their own passwords. For more information, see
Permitting IAM users to change their own passwords in the IAM User Guide. If you do not
specify a value for this parameter, then the operation uses the default value of false. The
result is that IAM users in the account do not automatically have permissions to change
their own password.
- `"HardExpiry"`: Prevents IAM users who are accessing the account via the Amazon Web
Services Management Console from setting a new console password after their password has
expired. The IAM user cannot access the console until an administrator resets the password.
If you do not specify a value for this parameter, then the operation uses the default value
of false. The result is that IAM users can change their passwords after they expire and
continue to sign in as the user. In the Amazon Web Services Management Console, the
custom password policy option Allow users to change their own password gives IAM users
permissions to iam:ChangePassword for only their user and to the
iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to
each user, rather the permissions are applied at the account-level for all users by IAM.
IAM users with iam:ChangePassword permission and active access keys can reset their own
expired console password using the CLI or API.
- `"MaxPasswordAge"`: The number of days that an IAM user password is valid. If you do not
specify a value for this parameter, then the operation uses the default value of 0. The
result is that IAM user passwords never expire.
- `"MinimumPasswordLength"`: The minimum number of characters allowed in an IAM user
password. If you do not specify a value for this parameter, then the operation uses the
default value of 6.
- `"PasswordReusePrevention"`: Specifies the number of previous passwords that IAM users
are prevented from reusing. If you do not specify a value for this parameter, then the
operation uses the default value of 0. The result is that IAM users are not prevented from
reusing previous passwords.
- `"RequireLowercaseCharacters"`: Specifies whether IAM user passwords must contain at
least one lowercase character from the ISO basic Latin alphabet (a to z). If you do not
specify a value for this parameter, then the operation uses the default value of false. The
result is that passwords do not require at least one lowercase character.
- `"RequireNumbers"`: Specifies whether IAM user passwords must contain at least one
numeric character (0 to 9). If you do not specify a value for this parameter, then the
operation uses the default value of false. The result is that passwords do not require at
least one numeric character.
- `"RequireSymbols"`: Specifies whether IAM user passwords must contain at least one of the
following non-alphanumeric characters: ! @ # % ^ & * ( ) _ + - = [ ] { } | ' If you do
not specify a value for this parameter, then the operation uses the default value of false.
The result is that passwords do not require at least one symbol character.
- `"RequireUppercaseCharacters"`: Specifies whether IAM user passwords must contain at
least one uppercase character from the ISO basic Latin alphabet (A to Z). If you do not
specify a value for this parameter, then the operation uses the default value of false. The
result is that passwords do not require at least one uppercase character.
"""
function update_account_password_policy(; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"UpdateAccountPasswordPolicy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_account_password_policy(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UpdateAccountPasswordPolicy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_assume_role_policy(policy_document, role_name)
update_assume_role_policy(policy_document, role_name, params::Dict{String,<:Any})
Updates the policy that grants an IAM entity permission to assume a role. This is typically
referred to as the \"role trust policy\". For more information about roles, see Using roles
to delegate permissions and federate identities.
# Arguments
- `policy_document`: The policy that grants an entity permission to assume the role. You
must provide policies in JSON format in IAM. However, for CloudFormation templates
formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always
converts a YAML policy to JSON format before submitting it to IAM. The regex pattern used
to validate this parameter is a string of characters consisting of the following: Any
printable ASCII character ranging from the space character (u0020) through the end of the
ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement
character set (through u00FF) The special characters tab (u0009), line feed (u000A), and
carriage return (u000D)
- `role_name`: The name of the role to update with the new policy. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function update_assume_role_policy(
PolicyDocument, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UpdateAssumeRolePolicy",
Dict{String,Any}("PolicyDocument" => PolicyDocument, "RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_assume_role_policy(
PolicyDocument,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateAssumeRolePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PolicyDocument" => PolicyDocument, "RoleName" => RoleName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_group(group_name)
update_group(group_name, params::Dict{String,<:Any})
Updates the name and/or the path of the specified IAM group. You should understand the
implications of changing a group's path or name. For more information, see Renaming users
and groups in the IAM User Guide. The person making the request (the principal), must
have permission to change the role group with the old name and the new name. For example,
to change the group named Managers to MGRs, the principal must have a policy that allows
them to update both groups. If the principal has permission to update the Managers group,
but not the MGRs group, then the update fails. For more information about permissions, see
Access management.
# Arguments
- `group_name`: Name of the IAM group to update. If you're changing the name of the group,
this is the original name. This parameter allows (through its regex pattern) a string of
characters consisting of upper and lowercase alphanumeric characters with no spaces. You
can also include any of the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NewGroupName"`: New name for the IAM group. Only include this if changing the group's
name. IAM user, group, role, and policy names must be unique within the account. Names are
not distinguished by case. For example, you cannot create resources named both
\"MyResource\" and \"myresource\".
- `"NewPath"`: New path for the IAM group. Only include this if changing the group's path.
This parameter allows (through its regex pattern) a string of characters consisting of
either a forward slash (/) by itself or a string that must begin and end with forward
slashes. In addition, it can contain any ASCII character from the ! (u0021) through the DEL
character (u007F), including most punctuation characters, digits, and upper and lowercased
letters.
"""
function update_group(GroupName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"UpdateGroup",
Dict{String,Any}("GroupName" => GroupName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_group(
GroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateGroup",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("GroupName" => GroupName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_login_profile(user_name)
update_login_profile(user_name, params::Dict{String,<:Any})
Changes the password for the specified IAM user. You can use the CLI, the Amazon Web
Services API, or the Users page in the IAM console to change the password for any IAM user.
Use ChangePassword to change your own password in the My Security Credentials page in the
Amazon Web Services Management Console. For more information about modifying passwords, see
Managing passwords in the IAM User Guide.
# Arguments
- `user_name`: The name of the user whose password you want to update. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Password"`: The new password for the specified IAM user. The regex pattern used to
validate this parameter is a string of characters consisting of the following: Any
printable ASCII character ranging from the space character (u0020) through the end of the
ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement
character set (through u00FF) The special characters tab (u0009), line feed (u000A), and
carriage return (u000D) However, the format can be further restricted by the account
administrator by setting a password policy on the Amazon Web Services account. For more
information, see UpdateAccountPasswordPolicy.
- `"PasswordResetRequired"`: Allows this new password to be used only once by requiring the
specified IAM user to set a new password on next sign-in.
"""
function update_login_profile(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"UpdateLoginProfile",
Dict{String,Any}("UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_login_profile(
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateLoginProfile",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_open_idconnect_provider_thumbprint(open_idconnect_provider_arn, thumbprint_list)
update_open_idconnect_provider_thumbprint(open_idconnect_provider_arn, thumbprint_list, params::Dict{String,<:Any})
Replaces the existing list of server certificate thumbprints associated with an OpenID
Connect (OIDC) provider resource object with a new list of thumbprints. The list that you
pass with this operation completely replaces the existing list of thumbprints. (The lists
are not merged.) Typically, you need to update a thumbprint only when the identity provider
certificate changes, which occurs rarely. However, if the provider's certificate does
change, any attempt to assume an IAM role that specifies the OIDC provider as a principal
fails until the certificate thumbprint is updated. Amazon Web Services secures
communication with some OIDC identity providers (IdPs) through our library of trusted root
certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP
server certificate. In these cases, your legacy thumbprint remains in your configuration,
but is no longer used for validation. These OIDC IdPs include Auth0, GitHub, GitLab,
Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint.
Trust for the OIDC provider is derived from the provider certificate and is validated by
the thumbprint. Therefore, it is best to limit access to the
UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.
# Arguments
- `open_idconnect_provider_arn`: The Amazon Resource Name (ARN) of the IAM OIDC provider
resource object for which you want to update the thumbprint. You can get a list of OIDC
provider ARNs by using the ListOpenIDConnectProviders operation. For more information about
ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
- `thumbprint_list`: A list of certificate thumbprints that are associated with the
specified IAM OpenID Connect provider. For more information, see
CreateOpenIDConnectProvider.
"""
function update_open_idconnect_provider_thumbprint(
OpenIDConnectProviderArn,
ThumbprintList;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateOpenIDConnectProviderThumbprint",
Dict{String,Any}(
"OpenIDConnectProviderArn" => OpenIDConnectProviderArn,
"ThumbprintList" => ThumbprintList,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_open_idconnect_provider_thumbprint(
OpenIDConnectProviderArn,
ThumbprintList,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateOpenIDConnectProviderThumbprint",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"OpenIDConnectProviderArn" => OpenIDConnectProviderArn,
"ThumbprintList" => ThumbprintList,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_role(role_name)
update_role(role_name, params::Dict{String,<:Any})
Updates the description or maximum session duration setting of a role.
# Arguments
- `role_name`: The name of the role that you want to modify.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: The new description that you want to apply to the specified role.
- `"MaxSessionDuration"`: The maximum session duration (in seconds) that you want to set
for the specified role. If you do not specify a value for this setting, the default value
of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who
assumes the role from the CLI or API can use the DurationSeconds API parameter or the
duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting
determines the maximum duration that can be requested using the DurationSeconds parameter.
If users don't specify a value for the DurationSeconds parameter, their security
credentials are valid for one hour by default. This applies when you use the AssumeRole*
API operations or the assume-role* CLI operations but does not apply when you use those
operations to create a console URL. For more information, see Using IAM roles in the IAM
User Guide. IAM role credentials provided by Amazon EC2 instances assigned to the role are
not subject to the specified maximum session duration.
"""
function update_role(RoleName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"UpdateRole",
Dict{String,Any}("RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_role(
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateRole",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("RoleName" => RoleName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_role_description(description, role_name)
update_role_description(description, role_name, params::Dict{String,<:Any})
Use UpdateRole instead. Modifies only the description of a role. This operation performs
the same function as the Description parameter in the UpdateRole operation.
# Arguments
- `description`: The new description that you want to apply to the specified role.
- `role_name`: The name of the role that you want to modify.
"""
function update_role_description(
Description, RoleName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UpdateRoleDescription",
Dict{String,Any}("Description" => Description, "RoleName" => RoleName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_role_description(
Description,
RoleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateRoleDescription",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Description" => Description, "RoleName" => RoleName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_samlprovider(samlmetadata_document, samlprovider_arn)
update_samlprovider(samlmetadata_document, samlprovider_arn, params::Dict{String,<:Any})
Updates the metadata document for an existing SAML provider resource object. This
operation requires Signature Version 4.
# Arguments
- `samlmetadata_document`: An XML document generated by an identity provider (IdP) that
supports SAML 2.0. The document includes the issuer's name, expiration information, and
keys that can be used to validate the SAML authentication response (assertions) that are
received from the IdP. You must generate the metadata document using the identity
management software that is used as your organization's IdP.
- `samlprovider_arn`: The Amazon Resource Name (ARN) of the SAML provider to update. For
more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services
General Reference.
"""
function update_samlprovider(
SAMLMetadataDocument, SAMLProviderArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UpdateSAMLProvider",
Dict{String,Any}(
"SAMLMetadataDocument" => SAMLMetadataDocument,
"SAMLProviderArn" => SAMLProviderArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_samlprovider(
SAMLMetadataDocument,
SAMLProviderArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateSAMLProvider",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SAMLMetadataDocument" => SAMLMetadataDocument,
"SAMLProviderArn" => SAMLProviderArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_server_certificate(server_certificate_name)
update_server_certificate(server_certificate_name, params::Dict{String,<:Any})
Updates the name and/or the path of the specified server certificate stored in IAM. For
more information about working with server certificates, see Working with server
certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services
services that can use the server certificates that you manage with IAM. You should
understand the implications of changing a server certificate's path or name. For more
information, see Renaming a server certificate in the IAM User Guide. The person making
the request (the principal), must have permission to change the server certificate with the
old name and the new name. For example, to change the certificate named ProductionCert to
ProdCert, the principal must have a policy that allows them to update both certificates. If
the principal has permission to update the ProductionCert group, but not the ProdCert
certificate, then the update fails. For more information about permissions, see Access
management in the IAM User Guide.
# Arguments
- `server_certificate_name`: The name of the server certificate that you want to update.
This parameter allows (through its regex pattern) a string of characters consisting of
upper and lowercase alphanumeric characters with no spaces. You can also include any of the
following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NewPath"`: The new path for the server certificate. Include this only if you are
updating the server certificate's path. This parameter allows (through its regex pattern) a
string of characters consisting of either a forward slash (/) by itself or a string that
must begin and end with forward slashes. In addition, it can contain any ASCII character
from the ! (u0021) through the DEL character (u007F), including most punctuation
characters, digits, and upper and lowercased letters.
- `"NewServerCertificateName"`: The new name for the server certificate. Include this only
if you are updating the server certificate's name. The name of the certificate cannot
contain any spaces. This parameter allows (through its regex pattern) a string of
characters consisting of upper and lowercase alphanumeric characters with no spaces. You
can also include any of the following characters: _+=,.@-
"""
function update_server_certificate(
ServerCertificateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UpdateServerCertificate",
Dict{String,Any}("ServerCertificateName" => ServerCertificateName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_server_certificate(
ServerCertificateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateServerCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("ServerCertificateName" => ServerCertificateName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_service_specific_credential(service_specific_credential_id, status)
update_service_specific_credential(service_specific_credential_id, status, params::Dict{String,<:Any})
Sets the status of a service-specific credential to Active or Inactive. Service-specific
credentials that are inactive cannot be used for authentication to the service. This
operation can be used to disable a user's service-specific credential as part of a
credential rotation work flow.
# Arguments
- `service_specific_credential_id`: The unique identifier of the service-specific
credential. This parameter allows (through its regex pattern) a string of characters that
can consist of any upper or lowercased letter or digit.
- `status`: The status to be assigned to the service-specific credential.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The name of the IAM user associated with the service-specific credential.
If you do not specify this value, then the operation assumes the user whose credentials are
used to call the operation. This parameter allows (through its regex pattern) a string of
characters consisting of upper and lowercase alphanumeric characters with no spaces. You
can also include any of the following characters: _+=,.@-
"""
function update_service_specific_credential(
ServiceSpecificCredentialId, Status; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UpdateServiceSpecificCredential",
Dict{String,Any}(
"ServiceSpecificCredentialId" => ServiceSpecificCredentialId, "Status" => Status
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_service_specific_credential(
ServiceSpecificCredentialId,
Status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateServiceSpecificCredential",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"ServiceSpecificCredentialId" => ServiceSpecificCredentialId,
"Status" => Status,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_signing_certificate(certificate_id, status)
update_signing_certificate(certificate_id, status, params::Dict{String,<:Any})
Changes the status of the specified user signing certificate from active to disabled, or
vice versa. This operation can be used to disable an IAM user's signing certificate as part
of a certificate rotation work flow. If the UserName field is not specified, the user name
is determined implicitly based on the Amazon Web Services access key ID used to sign the
request. This operation works for access keys under the Amazon Web Services account.
Consequently, you can use this operation to manage Amazon Web Services account root user
credentials even if the Amazon Web Services account has no associated users.
# Arguments
- `certificate_id`: The ID of the signing certificate you want to update. This parameter
allows (through its regex pattern) a string of characters that can consist of any upper or
lowercased letter or digit.
- `status`: The status you want to assign to the certificate. Active means that the
certificate can be used for programmatic calls to Amazon Web Services Inactive means that
the certificate cannot be used.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The name of the IAM user the signing certificate belongs to. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function update_signing_certificate(
CertificateId, Status; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UpdateSigningCertificate",
Dict{String,Any}("CertificateId" => CertificateId, "Status" => Status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_signing_certificate(
CertificateId,
Status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateSigningCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("CertificateId" => CertificateId, "Status" => Status),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_sshpublic_key(sshpublic_key_id, status, user_name)
update_sshpublic_key(sshpublic_key_id, status, user_name, params::Dict{String,<:Any})
Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that
are inactive cannot be used for authentication. This operation can be used to disable a
user's SSH public key as part of a key rotation work flow. The SSH public key affected by
this operation is used only for authenticating the associated IAM user to an CodeCommit
repository. For more information about using SSH keys to authenticate to an CodeCommit
repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
# Arguments
- `sshpublic_key_id`: The unique identifier for the SSH public key. This parameter allows
(through its regex pattern) a string of characters that can consist of any upper or
lowercased letter or digit.
- `status`: The status to assign to the SSH public key. Active means that the key can be
used for authentication with an CodeCommit repository. Inactive means that the key cannot
be used.
- `user_name`: The name of the IAM user associated with the SSH public key. This parameter
allows (through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function update_sshpublic_key(
SSHPublicKeyId, Status, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UpdateSSHPublicKey",
Dict{String,Any}(
"SSHPublicKeyId" => SSHPublicKeyId, "Status" => Status, "UserName" => UserName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_sshpublic_key(
SSHPublicKeyId,
Status,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UpdateSSHPublicKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SSHPublicKeyId" => SSHPublicKeyId,
"Status" => Status,
"UserName" => UserName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user(user_name)
update_user(user_name, params::Dict{String,<:Any})
Updates the name and/or the path of the specified IAM user. You should understand the
implications of changing an IAM user's path or name. For more information, see Renaming an
IAM user and Renaming an IAM group in the IAM User Guide. To change a user name, the
requester must have appropriate permissions on both the source object and the target
object. For example, to change Bob to Robert, the entity making the request must have
permission on Bob and Robert, or must have permission on all (*). For more information
about permissions, see Permissions and policies.
# Arguments
- `user_name`: Name of the user to update. If you're changing the name of the user, this is
the original user name. This parameter allows (through its regex pattern) a string of
characters consisting of upper and lowercase alphanumeric characters with no spaces. You
can also include any of the following characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"NewPath"`: New path for the IAM user. Include this parameter only if you're changing
the user's path. This parameter allows (through its regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that must begin and end with
forward slashes. In addition, it can contain any ASCII character from the ! (u0021) through
the DEL character (u007F), including most punctuation characters, digits, and upper and
lowercased letters.
- `"NewUserName"`: New name for the user. Include this parameter only if you're changing
the user's name. IAM user, group, role, and policy names must be unique within the account.
Names are not distinguished by case. For example, you cannot create resources named both
\"MyResource\" and \"myresource\".
"""
function update_user(UserName; aws_config::AbstractAWSConfig=global_aws_config())
return iam(
"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 iam(
"UpdateUser",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("UserName" => UserName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_server_certificate(certificate_body, private_key, server_certificate_name)
upload_server_certificate(certificate_body, private_key, server_certificate_name, params::Dict{String,<:Any})
Uploads a server certificate entity for the Amazon Web Services account. The server
certificate entity includes a public key certificate, a private key, and an optional
certificate chain, which should all be PEM-encoded. We recommend that you use Certificate
Manager to provision, manage, and deploy your server certificates. With ACM you can request
a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate
renewals for you. Certificates provided by ACM are free. For more information about using
ACM, see the Certificate Manager User Guide. For more information about working with server
certificates, see Working with server certificates in the IAM User Guide. This topic
includes a list of Amazon Web Services services that can use the server certificates that
you manage with IAM. For information about the number of server certificates you can
upload, see IAM and STS quotas in the IAM User Guide. Because the body of the public key
certificate, private key, and the certificate chain can be large, you should use POST
rather than GET when calling UploadServerCertificate. For information about setting up
signatures and authorization through the API, see Signing Amazon Web Services API requests
in the Amazon Web Services General Reference. For general information about using the Query
API with IAM, see Calling the API by making HTTP query requests in the IAM User Guide.
# Arguments
- `certificate_body`: The contents of the public key certificate in PEM-encoded format. The
regex pattern used to validate this parameter is a string of characters consisting of the
following: Any printable ASCII character ranging from the space character (u0020) through
the end of the ASCII character range The printable characters in the Basic Latin and
Latin-1 Supplement character set (through u00FF) The special characters tab (u0009), line
feed (u000A), and carriage return (u000D)
- `private_key`: The contents of the private key in PEM-encoded format. The regex pattern
used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (u0020) through the end of
the ASCII character range The printable characters in the Basic Latin and Latin-1
Supplement character set (through u00FF) The special characters tab (u0009), line feed
(u000A), and carriage return (u000D)
- `server_certificate_name`: The name for the server certificate. Do not include the path
in this value. The name of the certificate cannot contain any spaces. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CertificateChain"`: The contents of the certificate chain. This is typically a
concatenation of the PEM-encoded public key certificates of the chain. The regex pattern
used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (u0020) through the end of
the ASCII character range The printable characters in the Basic Latin and Latin-1
Supplement character set (through u00FF) The special characters tab (u0009), line feed
(u000A), and carriage return (u000D)
- `"Path"`: The path for the server certificate. For more information about paths, see IAM
identifiers in the IAM User Guide. This parameter is optional. If it is not included, it
defaults to a slash (/). This parameter allows (through its regex pattern) a string of
characters consisting of either a forward slash (/) by itself or a string that must begin
and end with forward slashes. In addition, it can contain any ASCII character from the !
(u0021) through the DEL character (u007F), including most punctuation characters, digits,
and upper and lowercased letters. If you are uploading a server certificate specifically
for use with Amazon CloudFront distributions, you must specify a path using the path
parameter. The path must begin with /cloudfront and must include a trailing slash (for
example, /cloudfront/test/).
- `"Tags"`: A list of tags that you want to attach to the new IAM server certificate
resource. Each tag consists of a key name and an associated value. For more information
about tagging, see Tagging IAM resources in the IAM User Guide. If any one of the tags is
invalid or if you exceed the allowed maximum number of tags, then the entire request fails
and the resource is not created.
"""
function upload_server_certificate(
CertificateBody,
PrivateKey,
ServerCertificateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UploadServerCertificate",
Dict{String,Any}(
"CertificateBody" => CertificateBody,
"PrivateKey" => PrivateKey,
"ServerCertificateName" => ServerCertificateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upload_server_certificate(
CertificateBody,
PrivateKey,
ServerCertificateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UploadServerCertificate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"CertificateBody" => CertificateBody,
"PrivateKey" => PrivateKey,
"ServerCertificateName" => ServerCertificateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_signing_certificate(certificate_body)
upload_signing_certificate(certificate_body, params::Dict{String,<:Any})
Uploads an X.509 signing certificate and associates it with the specified IAM user. Some
Amazon Web Services services require you to use certificates to validate requests that are
signed with a corresponding private key. When you upload the certificate, its default
status is Active. For information about when you would use an X.509 signing certificate,
see Managing server certificates in IAM in the IAM User Guide. If the UserName is not
specified, the IAM user name is determined implicitly based on the Amazon Web Services
access key ID used to sign the request. This operation works for access keys under the
Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web
Services account root user credentials even if the Amazon Web Services account has no
associated users. Because the body of an X.509 certificate can be large, you should use
POST rather than GET when calling UploadSigningCertificate. For information about setting
up signatures and authorization through the API, see Signing Amazon Web Services API
requests in the Amazon Web Services General Reference. For general information about using
the Query API with IAM, see Making query requests in the IAM User Guide.
# Arguments
- `certificate_body`: The contents of the signing certificate. The regex pattern used to
validate this parameter is a string of characters consisting of the following: Any
printable ASCII character ranging from the space character (u0020) through the end of the
ASCII character range The printable characters in the Basic Latin and Latin-1 Supplement
character set (through u00FF) The special characters tab (u0009), line feed (u000A), and
carriage return (u000D)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UserName"`: The name of the user the signing certificate is for. This parameter allows
(through its regex pattern) a string of characters consisting of upper and lowercase
alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function upload_signing_certificate(
CertificateBody; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UploadSigningCertificate",
Dict{String,Any}("CertificateBody" => CertificateBody);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upload_signing_certificate(
CertificateBody,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UploadSigningCertificate",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("CertificateBody" => CertificateBody), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
upload_sshpublic_key(sshpublic_key_body, user_name)
upload_sshpublic_key(sshpublic_key_body, user_name, params::Dict{String,<:Any})
Uploads an SSH public key and associates it with the specified IAM user. The SSH public key
uploaded by this operation can be used only for authenticating the associated IAM user to
an CodeCommit repository. For more information about using SSH keys to authenticate to an
CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User
Guide.
# Arguments
- `sshpublic_key_body`: The SSH public key. The public key must be encoded in ssh-rsa
format or PEM format. The minimum bit-length of the public key is 2048 bits. For example,
you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long. The regex
pattern used to validate this parameter is a string of characters consisting of the
following: Any printable ASCII character ranging from the space character (u0020) through
the end of the ASCII character range The printable characters in the Basic Latin and
Latin-1 Supplement character set (through u00FF) The special characters tab (u0009), line
feed (u000A), and carriage return (u000D)
- `user_name`: The name of the IAM user to associate the SSH public key with. This
parameter allows (through its regex pattern) a string of characters consisting of upper and
lowercase alphanumeric characters with no spaces. You can also include any of the following
characters: _+=,.@-
"""
function upload_sshpublic_key(
SSHPublicKeyBody, UserName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iam(
"UploadSSHPublicKey",
Dict{String,Any}("SSHPublicKeyBody" => SSHPublicKeyBody, "UserName" => UserName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function upload_sshpublic_key(
SSHPublicKeyBody,
UserName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iam(
"UploadSSHPublicKey",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"SSHPublicKeyBody" => SSHPublicKeyBody, "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 | 33566 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: identitystore
using AWS.Compat
using AWS.UUIDs
"""
create_group(identity_store_id)
create_group(identity_store_id, params::Dict{String,<:Any})
Creates a group within the specified identity store.
# Arguments
- `identity_store_id`: The globally unique identifier for the identity store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A string containing the description of the group.
- `"DisplayName"`: A string containing the name of the group. This value is commonly
displayed when the group is referenced. Administrator and AWSAdministrators are reserved
names and can't be used for users or groups.
"""
function create_group(IdentityStoreId; aws_config::AbstractAWSConfig=global_aws_config())
return identitystore(
"CreateGroup",
Dict{String,Any}("IdentityStoreId" => IdentityStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group(
IdentityStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"CreateGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("IdentityStoreId" => IdentityStoreId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group_membership(group_id, identity_store_id, member_id)
create_group_membership(group_id, identity_store_id, member_id, params::Dict{String,<:Any})
Creates a relationship between a member and a group. The following identifiers must be
specified: GroupId, IdentityStoreId, and MemberId.
# Arguments
- `group_id`: The identifier for a group in the identity store.
- `identity_store_id`: The globally unique identifier for the identity store.
- `member_id`: An object that contains the identifier of a group member. Setting the UserID
field to the specific identifier for a user indicates that the user is a member of the
group.
"""
function create_group_membership(
GroupId, IdentityStoreId, MemberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"CreateGroupMembership",
Dict{String,Any}(
"GroupId" => GroupId,
"IdentityStoreId" => IdentityStoreId,
"MemberId" => MemberId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group_membership(
GroupId,
IdentityStoreId,
MemberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"CreateGroupMembership",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupId" => GroupId,
"IdentityStoreId" => IdentityStoreId,
"MemberId" => MemberId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_user(identity_store_id)
create_user(identity_store_id, params::Dict{String,<:Any})
Creates a user within the specified identity store.
# Arguments
- `identity_store_id`: The globally unique identifier for the identity store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Addresses"`: A list of Address objects containing addresses associated with the user.
- `"DisplayName"`: A string containing the name of the user. This value is typically
formatted for display when the user is referenced. For example, \"John Doe.\"
- `"Emails"`: A list of Email objects containing email addresses associated with the user.
- `"Locale"`: A string containing the geographical region or location of the user.
- `"Name"`: An object containing the name of the user.
- `"NickName"`: A string containing an alternate name for the user.
- `"PhoneNumbers"`: A list of PhoneNumber objects containing phone numbers associated with
the user.
- `"PreferredLanguage"`: A string containing the preferred language of the user. For
example, \"American English\" or \"en-us.\"
- `"ProfileUrl"`: A string containing a URL that might be associated with the user.
- `"Timezone"`: A string containing the time zone of the user.
- `"Title"`: A string containing the title of the user. Possible values are left
unspecified. The value can vary based on your specific use case.
- `"UserName"`: A unique string used to identify the user. The length limit is 128
characters. This value can consist of letters, accented characters, symbols, numbers, and
punctuation. This value is specified at the time the user is created and stored as an
attribute of the user object in the identity store. Administrator and AWSAdministrators are
reserved names and can't be used for users or groups.
- `"UserType"`: A string indicating the type of user. Possible values are left unspecified.
The value can vary based on your specific use case.
"""
function create_user(IdentityStoreId; aws_config::AbstractAWSConfig=global_aws_config())
return identitystore(
"CreateUser",
Dict{String,Any}("IdentityStoreId" => IdentityStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_user(
IdentityStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"CreateUser",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("IdentityStoreId" => IdentityStoreId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group(group_id, identity_store_id)
delete_group(group_id, identity_store_id, params::Dict{String,<:Any})
Delete a group within an identity store given GroupId.
# Arguments
- `group_id`: The identifier for a group in the identity store.
- `identity_store_id`: The globally unique identifier for the identity store.
"""
function delete_group(
GroupId, IdentityStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"DeleteGroup",
Dict{String,Any}("GroupId" => GroupId, "IdentityStoreId" => IdentityStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group(
GroupId,
IdentityStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"DeleteGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupId" => GroupId, "IdentityStoreId" => IdentityStoreId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group_membership(identity_store_id, membership_id)
delete_group_membership(identity_store_id, membership_id, params::Dict{String,<:Any})
Delete a membership within a group given MembershipId.
# Arguments
- `identity_store_id`: The globally unique identifier for the identity store.
- `membership_id`: The identifier for a GroupMembership in an identity store.
"""
function delete_group_membership(
IdentityStoreId, MembershipId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"DeleteGroupMembership",
Dict{String,Any}(
"IdentityStoreId" => IdentityStoreId, "MembershipId" => MembershipId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group_membership(
IdentityStoreId,
MembershipId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"DeleteGroupMembership",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityStoreId" => IdentityStoreId, "MembershipId" => MembershipId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_user(identity_store_id, user_id)
delete_user(identity_store_id, user_id, params::Dict{String,<:Any})
Deletes a user within an identity store given UserId.
# Arguments
- `identity_store_id`: The globally unique identifier for the identity store.
- `user_id`: The identifier for a user in the identity store.
"""
function delete_user(
IdentityStoreId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"DeleteUser",
Dict{String,Any}("IdentityStoreId" => IdentityStoreId, "UserId" => UserId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_user(
IdentityStoreId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"DeleteUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IdentityStoreId" => IdentityStoreId, "UserId" => UserId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_group(group_id, identity_store_id)
describe_group(group_id, identity_store_id, params::Dict{String,<:Any})
Retrieves the group metadata and attributes from GroupId in an identity store. If you have
administrator access to a member account, you can use this API from the member account.
Read about member accounts in the Organizations User Guide.
# Arguments
- `group_id`: The identifier for a group in the identity store.
- `identity_store_id`: The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated
string that contains numbers and lower case letters. This value is generated at the time
that a new identity store is created.
"""
function describe_group(
GroupId, IdentityStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"DescribeGroup",
Dict{String,Any}("GroupId" => GroupId, "IdentityStoreId" => IdentityStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_group(
GroupId,
IdentityStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"DescribeGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupId" => GroupId, "IdentityStoreId" => IdentityStoreId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_group_membership(identity_store_id, membership_id)
describe_group_membership(identity_store_id, membership_id, params::Dict{String,<:Any})
Retrieves membership metadata and attributes from MembershipId in an identity store. If
you have administrator access to a member account, you can use this API from the member
account. Read about member accounts in the Organizations User Guide.
# Arguments
- `identity_store_id`: The globally unique identifier for the identity store.
- `membership_id`: The identifier for a GroupMembership in an identity store.
"""
function describe_group_membership(
IdentityStoreId, MembershipId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"DescribeGroupMembership",
Dict{String,Any}(
"IdentityStoreId" => IdentityStoreId, "MembershipId" => MembershipId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_group_membership(
IdentityStoreId,
MembershipId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"DescribeGroupMembership",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityStoreId" => IdentityStoreId, "MembershipId" => MembershipId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_user(identity_store_id, user_id)
describe_user(identity_store_id, user_id, params::Dict{String,<:Any})
Retrieves the user metadata and attributes from the UserId in an identity store. If you
have administrator access to a member account, you can use this API from the member
account. Read about member accounts in the Organizations User Guide.
# Arguments
- `identity_store_id`: The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated
string that contains numbers and lower case letters. This value is generated at the time
that a new identity store is created.
- `user_id`: The identifier for a user in the identity store.
"""
function describe_user(
IdentityStoreId, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"DescribeUser",
Dict{String,Any}("IdentityStoreId" => IdentityStoreId, "UserId" => UserId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_user(
IdentityStoreId,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"DescribeUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("IdentityStoreId" => IdentityStoreId, "UserId" => UserId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group_id(alternate_identifier, identity_store_id)
get_group_id(alternate_identifier, identity_store_id, params::Dict{String,<:Any})
Retrieves GroupId in an identity store. If you have administrator access to a member
account, you can use this API from the member account. Read about member accounts in the
Organizations User Guide.
# Arguments
- `alternate_identifier`: A unique identifier for a user or group that is not the primary
identifier. This value can be an identifier from an external identity provider (IdP) that
is associated with the user, the group, or a unique attribute. For the unique attribute,
the only valid path is displayName.
- `identity_store_id`: The globally unique identifier for the identity store.
"""
function get_group_id(
AlternateIdentifier, IdentityStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"GetGroupId",
Dict{String,Any}(
"AlternateIdentifier" => AlternateIdentifier,
"IdentityStoreId" => IdentityStoreId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group_id(
AlternateIdentifier,
IdentityStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"GetGroupId",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AlternateIdentifier" => AlternateIdentifier,
"IdentityStoreId" => IdentityStoreId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_group_membership_id(group_id, identity_store_id, member_id)
get_group_membership_id(group_id, identity_store_id, member_id, params::Dict{String,<:Any})
Retrieves the MembershipId in an identity store. If you have administrator access to a
member account, you can use this API from the member account. Read about member accounts in
the Organizations User Guide.
# Arguments
- `group_id`: The identifier for a group in the identity store.
- `identity_store_id`: The globally unique identifier for the identity store.
- `member_id`: An object that contains the identifier of a group member. Setting the UserID
field to the specific identifier for a user indicates that the user is a member of the
group.
"""
function get_group_membership_id(
GroupId, IdentityStoreId, MemberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"GetGroupMembershipId",
Dict{String,Any}(
"GroupId" => GroupId,
"IdentityStoreId" => IdentityStoreId,
"MemberId" => MemberId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_group_membership_id(
GroupId,
IdentityStoreId,
MemberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"GetGroupMembershipId",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupId" => GroupId,
"IdentityStoreId" => IdentityStoreId,
"MemberId" => MemberId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_user_id(alternate_identifier, identity_store_id)
get_user_id(alternate_identifier, identity_store_id, params::Dict{String,<:Any})
Retrieves the UserId in an identity store. If you have administrator access to a member
account, you can use this API from the member account. Read about member accounts in the
Organizations User Guide.
# Arguments
- `alternate_identifier`: A unique identifier for a user or group that is not the primary
identifier. This value can be an identifier from an external identity provider (IdP) that
is associated with the user, the group, or a unique attribute. For the unique attribute,
the only valid paths are userName and emails.value.
- `identity_store_id`: The globally unique identifier for the identity store.
"""
function get_user_id(
AlternateIdentifier, IdentityStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"GetUserId",
Dict{String,Any}(
"AlternateIdentifier" => AlternateIdentifier,
"IdentityStoreId" => IdentityStoreId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_user_id(
AlternateIdentifier,
IdentityStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"GetUserId",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AlternateIdentifier" => AlternateIdentifier,
"IdentityStoreId" => IdentityStoreId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
is_member_in_groups(group_ids, identity_store_id, member_id)
is_member_in_groups(group_ids, identity_store_id, member_id, params::Dict{String,<:Any})
Checks the user's membership in all requested groups and returns if the member exists in
all queried groups. If you have administrator access to a member account, you can use this
API from the member account. Read about member accounts in the Organizations User Guide.
# Arguments
- `group_ids`: A list of identifiers for groups in the identity store.
- `identity_store_id`: The globally unique identifier for the identity store.
- `member_id`: An object containing the identifier of a group member.
"""
function is_member_in_groups(
GroupIds, IdentityStoreId, MemberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"IsMemberInGroups",
Dict{String,Any}(
"GroupIds" => GroupIds,
"IdentityStoreId" => IdentityStoreId,
"MemberId" => MemberId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function is_member_in_groups(
GroupIds,
IdentityStoreId,
MemberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"IsMemberInGroups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupIds" => GroupIds,
"IdentityStoreId" => IdentityStoreId,
"MemberId" => MemberId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_group_memberships(group_id, identity_store_id)
list_group_memberships(group_id, identity_store_id, params::Dict{String,<:Any})
For the specified group in the specified identity store, returns the list of all
GroupMembership objects and returns results in paginated form. If you have administrator
access to a member account, you can use this API from the member account. Read about member
accounts in the Organizations User Guide.
# Arguments
- `group_id`: The identifier for a group in the identity store.
- `identity_store_id`: The globally unique identifier for the identity store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request. This parameter
is used in all List requests to specify how many results to return in one page.
- `"NextToken"`: The pagination token used for the ListUsers, ListGroups and
ListGroupMemberships API operations. This value is generated by the identity store service.
It is returned in the API response if the total results are more than the size of one page.
This token is also returned when it is used in the API request to search for the next page.
"""
function list_group_memberships(
GroupId, IdentityStoreId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"ListGroupMemberships",
Dict{String,Any}("GroupId" => GroupId, "IdentityStoreId" => IdentityStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_group_memberships(
GroupId,
IdentityStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"ListGroupMemberships",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupId" => GroupId, "IdentityStoreId" => IdentityStoreId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_group_memberships_for_member(identity_store_id, member_id)
list_group_memberships_for_member(identity_store_id, member_id, params::Dict{String,<:Any})
For the specified member in the specified identity store, returns the list of all
GroupMembership objects and returns results in paginated form. If you have administrator
access to a member account, you can use this API from the member account. Read about member
accounts in the Organizations User Guide.
# Arguments
- `identity_store_id`: The globally unique identifier for the identity store.
- `member_id`: An object that contains the identifier of a group member. Setting the UserID
field to the specific identifier for a user indicates that the user is a member of the
group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The maximum number of results to be returned per request. This parameter
is used in the ListUsers and ListGroups requests to specify how many results to return in
one page. The length limit is 50 characters.
- `"NextToken"`: The pagination token used for the ListUsers, ListGroups, and
ListGroupMemberships API operations. This value is generated by the identity store service.
It is returned in the API response if the total results are more than the size of one page.
This token is also returned when it is used in the API request to search for the next page.
"""
function list_group_memberships_for_member(
IdentityStoreId, MemberId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"ListGroupMembershipsForMember",
Dict{String,Any}("IdentityStoreId" => IdentityStoreId, "MemberId" => MemberId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_group_memberships_for_member(
IdentityStoreId,
MemberId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"ListGroupMembershipsForMember",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityStoreId" => IdentityStoreId, "MemberId" => MemberId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_groups(identity_store_id)
list_groups(identity_store_id, params::Dict{String,<:Any})
Lists all groups in the identity store. Returns a paginated list of complete Group objects.
Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the
GetGroupId API action. If you have administrator access to a member account, you can use
this API from the member account. Read about member accounts in the Organizations User
Guide.
# Arguments
- `identity_store_id`: The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated
string that contains numbers and lower case letters. This value is generated at the time
that a new identity store is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A list of Filter objects, which is used in the ListUsers and ListGroups
requests.
- `"MaxResults"`: The maximum number of results to be returned per request. This parameter
is used in the ListUsers and ListGroups requests to specify how many results to return in
one page. The length limit is 50 characters.
- `"NextToken"`: The pagination token used for the ListUsers and ListGroups API operations.
This value is generated by the identity store service. It is returned in the API response
if the total results are more than the size of one page. This token is also returned when
it is used in the API request to search for the next page.
"""
function list_groups(IdentityStoreId; aws_config::AbstractAWSConfig=global_aws_config())
return identitystore(
"ListGroups",
Dict{String,Any}("IdentityStoreId" => IdentityStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_groups(
IdentityStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"ListGroups",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("IdentityStoreId" => IdentityStoreId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_users(identity_store_id)
list_users(identity_store_id, params::Dict{String,<:Any})
Lists all users in the identity store. Returns a paginated list of complete User objects.
Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId
API action. If you have administrator access to a member account, you can use this API
from the member account. Read about member accounts in the Organizations User Guide.
# Arguments
- `identity_store_id`: The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated
string that contains numbers and lower case letters. This value is generated at the time
that a new identity store is created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Filters"`: A list of Filter objects, which is used in the ListUsers and ListGroups
requests.
- `"MaxResults"`: The maximum number of results to be returned per request. This parameter
is used in the ListUsers and ListGroups requests to specify how many results to return in
one page. The length limit is 50 characters.
- `"NextToken"`: The pagination token used for the ListUsers and ListGroups API operations.
This value is generated by the identity store service. It is returned in the API response
if the total results are more than the size of one page. This token is also returned when
it is used in the API request to search for the next page.
"""
function list_users(IdentityStoreId; aws_config::AbstractAWSConfig=global_aws_config())
return identitystore(
"ListUsers",
Dict{String,Any}("IdentityStoreId" => IdentityStoreId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_users(
IdentityStoreId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"ListUsers",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("IdentityStoreId" => IdentityStoreId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_group(group_id, identity_store_id, operations)
update_group(group_id, identity_store_id, operations, params::Dict{String,<:Any})
For the specified group in the specified identity store, updates the group metadata and
attributes.
# Arguments
- `group_id`: The identifier for a group in the identity store.
- `identity_store_id`: The globally unique identifier for the identity store.
- `operations`: A list of AttributeOperation objects to apply to the requested group. These
operations might add, replace, or remove an attribute.
"""
function update_group(
GroupId, IdentityStoreId, Operations; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"UpdateGroup",
Dict{String,Any}(
"GroupId" => GroupId,
"IdentityStoreId" => IdentityStoreId,
"Operations" => Operations,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_group(
GroupId,
IdentityStoreId,
Operations,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"UpdateGroup",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"GroupId" => GroupId,
"IdentityStoreId" => IdentityStoreId,
"Operations" => Operations,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_user(identity_store_id, operations, user_id)
update_user(identity_store_id, operations, user_id, params::Dict{String,<:Any})
For the specified user in the specified identity store, updates the user metadata and
attributes.
# Arguments
- `identity_store_id`: The globally unique identifier for the identity store.
- `operations`: A list of AttributeOperation objects to apply to the requested user. These
operations might add, replace, or remove an attribute.
- `user_id`: The identifier for a user in the identity store.
"""
function update_user(
IdentityStoreId, Operations, UserId; aws_config::AbstractAWSConfig=global_aws_config()
)
return identitystore(
"UpdateUser",
Dict{String,Any}(
"IdentityStoreId" => IdentityStoreId,
"Operations" => Operations,
"UserId" => UserId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_user(
IdentityStoreId,
Operations,
UserId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return identitystore(
"UpdateUser",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"IdentityStoreId" => IdentityStoreId,
"Operations" => Operations,
"UserId" => UserId,
),
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 | 128333 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: imagebuilder
using AWS.Compat
using AWS.UUIDs
"""
cancel_image_creation(client_token, image_build_version_arn)
cancel_image_creation(client_token, image_build_version_arn, params::Dict{String,<:Any})
CancelImageCreation cancels the creation of Image. This operation can only be used on
images in a non-terminal state.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `image_build_version_arn`: The Amazon Resource Name (ARN) of the image that you want to
cancel creation for.
"""
function cancel_image_creation(
clientToken, imageBuildVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"PUT",
"/CancelImageCreation",
Dict{String,Any}(
"clientToken" => clientToken, "imageBuildVersionArn" => imageBuildVersionArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_image_creation(
clientToken,
imageBuildVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CancelImageCreation",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"imageBuildVersionArn" => imageBuildVersionArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_lifecycle_execution(client_token, lifecycle_execution_id)
cancel_lifecycle_execution(client_token, lifecycle_execution_id, params::Dict{String,<:Any})
Cancel a specific image lifecycle policy runtime instance.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `lifecycle_execution_id`: Identifies the specific runtime instance of the image lifecycle
to cancel.
"""
function cancel_lifecycle_execution(
clientToken, lifecycleExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"PUT",
"/CancelLifecycleExecution",
Dict{String,Any}(
"clientToken" => clientToken, "lifecycleExecutionId" => lifecycleExecutionId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_lifecycle_execution(
clientToken,
lifecycleExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CancelLifecycleExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"lifecycleExecutionId" => lifecycleExecutionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_component(client_token, name, platform, semantic_version)
create_component(client_token, name, platform, semantic_version, params::Dict{String,<:Any})
Creates a new component that can be used to build, validate, test, and assess your image.
The component is based on a YAML document that you specify using exactly one of the
following methods: Inline, using the data property in the request body. A URL that
points to a YAML document file stored in Amazon S3, using the uri property in the request
body.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `name`: The name of the component.
- `platform`: The operating system platform of the component.
- `semantic_version`: The semantic version of the component. This version follows the
semantic version syntax. The semantic version has four nodes:
<major>.<minor>.<patch>/<build>. You can assign values for the
first three, and can filter on all of them. Assignment: For the first three nodes you can
assign any positive integer value, including zero, with an upper limit of 2^30-1, or
1073741823 for each node. Image Builder automatically assigns the build number to the
fourth node. Patterns: You can use any numeric pattern that adheres to the assignment
requirements for the nodes that you can assign. For example, you might choose a software
version pattern, such as 1.0.0, or a date, such as 2021.01.01.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"changeDescription"`: The change description of the component. Describes what change has
been made in this version, or what makes this version different from other versions of the
component.
- `"data"`: Component data contains inline YAML document content for the component.
Alternatively, you can specify the uri of a YAML document file stored in Amazon S3.
However, you cannot specify both properties.
- `"description"`: Describes the contents of the component.
- `"kmsKeyId"`: The ID of the KMS key that is used to encrypt this component.
- `"supportedOsVersions"`: The operating system (OS) version supported by the component. If
the OS information is available, a prefix match is performed against the base image OS
version during image recipe creation.
- `"tags"`: The tags that apply to the component.
- `"uri"`: The uri of a YAML component document file. This must be an S3 URL
(s3://bucket/key), and the requester must have permission to access the S3 bucket it points
to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data property.
You cannot specify both properties.
"""
function create_component(
clientToken,
name,
platform,
semanticVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateComponent",
Dict{String,Any}(
"clientToken" => clientToken,
"name" => name,
"platform" => platform,
"semanticVersion" => semanticVersion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_component(
clientToken,
name,
platform,
semanticVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"name" => name,
"platform" => platform,
"semanticVersion" => semanticVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_container_recipe(client_token, components, container_type, name, parent_image, semantic_version, target_repository)
create_container_recipe(client_token, components, container_type, name, parent_image, semantic_version, target_repository, params::Dict{String,<:Any})
Creates a new container recipe. Container recipes define how images are configured, tested,
and assessed.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `components`: Components for build and test that are included in the container recipe.
Recipes require a minimum of one build component, and can have a maximum of 20 build and
test components in any combination.
- `container_type`: The type of container to create.
- `name`: The name of the container recipe.
- `parent_image`: The base image for the container recipe.
- `semantic_version`: The semantic version of the container recipe. This version follows
the semantic version syntax. The semantic version has four nodes:
<major>.<minor>.<patch>/<build>. You can assign values for the
first three, and can filter on all of them. Assignment: For the first three nodes you can
assign any positive integer value, including zero, with an upper limit of 2^30-1, or
1073741823 for each node. Image Builder automatically assigns the build number to the
fourth node. Patterns: You can use any numeric pattern that adheres to the assignment
requirements for the nodes that you can assign. For example, you might choose a software
version pattern, such as 1.0.0, or a date, such as 2021.01.01.
- `target_repository`: The destination repository for the container image.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the container recipe.
- `"dockerfileTemplateData"`: The Dockerfile template used to build your image as an inline
data blob.
- `"dockerfileTemplateUri"`: The Amazon S3 URI for the Dockerfile that will be used to
build your container image.
- `"imageOsVersionOverride"`: Specifies the operating system version for the base image.
- `"instanceConfiguration"`: A group of options that can be used to configure an instance
for building and testing container images.
- `"kmsKeyId"`: Identifies which KMS key is used to encrypt the container image.
- `"platformOverride"`: Specifies the operating system platform when you use a custom base
image.
- `"tags"`: Tags that are attached to the container recipe.
- `"workingDirectory"`: The working directory for use during build and test workflows.
"""
function create_container_recipe(
clientToken,
components,
containerType,
name,
parentImage,
semanticVersion,
targetRepository;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateContainerRecipe",
Dict{String,Any}(
"clientToken" => clientToken,
"components" => components,
"containerType" => containerType,
"name" => name,
"parentImage" => parentImage,
"semanticVersion" => semanticVersion,
"targetRepository" => targetRepository,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_container_recipe(
clientToken,
components,
containerType,
name,
parentImage,
semanticVersion,
targetRepository,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateContainerRecipe",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"components" => components,
"containerType" => containerType,
"name" => name,
"parentImage" => parentImage,
"semanticVersion" => semanticVersion,
"targetRepository" => targetRepository,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_distribution_configuration(client_token, distributions, name)
create_distribution_configuration(client_token, distributions, name, params::Dict{String,<:Any})
Creates a new distribution configuration. Distribution configurations define and configure
the outputs of your pipeline.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `distributions`: The distributions of the distribution configuration.
- `name`: The name of the distribution configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the distribution configuration.
- `"tags"`: The tags of the distribution configuration.
"""
function create_distribution_configuration(
clientToken, distributions, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"PUT",
"/CreateDistributionConfiguration",
Dict{String,Any}(
"clientToken" => clientToken, "distributions" => distributions, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_distribution_configuration(
clientToken,
distributions,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateDistributionConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"distributions" => distributions,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_image(client_token, infrastructure_configuration_arn)
create_image(client_token, infrastructure_configuration_arn, params::Dict{String,<:Any})
Creates a new image. This request will create a new image along with all of the configured
output resources defined in the distribution configuration. You must specify exactly one
recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `infrastructure_configuration_arn`: The Amazon Resource Name (ARN) of the infrastructure
configuration that defines the environment in which your image will be built and tested.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"containerRecipeArn"`: The Amazon Resource Name (ARN) of the container recipe that
defines how images are configured and tested.
- `"distributionConfigurationArn"`: The Amazon Resource Name (ARN) of the distribution
configuration that defines and configures the outputs of your pipeline.
- `"enhancedImageMetadataEnabled"`: Collects additional information about the image being
created, including the operating system (OS) version and package list. This information is
used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
- `"executionRole"`: The name or Amazon Resource Name (ARN) for the IAM role you create
that grants Image Builder access to perform workflow actions.
- `"imageRecipeArn"`: The Amazon Resource Name (ARN) of the image recipe that defines how
images are configured, tested, and assessed.
- `"imageScanningConfiguration"`: Contains settings for vulnerability scans.
- `"imageTestsConfiguration"`: The image tests configuration of the image.
- `"tags"`: The tags of the image.
- `"workflows"`: Contains an array of workflow configuration objects.
"""
function create_image(
clientToken,
infrastructureConfigurationArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateImage",
Dict{String,Any}(
"clientToken" => clientToken,
"infrastructureConfigurationArn" => infrastructureConfigurationArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_image(
clientToken,
infrastructureConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"infrastructureConfigurationArn" => infrastructureConfigurationArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_image_pipeline(client_token, infrastructure_configuration_arn, name)
create_image_pipeline(client_token, infrastructure_configuration_arn, name, params::Dict{String,<:Any})
Creates a new image pipeline. Image pipelines enable you to automate the creation and
distribution of images.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `infrastructure_configuration_arn`: The Amazon Resource Name (ARN) of the infrastructure
configuration that will be used to build images created by this image pipeline.
- `name`: The name of the image pipeline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"containerRecipeArn"`: The Amazon Resource Name (ARN) of the container recipe that is
used to configure images created by this container pipeline.
- `"description"`: The description of the image pipeline.
- `"distributionConfigurationArn"`: The Amazon Resource Name (ARN) of the distribution
configuration that will be used to configure and distribute images created by this image
pipeline.
- `"enhancedImageMetadataEnabled"`: Collects additional information about the image being
created, including the operating system (OS) version and package list. This information is
used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
- `"executionRole"`: The name or Amazon Resource Name (ARN) for the IAM role you create
that grants Image Builder access to perform workflow actions.
- `"imageRecipeArn"`: The Amazon Resource Name (ARN) of the image recipe that will be used
to configure images created by this image pipeline.
- `"imageScanningConfiguration"`: Contains settings for vulnerability scans.
- `"imageTestsConfiguration"`: The image test configuration of the image pipeline.
- `"schedule"`: The schedule of the image pipeline.
- `"status"`: The status of the image pipeline.
- `"tags"`: The tags of the image pipeline.
- `"workflows"`: Contains an array of workflow configuration objects.
"""
function create_image_pipeline(
clientToken,
infrastructureConfigurationArn,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateImagePipeline",
Dict{String,Any}(
"clientToken" => clientToken,
"infrastructureConfigurationArn" => infrastructureConfigurationArn,
"name" => name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_image_pipeline(
clientToken,
infrastructureConfigurationArn,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateImagePipeline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"infrastructureConfigurationArn" => infrastructureConfigurationArn,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_image_recipe(client_token, components, name, parent_image, semantic_version)
create_image_recipe(client_token, components, name, parent_image, semantic_version, params::Dict{String,<:Any})
Creates a new image recipe. Image recipes define how images are configured, tested, and
assessed.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `components`: The components included in the image recipe.
- `name`: The name of the image recipe.
- `parent_image`: The base image of the image recipe. The value of the string can be the
ARN of the base image or an AMI ID. The format for the ARN follows this example:
arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x.
You can provide the specific version that you want to use, or you can use a wildcard in all
of the fields. If you enter an AMI ID for the string value, you must have access to the
AMI, and the AMI must be in the same Region in which you are using Image Builder.
- `semantic_version`: The semantic version of the image recipe. This version follows the
semantic version syntax. The semantic version has four nodes:
<major>.<minor>.<patch>/<build>. You can assign values for the
first three, and can filter on all of them. Assignment: For the first three nodes you can
assign any positive integer value, including zero, with an upper limit of 2^30-1, or
1073741823 for each node. Image Builder automatically assigns the build number to the
fourth node. Patterns: You can use any numeric pattern that adheres to the assignment
requirements for the nodes that you can assign. For example, you might choose a software
version pattern, such as 1.0.0, or a date, such as 2021.01.01.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalInstanceConfiguration"`: Specify additional settings and launch scripts for
your build instances.
- `"blockDeviceMappings"`: The block device mappings of the image recipe.
- `"description"`: The description of the image recipe.
- `"tags"`: The tags of the image recipe.
- `"workingDirectory"`: The working directory used during build and test workflows.
"""
function create_image_recipe(
clientToken,
components,
name,
parentImage,
semanticVersion;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateImageRecipe",
Dict{String,Any}(
"clientToken" => clientToken,
"components" => components,
"name" => name,
"parentImage" => parentImage,
"semanticVersion" => semanticVersion,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_image_recipe(
clientToken,
components,
name,
parentImage,
semanticVersion,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateImageRecipe",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"components" => components,
"name" => name,
"parentImage" => parentImage,
"semanticVersion" => semanticVersion,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_infrastructure_configuration(client_token, instance_profile_name, name)
create_infrastructure_configuration(client_token, instance_profile_name, name, params::Dict{String,<:Any})
Creates a new infrastructure configuration. An infrastructure configuration defines the
environment in which your image will be built and tested.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `instance_profile_name`: The instance profile to associate with the instance used to
customize your Amazon EC2 AMI.
- `name`: The name of the infrastructure configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the infrastructure configuration.
- `"instanceMetadataOptions"`: The instance metadata options that you can set for the HTTP
requests that pipeline builds use to launch EC2 build and test instances.
- `"instanceTypes"`: The instance types of the infrastructure configuration. You can
specify one or more instance types to use for this build. The service will pick one of
these instance types based on availability.
- `"keyPair"`: The key pair of the infrastructure configuration. You can use this to log on
to and debug the instance used to create your image.
- `"logging"`: The logging configuration of the infrastructure configuration.
- `"resourceTags"`: The tags attached to the resource created by Image Builder.
- `"securityGroupIds"`: The security group IDs to associate with the instance used to
customize your Amazon EC2 AMI.
- `"snsTopicArn"`: The Amazon Resource Name (ARN) for the SNS topic to which we send image
build event notifications. EC2 Image Builder is unable to send notifications to SNS topics
that are encrypted using keys from other accounts. The key that is used to encrypt the SNS
topic must reside in the account that the Image Builder service runs under.
- `"subnetId"`: The subnet ID in which to place the instance used to customize your Amazon
EC2 AMI.
- `"tags"`: The tags of the infrastructure configuration.
- `"terminateInstanceOnFailure"`: The terminate instance on failure setting of the
infrastructure configuration. Set to false if you want Image Builder to retain the instance
used to configure your AMI if the build or test phase of your workflow fails.
"""
function create_infrastructure_configuration(
clientToken,
instanceProfileName,
name;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateInfrastructureConfiguration",
Dict{String,Any}(
"clientToken" => clientToken,
"instanceProfileName" => instanceProfileName,
"name" => name,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_infrastructure_configuration(
clientToken,
instanceProfileName,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateInfrastructureConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"instanceProfileName" => instanceProfileName,
"name" => name,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_lifecycle_policy(client_token, execution_role, name, policy_details, resource_selection, resource_type)
create_lifecycle_policy(client_token, execution_role, name, policy_details, resource_selection, resource_type, params::Dict{String,<:Any})
Create a lifecycle policy resource.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `execution_role`: The name or Amazon Resource Name (ARN) for the IAM role you create that
grants Image Builder access to run lifecycle actions.
- `name`: The name of the lifecycle policy to create.
- `policy_details`: Configuration details for the lifecycle policy rules.
- `resource_selection`: Selection criteria for the resources that the lifecycle policy
applies to.
- `resource_type`: The type of Image Builder resource that the lifecycle policy applies to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: Optional description for the lifecycle policy.
- `"status"`: Indicates whether the lifecycle policy resource is enabled.
- `"tags"`: Tags to apply to the lifecycle policy resource.
"""
function create_lifecycle_policy(
clientToken,
executionRole,
name,
policyDetails,
resourceSelection,
resourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateLifecyclePolicy",
Dict{String,Any}(
"clientToken" => clientToken,
"executionRole" => executionRole,
"name" => name,
"policyDetails" => policyDetails,
"resourceSelection" => resourceSelection,
"resourceType" => resourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_lifecycle_policy(
clientToken,
executionRole,
name,
policyDetails,
resourceSelection,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateLifecyclePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"executionRole" => executionRole,
"name" => name,
"policyDetails" => policyDetails,
"resourceSelection" => resourceSelection,
"resourceType" => resourceType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_workflow(client_token, name, semantic_version, type)
create_workflow(client_token, name, semantic_version, type, params::Dict{String,<:Any})
Create a new workflow or a new version of an existing workflow.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `name`: The name of the workflow to create.
- `semantic_version`: The semantic version of this workflow resource. The semantic version
syntax adheres to the following rules. The semantic version has four nodes:
<major>.<minor>.<patch>/<build>. You can assign values for the
first three, and can filter on all of them. Assignment: For the first three nodes you can
assign any positive integer value, including zero, with an upper limit of 2^30-1, or
1073741823 for each node. Image Builder automatically assigns the build number to the
fourth node. Patterns: You can use any numeric pattern that adheres to the assignment
requirements for the nodes that you can assign. For example, you might choose a software
version pattern, such as 1.0.0, or a date, such as 2021.01.01.
- `type`: The phase in the image build process for which the workflow resource is
responsible.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"changeDescription"`: Describes what change has been made in this version of the
workflow, or what makes this version different from other versions of the workflow.
- `"data"`: Contains the UTF-8 encoded YAML document content for the workflow.
Alternatively, you can specify the uri of a YAML document file stored in Amazon S3.
However, you cannot specify both properties.
- `"description"`: Describes the workflow.
- `"kmsKeyId"`: The ID of the KMS key that is used to encrypt this workflow resource.
- `"tags"`: Tags that apply to the workflow resource.
- `"uri"`: The uri of a YAML component document file. This must be an S3 URL
(s3://bucket/key), and the requester must have permission to access the S3 bucket it points
to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data property.
You cannot specify both properties.
"""
function create_workflow(
clientToken,
name,
semanticVersion,
type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateWorkflow",
Dict{String,Any}(
"clientToken" => clientToken,
"name" => name,
"semanticVersion" => semanticVersion,
"type" => type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_workflow(
clientToken,
name,
semanticVersion,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/CreateWorkflow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"name" => name,
"semanticVersion" => semanticVersion,
"type" => type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_component(component_build_version_arn)
delete_component(component_build_version_arn, params::Dict{String,<:Any})
Deletes a component build version.
# Arguments
- `component_build_version_arn`: The Amazon Resource Name (ARN) of the component build
version to delete.
"""
function delete_component(
componentBuildVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"DELETE",
"/DeleteComponent",
Dict{String,Any}("componentBuildVersionArn" => componentBuildVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_component(
componentBuildVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"DELETE",
"/DeleteComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("componentBuildVersionArn" => componentBuildVersionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_container_recipe(container_recipe_arn)
delete_container_recipe(container_recipe_arn, params::Dict{String,<:Any})
Deletes a container recipe.
# Arguments
- `container_recipe_arn`: The Amazon Resource Name (ARN) of the container recipe to delete.
"""
function delete_container_recipe(
containerRecipeArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"DELETE",
"/DeleteContainerRecipe",
Dict{String,Any}("containerRecipeArn" => containerRecipeArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_container_recipe(
containerRecipeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"DELETE",
"/DeleteContainerRecipe",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("containerRecipeArn" => containerRecipeArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_distribution_configuration(distribution_configuration_arn)
delete_distribution_configuration(distribution_configuration_arn, params::Dict{String,<:Any})
Deletes a distribution configuration.
# Arguments
- `distribution_configuration_arn`: The Amazon Resource Name (ARN) of the distribution
configuration to delete.
"""
function delete_distribution_configuration(
distributionConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"DELETE",
"/DeleteDistributionConfiguration",
Dict{String,Any}("distributionConfigurationArn" => distributionConfigurationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_distribution_configuration(
distributionConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"DELETE",
"/DeleteDistributionConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"distributionConfigurationArn" => distributionConfigurationArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_image(image_build_version_arn)
delete_image(image_build_version_arn, params::Dict{String,<:Any})
Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container
images that are created during the image build process. You must clean those up separately,
using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.
To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide
. To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2
Windows Guide . To delete a container image from Amazon ECR, see Deleting an image in the
Amazon ECR User Guide.
# Arguments
- `image_build_version_arn`: The Amazon Resource Name (ARN) of the Image Builder image
resource to delete.
"""
function delete_image(
imageBuildVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"DELETE",
"/DeleteImage",
Dict{String,Any}("imageBuildVersionArn" => imageBuildVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_image(
imageBuildVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"DELETE",
"/DeleteImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("imageBuildVersionArn" => imageBuildVersionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_image_pipeline(image_pipeline_arn)
delete_image_pipeline(image_pipeline_arn, params::Dict{String,<:Any})
Deletes an image pipeline.
# Arguments
- `image_pipeline_arn`: The Amazon Resource Name (ARN) of the image pipeline to delete.
"""
function delete_image_pipeline(
imagePipelineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"DELETE",
"/DeleteImagePipeline",
Dict{String,Any}("imagePipelineArn" => imagePipelineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_image_pipeline(
imagePipelineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"DELETE",
"/DeleteImagePipeline",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("imagePipelineArn" => imagePipelineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_image_recipe(image_recipe_arn)
delete_image_recipe(image_recipe_arn, params::Dict{String,<:Any})
Deletes an image recipe.
# Arguments
- `image_recipe_arn`: The Amazon Resource Name (ARN) of the image recipe to delete.
"""
function delete_image_recipe(
imageRecipeArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"DELETE",
"/DeleteImageRecipe",
Dict{String,Any}("imageRecipeArn" => imageRecipeArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_image_recipe(
imageRecipeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"DELETE",
"/DeleteImageRecipe",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("imageRecipeArn" => imageRecipeArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_infrastructure_configuration(infrastructure_configuration_arn)
delete_infrastructure_configuration(infrastructure_configuration_arn, params::Dict{String,<:Any})
Deletes an infrastructure configuration.
# Arguments
- `infrastructure_configuration_arn`: The Amazon Resource Name (ARN) of the infrastructure
configuration to delete.
"""
function delete_infrastructure_configuration(
infrastructureConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"DELETE",
"/DeleteInfrastructureConfiguration",
Dict{String,Any}(
"infrastructureConfigurationArn" => infrastructureConfigurationArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_infrastructure_configuration(
infrastructureConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"DELETE",
"/DeleteInfrastructureConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"infrastructureConfigurationArn" => infrastructureConfigurationArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_lifecycle_policy(lifecycle_policy_arn)
delete_lifecycle_policy(lifecycle_policy_arn, params::Dict{String,<:Any})
Delete the specified lifecycle policy resource.
# Arguments
- `lifecycle_policy_arn`: The Amazon Resource Name (ARN) of the lifecycle policy resource
to delete.
"""
function delete_lifecycle_policy(
lifecyclePolicyArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"DELETE",
"/DeleteLifecyclePolicy",
Dict{String,Any}("lifecyclePolicyArn" => lifecyclePolicyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_lifecycle_policy(
lifecyclePolicyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"DELETE",
"/DeleteLifecyclePolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("lifecyclePolicyArn" => lifecyclePolicyArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_workflow(workflow_build_version_arn)
delete_workflow(workflow_build_version_arn, params::Dict{String,<:Any})
Deletes a specific workflow resource.
# Arguments
- `workflow_build_version_arn`: The Amazon Resource Name (ARN) of the workflow resource to
delete.
"""
function delete_workflow(
workflowBuildVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"DELETE",
"/DeleteWorkflow",
Dict{String,Any}("workflowBuildVersionArn" => workflowBuildVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_workflow(
workflowBuildVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"DELETE",
"/DeleteWorkflow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("workflowBuildVersionArn" => workflowBuildVersionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_component(component_build_version_arn)
get_component(component_build_version_arn, params::Dict{String,<:Any})
Gets a component object.
# Arguments
- `component_build_version_arn`: The Amazon Resource Name (ARN) of the component that you
want to get. Regex requires the suffix /d+.
"""
function get_component(
componentBuildVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetComponent",
Dict{String,Any}("componentBuildVersionArn" => componentBuildVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_component(
componentBuildVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("componentBuildVersionArn" => componentBuildVersionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_component_policy(component_arn)
get_component_policy(component_arn, params::Dict{String,<:Any})
Gets a component policy.
# Arguments
- `component_arn`: The Amazon Resource Name (ARN) of the component whose policy you want to
retrieve.
"""
function get_component_policy(
componentArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetComponentPolicy",
Dict{String,Any}("componentArn" => componentArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_component_policy(
componentArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetComponentPolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("componentArn" => componentArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_container_recipe(container_recipe_arn)
get_container_recipe(container_recipe_arn, params::Dict{String,<:Any})
Retrieves a container recipe.
# Arguments
- `container_recipe_arn`: The Amazon Resource Name (ARN) of the container recipe to
retrieve.
"""
function get_container_recipe(
containerRecipeArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetContainerRecipe",
Dict{String,Any}("containerRecipeArn" => containerRecipeArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_container_recipe(
containerRecipeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetContainerRecipe",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("containerRecipeArn" => containerRecipeArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_container_recipe_policy(container_recipe_arn)
get_container_recipe_policy(container_recipe_arn, params::Dict{String,<:Any})
Retrieves the policy for a container recipe.
# Arguments
- `container_recipe_arn`: The Amazon Resource Name (ARN) of the container recipe for the
policy being requested.
"""
function get_container_recipe_policy(
containerRecipeArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetContainerRecipePolicy",
Dict{String,Any}("containerRecipeArn" => containerRecipeArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_container_recipe_policy(
containerRecipeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetContainerRecipePolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("containerRecipeArn" => containerRecipeArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_distribution_configuration(distribution_configuration_arn)
get_distribution_configuration(distribution_configuration_arn, params::Dict{String,<:Any})
Gets a distribution configuration.
# Arguments
- `distribution_configuration_arn`: The Amazon Resource Name (ARN) of the distribution
configuration that you want to retrieve.
"""
function get_distribution_configuration(
distributionConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetDistributionConfiguration",
Dict{String,Any}("distributionConfigurationArn" => distributionConfigurationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_distribution_configuration(
distributionConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetDistributionConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"distributionConfigurationArn" => distributionConfigurationArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_image(image_build_version_arn)
get_image(image_build_version_arn, params::Dict{String,<:Any})
Gets an image.
# Arguments
- `image_build_version_arn`: The Amazon Resource Name (ARN) of the image that you want to
get.
"""
function get_image(imageBuildVersionArn; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"GET",
"/GetImage",
Dict{String,Any}("imageBuildVersionArn" => imageBuildVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_image(
imageBuildVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("imageBuildVersionArn" => imageBuildVersionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_image_pipeline(image_pipeline_arn)
get_image_pipeline(image_pipeline_arn, params::Dict{String,<:Any})
Gets an image pipeline.
# Arguments
- `image_pipeline_arn`: The Amazon Resource Name (ARN) of the image pipeline that you want
to retrieve.
"""
function get_image_pipeline(
imagePipelineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetImagePipeline",
Dict{String,Any}("imagePipelineArn" => imagePipelineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_image_pipeline(
imagePipelineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetImagePipeline",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("imagePipelineArn" => imagePipelineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_image_policy(image_arn)
get_image_policy(image_arn, params::Dict{String,<:Any})
Gets an image policy.
# Arguments
- `image_arn`: The Amazon Resource Name (ARN) of the image whose policy you want to
retrieve.
"""
function get_image_policy(imageArn; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"GET",
"/GetImagePolicy",
Dict{String,Any}("imageArn" => imageArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_image_policy(
imageArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetImagePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("imageArn" => imageArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_image_recipe(image_recipe_arn)
get_image_recipe(image_recipe_arn, params::Dict{String,<:Any})
Gets an image recipe.
# Arguments
- `image_recipe_arn`: The Amazon Resource Name (ARN) of the image recipe that you want to
retrieve.
"""
function get_image_recipe(imageRecipeArn; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"GET",
"/GetImageRecipe",
Dict{String,Any}("imageRecipeArn" => imageRecipeArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_image_recipe(
imageRecipeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetImageRecipe",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("imageRecipeArn" => imageRecipeArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_image_recipe_policy(image_recipe_arn)
get_image_recipe_policy(image_recipe_arn, params::Dict{String,<:Any})
Gets an image recipe policy.
# Arguments
- `image_recipe_arn`: The Amazon Resource Name (ARN) of the image recipe whose policy you
want to retrieve.
"""
function get_image_recipe_policy(
imageRecipeArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetImageRecipePolicy",
Dict{String,Any}("imageRecipeArn" => imageRecipeArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_image_recipe_policy(
imageRecipeArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetImageRecipePolicy",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("imageRecipeArn" => imageRecipeArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_infrastructure_configuration(infrastructure_configuration_arn)
get_infrastructure_configuration(infrastructure_configuration_arn, params::Dict{String,<:Any})
Gets an infrastructure configuration.
# Arguments
- `infrastructure_configuration_arn`: The Amazon Resource Name (ARN) of the infrastructure
configuration that you want to retrieve.
"""
function get_infrastructure_configuration(
infrastructureConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetInfrastructureConfiguration",
Dict{String,Any}(
"infrastructureConfigurationArn" => infrastructureConfigurationArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_infrastructure_configuration(
infrastructureConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetInfrastructureConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"infrastructureConfigurationArn" => infrastructureConfigurationArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lifecycle_execution(lifecycle_execution_id)
get_lifecycle_execution(lifecycle_execution_id, params::Dict{String,<:Any})
Get the runtime information that was logged for a specific runtime instance of the
lifecycle policy.
# Arguments
- `lifecycle_execution_id`: Use the unique identifier for a runtime instance of the
lifecycle policy to get runtime details.
"""
function get_lifecycle_execution(
lifecycleExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetLifecycleExecution",
Dict{String,Any}("lifecycleExecutionId" => lifecycleExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lifecycle_execution(
lifecycleExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetLifecycleExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("lifecycleExecutionId" => lifecycleExecutionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_lifecycle_policy(lifecycle_policy_arn)
get_lifecycle_policy(lifecycle_policy_arn, params::Dict{String,<:Any})
Get details for the specified image lifecycle policy.
# Arguments
- `lifecycle_policy_arn`: Specifies the Amazon Resource Name (ARN) of the image lifecycle
policy resource to get.
"""
function get_lifecycle_policy(
lifecyclePolicyArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetLifecyclePolicy",
Dict{String,Any}("lifecyclePolicyArn" => lifecyclePolicyArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_lifecycle_policy(
lifecyclePolicyArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetLifecyclePolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("lifecyclePolicyArn" => lifecyclePolicyArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow(workflow_build_version_arn)
get_workflow(workflow_build_version_arn, params::Dict{String,<:Any})
Get a workflow resource object.
# Arguments
- `workflow_build_version_arn`: The Amazon Resource Name (ARN) of the workflow resource
that you want to get.
"""
function get_workflow(
workflowBuildVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetWorkflow",
Dict{String,Any}("workflowBuildVersionArn" => workflowBuildVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow(
workflowBuildVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetWorkflow",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("workflowBuildVersionArn" => workflowBuildVersionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow_execution(workflow_execution_id)
get_workflow_execution(workflow_execution_id, params::Dict{String,<:Any})
Get the runtime information that was logged for a specific runtime instance of the workflow.
# Arguments
- `workflow_execution_id`: Use the unique identifier for a runtime instance of the workflow
to get runtime details.
"""
function get_workflow_execution(
workflowExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetWorkflowExecution",
Dict{String,Any}("workflowExecutionId" => workflowExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow_execution(
workflowExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetWorkflowExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("workflowExecutionId" => workflowExecutionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_workflow_step_execution(step_execution_id)
get_workflow_step_execution(step_execution_id, params::Dict{String,<:Any})
Get the runtime information that was logged for a specific runtime instance of the workflow
step.
# Arguments
- `step_execution_id`: Use the unique identifier for a specific runtime instance of the
workflow step to get runtime details for that step.
"""
function get_workflow_step_execution(
stepExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"GET",
"/GetWorkflowStepExecution",
Dict{String,Any}("stepExecutionId" => stepExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_workflow_step_execution(
stepExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"GET",
"/GetWorkflowStepExecution",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("stepExecutionId" => stepExecutionId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_component(client_token, format, name, platform, semantic_version, type)
import_component(client_token, format, name, platform, semantic_version, type, params::Dict{String,<:Any})
Imports a component and transforms its data into a component document.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `format`: The format of the resource that you want to import as a component.
- `name`: The name of the component.
- `platform`: The platform of the component.
- `semantic_version`: The semantic version of the component. This version follows the
semantic version syntax. The semantic version has four nodes:
<major>.<minor>.<patch>/<build>. You can assign values for the
first three, and can filter on all of them. Filtering: With semantic versioning, you have
the flexibility to use wildcards (x) to specify the most recent versions or nodes when
selecting the base image or components for your recipe. When you use a wildcard in any
node, all nodes to the right of the first wildcard must also be wildcards.
- `type`: The type of the component denotes whether the component is used to build the
image, or only to test it.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"changeDescription"`: The change description of the component. This description
indicates the change that has been made in this version, or what makes this version
different from other versions of the component.
- `"data"`: The data of the component. Used to specify the data inline. Either data or uri
can be used to specify the data within the component.
- `"description"`: The description of the component. Describes the contents of the
component.
- `"kmsKeyId"`: The ID of the KMS key that should be used to encrypt this component.
- `"tags"`: The tags of the component.
- `"uri"`: The uri of the component. Must be an Amazon S3 URL and the requester must have
permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component
content up to your service quota. Either data or uri can be used to specify the data within
the component.
"""
function import_component(
clientToken,
format,
name,
platform,
semanticVersion,
type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/ImportComponent",
Dict{String,Any}(
"clientToken" => clientToken,
"format" => format,
"name" => name,
"platform" => platform,
"semanticVersion" => semanticVersion,
"type" => type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_component(
clientToken,
format,
name,
platform,
semanticVersion,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/ImportComponent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"format" => format,
"name" => name,
"platform" => platform,
"semanticVersion" => semanticVersion,
"type" => type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
import_vm_image(client_token, name, platform, semantic_version, vm_import_task_id)
import_vm_image(client_token, name, platform, semantic_version, vm_import_task_id, params::Dict{String,<:Any})
When you export your virtual machine (VM) from its virtualization environment, that process
creates a set of one or more disk container files that act as snapshots of your VM’s
environment, settings, and data. The Amazon EC2 API ImportImage action uses those files to
import your VM and create an AMI. To import using the CLI command, see import-image You
can reference the task ID from the VM import to pull in the AMI that the import created as
the base image for your Image Builder recipe.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `name`: The name of the base image that is created by the import process.
- `platform`: The operating system platform for the imported VM.
- `semantic_version`: The semantic version to attach to the base image that was created
during the import process. This version follows the semantic version syntax. The semantic
version has four nodes: <major>.<minor>.<patch>/<build>. You can
assign values for the first three, and can filter on all of them. Assignment: For the
first three nodes you can assign any positive integer value, including zero, with an upper
limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build
number to the fourth node. Patterns: You can use any numeric pattern that adheres to the
assignment requirements for the nodes that you can assign. For example, you might choose a
software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
- `vm_import_task_id`: The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM
import process. Image Builder retrieves information from the import process to pull in the
AMI that is created from the VM source as the base image for your recipe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description for the base image that is created by the import process.
- `"osVersion"`: The operating system version for the imported VM.
- `"tags"`: Tags that are attached to the import resources.
"""
function import_vm_image(
clientToken,
name,
platform,
semanticVersion,
vmImportTaskId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/ImportVmImage",
Dict{String,Any}(
"clientToken" => clientToken,
"name" => name,
"platform" => platform,
"semanticVersion" => semanticVersion,
"vmImportTaskId" => vmImportTaskId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function import_vm_image(
clientToken,
name,
platform,
semanticVersion,
vmImportTaskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/ImportVmImage",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"name" => name,
"platform" => platform,
"semanticVersion" => semanticVersion,
"vmImportTaskId" => vmImportTaskId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_component_build_versions(component_version_arn)
list_component_build_versions(component_version_arn, params::Dict{String,<:Any})
Returns the list of component build versions for the specified semantic version. The
semantic version has four nodes: <major>.<minor>.<patch>/<build>.
You can assign values for the first three, and can filter on all of them. Filtering: With
semantic versioning, you have the flexibility to use wildcards (x) to specify the most
recent versions or nodes when selecting the base image or components for your recipe. When
you use a wildcard in any node, all nodes to the right of the first wildcard must also be
wildcards.
# Arguments
- `component_version_arn`: The component version Amazon Resource Name (ARN) whose versions
you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_component_build_versions(
componentVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListComponentBuildVersions",
Dict{String,Any}("componentVersionArn" => componentVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_component_build_versions(
componentVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"POST",
"/ListComponentBuildVersions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("componentVersionArn" => componentVersionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_components()
list_components(params::Dict{String,<:Any})
Returns the list of components that can be filtered by name, or by using the listed filters
to streamline results. Newly created components can take up to two minutes to appear in the
ListComponents API Results. The semantic version has four nodes:
<major>.<minor>.<patch>/<build>. You can assign values for the
first three, and can filter on all of them. Filtering: With semantic versioning, you have
the flexibility to use wildcards (x) to specify the most recent versions or nodes when
selecting the base image or components for your recipe. When you use a wildcard in any
node, all nodes to the right of the first wildcard must also be wildcards.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"byName"`: Returns the list of components for the specified name.
- `"filters"`: Use the following filters to streamline results: description name
platform supportedOsVersion type version
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
- `"owner"`: Filters results based on the type of owner for the component. By default, this
request returns a list of components that your account owns. To see results for other types
of owners, you can specify components that Amazon manages, third party components, or
components that other accounts have shared with you.
"""
function list_components(; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"POST", "/ListComponents"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_components(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListComponents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_container_recipes()
list_container_recipes(params::Dict{String,<:Any})
Returns a list of container recipes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Use the following filters to streamline results: containerType name
parentImage platform
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
- `"owner"`: Returns container recipes belonging to the specified owner, that have been
shared with you. You can omit this field to return container recipes belonging to your
account.
"""
function list_container_recipes(; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"POST",
"/ListContainerRecipes";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_container_recipes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListContainerRecipes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_distribution_configurations()
list_distribution_configurations(params::Dict{String,<:Any})
Returns a list of distribution configurations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: You can filter on name to streamline results.
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_distribution_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListDistributionConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_distribution_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListDistributionConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_image_build_versions(image_version_arn)
list_image_build_versions(image_version_arn, params::Dict{String,<:Any})
Returns a list of image build versions.
# Arguments
- `image_version_arn`: The Amazon Resource Name (ARN) of the image whose build versions you
want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Use the following filters to streamline results: name osVersion
platform type version
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_image_build_versions(
imageVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListImageBuildVersions",
Dict{String,Any}("imageVersionArn" => imageVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_image_build_versions(
imageVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"POST",
"/ListImageBuildVersions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("imageVersionArn" => imageVersionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_image_packages(image_build_version_arn)
list_image_packages(image_build_version_arn, params::Dict{String,<:Any})
List the Packages that are associated with an Image Build Version, as determined by Amazon
Web Services Systems Manager Inventory at build time.
# Arguments
- `image_build_version_arn`: Filter results for the ListImagePackages request by the Image
Build Version ARN
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_image_packages(
imageBuildVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListImagePackages",
Dict{String,Any}("imageBuildVersionArn" => imageBuildVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_image_packages(
imageBuildVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"POST",
"/ListImagePackages",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("imageBuildVersionArn" => imageBuildVersionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_image_pipeline_images(image_pipeline_arn)
list_image_pipeline_images(image_pipeline_arn, params::Dict{String,<:Any})
Returns a list of images created by the specified pipeline.
# Arguments
- `image_pipeline_arn`: The Amazon Resource Name (ARN) of the image pipeline whose images
you want to view.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Use the following filters to streamline results: name version
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_image_pipeline_images(
imagePipelineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListImagePipelineImages",
Dict{String,Any}("imagePipelineArn" => imagePipelineArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_image_pipeline_images(
imagePipelineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"POST",
"/ListImagePipelineImages",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("imagePipelineArn" => imagePipelineArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_image_pipelines()
list_image_pipelines(params::Dict{String,<:Any})
Returns a list of image pipelines.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Use the following filters to streamline results: description
distributionConfigurationArn imageRecipeArn infrastructureConfigurationArn name
status
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_image_pipelines(; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"POST",
"/ListImagePipelines";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_image_pipelines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListImagePipelines",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_image_recipes()
list_image_recipes(params::Dict{String,<:Any})
Returns a list of image recipes.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Use the following filters to streamline results: name parentImage
platform
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
- `"owner"`: The owner defines which image recipes you want to list. By default, this
request will only show image recipes owned by your account. You can use this field to
specify if you want to view image recipes owned by yourself, by Amazon, or those image
recipes that have been shared with you by other customers.
"""
function list_image_recipes(; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"POST", "/ListImageRecipes"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_image_recipes(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListImageRecipes",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_image_scan_finding_aggregations()
list_image_scan_finding_aggregations(params::Dict{String,<:Any})
Returns a list of image scan aggregations for your account. You can filter by the type of
key that Image Builder uses to group results. For example, if you want to get a list of
findings by severity level for one of your pipelines, you might specify your pipeline with
the imagePipelineArn filter. If you don't specify a filter, Image Builder returns an
aggregation for your account. To streamline results, you can use the following filters in
your request: accountId imageBuildVersionArn imagePipelineArn
vulnerabilityId
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`:
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_image_scan_finding_aggregations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListImageScanFindingAggregations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_image_scan_finding_aggregations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListImageScanFindingAggregations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_image_scan_findings()
list_image_scan_findings(params::Dict{String,<:Any})
Returns a list of image scan findings for your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: An array of name value pairs that you can use to filter your results. You
can use the following filters to streamline results: imageBuildVersionArn
imagePipelineArn vulnerabilityId severity If you don't request a filter, then
all findings in your account are listed.
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_image_scan_findings(; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"POST",
"/ListImageScanFindings";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_image_scan_findings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListImageScanFindings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_images()
list_images(params::Dict{String,<:Any})
Returns the list of images that you have access to. Newly created images can take up to two
minutes to appear in the ListImages API Results.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"byName"`: Requests a list of images with a specific recipe name.
- `"filters"`: Use the following filters to streamline results: name osVersion
platform type version
- `"includeDeprecated"`: Includes deprecated images in the response list.
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
- `"owner"`: The owner defines which images you want to list. By default, this request will
only show images owned by your account. You can use this field to specify if you want to
view images owned by yourself, by Amazon, or those images that have been shared with you by
other customers.
"""
function list_images(; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"POST", "/ListImages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_images(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListImages",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_infrastructure_configurations()
list_infrastructure_configurations(params::Dict{String,<:Any})
Returns a list of infrastructure configurations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: You can filter on name to streamline results.
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_infrastructure_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListInfrastructureConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_infrastructure_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListInfrastructureConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lifecycle_execution_resources(lifecycle_execution_id)
list_lifecycle_execution_resources(lifecycle_execution_id, params::Dict{String,<:Any})
List resources that the runtime instance of the image lifecycle identified for lifecycle
actions.
# Arguments
- `lifecycle_execution_id`: Use the unique identifier for a runtime instance of the
lifecycle policy to get runtime details.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
- `"parentResourceId"`: You can leave this empty to get a list of Image Builder resources
that were identified for lifecycle actions. To get a list of associated resources that are
impacted for an individual resource (the parent), specify its Amazon Resource Name (ARN).
Associated resources are produced from your image and distributed when you run a build,
such as AMIs or container images stored in ECR repositories.
"""
function list_lifecycle_execution_resources(
lifecycleExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListLifecycleExecutionResources",
Dict{String,Any}("lifecycleExecutionId" => lifecycleExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_lifecycle_execution_resources(
lifecycleExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"POST",
"/ListLifecycleExecutionResources",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("lifecycleExecutionId" => lifecycleExecutionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lifecycle_executions(resource_arn)
list_lifecycle_executions(resource_arn, params::Dict{String,<:Any})
Get the lifecycle runtime history for the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource for which to get a list of
lifecycle runtime instances.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_lifecycle_executions(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListLifecycleExecutions",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_lifecycle_executions(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"POST",
"/ListLifecycleExecutions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_lifecycle_policies()
list_lifecycle_policies(params::Dict{String,<:Any})
Get a list of lifecycle policies in your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filters"`: Streamline results based on one of the following values: Name, Status.
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_lifecycle_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"POST",
"/ListLifecyclePolicies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_lifecycle_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListLifecyclePolicies",
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 list of tags for the specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource whose tags you want to
retrieve.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"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 imagebuilder(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_waiting_workflow_steps()
list_waiting_workflow_steps(params::Dict{String,<:Any})
Get a list of workflow steps that are waiting for action for workflows in your Amazon Web
Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_waiting_workflow_steps(; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"POST",
"/ListWaitingWorkflowSteps";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_waiting_workflow_steps(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListWaitingWorkflowSteps",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflow_build_versions(workflow_version_arn)
list_workflow_build_versions(workflow_version_arn, params::Dict{String,<:Any})
Returns a list of build versions for a specific workflow resource.
# Arguments
- `workflow_version_arn`: The Amazon Resource Name (ARN) of the workflow resource for which
to get a list of build versions.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_workflow_build_versions(
workflowVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListWorkflowBuildVersions",
Dict{String,Any}("workflowVersionArn" => workflowVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workflow_build_versions(
workflowVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"POST",
"/ListWorkflowBuildVersions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("workflowVersionArn" => workflowVersionArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflow_executions(image_build_version_arn)
list_workflow_executions(image_build_version_arn, params::Dict{String,<:Any})
Returns a list of workflow runtime instance metadata objects for a specific image build
version.
# Arguments
- `image_build_version_arn`: List all workflow runtime instances for the specified image
build version resource ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_workflow_executions(
imageBuildVersionArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListWorkflowExecutions",
Dict{String,Any}("imageBuildVersionArn" => imageBuildVersionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workflow_executions(
imageBuildVersionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"POST",
"/ListWorkflowExecutions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("imageBuildVersionArn" => imageBuildVersionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflow_step_executions(workflow_execution_id)
list_workflow_step_executions(workflow_execution_id, params::Dict{String,<:Any})
Returns runtime data for each step in a runtime instance of the workflow that you specify
in the request.
# Arguments
- `workflow_execution_id`: The unique identifier that Image Builder assigned to keep track
of runtime details when it ran the workflow.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
"""
function list_workflow_step_executions(
workflowExecutionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListWorkflowStepExecutions",
Dict{String,Any}("workflowExecutionId" => workflowExecutionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_workflow_step_executions(
workflowExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"POST",
"/ListWorkflowStepExecutions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("workflowExecutionId" => workflowExecutionId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_workflows()
list_workflows(params::Dict{String,<:Any})
Lists workflow build versions based on filtering parameters.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"byName"`: Specify all or part of the workflow name to streamline results.
- `"filters"`: Used to streamline search results.
- `"maxResults"`: The maximum items to return in a request.
- `"nextToken"`: A token to specify where to start paginating. This is the nextToken from a
previously truncated response.
- `"owner"`: Used to get a list of workflow build version filtered by the identity of the
creator.
"""
function list_workflows(; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"POST", "/ListWorkflows"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_workflows(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"POST",
"/ListWorkflows",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_component_policy(component_arn, policy)
put_component_policy(component_arn, policy, params::Dict{String,<:Any})
Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare
to share resources. If you call the Image Builder API PutComponentPolicy, you must also
call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be
visible to all principals with whom the resource is shared.
# Arguments
- `component_arn`: The Amazon Resource Name (ARN) of the component that this policy should
be applied to.
- `policy`: The policy to apply.
"""
function put_component_policy(
componentArn, policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"PUT",
"/PutComponentPolicy",
Dict{String,Any}("componentArn" => componentArn, "policy" => policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_component_policy(
componentArn,
policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/PutComponentPolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("componentArn" => componentArn, "policy" => policy),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_container_recipe_policy(container_recipe_arn, policy)
put_container_recipe_policy(container_recipe_arn, policy, params::Dict{String,<:Any})
Applies a policy to a container image. We recommend that you call the RAM API
CreateResourceShare
(https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to
share resources. If you call the Image Builder API PutContainerImagePolicy, you must also
call the RAM API PromoteResourceShareCreatedFromPolicy
(https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPol
icy.html) in order for the resource to be visible to all principals with whom the resource
is shared.
# Arguments
- `container_recipe_arn`: The Amazon Resource Name (ARN) of the container recipe that this
policy should be applied to.
- `policy`: The policy to apply to the container recipe.
"""
function put_container_recipe_policy(
containerRecipeArn, policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"PUT",
"/PutContainerRecipePolicy",
Dict{String,Any}("containerRecipeArn" => containerRecipeArn, "policy" => policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_container_recipe_policy(
containerRecipeArn,
policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/PutContainerRecipePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"containerRecipeArn" => containerRecipeArn, "policy" => policy
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_image_policy(image_arn, policy)
put_image_policy(image_arn, policy, params::Dict{String,<:Any})
Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to
share resources. If you call the Image Builder API PutImagePolicy, you must also call the
RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to
all principals with whom the resource is shared.
# Arguments
- `image_arn`: The Amazon Resource Name (ARN) of the image that this policy should be
applied to.
- `policy`: The policy to apply.
"""
function put_image_policy(
imageArn, policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"PUT",
"/PutImagePolicy",
Dict{String,Any}("imageArn" => imageArn, "policy" => policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_image_policy(
imageArn,
policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/PutImagePolicy",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("imageArn" => imageArn, "policy" => policy), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_image_recipe_policy(image_recipe_arn, policy)
put_image_recipe_policy(image_recipe_arn, policy, params::Dict{String,<:Any})
Applies a policy to an image recipe. We recommend that you call the RAM API
CreateResourceShare to share resources. If you call the Image Builder API
PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy
in order for the resource to be visible to all principals with whom the resource is shared.
# Arguments
- `image_recipe_arn`: The Amazon Resource Name (ARN) of the image recipe that this policy
should be applied to.
- `policy`: The policy to apply.
"""
function put_image_recipe_policy(
imageRecipeArn, policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"PUT",
"/PutImageRecipePolicy",
Dict{String,Any}("imageRecipeArn" => imageRecipeArn, "policy" => policy);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_image_recipe_policy(
imageRecipeArn,
policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/PutImageRecipePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("imageRecipeArn" => imageRecipeArn, "policy" => policy),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_workflow_step_action(action, client_token, image_build_version_arn, step_execution_id)
send_workflow_step_action(action, client_token, image_build_version_arn, step_execution_id, params::Dict{String,<:Any})
Pauses or resumes image creation when the associated workflow runs a WaitForAction step.
# Arguments
- `action`: The action for the image creation process to take while a workflow
WaitForAction step waits for an asynchronous action to complete.
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `image_build_version_arn`: The Amazon Resource Name (ARN) of the image build version to
send action for.
- `step_execution_id`: Uniquely identifies the workflow step that sent the step action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"reason"`: The reason why this action is sent.
"""
function send_workflow_step_action(
action,
clientToken,
imageBuildVersionArn,
stepExecutionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/SendWorkflowStepAction",
Dict{String,Any}(
"action" => action,
"clientToken" => clientToken,
"imageBuildVersionArn" => imageBuildVersionArn,
"stepExecutionId" => stepExecutionId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_workflow_step_action(
action,
clientToken,
imageBuildVersionArn,
stepExecutionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/SendWorkflowStepAction",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"action" => action,
"clientToken" => clientToken,
"imageBuildVersionArn" => imageBuildVersionArn,
"stepExecutionId" => stepExecutionId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_image_pipeline_execution(client_token, image_pipeline_arn)
start_image_pipeline_execution(client_token, image_pipeline_arn, params::Dict{String,<:Any})
Manually triggers a pipeline to create an image.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `image_pipeline_arn`: The Amazon Resource Name (ARN) of the image pipeline that you want
to manually invoke.
"""
function start_image_pipeline_execution(
clientToken, imagePipelineArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"PUT",
"/StartImagePipelineExecution",
Dict{String,Any}(
"clientToken" => clientToken, "imagePipelineArn" => imagePipelineArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_image_pipeline_execution(
clientToken,
imagePipelineArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/StartImagePipelineExecution",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken, "imagePipelineArn" => imagePipelineArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_resource_state_update(client_token, resource_arn, state)
start_resource_state_update(client_token, resource_arn, state, params::Dict{String,<:Any})
Begin asynchronous resource state update for lifecycle changes to the specified image
resources.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `resource_arn`: The ARN of the Image Builder resource that is updated. The state update
might also impact associated resources.
- `state`: Indicates the lifecycle action to take for this request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"exclusionRules"`: Skip action on the image resource and associated resources if
specified exclusion rules are met.
- `"executionRole"`: The name or Amazon Resource Name (ARN) of the IAM role that’s used
to update image state.
- `"includeResources"`: A list of image resources to update state for.
- `"updateAt"`: The timestamp that indicates when resources are updated by a lifecycle
action.
"""
function start_resource_state_update(
clientToken, resourceArn, state; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"PUT",
"/StartResourceStateUpdate",
Dict{String,Any}(
"clientToken" => clientToken, "resourceArn" => resourceArn, "state" => state
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_resource_state_update(
clientToken,
resourceArn,
state,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/StartResourceStateUpdate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"resourceArn" => resourceArn,
"state" => state,
),
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 tag to a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to tag.
- `tags`: The tags to apply to the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return imagebuilder(
"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 imagebuilder(
"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 tag from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that you want to untag.
- `tag_keys`: The tag keys to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return imagebuilder(
"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 imagebuilder(
"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_distribution_configuration(client_token, distribution_configuration_arn, distributions)
update_distribution_configuration(client_token, distribution_configuration_arn, distributions, params::Dict{String,<:Any})
Updates a new distribution configuration. Distribution configurations define and configure
the outputs of your pipeline.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `distribution_configuration_arn`: The Amazon Resource Name (ARN) of the distribution
configuration that you want to update.
- `distributions`: The distributions of the distribution configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the distribution configuration.
"""
function update_distribution_configuration(
clientToken,
distributionConfigurationArn,
distributions;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/UpdateDistributionConfiguration",
Dict{String,Any}(
"clientToken" => clientToken,
"distributionConfigurationArn" => distributionConfigurationArn,
"distributions" => distributions,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_distribution_configuration(
clientToken,
distributionConfigurationArn,
distributions,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/UpdateDistributionConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"distributionConfigurationArn" => distributionConfigurationArn,
"distributions" => distributions,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_image_pipeline(client_token, image_pipeline_arn, infrastructure_configuration_arn)
update_image_pipeline(client_token, image_pipeline_arn, infrastructure_configuration_arn, params::Dict{String,<:Any})
Updates an image pipeline. Image pipelines enable you to automate the creation and
distribution of images. You must specify exactly one recipe for your image, using either a
containerRecipeArn or an imageRecipeArn. UpdateImagePipeline does not support selective
updates for the pipeline. You must specify all of the required properties in the update
request, not just the properties that have changed.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `image_pipeline_arn`: The Amazon Resource Name (ARN) of the image pipeline that you want
to update.
- `infrastructure_configuration_arn`: The Amazon Resource Name (ARN) of the infrastructure
configuration that Image Builder uses to build images that this image pipeline has updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"containerRecipeArn"`: The Amazon Resource Name (ARN) of the container pipeline to
update.
- `"description"`: The description of the image pipeline.
- `"distributionConfigurationArn"`: The Amazon Resource Name (ARN) of the distribution
configuration that Image Builder uses to configure and distribute images that this image
pipeline has updated.
- `"enhancedImageMetadataEnabled"`: Collects additional information about the image being
created, including the operating system (OS) version and package list. This information is
used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
- `"executionRole"`: The name or Amazon Resource Name (ARN) for the IAM role you create
that grants Image Builder access to perform workflow actions.
- `"imageRecipeArn"`: The Amazon Resource Name (ARN) of the image recipe that will be used
to configure images updated by this image pipeline.
- `"imageScanningConfiguration"`: Contains settings for vulnerability scans.
- `"imageTestsConfiguration"`: The image test configuration of the image pipeline.
- `"schedule"`: The schedule of the image pipeline.
- `"status"`: The status of the image pipeline.
- `"workflows"`: Contains the workflows to run for the pipeline.
"""
function update_image_pipeline(
clientToken,
imagePipelineArn,
infrastructureConfigurationArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/UpdateImagePipeline",
Dict{String,Any}(
"clientToken" => clientToken,
"imagePipelineArn" => imagePipelineArn,
"infrastructureConfigurationArn" => infrastructureConfigurationArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_image_pipeline(
clientToken,
imagePipelineArn,
infrastructureConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/UpdateImagePipeline",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"imagePipelineArn" => imagePipelineArn,
"infrastructureConfigurationArn" => infrastructureConfigurationArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_infrastructure_configuration(client_token, infrastructure_configuration_arn, instance_profile_name)
update_infrastructure_configuration(client_token, infrastructure_configuration_arn, instance_profile_name, params::Dict{String,<:Any})
Updates a new infrastructure configuration. An infrastructure configuration defines the
environment in which your image will be built and tested.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `infrastructure_configuration_arn`: The Amazon Resource Name (ARN) of the infrastructure
configuration that you want to update.
- `instance_profile_name`: The instance profile to associate with the instance used to
customize your Amazon EC2 AMI.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the infrastructure configuration.
- `"instanceMetadataOptions"`: The instance metadata options that you can set for the HTTP
requests that pipeline builds use to launch EC2 build and test instances. For more
information about instance metadata options, see one of the following links: Configure
the instance metadata options in the Amazon EC2 User Guide for Linux instances.
Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows
instances.
- `"instanceTypes"`: The instance types of the infrastructure configuration. You can
specify one or more instance types to use for this build. The service will pick one of
these instance types based on availability.
- `"keyPair"`: The key pair of the infrastructure configuration. You can use this to log on
to and debug the instance used to create your image.
- `"logging"`: The logging configuration of the infrastructure configuration.
- `"resourceTags"`: The tags attached to the resource created by Image Builder.
- `"securityGroupIds"`: The security group IDs to associate with the instance used to
customize your Amazon EC2 AMI.
- `"snsTopicArn"`: The Amazon Resource Name (ARN) for the SNS topic to which we send image
build event notifications. EC2 Image Builder is unable to send notifications to SNS topics
that are encrypted using keys from other accounts. The key that is used to encrypt the SNS
topic must reside in the account that the Image Builder service runs under.
- `"subnetId"`: The subnet ID to place the instance used to customize your Amazon EC2 AMI
in.
- `"terminateInstanceOnFailure"`: The terminate instance on failure setting of the
infrastructure configuration. Set to false if you want Image Builder to retain the instance
used to configure your AMI if the build or test phase of your workflow fails.
"""
function update_infrastructure_configuration(
clientToken,
infrastructureConfigurationArn,
instanceProfileName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/UpdateInfrastructureConfiguration",
Dict{String,Any}(
"clientToken" => clientToken,
"infrastructureConfigurationArn" => infrastructureConfigurationArn,
"instanceProfileName" => instanceProfileName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_infrastructure_configuration(
clientToken,
infrastructureConfigurationArn,
instanceProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/UpdateInfrastructureConfiguration",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"infrastructureConfigurationArn" => infrastructureConfigurationArn,
"instanceProfileName" => instanceProfileName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_lifecycle_policy(client_token, execution_role, lifecycle_policy_arn, policy_details, resource_selection, resource_type)
update_lifecycle_policy(client_token, execution_role, lifecycle_policy_arn, policy_details, resource_selection, resource_type, params::Dict{String,<:Any})
Update the specified lifecycle policy.
# Arguments
- `client_token`: Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- `execution_role`: The name or Amazon Resource Name (ARN) of the IAM role that Image
Builder uses to update the lifecycle policy.
- `lifecycle_policy_arn`: The Amazon Resource Name (ARN) of the lifecycle policy resource.
- `policy_details`: The configuration details for a lifecycle policy resource.
- `resource_selection`: Selection criteria for resources that the lifecycle policy applies
to.
- `resource_type`: The type of image resource that the lifecycle policy applies to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: Optional description for the lifecycle policy.
- `"status"`: Indicates whether the lifecycle policy resource is enabled.
"""
function update_lifecycle_policy(
clientToken,
executionRole,
lifecyclePolicyArn,
policyDetails,
resourceSelection,
resourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/UpdateLifecyclePolicy",
Dict{String,Any}(
"clientToken" => clientToken,
"executionRole" => executionRole,
"lifecyclePolicyArn" => lifecyclePolicyArn,
"policyDetails" => policyDetails,
"resourceSelection" => resourceSelection,
"resourceType" => resourceType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_lifecycle_policy(
clientToken,
executionRole,
lifecyclePolicyArn,
policyDetails,
resourceSelection,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return imagebuilder(
"PUT",
"/UpdateLifecyclePolicy",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken,
"executionRole" => executionRole,
"lifecyclePolicyArn" => lifecyclePolicyArn,
"policyDetails" => policyDetails,
"resourceSelection" => resourceSelection,
"resourceType" => resourceType,
),
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 | 7653 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: importexport
using AWS.Compat
using AWS.UUIDs
"""
cancel_job(job_id)
cancel_job(job_id, params::Dict{String,<:Any})
This operation cancels a specified job. Only the job owner can cancel it. The operation
fails if the job has already started or is complete.
# Arguments
- `job_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"APIVersion"`:
"""
function cancel_job(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return importexport(
"CancelJob",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_job(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return importexport(
"CancelJob",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job(job_type, manifest, validate_only)
create_job(job_type, manifest, validate_only, params::Dict{String,<:Any})
This operation initiates the process of scheduling an upload or download of your data. You
include in the request a manifest that describes the data transfer specifics. The response
to the request includes a job ID, which you can use in other operations, a signature that
you use to identify your storage device, and the address where you should ship your storage
device.
# Arguments
- `job_type`:
- `manifest`:
- `validate_only`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"APIVersion"`:
- `"ManifestAddendum"`:
"""
function create_job(
JobType, Manifest, ValidateOnly; aws_config::AbstractAWSConfig=global_aws_config()
)
return importexport(
"CreateJob",
Dict{String,Any}(
"JobType" => JobType, "Manifest" => Manifest, "ValidateOnly" => ValidateOnly
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job(
JobType,
Manifest,
ValidateOnly,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return importexport(
"CreateJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"JobType" => JobType,
"Manifest" => Manifest,
"ValidateOnly" => ValidateOnly,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_shipping_label(job_ids)
get_shipping_label(job_ids, params::Dict{String,<:Any})
This operation generates a pre-paid UPS shipping label that you will use to ship your
device to AWS for processing.
# Arguments
- `job_ids`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"APIVersion"`:
- `"city"`:
- `"company"`:
- `"country"`:
- `"name"`:
- `"phoneNumber"`:
- `"postalCode"`:
- `"stateOrProvince"`:
- `"street1"`:
- `"street2"`:
- `"street3"`:
"""
function get_shipping_label(jobIds; aws_config::AbstractAWSConfig=global_aws_config())
return importexport(
"GetShippingLabel",
Dict{String,Any}("jobIds" => jobIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_shipping_label(
jobIds, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return importexport(
"GetShippingLabel",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("jobIds" => jobIds), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_status(job_id)
get_status(job_id, params::Dict{String,<:Any})
This operation returns information about a job, including where the job is in the
processing pipeline, the status of the results, and the signature value associated with the
job. You can only return information about jobs you own.
# Arguments
- `job_id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"APIVersion"`:
"""
function get_status(JobId; aws_config::AbstractAWSConfig=global_aws_config())
return importexport(
"GetStatus",
Dict{String,Any}("JobId" => JobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_status(
JobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return importexport(
"GetStatus",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("JobId" => JobId), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs()
list_jobs(params::Dict{String,<:Any})
This operation returns the jobs associated with the requester. AWS Import/Export lists the
jobs in reverse chronological order based on the date of creation. For example if Job Test1
was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return
Test2 followed by Test1.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"APIVersion"`:
- `"Marker"`:
- `"MaxJobs"`:
"""
function list_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return importexport("ListJobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return importexport(
"ListJobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
update_job(job_id, job_type, manifest, validate_only)
update_job(job_id, job_type, manifest, validate_only, params::Dict{String,<:Any})
You use this operation to change the parameters specified in the original manifest file by
supplying a new manifest file. The manifest file attached to this request replaces the
original manifest file. You can only use the operation after a CreateJob request but before
the data transfer starts and you can only use it on jobs you own.
# Arguments
- `job_id`:
- `job_type`:
- `manifest`:
- `validate_only`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"APIVersion"`:
"""
function update_job(
JobId,
JobType,
Manifest,
ValidateOnly;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return importexport(
"UpdateJob",
Dict{String,Any}(
"JobId" => JobId,
"JobType" => JobType,
"Manifest" => Manifest,
"ValidateOnly" => ValidateOnly,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_job(
JobId,
JobType,
Manifest,
ValidateOnly,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return importexport(
"UpdateJob",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"JobId" => JobId,
"JobType" => JobType,
"Manifest" => Manifest,
"ValidateOnly" => ValidateOnly,
),
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 | 54166 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: inspector
using AWS.Compat
using AWS.UUIDs
"""
add_attributes_to_findings(attributes, finding_arns)
add_attributes_to_findings(attributes, finding_arns, params::Dict{String,<:Any})
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of
the findings.
# Arguments
- `attributes`: The array of attributes that you want to assign to specified findings.
- `finding_arns`: The ARNs that specify the findings that you want to assign attributes to.
"""
function add_attributes_to_findings(
attributes, findingArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"AddAttributesToFindings",
Dict{String,Any}("attributes" => attributes, "findingArns" => findingArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_attributes_to_findings(
attributes,
findingArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"AddAttributesToFindings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("attributes" => attributes, "findingArns" => findingArns),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_assessment_target(assessment_target_name)
create_assessment_target(assessment_target_name, params::Dict{String,<:Any})
Creates a new assessment target using the ARN of the resource group that is generated by
CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current
AWS account and region are included in the assessment target. If the service-linked role
isn’t already registered, this action also creates and registers a service-linked role to
grant Amazon Inspector access to AWS Services needed to perform security assessments. You
can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent
agents per AWS account. For more information, see Amazon Inspector Assessment Targets.
# Arguments
- `assessment_target_name`: The user-defined name that identifies the assessment target
that you want to create. The name must be unique within the AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"resourceGroupArn"`: The ARN that specifies the resource group that is used to create
the assessment target. If resourceGroupArn is not specified, all EC2 instances in the
current AWS account and region are included in the assessment target.
"""
function create_assessment_target(
assessmentTargetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"CreateAssessmentTarget",
Dict{String,Any}("assessmentTargetName" => assessmentTargetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_assessment_target(
assessmentTargetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"CreateAssessmentTarget",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("assessmentTargetName" => assessmentTargetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_assessment_template(assessment_target_arn, assessment_template_name, duration_in_seconds, rules_package_arns)
create_assessment_template(assessment_target_arn, assessment_template_name, duration_in_seconds, rules_package_arns, params::Dict{String,<:Any})
Creates an assessment template for the assessment target that is specified by the ARN of
the assessment target. If the service-linked role isn’t already registered, this action
also creates and registers a service-linked role to grant Amazon Inspector access to AWS
Services needed to perform security assessments.
# Arguments
- `assessment_target_arn`: The ARN that specifies the assessment target for which you want
to create the assessment template.
- `assessment_template_name`: The user-defined name that identifies the assessment template
that you want to create. You can create several assessment templates for an assessment
target. The names of the assessment templates that correspond to a particular assessment
target must be unique.
- `duration_in_seconds`: The duration of the assessment run in seconds.
- `rules_package_arns`: The ARNs that specify the rules packages that you want to attach to
the assessment template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"userAttributesForFindings"`: The user-defined attributes that are assigned to every
finding that is generated by the assessment run that uses this assessment template. An
attribute is a key and value pair (an Attribute object). Within an assessment template,
each key must be unique.
"""
function create_assessment_template(
assessmentTargetArn,
assessmentTemplateName,
durationInSeconds,
rulesPackageArns;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"CreateAssessmentTemplate",
Dict{String,Any}(
"assessmentTargetArn" => assessmentTargetArn,
"assessmentTemplateName" => assessmentTemplateName,
"durationInSeconds" => durationInSeconds,
"rulesPackageArns" => rulesPackageArns,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_assessment_template(
assessmentTargetArn,
assessmentTemplateName,
durationInSeconds,
rulesPackageArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"CreateAssessmentTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assessmentTargetArn" => assessmentTargetArn,
"assessmentTemplateName" => assessmentTemplateName,
"durationInSeconds" => durationInSeconds,
"rulesPackageArns" => rulesPackageArns,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_exclusions_preview(assessment_template_arn)
create_exclusions_preview(assessment_template_arn, params::Dict{String,<:Any})
Starts the generation of an exclusions preview for the specified assessment template. The
exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can
detect before it runs the assessment.
# Arguments
- `assessment_template_arn`: The ARN that specifies the assessment template for which you
want to create an exclusions preview.
"""
function create_exclusions_preview(
assessmentTemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"CreateExclusionsPreview",
Dict{String,Any}("assessmentTemplateArn" => assessmentTemplateArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_exclusions_preview(
assessmentTemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"CreateExclusionsPreview",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("assessmentTemplateArn" => assessmentTemplateArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resource_group(resource_group_tags)
create_resource_group(resource_group_tags, params::Dict{String,<:Any})
Creates a resource group using the specified set of tags (key and value pairs) that are
used to select the EC2 instances to be included in an Amazon Inspector assessment target.
The created resource group is then used to create an Amazon Inspector assessment target.
For more information, see CreateAssessmentTarget.
# Arguments
- `resource_group_tags`: A collection of keys and an array of possible values,
'[{\"key\":\"key1\",\"values\":[\"Value1\",\"Value2\"]},{\"key\":\"Key2\",\"values\":[\"Valu
e3\"]}]'. For example,'[{\"key\":\"Name\",\"values\":[\"TestEC2Instance\"]}]'.
"""
function create_resource_group(
resourceGroupTags; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"CreateResourceGroup",
Dict{String,Any}("resourceGroupTags" => resourceGroupTags);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_group(
resourceGroupTags,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"CreateResourceGroup",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("resourceGroupTags" => resourceGroupTags), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assessment_run(assessment_run_arn)
delete_assessment_run(assessment_run_arn, params::Dict{String,<:Any})
Deletes the assessment run that is specified by the ARN of the assessment run.
# Arguments
- `assessment_run_arn`: The ARN that specifies the assessment run that you want to delete.
"""
function delete_assessment_run(
assessmentRunArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DeleteAssessmentRun",
Dict{String,Any}("assessmentRunArn" => assessmentRunArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assessment_run(
assessmentRunArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"DeleteAssessmentRun",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("assessmentRunArn" => assessmentRunArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assessment_target(assessment_target_arn)
delete_assessment_target(assessment_target_arn, params::Dict{String,<:Any})
Deletes the assessment target that is specified by the ARN of the assessment target.
# Arguments
- `assessment_target_arn`: The ARN that specifies the assessment target that you want to
delete.
"""
function delete_assessment_target(
assessmentTargetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DeleteAssessmentTarget",
Dict{String,Any}("assessmentTargetArn" => assessmentTargetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assessment_target(
assessmentTargetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"DeleteAssessmentTarget",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("assessmentTargetArn" => assessmentTargetArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assessment_template(assessment_template_arn)
delete_assessment_template(assessment_template_arn, params::Dict{String,<:Any})
Deletes the assessment template that is specified by the ARN of the assessment template.
# Arguments
- `assessment_template_arn`: The ARN that specifies the assessment template that you want
to delete.
"""
function delete_assessment_template(
assessmentTemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DeleteAssessmentTemplate",
Dict{String,Any}("assessmentTemplateArn" => assessmentTemplateArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assessment_template(
assessmentTemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"DeleteAssessmentTemplate",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("assessmentTemplateArn" => assessmentTemplateArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_assessment_runs(assessment_run_arns)
describe_assessment_runs(assessment_run_arns, params::Dict{String,<:Any})
Describes the assessment runs that are specified by the ARNs of the assessment runs.
# Arguments
- `assessment_run_arns`: The ARN that specifies the assessment run that you want to
describe.
"""
function describe_assessment_runs(
assessmentRunArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DescribeAssessmentRuns",
Dict{String,Any}("assessmentRunArns" => assessmentRunArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_assessment_runs(
assessmentRunArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"DescribeAssessmentRuns",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("assessmentRunArns" => assessmentRunArns), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_assessment_targets(assessment_target_arns)
describe_assessment_targets(assessment_target_arns, params::Dict{String,<:Any})
Describes the assessment targets that are specified by the ARNs of the assessment targets.
# Arguments
- `assessment_target_arns`: The ARNs that specifies the assessment targets that you want to
describe.
"""
function describe_assessment_targets(
assessmentTargetArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DescribeAssessmentTargets",
Dict{String,Any}("assessmentTargetArns" => assessmentTargetArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_assessment_targets(
assessmentTargetArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"DescribeAssessmentTargets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("assessmentTargetArns" => assessmentTargetArns),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_assessment_templates(assessment_template_arns)
describe_assessment_templates(assessment_template_arns, params::Dict{String,<:Any})
Describes the assessment templates that are specified by the ARNs of the assessment
templates.
# Arguments
- `assessment_template_arns`:
"""
function describe_assessment_templates(
assessmentTemplateArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DescribeAssessmentTemplates",
Dict{String,Any}("assessmentTemplateArns" => assessmentTemplateArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_assessment_templates(
assessmentTemplateArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"DescribeAssessmentTemplates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("assessmentTemplateArns" => assessmentTemplateArns),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cross_account_access_role()
describe_cross_account_access_role(params::Dict{String,<:Any})
Describes the IAM role that enables Amazon Inspector to access your AWS account.
"""
function describe_cross_account_access_role(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DescribeCrossAccountAccessRole";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cross_account_access_role(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DescribeCrossAccountAccessRole",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_exclusions(exclusion_arns)
describe_exclusions(exclusion_arns, params::Dict{String,<:Any})
Describes the exclusions that are specified by the exclusions' ARNs.
# Arguments
- `exclusion_arns`: The list of ARNs that specify the exclusions that you want to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: The locale into which you want to translate the exclusion's title,
description, and recommendation.
"""
function describe_exclusions(
exclusionArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DescribeExclusions",
Dict{String,Any}("exclusionArns" => exclusionArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_exclusions(
exclusionArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"DescribeExclusions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("exclusionArns" => exclusionArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_findings(finding_arns)
describe_findings(finding_arns, params::Dict{String,<:Any})
Describes the findings that are specified by the ARNs of the findings.
# Arguments
- `finding_arns`: The ARN that specifies the finding that you want to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: The locale into which you want to translate a finding description,
recommendation, and the short description that identifies the finding.
"""
function describe_findings(findingArns; aws_config::AbstractAWSConfig=global_aws_config())
return inspector(
"DescribeFindings",
Dict{String,Any}("findingArns" => findingArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_findings(
findingArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"DescribeFindings",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("findingArns" => findingArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_resource_groups(resource_group_arns)
describe_resource_groups(resource_group_arns, params::Dict{String,<:Any})
Describes the resource groups that are specified by the ARNs of the resource groups.
# Arguments
- `resource_group_arns`: The ARN that specifies the resource group that you want to
describe.
"""
function describe_resource_groups(
resourceGroupArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DescribeResourceGroups",
Dict{String,Any}("resourceGroupArns" => resourceGroupArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_resource_groups(
resourceGroupArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"DescribeResourceGroups",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("resourceGroupArns" => resourceGroupArns), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_rules_packages(rules_package_arns)
describe_rules_packages(rules_package_arns, params::Dict{String,<:Any})
Describes the rules packages that are specified by the ARNs of the rules packages.
# Arguments
- `rules_package_arns`: The ARN that specifies the rules package that you want to describe.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: The locale that you want to translate a rules package description into.
"""
function describe_rules_packages(
rulesPackageArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"DescribeRulesPackages",
Dict{String,Any}("rulesPackageArns" => rulesPackageArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_rules_packages(
rulesPackageArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"DescribeRulesPackages",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("rulesPackageArns" => rulesPackageArns), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_assessment_report(assessment_run_arn, report_file_format, report_type)
get_assessment_report(assessment_run_arn, report_file_format, report_type, params::Dict{String,<:Any})
Produces an assessment report that includes detailed and comprehensive results of a
specified assessment run.
# Arguments
- `assessment_run_arn`: The ARN that specifies the assessment run for which you want to
generate a report.
- `report_file_format`: Specifies the file format (html or pdf) of the assessment report
that you want to generate.
- `report_type`: Specifies the type of the assessment report that you want to generate.
There are two types of assessment reports: a finding report and a full report. For more
information, see Assessment Reports.
"""
function get_assessment_report(
assessmentRunArn,
reportFileFormat,
reportType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"GetAssessmentReport",
Dict{String,Any}(
"assessmentRunArn" => assessmentRunArn,
"reportFileFormat" => reportFileFormat,
"reportType" => reportType,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_assessment_report(
assessmentRunArn,
reportFileFormat,
reportType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"GetAssessmentReport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assessmentRunArn" => assessmentRunArn,
"reportFileFormat" => reportFileFormat,
"reportType" => reportType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_exclusions_preview(assessment_template_arn, preview_token)
get_exclusions_preview(assessment_template_arn, preview_token, params::Dict{String,<:Any})
Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the
preview token. You can obtain the preview token by running the CreateExclusionsPreview API.
# Arguments
- `assessment_template_arn`: The ARN that specifies the assessment template for which the
exclusions preview was requested.
- `preview_token`: The unique identifier associated of the exclusions preview.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: The locale into which you want to translate the exclusion's title,
description, and recommendation.
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 100. The maximum value is 500.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent
calls to the action fill nextToken in the request with the value of nextToken from the
previous response to continue listing data.
"""
function get_exclusions_preview(
assessmentTemplateArn, previewToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"GetExclusionsPreview",
Dict{String,Any}(
"assessmentTemplateArn" => assessmentTemplateArn, "previewToken" => previewToken
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_exclusions_preview(
assessmentTemplateArn,
previewToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"GetExclusionsPreview",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assessmentTemplateArn" => assessmentTemplateArn,
"previewToken" => previewToken,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_telemetry_metadata(assessment_run_arn)
get_telemetry_metadata(assessment_run_arn, params::Dict{String,<:Any})
Information about the data that is collected for the specified assessment run.
# Arguments
- `assessment_run_arn`: The ARN that specifies the assessment run that has the telemetry
data that you want to obtain.
"""
function get_telemetry_metadata(
assessmentRunArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"GetTelemetryMetadata",
Dict{String,Any}("assessmentRunArn" => assessmentRunArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_telemetry_metadata(
assessmentRunArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"GetTelemetryMetadata",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("assessmentRunArn" => assessmentRunArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assessment_run_agents(assessment_run_arn)
list_assessment_run_agents(assessment_run_arn, params::Dict{String,<:Any})
Lists the agents of the assessment runs that are specified by the ARNs of the assessment
runs.
# Arguments
- `assessment_run_arn`: The ARN that specifies the assessment run whose agents you want to
list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: You can use this parameter to specify a subset of data to be included in the
action's response. For a record to match a filter, all specified filter attributes must
match. When multiple values are specified for a filter attribute, any of the values can
match.
- `"maxResults"`: You can use this parameter to indicate the maximum number of items that
you want in the response. The default value is 10. The maximum value is 500.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the ListAssessmentRunAgents action. Subsequent
calls to the action fill nextToken in the request with the value of NextToken from the
previous response to continue listing data.
"""
function list_assessment_run_agents(
assessmentRunArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"ListAssessmentRunAgents",
Dict{String,Any}("assessmentRunArn" => assessmentRunArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_assessment_run_agents(
assessmentRunArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"ListAssessmentRunAgents",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("assessmentRunArn" => assessmentRunArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assessment_runs()
list_assessment_runs(params::Dict{String,<:Any})
Lists the assessment runs that correspond to the assessment templates that are specified by
the ARNs of the assessment templates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assessmentTemplateArns"`: The ARNs that specify the assessment templates whose
assessment runs you want to list.
- `"filter"`: You can use this parameter to specify a subset of data to be included in the
action's response. For a record to match a filter, all specified filter attributes must
match. When multiple values are specified for a filter attribute, any of the values can
match.
- `"maxResults"`: You can use this parameter to indicate the maximum number of items that
you want in the response. The default value is 10. The maximum value is 500.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the ListAssessmentRuns action. Subsequent calls to
the action fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
"""
function list_assessment_runs(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector(
"ListAssessmentRuns"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_assessment_runs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"ListAssessmentRuns", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_assessment_targets()
list_assessment_targets(params::Dict{String,<:Any})
Lists the ARNs of the assessment targets within this AWS account. For more information
about assessment targets, see Amazon Inspector Assessment Targets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filter"`: You can use this parameter to specify a subset of data to be included in the
action's response. For a record to match a filter, all specified filter attributes must
match. When multiple values are specified for a filter attribute, any of the values can
match.
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 10. The maximum value is 500.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the ListAssessmentTargets action. Subsequent calls
to the action fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
"""
function list_assessment_targets(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector(
"ListAssessmentTargets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_assessment_targets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"ListAssessmentTargets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_assessment_templates()
list_assessment_templates(params::Dict{String,<:Any})
Lists the assessment templates that correspond to the assessment targets that are specified
by the ARNs of the assessment targets.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assessmentTargetArns"`: A list of ARNs that specifies the assessment targets whose
assessment templates you want to list.
- `"filter"`: You can use this parameter to specify a subset of data to be included in the
action's response. For a record to match a filter, all specified filter attributes must
match. When multiple values are specified for a filter attribute, any of the values can
match.
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 10. The maximum value is 500.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the ListAssessmentTemplates action. Subsequent
calls to the action fill nextToken in the request with the value of NextToken from the
previous response to continue listing data.
"""
function list_assessment_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector(
"ListAssessmentTemplates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_assessment_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"ListAssessmentTemplates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_event_subscriptions()
list_event_subscriptions(params::Dict{String,<:Any})
Lists all the event subscriptions for the assessment template that is specified by the ARN
of the assessment template. For more information, see SubscribeToEvent and
UnsubscribeFromEvent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 10. The maximum value is 500.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the ListEventSubscriptions action. Subsequent calls
to the action fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
- `"resourceArn"`: The ARN of the assessment template for which you want to list the
existing event subscriptions.
"""
function list_event_subscriptions(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector(
"ListEventSubscriptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_event_subscriptions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"ListEventSubscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_exclusions(assessment_run_arn)
list_exclusions(assessment_run_arn, params::Dict{String,<:Any})
List exclusions that are generated by the assessment run.
# Arguments
- `assessment_run_arn`: The ARN of the assessment run that generated the exclusions that
you want to list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 100. The maximum value is 500.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the ListExclusionsRequest action. Subsequent calls
to the action fill nextToken in the request with the value of nextToken from the previous
response to continue listing data.
"""
function list_exclusions(
assessmentRunArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"ListExclusions",
Dict{String,Any}("assessmentRunArn" => assessmentRunArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_exclusions(
assessmentRunArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"ListExclusions",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("assessmentRunArn" => assessmentRunArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_findings()
list_findings(params::Dict{String,<:Any})
Lists findings that are generated by the assessment runs that are specified by the ARNs of
the assessment runs.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assessmentRunArns"`: The ARNs of the assessment runs that generate the findings that
you want to list.
- `"filter"`: You can use this parameter to specify a subset of data to be included in the
action's response. For a record to match a filter, all specified filter attributes must
match. When multiple values are specified for a filter attribute, any of the values can
match.
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 10. The maximum value is 500.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the ListFindings action. Subsequent calls to the
action fill nextToken in the request with the value of NextToken from the previous response
to continue listing data.
"""
function list_findings(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector("ListFindings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_findings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"ListFindings", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_rules_packages()
list_rules_packages(params::Dict{String,<:Any})
Lists all available Amazon Inspector rules packages.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 10. The maximum value is 500.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the ListRulesPackages action. Subsequent calls to
the action fill nextToken in the request with the value of NextToken from the previous
response to continue listing data.
"""
function list_rules_packages(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector(
"ListRulesPackages"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_rules_packages(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"ListRulesPackages", 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 an assessment template.
# Arguments
- `resource_arn`: The ARN that specifies the assessment template whose tags you want to
list.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"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 inspector(
"ListTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
preview_agents(preview_agents_arn)
preview_agents(preview_agents_arn, params::Dict{String,<:Any})
Previews the agents installed on the EC2 instances that are part of the specified
assessment target.
# Arguments
- `preview_agents_arn`: The ARN of the assessment target whose agents you want to preview.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: You can use this parameter to indicate the maximum number of items you
want in the response. The default value is 10. The maximum value is 500.
- `"nextToken"`: You can use this parameter when paginating results. Set the value of this
parameter to null on your first call to the PreviewAgents action. Subsequent calls to the
action fill nextToken in the request with the value of NextToken from the previous response
to continue listing data.
"""
function preview_agents(previewAgentsArn; aws_config::AbstractAWSConfig=global_aws_config())
return inspector(
"PreviewAgents",
Dict{String,Any}("previewAgentsArn" => previewAgentsArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function preview_agents(
previewAgentsArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"PreviewAgents",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("previewAgentsArn" => previewAgentsArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_cross_account_access_role(role_arn)
register_cross_account_access_role(role_arn, params::Dict{String,<:Any})
Registers the IAM role that grants Amazon Inspector access to AWS Services needed to
perform security assessments.
# Arguments
- `role_arn`: The ARN of the IAM role that grants Amazon Inspector access to AWS Services
needed to perform security assessments.
"""
function register_cross_account_access_role(
roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"RegisterCrossAccountAccessRole",
Dict{String,Any}("roleArn" => roleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_cross_account_access_role(
roleArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"RegisterCrossAccountAccessRole",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("roleArn" => roleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_attributes_from_findings(attribute_keys, finding_arns)
remove_attributes_from_findings(attribute_keys, finding_arns, params::Dict{String,<:Any})
Removes entire attributes (key and value pairs) from the findings that are specified by the
ARNs of the findings where an attribute with the specified key exists.
# Arguments
- `attribute_keys`: The array of attribute keys that you want to remove from specified
findings.
- `finding_arns`: The ARNs that specify the findings that you want to remove attributes
from.
"""
function remove_attributes_from_findings(
attributeKeys, findingArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"RemoveAttributesFromFindings",
Dict{String,Any}("attributeKeys" => attributeKeys, "findingArns" => findingArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_attributes_from_findings(
attributeKeys,
findingArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"RemoveAttributesFromFindings",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"attributeKeys" => attributeKeys, "findingArns" => findingArns
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_tags_for_resource(resource_arn)
set_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Sets tags (key and value pairs) to the assessment template that is specified by the ARN of
the assessment template.
# Arguments
- `resource_arn`: The ARN of the assessment template that you want to set tags to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A collection of key and value pairs that you want to set to the assessment
template.
"""
function set_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"SetTagsForResource",
Dict{String,Any}("resourceArn" => resourceArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"SetTagsForResource",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_assessment_run(assessment_template_arn)
start_assessment_run(assessment_template_arn, params::Dict{String,<:Any})
Starts the assessment run specified by the ARN of the assessment template. For this API to
function properly, you must not exceed the limit of running up to 500 concurrent agents per
AWS account.
# Arguments
- `assessment_template_arn`: The ARN of the assessment template of the assessment run that
you want to start.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"assessmentRunName"`: You can specify the name for the assessment run. The name must be
unique for the assessment template whose ARN is used to start the assessment run.
"""
function start_assessment_run(
assessmentTemplateArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"StartAssessmentRun",
Dict{String,Any}("assessmentTemplateArn" => assessmentTemplateArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_assessment_run(
assessmentTemplateArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"StartAssessmentRun",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("assessmentTemplateArn" => assessmentTemplateArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_assessment_run(assessment_run_arn)
stop_assessment_run(assessment_run_arn, params::Dict{String,<:Any})
Stops the assessment run that is specified by the ARN of the assessment run.
# Arguments
- `assessment_run_arn`: The ARN of the assessment run that you want to stop.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"stopAction"`: An input option that can be set to either START_EVALUATION or
SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting
data and begins the results evaluation and the findings generation process. SKIP_EVALUATION
cancels the assessment run immediately, after which no findings are generated.
"""
function stop_assessment_run(
assessmentRunArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"StopAssessmentRun",
Dict{String,Any}("assessmentRunArn" => assessmentRunArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_assessment_run(
assessmentRunArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"StopAssessmentRun",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("assessmentRunArn" => assessmentRunArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
subscribe_to_event(event, resource_arn, topic_arn)
subscribe_to_event(event, resource_arn, topic_arn, params::Dict{String,<:Any})
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about
a specified event to a specified SNS topic.
# Arguments
- `event`: The event for which you want to receive SNS notifications.
- `resource_arn`: The ARN of the assessment template that is used during the event for
which you want to receive SNS notifications.
- `topic_arn`: The ARN of the SNS topic to which the SNS notifications are sent.
"""
function subscribe_to_event(
event, resourceArn, topicArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"SubscribeToEvent",
Dict{String,Any}(
"event" => event, "resourceArn" => resourceArn, "topicArn" => topicArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function subscribe_to_event(
event,
resourceArn,
topicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"SubscribeToEvent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"event" => event, "resourceArn" => resourceArn, "topicArn" => topicArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
unsubscribe_from_event(event, resource_arn, topic_arn)
unsubscribe_from_event(event, resource_arn, topic_arn, params::Dict{String,<:Any})
Disables the process of sending Amazon Simple Notification Service (SNS) notifications
about a specified event to a specified SNS topic.
# Arguments
- `event`: The event for which you want to stop receiving SNS notifications.
- `resource_arn`: The ARN of the assessment template that is used during the event for
which you want to stop receiving SNS notifications.
- `topic_arn`: The ARN of the SNS topic to which SNS notifications are sent.
"""
function unsubscribe_from_event(
event, resourceArn, topicArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector(
"UnsubscribeFromEvent",
Dict{String,Any}(
"event" => event, "resourceArn" => resourceArn, "topicArn" => topicArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unsubscribe_from_event(
event,
resourceArn,
topicArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"UnsubscribeFromEvent",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"event" => event, "resourceArn" => resourceArn, "topicArn" => topicArn
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_assessment_target(assessment_target_arn, assessment_target_name)
update_assessment_target(assessment_target_arn, assessment_target_name, params::Dict{String,<:Any})
Updates the assessment target that is specified by the ARN of the assessment target. If
resourceGroupArn is not specified, all EC2 instances in the current AWS account and region
are included in the assessment target.
# Arguments
- `assessment_target_arn`: The ARN of the assessment target that you want to update.
- `assessment_target_name`: The name of the assessment target that you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"resourceGroupArn"`: The ARN of the resource group that is used to specify the new
resource group to associate with the assessment target.
"""
function update_assessment_target(
assessmentTargetArn,
assessmentTargetName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"UpdateAssessmentTarget",
Dict{String,Any}(
"assessmentTargetArn" => assessmentTargetArn,
"assessmentTargetName" => assessmentTargetName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_assessment_target(
assessmentTargetArn,
assessmentTargetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector(
"UpdateAssessmentTarget",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assessmentTargetArn" => assessmentTargetArn,
"assessmentTargetName" => assessmentTargetName,
),
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 | 74648 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: inspector2
using AWS.Compat
using AWS.UUIDs
"""
associate_member(account_id)
associate_member(account_id, params::Dict{String,<:Any})
Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.
An HTTP 200 response indicates the association was successfully started, but doesn’t
indicate whether it was completed. You can check if the association completed by using
ListMembers for multiple accounts or GetMembers for a single account.
# Arguments
- `account_id`: The Amazon Web Services account ID of the member account to be associated.
"""
function associate_member(accountId; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/members/associate",
Dict{String,Any}("accountId" => accountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_member(
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/members/associate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountId" => accountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_account_status()
batch_get_account_status(params::Dict{String,<:Any})
Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your
environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The 12-digit Amazon Web Services account IDs of the accounts to retrieve
Amazon Inspector status for.
"""
function batch_get_account_status(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST", "/status/batch/get"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function batch_get_account_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/status/batch/get",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_code_snippet(finding_arns)
batch_get_code_snippet(finding_arns, params::Dict{String,<:Any})
Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities
in.
# Arguments
- `finding_arns`: An array of finding ARNs for the findings you want to retrieve code
snippets from.
"""
function batch_get_code_snippet(
findingArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/codesnippet/batchget",
Dict{String,Any}("findingArns" => findingArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_code_snippet(
findingArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/codesnippet/batchget",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("findingArns" => findingArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_finding_details(finding_arns)
batch_get_finding_details(finding_arns, params::Dict{String,<:Any})
Gets vulnerability details for findings.
# Arguments
- `finding_arns`: A list of finding ARNs.
"""
function batch_get_finding_details(
findingArns; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/findings/details/batch/get",
Dict{String,Any}("findingArns" => findingArns);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_finding_details(
findingArns,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/findings/details/batch/get",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("findingArns" => findingArns), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_free_trial_info(account_ids)
batch_get_free_trial_info(account_ids, params::Dict{String,<:Any})
Gets free trial status for multiple Amazon Web Services accounts.
# Arguments
- `account_ids`: The account IDs to get free trial status for.
"""
function batch_get_free_trial_info(
accountIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/freetrialinfo/batchget",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_free_trial_info(
accountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/freetrialinfo/batchget",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_member_ec2_deep_inspection_status()
batch_get_member_ec2_deep_inspection_status(params::Dict{String,<:Any})
Retrieves Amazon Inspector deep inspection activation status of multiple member accounts
within your organization. You must be the delegated administrator of an organization in
Amazon Inspector to use this API.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The unique identifiers for the Amazon Web Services accounts to retrieve
Amazon Inspector deep inspection activation status for. </p>
"""
function batch_get_member_ec2_deep_inspection_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/ec2deepinspectionstatus/member/batch/get";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_member_ec2_deep_inspection_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/ec2deepinspectionstatus/member/batch/get",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_member_ec2_deep_inspection_status(account_ids)
batch_update_member_ec2_deep_inspection_status(account_ids, params::Dict{String,<:Any})
Activates or deactivates Amazon Inspector deep inspection for the provided member accounts
in your organization. You must be the delegated administrator of an organization in Amazon
Inspector to use this API.
# Arguments
- `account_ids`: The unique identifiers for the Amazon Web Services accounts to change
Amazon Inspector deep inspection status for.
"""
function batch_update_member_ec2_deep_inspection_status(
accountIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/ec2deepinspectionstatus/member/batch/update",
Dict{String,Any}("accountIds" => accountIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_member_ec2_deep_inspection_status(
accountIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/ec2deepinspectionstatus/member/batch/update",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountIds" => accountIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_findings_report(report_id)
cancel_findings_report(report_id, params::Dict{String,<:Any})
Cancels the given findings report.
# Arguments
- `report_id`: The ID of the report to be canceled.
"""
function cancel_findings_report(reportId; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/reporting/cancel",
Dict{String,Any}("reportId" => reportId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_findings_report(
reportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/reporting/cancel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("reportId" => reportId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_sbom_export(report_id)
cancel_sbom_export(report_id, params::Dict{String,<:Any})
Cancels a software bill of materials (SBOM) report.
# Arguments
- `report_id`: The report ID of the SBOM export to cancel.
"""
function cancel_sbom_export(reportId; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/sbomexport/cancel",
Dict{String,Any}("reportId" => reportId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_sbom_export(
reportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/sbomexport/cancel",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("reportId" => reportId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_cis_scan_configuration(scan_name, schedule, security_level, targets)
create_cis_scan_configuration(scan_name, schedule, security_level, targets, params::Dict{String,<:Any})
Creates a CIS scan configuration.
# Arguments
- `scan_name`: The scan name for the CIS scan configuration.
- `schedule`: The schedule for the CIS scan configuration.
- `security_level`: The security level for the CIS scan configuration. Security level
refers to the Benchmark levels that CIS assigns to a profile.
- `targets`: The targets for the CIS scan configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: The tags for the CIS scan configuration.
"""
function create_cis_scan_configuration(
scanName,
schedule,
securityLevel,
targets;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/cis/scan-configuration/create",
Dict{String,Any}(
"scanName" => scanName,
"schedule" => schedule,
"securityLevel" => securityLevel,
"targets" => targets,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_cis_scan_configuration(
scanName,
schedule,
securityLevel,
targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/cis/scan-configuration/create",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"scanName" => scanName,
"schedule" => schedule,
"securityLevel" => securityLevel,
"targets" => targets,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_filter(action, filter_criteria, name)
create_filter(action, filter_criteria, name, params::Dict{String,<:Any})
Creates a filter resource using specified filter criteria. When the filter action is set to
SUPPRESS this action creates a suppression rule.
# Arguments
- `action`: Defines the action that is to be applied to the findings that match the filter.
- `filter_criteria`: Defines the criteria to be used in the filter for querying findings.
- `name`: The name of the filter. Minimum length of 3. Maximum length of 64. Valid
characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces
are not allowed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the filter.
- `"reason"`: The reason for creating the filter.
- `"tags"`: A list of tags for the filter.
"""
function create_filter(
action, filterCriteria, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/filters/create",
Dict{String,Any}(
"action" => action, "filterCriteria" => filterCriteria, "name" => name
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_filter(
action,
filterCriteria,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/filters/create",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"action" => action, "filterCriteria" => filterCriteria, "name" => name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_findings_report(report_format, s3_destination)
create_findings_report(report_format, s3_destination, params::Dict{String,<:Any})
Creates a finding report. By default only ACTIVE findings are returned in the report. To
see SUPRESSED or CLOSED findings you must specify a value for the findingStatus filter
criteria.
# Arguments
- `report_format`: The format to generate the report in.
- `s3_destination`: The Amazon S3 export destination for the report.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: The filter criteria to apply to the results of the finding report.
"""
function create_findings_report(
reportFormat, s3Destination; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/reporting/create",
Dict{String,Any}("reportFormat" => reportFormat, "s3Destination" => s3Destination);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_findings_report(
reportFormat,
s3Destination,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/reporting/create",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"reportFormat" => reportFormat, "s3Destination" => s3Destination
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_sbom_export(report_format, s3_destination)
create_sbom_export(report_format, s3_destination, params::Dict{String,<:Any})
Creates a software bill of materials (SBOM) report.
# Arguments
- `report_format`: The output format for the software bill of materials (SBOM) report.
- `s3_destination`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"resourceFilterCriteria"`: The resource filter criteria for the software bill of
materials (SBOM) report.
"""
function create_sbom_export(
reportFormat, s3Destination; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/sbomexport/create",
Dict{String,Any}("reportFormat" => reportFormat, "s3Destination" => s3Destination);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_sbom_export(
reportFormat,
s3Destination,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/sbomexport/create",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"reportFormat" => reportFormat, "s3Destination" => s3Destination
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cis_scan_configuration(scan_configuration_arn)
delete_cis_scan_configuration(scan_configuration_arn, params::Dict{String,<:Any})
Deletes a CIS scan configuration.
# Arguments
- `scan_configuration_arn`: The ARN of the CIS scan configuration.
"""
function delete_cis_scan_configuration(
scanConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/cis/scan-configuration/delete",
Dict{String,Any}("scanConfigurationArn" => scanConfigurationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cis_scan_configuration(
scanConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/cis/scan-configuration/delete",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("scanConfigurationArn" => scanConfigurationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_filter(arn)
delete_filter(arn, params::Dict{String,<:Any})
Deletes a filter resource.
# Arguments
- `arn`: The Amazon Resource Number (ARN) of the filter to be deleted.
"""
function delete_filter(arn; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/filters/delete",
Dict{String,Any}("arn" => arn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_filter(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/filters/delete",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("arn" => arn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_organization_configuration()
describe_organization_configuration(params::Dict{String,<:Any})
Describe Amazon Inspector configuration settings for an Amazon Web Services organization.
"""
function describe_organization_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/organizationconfiguration/describe";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_organization_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/organizationconfiguration/describe",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable()
disable(params::Dict{String,<:Any})
Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all
scan types in an account disables the Amazon Inspector service.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: An array of account IDs you want to disable Amazon Inspector scans for.
- `"resourceTypes"`: The resource scan types you want to disable.
"""
function disable(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST", "/disable"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function disable(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST", "/disable", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
disable_delegated_admin_account(delegated_admin_account_id)
disable_delegated_admin_account(delegated_admin_account_id, params::Dict{String,<:Any})
Disables the Amazon Inspector delegated administrator for your organization.
# Arguments
- `delegated_admin_account_id`: The Amazon Web Services account ID of the current Amazon
Inspector delegated administrator.
"""
function disable_delegated_admin_account(
delegatedAdminAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/delegatedadminaccounts/disable",
Dict{String,Any}("delegatedAdminAccountId" => delegatedAdminAccountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_delegated_admin_account(
delegatedAdminAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/delegatedadminaccounts/disable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("delegatedAdminAccountId" => delegatedAdminAccountId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_member(account_id)
disassociate_member(account_id, params::Dict{String,<:Any})
Disassociates a member account from an Amazon Inspector delegated administrator.
# Arguments
- `account_id`: The Amazon Web Services account ID of the member account to disassociate.
"""
function disassociate_member(accountId; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/members/disassociate",
Dict{String,Any}("accountId" => accountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_member(
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/members/disassociate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountId" => accountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable(resource_types)
enable(resource_types, params::Dict{String,<:Any})
Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
# Arguments
- `resource_types`: The resource scan types you want to enable.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: A list of account IDs you want to enable Amazon Inspector scans for.
- `"clientToken"`: The idempotency token for the request.
"""
function enable(resourceTypes; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/enable",
Dict{String,Any}(
"resourceTypes" => resourceTypes, "clientToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable(
resourceTypes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/enable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"resourceTypes" => resourceTypes, "clientToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_delegated_admin_account(delegated_admin_account_id)
enable_delegated_admin_account(delegated_admin_account_id, params::Dict{String,<:Any})
Enables the Amazon Inspector delegated administrator for your Organizations organization.
# Arguments
- `delegated_admin_account_id`: The Amazon Web Services account ID of the Amazon Inspector
delegated administrator.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: The idempotency token for the request.
"""
function enable_delegated_admin_account(
delegatedAdminAccountId; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/delegatedadminaccounts/enable",
Dict{String,Any}(
"delegatedAdminAccountId" => delegatedAdminAccountId,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_delegated_admin_account(
delegatedAdminAccountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/delegatedadminaccounts/enable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"delegatedAdminAccountId" => delegatedAdminAccountId,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cis_scan_report(scan_arn)
get_cis_scan_report(scan_arn, params::Dict{String,<:Any})
Retrieves a CIS scan report.
# Arguments
- `scan_arn`: The scan ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"reportFormat"`: The format of the report. Valid values are PDF and CSV. If no value is
specified, the report format defaults to PDF.
- `"targetAccounts"`: The target accounts.
"""
function get_cis_scan_report(scanArn; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/cis/scan/report/get",
Dict{String,Any}("scanArn" => scanArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cis_scan_report(
scanArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/cis/scan/report/get",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("scanArn" => scanArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cis_scan_result_details(account_id, scan_arn, target_resource_id)
get_cis_scan_result_details(account_id, scan_arn, target_resource_id, params::Dict{String,<:Any})
Retrieves CIS scan result details.
# Arguments
- `account_id`: The account ID.
- `scan_arn`: The scan ARN.
- `target_resource_id`: The target resource ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: The filter criteria.
- `"maxResults"`: The maximum number of CIS scan result details to be returned in a single
page of results.
- `"nextToken"`: The pagination token from a previous request that's used to retrieve the
next page of results.
- `"sortBy"`: The sort by order.
- `"sortOrder"`: The sort order.
"""
function get_cis_scan_result_details(
accountId, scanArn, targetResourceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/cis/scan-result/details/get",
Dict{String,Any}(
"accountId" => accountId,
"scanArn" => scanArn,
"targetResourceId" => targetResourceId,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cis_scan_result_details(
accountId,
scanArn,
targetResourceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/cis/scan-result/details/get",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"accountId" => accountId,
"scanArn" => scanArn,
"targetResourceId" => targetResourceId,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_configuration()
get_configuration(params::Dict{String,<:Any})
Retrieves setting configurations for Inspector scans.
"""
function get_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST", "/configuration/get"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/configuration/get",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_delegated_admin_account()
get_delegated_admin_account(params::Dict{String,<:Any})
Retrieves information about the Amazon Inspector delegated administrator for your
organization.
"""
function get_delegated_admin_account(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/delegatedadminaccounts/get";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_delegated_admin_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/delegatedadminaccounts/get",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_ec2_deep_inspection_configuration()
get_ec2_deep_inspection_configuration(params::Dict{String,<:Any})
Retrieves the activation status of Amazon Inspector deep inspection and custom paths
associated with your account.
"""
function get_ec2_deep_inspection_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/ec2deepinspectionconfiguration/get";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_ec2_deep_inspection_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/ec2deepinspectionconfiguration/get",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_encryption_key(resource_type, scan_type)
get_encryption_key(resource_type, scan_type, params::Dict{String,<:Any})
Gets an encryption key.
# Arguments
- `resource_type`: The resource type the key encrypts.
- `scan_type`: The scan type the key encrypts.
"""
function get_encryption_key(
resourceType, scanType; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"GET",
"/encryptionkey/get",
Dict{String,Any}("resourceType" => resourceType, "scanType" => scanType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_encryption_key(
resourceType,
scanType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"GET",
"/encryptionkey/get",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceType" => resourceType, "scanType" => scanType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_findings_report_status()
get_findings_report_status(params::Dict{String,<:Any})
Gets the status of a findings report.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"reportId"`: The ID of the report to retrieve the status of.
"""
function get_findings_report_status(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/reporting/status/get";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_findings_report_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/reporting/status/get",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_member(account_id)
get_member(account_id, params::Dict{String,<:Any})
Gets member information for your organization.
# Arguments
- `account_id`: The Amazon Web Services account ID of the member account to retrieve
information on.
"""
function get_member(accountId; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/members/get",
Dict{String,Any}("accountId" => accountId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_member(
accountId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/members/get",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("accountId" => accountId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_sbom_export(report_id)
get_sbom_export(report_id, params::Dict{String,<:Any})
Gets details of a software bill of materials (SBOM) report.
# Arguments
- `report_id`: The report ID of the SBOM export to get details for.
"""
function get_sbom_export(reportId; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/sbomexport/get",
Dict{String,Any}("reportId" => reportId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_sbom_export(
reportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/sbomexport/get",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("reportId" => reportId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_account_permissions()
list_account_permissions(params::Dict{String,<:Any})
Lists the permissions an account has to configure Amazon Inspector.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results the response can return. If your request
would return more than the maximum the response will return a nextToken value, use this
value when you call the action again to get the remaining results.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. If your
response returns more than the maxResults maximum value it will also return a nextToken
value. For subsequent calls, use the NextToken value returned from the previous request to
continue listing results after the first page.
- `"service"`: The service scan type to check permissions for.
"""
function list_account_permissions(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/accountpermissions/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_account_permissions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/accountpermissions/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cis_scan_configurations()
list_cis_scan_configurations(params::Dict{String,<:Any})
Lists CIS scan configurations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: The CIS scan configuration filter criteria.
- `"maxResults"`: The maximum number of CIS scan configurations to be returned in a single
page of results.
- `"nextToken"`: The pagination token from a previous request that's used to retrieve the
next page of results.
- `"sortBy"`: The CIS scan configuration sort by order.
- `"sortOrder"`: The CIS scan configuration sort order order.
"""
function list_cis_scan_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/cis/scan-configuration/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cis_scan_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/cis/scan-configuration/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cis_scan_results_aggregated_by_checks(scan_arn)
list_cis_scan_results_aggregated_by_checks(scan_arn, params::Dict{String,<:Any})
Lists scan results aggregated by checks.
# Arguments
- `scan_arn`: The scan ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: The filter criteria.
- `"maxResults"`: The maximum number of scan results aggregated by checks to be returned in
a single page of results.
- `"nextToken"`: The pagination token from a previous request that's used to retrieve the
next page of results.
- `"sortBy"`: The sort by order.
- `"sortOrder"`: The sort order.
"""
function list_cis_scan_results_aggregated_by_checks(
scanArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/cis/scan-result/check/list",
Dict{String,Any}("scanArn" => scanArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cis_scan_results_aggregated_by_checks(
scanArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/cis/scan-result/check/list",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("scanArn" => scanArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cis_scan_results_aggregated_by_target_resource(scan_arn)
list_cis_scan_results_aggregated_by_target_resource(scan_arn, params::Dict{String,<:Any})
Lists scan results aggregated by a target resource.
# Arguments
- `scan_arn`: The scan ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: The filter criteria.
- `"maxResults"`: The maximum number of scan results aggregated by a target resource to be
returned in a single page of results.
- `"nextToken"`: The pagination token from a previous request that's used to retrieve the
next page of results.
- `"sortBy"`: The sort by order.
- `"sortOrder"`: The sort order.
"""
function list_cis_scan_results_aggregated_by_target_resource(
scanArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/cis/scan-result/resource/list",
Dict{String,Any}("scanArn" => scanArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_cis_scan_results_aggregated_by_target_resource(
scanArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/cis/scan-result/resource/list",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("scanArn" => scanArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cis_scans()
list_cis_scans(params::Dict{String,<:Any})
Returns a CIS scan list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"detailLevel"`: The detail applied to the CIS scan.
- `"filterCriteria"`: The CIS scan filter criteria.
- `"maxResults"`: The maximum number of results to be returned.
- `"nextToken"`: The pagination token from a previous request that's used to retrieve the
next page of results.
- `"sortBy"`: The CIS scans sort by order.
- `"sortOrder"`: The CIS scans sort order.
"""
function list_cis_scans(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST", "/cis/scan/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_cis_scans(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/cis/scan/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_coverage()
list_coverage(params::Dict{String,<:Any})
Lists coverage details for you environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: An object that contains details on the filters to apply to the
coverage data for your environment.
- `"maxResults"`: The maximum number of results the response can return. If your request
would return more than the maximum the response will return a nextToken value, use this
value when you call the action again to get the remaining results.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. If your
response returns more than the maxResults maximum value it will also return a nextToken
value. For subsequent calls, use the nextToken value returned from the previous request to
continue listing results after the first page.
"""
function list_coverage(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST", "/coverage/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_coverage(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/coverage/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_coverage_statistics()
list_coverage_statistics(params::Dict{String,<:Any})
Lists Amazon Inspector coverage statistics for your environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: An object that contains details on the filters to apply to the
coverage data for your environment.
- `"groupBy"`: The value to group the results by.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. For
subsequent calls, use the NextToken value returned from the previous request to continue
listing results after the first page.
"""
function list_coverage_statistics(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/coverage/statistics/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_coverage_statistics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/coverage/statistics/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_delegated_admin_accounts()
list_delegated_admin_accounts(params::Dict{String,<:Any})
Lists information about the Amazon Inspector delegated administrator of your organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results the response can return. If your request
would return more than the maximum the response will return a nextToken value, use this
value when you call the action again to get the remaining results.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. If your
response returns more than the maxResults maximum value it will also return a nextToken
value. For subsequent calls, use the nextToken value returned from the previous request to
continue listing results after the first page.
"""
function list_delegated_admin_accounts(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/delegatedadminaccounts/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_delegated_admin_accounts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/delegatedadminaccounts/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_filters()
list_filters(params::Dict{String,<:Any})
Lists the filters associated with your account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"action"`: The action the filter applies to matched findings.
- `"arns"`: The Amazon resource number (ARN) of the filter.
- `"maxResults"`: The maximum number of results the response can return. If your request
would return more than the maximum the response will return a nextToken value, use this
value when you call the action again to get the remaining results.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. If your
response returns more than the maxResults maximum value it will also return a nextToken
value. For subsequent calls, use the nextToken value returned from the previous request to
continue listing results after the first page.
"""
function list_filters(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST", "/filters/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_filters(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/filters/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_finding_aggregations(aggregation_type)
list_finding_aggregations(aggregation_type, params::Dict{String,<:Any})
Lists aggregated finding data for your environment based on specific criteria.
# Arguments
- `aggregation_type`: The type of the aggregation request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The Amazon Web Services account IDs to retrieve finding aggregation data
for.
- `"aggregationRequest"`: Details of the aggregation request that is used to filter your
aggregation results.
- `"maxResults"`: The maximum number of results the response can return. If your request
would return more than the maximum the response will return a nextToken value, use this
value when you call the action again to get the remaining results.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. If your
response returns more than the maxResults maximum value it will also return a nextToken
value. For subsequent calls, use the nextToken value returned from the previous request to
continue listing results after the first page.
"""
function list_finding_aggregations(
aggregationType; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/findings/aggregation/list",
Dict{String,Any}("aggregationType" => aggregationType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_finding_aggregations(
aggregationType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/findings/aggregation/list",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("aggregationType" => aggregationType), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_findings()
list_findings(params::Dict{String,<:Any})
Lists findings for your environment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"filterCriteria"`: Details on the filters to apply to your finding results.
- `"maxResults"`: The maximum number of results the response can return. If your request
would return more than the maximum the response will return a nextToken value, use this
value when you call the action again to get the remaining results.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. If your
response returns more than the maxResults maximum value it will also return a nextToken
value. For subsequent calls, use the nextToken value returned from the previous request to
continue listing results after the first page.
- `"sortCriteria"`: Details on the sort criteria to apply to your finding results.
"""
function list_findings(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST", "/findings/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_findings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/findings/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_members()
list_members(params::Dict{String,<:Any})
List members associated with the Amazon Inspector delegated administrator for your
organization.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results the response can return. If your request
would return more than the maximum the response will return a nextToken value, use this
value when you call the action again to get the remaining results.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. If your
response returns more than the maxResults maximum value it will also return a nextToken
value. For subsequent calls, use the nextToken value returned from the previous request to
continue listing results after the first page.
- `"onlyAssociated"`: Specifies whether to list only currently associated members if True
or to list all members within the organization if False.
"""
function list_members(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST", "/members/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_members(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/members/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 attached to a given resource.
# Arguments
- `resource_arn`: The Amazon resource number (ARN) of the resource to list tags of.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"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 inspector2(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_usage_totals()
list_usage_totals(params::Dict{String,<:Any})
Lists the Amazon Inspector usage totals over the last 30 days.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountIds"`: The Amazon Web Services account IDs to retrieve usage totals for.
- `"maxResults"`: The maximum number of results the response can return. If your request
would return more than the maximum the response will return a nextToken value, use this
value when you call the action again to get the remaining results.
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. If your
response returns more than the maxResults maximum value it will also return a nextToken
value. For subsequent calls, use the nextToken value returned from the previous request to
continue listing results after the first page.
"""
function list_usage_totals(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST", "/usage/list"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_usage_totals(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/usage/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_encryption_key(resource_type, scan_type)
reset_encryption_key(resource_type, scan_type, params::Dict{String,<:Any})
Resets an encryption key. After the key is reset your resources will be encrypted by an
Amazon Web Services owned key.
# Arguments
- `resource_type`: The resource type the key encrypts.
- `scan_type`: The scan type the key encrypts.
"""
function reset_encryption_key(
resourceType, scanType; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"PUT",
"/encryptionkey/reset",
Dict{String,Any}("resourceType" => resourceType, "scanType" => scanType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_encryption_key(
resourceType,
scanType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"PUT",
"/encryptionkey/reset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceType" => resourceType, "scanType" => scanType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_vulnerabilities(filter_criteria)
search_vulnerabilities(filter_criteria, params::Dict{String,<:Any})
Lists Amazon Inspector coverage details for a specific vulnerability.
# Arguments
- `filter_criteria`: The criteria used to filter the results of a vulnerability search.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list action. For
subsequent calls, use the NextToken value returned from the previous request to continue
listing results after the first page.
"""
function search_vulnerabilities(
filterCriteria; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/vulnerabilities/search",
Dict{String,Any}("filterCriteria" => filterCriteria);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_vulnerabilities(
filterCriteria,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/vulnerabilities/search",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("filterCriteria" => filterCriteria), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_cis_session_health(scan_job_id, session_token)
send_cis_session_health(scan_job_id, session_token, params::Dict{String,<:Any})
Sends a CIS session health. This API is used by the Amazon Inspector SSM plugin to
communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this
API to start a CIS scan session for the scan ID supplied by the service.
# Arguments
- `scan_job_id`: A unique identifier for the scan job.
- `session_token`: The unique token that identifies the CIS session.
"""
function send_cis_session_health(
scanJobId, sessionToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"PUT",
"/cissession/health/send",
Dict{String,Any}("scanJobId" => scanJobId, "sessionToken" => sessionToken);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_cis_session_health(
scanJobId,
sessionToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"PUT",
"/cissession/health/send",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("scanJobId" => scanJobId, "sessionToken" => sessionToken),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_cis_session_telemetry(messages, scan_job_id, session_token)
send_cis_session_telemetry(messages, scan_job_id, session_token, params::Dict{String,<:Any})
Sends a CIS session telemetry. This API is used by the Amazon Inspector SSM plugin to
communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this
API to start a CIS scan session for the scan ID supplied by the service.
# Arguments
- `messages`: The CIS session telemetry messages.
- `scan_job_id`: A unique identifier for the scan job.
- `session_token`: The unique token that identifies the CIS session.
"""
function send_cis_session_telemetry(
messages, scanJobId, sessionToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"PUT",
"/cissession/telemetry/send",
Dict{String,Any}(
"messages" => messages, "scanJobId" => scanJobId, "sessionToken" => sessionToken
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_cis_session_telemetry(
messages,
scanJobId,
sessionToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"PUT",
"/cissession/telemetry/send",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"messages" => messages,
"scanJobId" => scanJobId,
"sessionToken" => sessionToken,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_cis_session(message, scan_job_id)
start_cis_session(message, scan_job_id, params::Dict{String,<:Any})
Starts a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate
with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start
a CIS scan session for the scan ID supplied by the service.
# Arguments
- `message`: The start CIS session message.
- `scan_job_id`: A unique identifier for the scan job.
"""
function start_cis_session(
message, scanJobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"PUT",
"/cissession/start",
Dict{String,Any}("message" => message, "scanJobId" => scanJobId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_cis_session(
message,
scanJobId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"PUT",
"/cissession/start",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("message" => message, "scanJobId" => scanJobId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_cis_session(message, scan_job_id, session_token)
stop_cis_session(message, scan_job_id, session_token, params::Dict{String,<:Any})
Stops a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate
with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start
a CIS scan session for the scan ID supplied by the service.
# Arguments
- `message`: The stop CIS session message.
- `scan_job_id`: A unique identifier for the scan job.
- `session_token`: The unique token that identifies the CIS session.
"""
function stop_cis_session(
message, scanJobId, sessionToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"PUT",
"/cissession/stop",
Dict{String,Any}(
"message" => message, "scanJobId" => scanJobId, "sessionToken" => sessionToken
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_cis_session(
message,
scanJobId,
sessionToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"PUT",
"/cissession/stop",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"message" => message,
"scanJobId" => scanJobId,
"sessionToken" => sessionToken,
),
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 Amazon Resource Name (ARN) of the resource to apply a tag to.
- `tags`: The tags to be added to a resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"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 inspector2(
"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 Amazon Resource Name (ARN) for the resource to remove tags from.
- `tag_keys`: The tag keys to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"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 inspector2(
"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_cis_scan_configuration(scan_configuration_arn)
update_cis_scan_configuration(scan_configuration_arn, params::Dict{String,<:Any})
Updates a CIS scan configuration.
# Arguments
- `scan_configuration_arn`: The CIS scan configuration ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"scanName"`: The scan name for the CIS scan configuration.
- `"schedule"`: The schedule for the CIS scan configuration.
- `"securityLevel"`: The security level for the CIS scan configuration. Security level
refers to the Benchmark levels that CIS assigns to a profile.
- `"targets"`: The targets for the CIS scan configuration.
"""
function update_cis_scan_configuration(
scanConfigurationArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/cis/scan-configuration/update",
Dict{String,Any}("scanConfigurationArn" => scanConfigurationArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cis_scan_configuration(
scanConfigurationArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/cis/scan-configuration/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("scanConfigurationArn" => scanConfigurationArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_configuration()
update_configuration(params::Dict{String,<:Any})
Updates setting configurations for your Amazon Inspector account. When you use this API as
an Amazon Inspector delegated administrator this updates the setting for all accounts you
manage. Member accounts in an organization cannot update this setting.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ec2Configuration"`: Specifies how the Amazon EC2 automated scan will be updated for
your environment.
- `"ecrConfiguration"`: Specifies how the ECR automated re-scan will be updated for your
environment.
"""
function update_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/configuration/update";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/configuration/update",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_ec2_deep_inspection_configuration()
update_ec2_deep_inspection_configuration(params::Dict{String,<:Any})
Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your
account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"activateDeepInspection"`: Specify TRUE to activate Amazon Inspector deep inspection in
your account, or FALSE to deactivate. Member accounts in an organization cannot deactivate
deep inspection, instead the delegated administrator for the organization can deactivate a
member account using BatchUpdateMemberEc2DeepInspectionStatus.
- `"packagePaths"`: The Amazon Inspector deep inspection custom paths you are adding for
your account.
"""
function update_ec2_deep_inspection_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/ec2deepinspectionconfiguration/update";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_ec2_deep_inspection_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/ec2deepinspectionconfiguration/update",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_encryption_key(kms_key_id, resource_type, scan_type)
update_encryption_key(kms_key_id, resource_type, scan_type, params::Dict{String,<:Any})
Updates an encryption key. A ResourceNotFoundException means that an Amazon Web Services
owned key is being used for encryption.
# Arguments
- `kms_key_id`: A KMS key ID for the encryption key.
- `resource_type`: The resource type for the encryption key.
- `scan_type`: The scan type for the encryption key.
"""
function update_encryption_key(
kmsKeyId, resourceType, scanType; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"PUT",
"/encryptionkey/update",
Dict{String,Any}(
"kmsKeyId" => kmsKeyId, "resourceType" => resourceType, "scanType" => scanType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_encryption_key(
kmsKeyId,
resourceType,
scanType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"PUT",
"/encryptionkey/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"kmsKeyId" => kmsKeyId,
"resourceType" => resourceType,
"scanType" => scanType,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_filter(filter_arn)
update_filter(filter_arn, params::Dict{String,<:Any})
Specifies the action that is to be applied to the findings that match the filter.
# Arguments
- `filter_arn`: The Amazon Resource Number (ARN) of the filter to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"action"`: Specifies the action that is to be applied to the findings that match the
filter.
- `"description"`: A description of the filter.
- `"filterCriteria"`: Defines the criteria to be update in the filter.
- `"name"`: The name of the filter.
- `"reason"`: The reason the filter was updated.
"""
function update_filter(filterArn; aws_config::AbstractAWSConfig=global_aws_config())
return inspector2(
"POST",
"/filters/update",
Dict{String,Any}("filterArn" => filterArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_filter(
filterArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/filters/update",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("filterArn" => filterArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_org_ec2_deep_inspection_configuration(org_package_paths)
update_org_ec2_deep_inspection_configuration(org_package_paths, params::Dict{String,<:Any})
Updates the Amazon Inspector deep inspection custom paths for your organization. You must
be an Amazon Inspector delegated administrator to use this API.
# Arguments
- `org_package_paths`: The Amazon Inspector deep inspection custom paths you are adding for
your organization.
"""
function update_org_ec2_deep_inspection_configuration(
orgPackagePaths; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/ec2deepinspectionconfiguration/org/update",
Dict{String,Any}("orgPackagePaths" => orgPackagePaths);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_org_ec2_deep_inspection_configuration(
orgPackagePaths,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return inspector2(
"POST",
"/ec2deepinspectionconfiguration/org/update",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("orgPackagePaths" => orgPackagePaths), 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 configurations for your Amazon Inspector organization.
# Arguments
- `auto_enable`: Defines which scan types are enabled automatically for new members of your
Amazon Inspector organization.
"""
function update_organization_configuration(
autoEnable; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector2(
"POST",
"/organizationconfiguration/update",
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 inspector2(
"POST",
"/organizationconfiguration/update",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("autoEnable" => autoEnable), 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 | 1298 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: inspector_scan
using AWS.Compat
using AWS.UUIDs
"""
scan_sbom(sbom)
scan_sbom(sbom, params::Dict{String,<:Any})
Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that
SBOM. You can generate compatible SBOMs for your resources using the Amazon Inspector SBOM
generator.
# Arguments
- `sbom`: The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5
format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"outputFormat"`: The output format for the vulnerability report.
"""
function scan_sbom(sbom; aws_config::AbstractAWSConfig=global_aws_config())
return inspector_scan(
"POST",
"/scan/sbom",
Dict{String,Any}("sbom" => sbom);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function scan_sbom(
sbom, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return inspector_scan(
"POST",
"/scan/sbom",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("sbom" => sbom), 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 | 31450 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: internetmonitor
using AWS.Compat
using AWS.UUIDs
"""
create_monitor(monitor_name)
create_monitor(monitor_name, params::Dict{String,<:Any})
Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on
information from the application resources that you add: VPCs, Network Load Balancers
(NLBs), Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet
Monitor then publishes internet measurements from Amazon Web Services that are specific to
the city-networks. That is, the locations and ASNs (typically internet service providers or
ISPs), where clients access your application. For more information, see Using Amazon
CloudWatch Internet Monitor in the Amazon CloudWatch User Guide. When you create a monitor,
you choose the percentage of traffic that you want to monitor. You can also set a maximum
limit for the number of city-networks where client traffic is monitored, that caps the
total traffic that Internet Monitor monitors. A city-network maximum is the limit of
city-networks, but you only pay for the number of city-networks that are actually
monitored. You can update your monitor at any time to change the percentage of traffic to
monitor or the city-networks maximum. For more information, see Choosing a city-network
maximum value in the Amazon CloudWatch User Guide.
# Arguments
- `monitor_name`: The name of the monitor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique, case-sensitive string of up to 64 ASCII characters that you
specify to make an idempotent API request. Don't reuse the same client token for other API
requests.
- `"HealthEventsConfig"`: Defines the threshold percentages and other configuration
information for when Amazon CloudWatch Internet Monitor creates a health event. Internet
Monitor creates a health event when an internet issue that affects your application end
users has a health score percentage that is at or below a specific threshold, and,
sometimes, when other criteria are met. If you don't set a health event threshold, the
default value is 95%. For more information, see Change health event thresholds in the
Internet Monitor section of the CloudWatch User Guide.
- `"InternetMeasurementsLogDelivery"`: Publish internet measurements for Internet Monitor
to an Amazon S3 bucket in addition to CloudWatch Logs.
- `"MaxCityNetworksToMonitor"`: The maximum number of city-networks to monitor for your
resources. A city-network is the location (city) where clients access your application
resources from and the ASN or network provider, such as an internet service provider (ISP),
that clients access the resources through. Setting this limit can help control billing
costs. To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch
Internet Monitor section of the CloudWatch User Guide.
- `"Resources"`: The resources to include in a monitor, which you provide as a set of
Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions,
or Amazon WorkSpaces directories. You can add a combination of VPCs and CloudFront
distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add
NLBs or WorkSpaces directories together with any other resources. If you add only Amazon
VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure
that it has internet connectivity.
- `"Tags"`: The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.
- `"TrafficPercentageToMonitor"`: The percentage of the internet-facing traffic for your
application that you want to monitor with this monitor. If you set a city-networks maximum,
that limit overrides the traffic percentage that you set. To learn more, see Choosing an
application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor
section of the CloudWatch User Guide.
"""
function create_monitor(MonitorName; aws_config::AbstractAWSConfig=global_aws_config())
return internetmonitor(
"POST",
"/v20210603/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 internetmonitor(
"POST",
"/v20210603/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
"""
delete_monitor(monitor_name)
delete_monitor(monitor_name, params::Dict{String,<:Any})
Deletes a monitor in Amazon CloudWatch Internet Monitor.
# Arguments
- `monitor_name`: The name of the monitor to delete.
"""
function delete_monitor(MonitorName; aws_config::AbstractAWSConfig=global_aws_config())
return internetmonitor(
"DELETE",
"/v20210603/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 internetmonitor(
"DELETE",
"/v20210603/Monitors/$(MonitorName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_health_event(event_id, monitor_name)
get_health_event(event_id, monitor_name, params::Dict{String,<:Any})
Gets information that Amazon CloudWatch Internet Monitor has created and stored about a
health event for a specified monitor. This information includes the impacted locations, and
all the information related to the event, by location. The information returned includes
the impact on performance, availability, and round-trip time, information about the network
providers (ASNs), the event type, and so on. Information rolled up at the global traffic
level is also returned, including the impact type and total traffic impact.
# Arguments
- `event_id`: The internally-generated identifier of a health event. Because EventID
contains the forward slash (“/”) character, you must URL-encode the EventID field in
the request URL.
- `monitor_name`: The name of the monitor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LinkedAccountId"`: The account ID for an account that you've set up cross-account
sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by
using Amazon CloudWatch Observability Access Manager. For more information, see Internet
Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
"""
function get_health_event(
EventId, MonitorName; aws_config::AbstractAWSConfig=global_aws_config()
)
return internetmonitor(
"GET",
"/v20210603/Monitors/$(MonitorName)/HealthEvents/$(EventId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_health_event(
EventId,
MonitorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return internetmonitor(
"GET",
"/v20210603/Monitors/$(MonitorName)/HealthEvents/$(EventId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_internet_event(event_id)
get_internet_event(event_id, params::Dict{String,<:Any})
Gets information that Amazon CloudWatch Internet Monitor has generated about an internet
event. Internet Monitor displays information about recent global health events, called
internet events, on a global outages map that is available to all Amazon Web Services
customers. The information returned here includes the impacted location, when the event
started and (if the event is over) ended, the type of event (PERFORMANCE or AVAILABILITY),
and the status (ACTIVE or RESOLVED).
# Arguments
- `event_id`: The EventId of the internet event to return information for.
"""
function get_internet_event(EventId; aws_config::AbstractAWSConfig=global_aws_config())
return internetmonitor(
"GET",
"/v20210603/InternetEvents/$(EventId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_internet_event(
EventId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return internetmonitor(
"GET",
"/v20210603/InternetEvents/$(EventId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_monitor(monitor_name)
get_monitor(monitor_name, params::Dict{String,<:Any})
Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor
name. The information returned includes the Amazon Resource Name (ARN), create time,
modified time, resources included in the monitor, and status information.
# Arguments
- `monitor_name`: The name of the monitor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LinkedAccountId"`: The account ID for an account that you've set up cross-account
sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by
using Amazon CloudWatch Observability Access Manager. For more information, see Internet
Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
"""
function get_monitor(MonitorName; aws_config::AbstractAWSConfig=global_aws_config())
return internetmonitor(
"GET",
"/v20210603/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 internetmonitor(
"GET",
"/v20210603/Monitors/$(MonitorName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_query_results(monitor_name, query_id)
get_query_results(monitor_name, query_id, params::Dict{String,<:Any})
Return the data for a query with the Amazon CloudWatch Internet Monitor query interface.
Specify the query that you want to return results for by providing a QueryId and a monitor
name. For more information about using the query interface, including examples, see Using
the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet
Monitor User Guide.
# Arguments
- `monitor_name`: The name of the monitor to return data for.
- `query_id`: The ID of the query that you want to return data results for. A QueryId is an
internally-generated identifier for a specific query.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"MaxResults"`: The number of query results that you want to return with this call.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function get_query_results(
MonitorName, QueryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return internetmonitor(
"GET",
"/v20210603/Monitors/$(MonitorName)/Queries/$(QueryId)/Results";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_query_results(
MonitorName,
QueryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return internetmonitor(
"GET",
"/v20210603/Monitors/$(MonitorName)/Queries/$(QueryId)/Results",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_query_status(monitor_name, query_id)
get_query_status(monitor_name, query_id, params::Dict{String,<:Any})
Returns the current status of a query for the Amazon CloudWatch Internet Monitor query
interface, for a specified query ID and monitor. When you run a query, check the status to
make sure that the query has SUCCEEDED before you review the results. QUEUED: The query
is scheduled to run. RUNNING: The query is in progress but not complete. SUCCEEDED:
The query completed sucessfully. FAILED: The query failed due to an error. CANCELED:
The query was canceled.
# Arguments
- `monitor_name`: The name of the monitor.
- `query_id`: The ID of the query that you want to return the status for. A QueryId is an
internally-generated dentifier for a specific query.
"""
function get_query_status(
MonitorName, QueryId; aws_config::AbstractAWSConfig=global_aws_config()
)
return internetmonitor(
"GET",
"/v20210603/Monitors/$(MonitorName)/Queries/$(QueryId)/Status";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_query_status(
MonitorName,
QueryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return internetmonitor(
"GET",
"/v20210603/Monitors/$(MonitorName)/Queries/$(QueryId)/Status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_health_events(monitor_name)
list_health_events(monitor_name, params::Dict{String,<:Any})
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns
information for health events including the event start and end times, and the status.
Health events that have start times during the time frame that is requested are not
included in the list of health events.
# Arguments
- `monitor_name`: The name of the monitor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndTime"`: The time when a health event ended. If the health event is still ongoing,
then the end time is not set.
- `"EventStatus"`: The status of a health event.
- `"LinkedAccountId"`: The account ID for an account that you've set up cross-account
sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by
using Amazon CloudWatch Observability Access Manager. For more information, see Internet
Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
- `"MaxResults"`: The number of health event objects that you want to return with this
call.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
- `"StartTime"`: The time when a health event started.
"""
function list_health_events(MonitorName; aws_config::AbstractAWSConfig=global_aws_config())
return internetmonitor(
"GET",
"/v20210603/Monitors/$(MonitorName)/HealthEvents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_health_events(
MonitorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return internetmonitor(
"GET",
"/v20210603/Monitors/$(MonitorName)/HealthEvents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_internet_events()
list_internet_events(params::Dict{String,<:Any})
Lists internet events that cause performance or availability issues for client locations.
Amazon CloudWatch Internet Monitor displays information about recent global health events,
called internet events, on a global outages map that is available to all Amazon Web
Services customers. You can constrain the list of internet events returned by providing a
start time and end time to define a total time frame for events you want to list. Both
start time and end time specify the time when an event started. End time is optional. If
you don't include it, the default end time is the current time. You can also limit the
events returned to a specific status (ACTIVE or RESOLVED) or type (PERFORMANCE or
AVAILABILITY).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"EndTime"`: The end time of the time window that you want to get a list of internet
events for.
- `"EventStatus"`: The status of an internet event.
- `"EventType"`: The type of network impairment.
- `"InternetEventMaxResults"`: The number of query results that you want to return with
this call.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
- `"StartTime"`: The start time of the time window that you want to get a list of internet
events for.
"""
function list_internet_events(; aws_config::AbstractAWSConfig=global_aws_config())
return internetmonitor(
"GET",
"/v20210603/InternetEvents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_internet_events(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return internetmonitor(
"GET",
"/v20210603/InternetEvents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_monitors()
list_monitors(params::Dict{String,<:Any})
Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along
with the Amazon Resource Name (ARN) and name of each monitor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IncludeLinkedAccounts"`: A boolean option that you can set to TRUE to include monitors
for linked accounts in a list of monitors, when you've set up cross-account sharing in
Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon
CloudWatch Observability Access Manager. For more information, see Internet Monitor
cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
- `"MaxResults"`: The number of monitor objects that you want to return with this call.
- `"MonitorStatus"`: The status of a monitor. This includes the status of the data
processing for the monitor and the status of the monitor itself. For information about the
statuses for a monitor, see Monitor.
- `"NextToken"`: The token for the next set of results. You receive this token from a
previous call.
"""
function list_monitors(; aws_config::AbstractAWSConfig=global_aws_config())
return internetmonitor(
"GET", "/v20210603/Monitors"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_monitors(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return internetmonitor(
"GET",
"/v20210603/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 for a resource. Tags are supported only for monitors in Amazon CloudWatch
Internet Monitor.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for a resource.
"""
function list_tags_for_resource(
ResourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return internetmonitor(
"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 internetmonitor(
"GET",
"/tags/$(ResourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_query(end_time, monitor_name, query_type, start_time)
start_query(end_time, monitor_name, query_type, start_time, params::Dict{String,<:Any})
Start a query to return data for a specific query type for the Amazon CloudWatch Internet
Monitor query interface. Specify a time period for the data that you want returned by using
StartTime and EndTime. You filter the query results to return by providing parameters that
you specify with FilterParameters. For more information about using the query interface,
including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the
Amazon CloudWatch Internet Monitor User Guide.
# Arguments
- `end_time`: The timestamp that is the end of the period that you want to retrieve data
for with your query.
- `monitor_name`: The name of the monitor to query.
- `query_type`: The type of query to run. The following are the three types of queries that
you can run using the Internet Monitor query interface: MEASUREMENTS: Provides
availability score, performance score, total traffic, and round-trip times, at 5 minute
intervals. TOP_LOCATIONS: Provides availability score, performance score, total traffic,
and time to first byte (TTFB) information, for the top location and ASN combinations that
you're monitoring, by traffic volume. TOP_LOCATION_DETAILS: Provides TTFB for Amazon
CloudFront, your current configuration, and the best performing EC2 configuration, at 1
hour intervals. For lists of the fields returned with each query type and more
information about how each type of query is performed, see Using the Amazon CloudWatch
Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
- `start_time`: The timestamp that is the beginning of the period that you want to retrieve
data for with your query.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FilterParameters"`: The FilterParameters field that you use with Amazon CloudWatch
Internet Monitor queries is a string the defines how you want a query to be filtered. The
filter parameters that you can specify depend on the query type, since each query type
returns a different set of Internet Monitor data. For more information about specifying
filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the
Amazon CloudWatch Internet Monitor User Guide.
- `"LinkedAccountId"`: The account ID for an account that you've set up cross-account
sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by
using Amazon CloudWatch Observability Access Manager. For more information, see Internet
Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
"""
function start_query(
EndTime,
MonitorName,
QueryType,
StartTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return internetmonitor(
"POST",
"/v20210603/Monitors/$(MonitorName)/Queries",
Dict{String,Any}(
"EndTime" => EndTime, "QueryType" => QueryType, "StartTime" => StartTime
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_query(
EndTime,
MonitorName,
QueryType,
StartTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return internetmonitor(
"POST",
"/v20210603/Monitors/$(MonitorName)/Queries",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"EndTime" => EndTime, "QueryType" => QueryType, "StartTime" => StartTime
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_query(monitor_name, query_id)
stop_query(monitor_name, query_id, params::Dict{String,<:Any})
Stop a query that is progress for a specific monitor.
# Arguments
- `monitor_name`: The name of the monitor.
- `query_id`: The ID of the query that you want to stop. A QueryId is an
internally-generated identifier for a specific query.
"""
function stop_query(MonitorName, QueryId; aws_config::AbstractAWSConfig=global_aws_config())
return internetmonitor(
"DELETE",
"/v20210603/Monitors/$(MonitorName)/Queries/$(QueryId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_query(
MonitorName,
QueryId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return internetmonitor(
"DELETE",
"/v20210603/Monitors/$(MonitorName)/Queries/$(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 a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch
Internet Monitor. You can add a maximum of 50 tags in Internet Monitor. A minimum of one
tag is required for this call. It returns an error if you use the TagResource request with
0 tags.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for a tag that you add to a resource. Tags
are supported only for monitors in Amazon CloudWatch Internet Monitor.
- `tags`: Tags that you add to a resource. You can add a maximum of 50 tags in Internet
Monitor.
"""
function tag_resource(ResourceArn, Tags; aws_config::AbstractAWSConfig=global_aws_config())
return internetmonitor(
"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 internetmonitor(
"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 tag from a resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) for a tag you remove a resource from.
- `tag_keys`: Tag keys that you remove from a resource.
"""
function untag_resource(
ResourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return internetmonitor(
"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 internetmonitor(
"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(monitor_name)
update_monitor(monitor_name, params::Dict{String,<:Any})
Updates a monitor. You can update a monitor to change the percentage of traffic to monitor
or the maximum number of city-networks (locations and ASNs), to add or remove resources, or
to change the status of the monitor. Note that you can't change the name of a monitor. The
city-network maximum that you choose is the limit, but you only pay for the number of
city-networks that are actually monitored. For more information, see Choosing a
city-network maximum value in the Amazon CloudWatch User Guide.
# Arguments
- `monitor_name`: The name of the monitor.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientToken"`: A unique, case-sensitive string of up to 64 ASCII characters that you
specify to make an idempotent API request. You should not reuse the same client token for
other API requests.
- `"HealthEventsConfig"`: The list of health score thresholds. A threshold percentage for
health scores, along with other configuration information, determines when Internet Monitor
creates a health event when there's an internet issue that affects your application end
users. For more information, see Change health event thresholds in the Internet Monitor
section of the CloudWatch User Guide.
- `"InternetMeasurementsLogDelivery"`: Publish internet measurements for Internet Monitor
to another location, such as an Amazon S3 bucket. The measurements are also published to
Amazon CloudWatch Logs.
- `"MaxCityNetworksToMonitor"`: The maximum number of city-networks to monitor for your
application. A city-network is the location (city) where clients access your application
resources from and the ASN or network provider, such as an internet service provider (ISP),
that clients access the resources through. Setting this limit can help control billing
costs.
- `"ResourcesToAdd"`: The resources to include in a monitor, which you provide as a set of
Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions,
or Amazon WorkSpaces directories. You can add a combination of VPCs and CloudFront
distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add
NLBs or WorkSpaces directories together with any other resources. If you add only Amazon
Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached
to it, to make sure that it has internet connectivity.
- `"ResourcesToRemove"`: The resources to remove from a monitor, which you provide as a set
of Amazon Resource Names (ARNs).
- `"Status"`: The status for a monitor. The accepted values for Status with the
UpdateMonitor API call are the following: ACTIVE and INACTIVE. The following values are not
accepted: PENDING, and ERROR.
- `"TrafficPercentageToMonitor"`: The percentage of the internet-facing traffic for your
application that you want to monitor with this monitor. If you set a city-networks maximum,
that limit overrides the traffic percentage that you set. To learn more, see Choosing an
application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor
section of the CloudWatch User Guide.
"""
function update_monitor(MonitorName; aws_config::AbstractAWSConfig=global_aws_config())
return internetmonitor(
"PATCH",
"/v20210603/Monitors/$(MonitorName)",
Dict{String,Any}("ClientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_monitor(
MonitorName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return internetmonitor(
"PATCH",
"/v20210603/Monitors/$(MonitorName)",
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 | 350626 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iot
using AWS.Compat
using AWS.UUIDs
"""
accept_certificate_transfer(certificate_id)
accept_certificate_transfer(certificate_id, params::Dict{String,<:Any})
Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your
certificates. Requires permission to access the AcceptCertificateTransfer action.
# Arguments
- `certificate_id`: The ID of the certificate. (The last part of the certificate ARN
contains the certificate ID.)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"setAsActive"`: Specifies whether the certificate is active.
"""
function accept_certificate_transfer(
certificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/accept-certificate-transfer/$(certificateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_certificate_transfer(
certificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/accept-certificate-transfer/$(certificateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_thing_to_billing_group()
add_thing_to_billing_group(params::Dict{String,<:Any})
Adds a thing to a billing group. Requires permission to access the AddThingToBillingGroup
action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"billingGroupArn"`: The ARN of the billing group.
- `"billingGroupName"`: The name of the billing group. This call is asynchronous. It might
take several seconds for the detachment to propagate.
- `"thingArn"`: The ARN of the thing to be added to the billing group.
- `"thingName"`: The name of the thing to be added to the billing group.
"""
function add_thing_to_billing_group(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PUT",
"/billing-groups/addThingToBillingGroup";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_thing_to_billing_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/billing-groups/addThingToBillingGroup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
add_thing_to_thing_group()
add_thing_to_thing_group(params::Dict{String,<:Any})
Adds a thing to a thing group. Requires permission to access the AddThingToThingGroup
action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"overrideDynamicGroups"`: Override dynamic thing groups with static thing groups when
10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those
groups are dynamic thing groups, adding a thing to a static group removes the thing from
the last dynamic group.
- `"thingArn"`: The ARN of the thing to add to a group.
- `"thingGroupArn"`: The ARN of the group to which you are adding a thing.
- `"thingGroupName"`: The name of the group to which you are adding a thing.
- `"thingName"`: The name of the thing to add to a group.
"""
function add_thing_to_thing_group(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PUT",
"/thing-groups/addThingToThingGroup";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_thing_to_thing_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/thing-groups/addThingToThingGroup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_targets_with_job(job_id, targets)
associate_targets_with_job(job_id, targets, params::Dict{String,<:Any})
Associates a group with a continuous job. The following criteria must be met: The job
must have been created with the targetSelection field set to \"CONTINUOUS\". The job
status must currently be \"IN_PROGRESS\". The total number of targets associated with a
job must not exceed 100. Requires permission to access the AssociateTargetsWithJob action.
# Arguments
- `job_id`: The unique identifier you assigned to this job when it was created.
- `targets`: A list of thing group ARNs that define the targets of the job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"comment"`: An optional comment string describing why the job was associated with the
targets.
- `"namespaceId"`: The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs
notifications to MQTT topics that contain the value in the following format.
aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature
is only supported by IoT Greengrass at this time. For more information, see Setting up IoT
Greengrass core devices.
"""
function associate_targets_with_job(
jobId, targets; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/jobs/$(jobId)/targets",
Dict{String,Any}("targets" => targets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_targets_with_job(
jobId,
targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/jobs/$(jobId)/targets",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("targets" => targets), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_policy(policy_name, target)
attach_policy(policy_name, target, params::Dict{String,<:Any})
Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
# Arguments
- `policy_name`: The name of the policy to attach.
- `target`: The identity to which the policy is attached. For example, a thing group or a
certificate.
"""
function attach_policy(
policyName, target; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/target-policies/$(policyName)",
Dict{String,Any}("target" => target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_policy(
policyName,
target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/target-policies/$(policyName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("target" => target), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_principal_policy(policy_name, x-amzn-iot-principal)
attach_principal_policy(policy_name, x-amzn-iot-principal, params::Dict{String,<:Any})
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This action is deprecated and works as expected for backward compatibility, but we
won't add enhancements. Use AttachPolicy instead. Requires permission to access the
AttachPrincipalPolicy action.
# Arguments
- `policy_name`: The policy name.
- `x-amzn-iot-principal`: The principal, which can be a certificate ARN (as returned from
the CreateCertificate operation) or an Amazon Cognito ID.
"""
function attach_principal_policy(
policyName, x_amzn_iot_principal; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/principal-policies/$(policyName)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-iot-principal" => x_amzn_iot_principal)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_principal_policy(
policyName,
x_amzn_iot_principal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/principal-policies/$(policyName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" =>
Dict{String,Any}("x-amzn-iot-principal" => x_amzn_iot_principal),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_security_profile(security_profile_name, security_profile_target_arn)
attach_security_profile(security_profile_name, security_profile_target_arn, params::Dict{String,<:Any})
Associates a Device Defender security profile with a thing group or this account. Each
thing group or account can have up to five security profiles associated with it. Requires
permission to access the AttachSecurityProfile action.
# Arguments
- `security_profile_name`: The security profile that is attached.
- `security_profile_target_arn`: The ARN of the target (thing group) to which the security
profile is attached.
"""
function attach_security_profile(
securityProfileName,
securityProfileTargetArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/security-profiles/$(securityProfileName)/targets",
Dict{String,Any}("securityProfileTargetArn" => securityProfileTargetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_security_profile(
securityProfileName,
securityProfileTargetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/security-profiles/$(securityProfileName)/targets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("securityProfileTargetArn" => securityProfileTargetArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
attach_thing_principal(thing_name, x-amzn-principal)
attach_thing_principal(thing_name, x-amzn-principal, params::Dict{String,<:Any})
Attaches the specified principal to the specified thing. A principal can be X.509
certificates, Amazon Cognito identities or federated identities. Requires permission to
access the AttachThingPrincipal action.
# Arguments
- `thing_name`: The name of the thing.
- `x-amzn-principal`: The principal, which can be a certificate ARN (as returned from the
CreateCertificate operation) or an Amazon Cognito ID.
"""
function attach_thing_principal(
thingName, x_amzn_principal; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/things/$(thingName)/principals",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-principal" => x_amzn_principal)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function attach_thing_principal(
thingName,
x_amzn_principal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/things/$(thingName)/principals",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-principal" => x_amzn_principal)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_audit_mitigation_actions_task(task_id)
cancel_audit_mitigation_actions_task(task_id, params::Dict{String,<:Any})
Cancels a mitigation action task that is in progress. If the task is not in progress, an
InvalidRequestException occurs. Requires permission to access the
CancelAuditMitigationActionsTask action.
# Arguments
- `task_id`: The unique identifier for the task that you want to cancel.
"""
function cancel_audit_mitigation_actions_task(
taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/audit/mitigationactions/tasks/$(taskId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_audit_mitigation_actions_task(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/audit/mitigationactions/tasks/$(taskId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_audit_task(task_id)
cancel_audit_task(task_id, params::Dict{String,<:Any})
Cancels an audit that is in progress. The audit can be either scheduled or on demand. If
the audit isn't in progress, an \"InvalidRequestException\" occurs. Requires permission to
access the CancelAuditTask action.
# Arguments
- `task_id`: The ID of the audit you want to cancel. You can only cancel an audit that is
\"IN_PROGRESS\".
"""
function cancel_audit_task(taskId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PUT",
"/audit/tasks/$(taskId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_audit_task(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/audit/tasks/$(taskId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_certificate_transfer(certificate_id)
cancel_certificate_transfer(certificate_id, params::Dict{String,<:Any})
Cancels a pending transfer for the specified certificate. Note Only the transfer source
account can use this operation to cancel a transfer. (Transfer destinations can use
RejectCertificateTransfer instead.) After transfer, IoT returns the certificate to the
source account in the INACTIVE state. After the destination account has accepted the
transfer, the transfer cannot be cancelled. After a certificate transfer is cancelled, the
status of the certificate changes from PENDING_TRANSFER to INACTIVE. Requires permission to
access the CancelCertificateTransfer action.
# Arguments
- `certificate_id`: The ID of the certificate. (The last part of the certificate ARN
contains the certificate ID.)
"""
function cancel_certificate_transfer(
certificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/cancel-certificate-transfer/$(certificateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_certificate_transfer(
certificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/cancel-certificate-transfer/$(certificateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_detect_mitigation_actions_task(task_id)
cancel_detect_mitigation_actions_task(task_id, params::Dict{String,<:Any})
Cancels a Device Defender ML Detect mitigation action. Requires permission to access the
CancelDetectMitigationActionsTask action.
# Arguments
- `task_id`: The unique identifier of the task.
"""
function cancel_detect_mitigation_actions_task(
taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/detect/mitigationactions/tasks/$(taskId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_detect_mitigation_actions_task(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/detect/mitigationactions/tasks/$(taskId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_job(job_id)
cancel_job(job_id, params::Dict{String,<:Any})
Cancels a job. Requires permission to access the CancelJob action.
# Arguments
- `job_id`: The unique identifier you assigned to this job when it was created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"comment"`: An optional comment string describing why the job was canceled.
- `"force"`: (Optional) If true job executions with status \"IN_PROGRESS\" and \"QUEUED\"
are canceled, otherwise only job executions with status \"QUEUED\" are canceled. The
default is false. Canceling a job which is \"IN_PROGRESS\", will cause a device which is
executing the job to be unable to update the job execution status. Use caution and ensure
that each device executing a job which is canceled is able to recover to a valid state.
- `"reasonCode"`: (Optional)A reason code string that explains why the job was canceled.
"""
function cancel_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PUT",
"/jobs/$(jobId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/jobs/$(jobId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_job_execution(job_id, thing_name)
cancel_job_execution(job_id, thing_name, params::Dict{String,<:Any})
Cancels the execution of a job for a given thing. Requires permission to access the
CancelJobExecution action.
# Arguments
- `job_id`: The ID of the job to be canceled.
- `thing_name`: The name of the thing whose execution of the job will be canceled.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedVersion"`: (Optional) The expected current version of the job execution. Each
time you update the job execution, its version is incremented. If the version of the job
execution stored in Jobs does not match, the update is rejected with a VersionMismatch
error, and an ErrorResponse that contains the current job execution status data is
returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in
order to obtain the job execution status data.)
- `"force"`: (Optional) If true the job execution will be canceled if it has status
IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status
QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set
force to true, then an InvalidStateTransitionException will be thrown. The default is
false. Canceling a job execution which is \"IN_PROGRESS\", will cause the device to be
unable to update the job execution status. Use caution and ensure that the device is able
to recover to a valid state.
- `"statusDetails"`: A collection of name/value pairs that describe the status of the job
execution. If not specified, the statusDetails are unchanged. You can specify at most 10
name/value pairs.
"""
function cancel_job_execution(
jobId, thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/things/$(thingName)/jobs/$(jobId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_job_execution(
jobId,
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/things/$(thingName)/jobs/$(jobId)/cancel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
clear_default_authorizer()
clear_default_authorizer(params::Dict{String,<:Any})
Clears the default authorizer. Requires permission to access the ClearDefaultAuthorizer
action.
"""
function clear_default_authorizer(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/default-authorizer";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function clear_default_authorizer(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/default-authorizer",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
confirm_topic_rule_destination(confirmation_token)
confirm_topic_rule_destination(confirmation_token, params::Dict{String,<:Any})
Confirms a topic rule destination. When you create a rule requiring a destination, IoT
sends a confirmation message to the endpoint or base address you specify. The message
includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm
that you own or have access to the endpoint. Requires permission to access the
ConfirmTopicRuleDestination action.
# Arguments
- `confirmation_token`: The token used to confirm ownership or access to the topic rule
confirmation URL.
"""
function confirm_topic_rule_destination(
confirmationToken; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/confirmdestination/$(confirmationToken)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function confirm_topic_rule_destination(
confirmationToken,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/confirmdestination/$(confirmationToken)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_audit_suppression(check_name, client_request_token, resource_identifier)
create_audit_suppression(check_name, client_request_token, resource_identifier, params::Dict{String,<:Any})
Creates a Device Defender audit suppression. Requires permission to access the
CreateAuditSuppression action.
# Arguments
- `check_name`:
- `client_request_token`: Each audit supression must have a unique client request token.
If you try to create a new audit suppression with the same token as one that already
exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will
automatically generate a unique client request.
- `resource_identifier`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the audit suppression.
- `"expirationDate"`: The epoch timestamp in seconds at which this suppression expires.
- `"suppressIndefinitely"`: Indicates whether a suppression should exist indefinitely or
not.
"""
function create_audit_suppression(
checkName,
clientRequestToken,
resourceIdentifier;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/audit/suppressions/create",
Dict{String,Any}(
"checkName" => checkName,
"clientRequestToken" => clientRequestToken,
"resourceIdentifier" => resourceIdentifier,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_audit_suppression(
checkName,
clientRequestToken,
resourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/audit/suppressions/create",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"checkName" => checkName,
"clientRequestToken" => clientRequestToken,
"resourceIdentifier" => resourceIdentifier,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_authorizer(authorizer_function_arn, authorizer_name)
create_authorizer(authorizer_function_arn, authorizer_name, params::Dict{String,<:Any})
Creates an authorizer. Requires permission to access the CreateAuthorizer action.
# Arguments
- `authorizer_function_arn`: The ARN of the authorizer's Lambda function.
- `authorizer_name`: The authorizer name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enableCachingForHttp"`: When true, the result from the authorizer’s Lambda function
is cached for clients that use persistent HTTP connections. The results are cached for the
time specified by the Lambda function in refreshAfterInSeconds. This value does not affect
authorization of clients that use MQTT connections. The default value is false.
- `"signingDisabled"`: Specifies whether IoT validates the token signature in an
authorization request.
- `"status"`: The status of the create authorizer request.
- `"tags"`: Metadata which can be used to manage the custom authorizer. For URI Request
parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter
use format: &&tags \"key1=value1&key2=value2...\" For the cli-input-json file
use format: \"tags\": \"key1=value1&key2=value2...\"
- `"tokenKeyName"`: The name of the token key used to extract the token from the HTTP
headers.
- `"tokenSigningPublicKeys"`: The public keys used to verify the digital signature returned
by your custom authentication service.
"""
function create_authorizer(
authorizerFunctionArn, authorizerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/authorizer/$(authorizerName)",
Dict{String,Any}("authorizerFunctionArn" => authorizerFunctionArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_authorizer(
authorizerFunctionArn,
authorizerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/authorizer/$(authorizerName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("authorizerFunctionArn" => authorizerFunctionArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_billing_group(billing_group_name)
create_billing_group(billing_group_name, params::Dict{String,<:Any})
Creates a billing group. Requires permission to access the CreateBillingGroup action.
# Arguments
- `billing_group_name`: The name you wish to give to the billing group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"billingGroupProperties"`: The properties of the billing group.
- `"tags"`: Metadata which can be used to manage the billing group.
"""
function create_billing_group(
billingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/billing-groups/$(billingGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_billing_group(
billingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/billing-groups/$(billingGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_certificate_from_csr(certificate_signing_request)
create_certificate_from_csr(certificate_signing_request, params::Dict{String,<:Any})
Creates an X.509 certificate using the specified certificate signing request. Requires
permission to access the CreateCertificateFromCsr action. The CSR must include a public
key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST
P-256, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate
signing algorithms supported by IoT. Reusing the same certificate signing request (CSR)
results in a distinct certificate. You can create multiple certificates in a batch by
creating a directory, copying multiple .csr files into that directory, and then specifying
that directory on the command line. The following commands show how to create a batch of
certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs
are located inside of the directory my-csr-directory: On Linux and OS X, the command is:
ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr
--certificate-signing-request file://my-csr-directory/{} This command lists all of the
CSRs in my-csr-directory and pipes each CSR file name to the aws iot
create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the
corresponding CSR. You can also run the aws iot create-certificate-from-csr part of the
command in parallel to speed up the certificate creation process: ls my-csr-directory/ |
xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request
file://my-csr-directory/{} On Windows PowerShell, the command to create certificates for
all CSRs in my-csr-directory is: > ls -Name my-csr-directory | %{aws iot
create-certificate-from-csr --certificate-signing-request file://my-csr-directory/_} On a
Windows command prompt, the command to create certificates for all CSRs in my-csr-directory
is: > forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr
--certificate-signing-request file://@path\"
# Arguments
- `certificate_signing_request`: The certificate signing request (CSR).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"setAsActive"`: Specifies whether the certificate is active.
"""
function create_certificate_from_csr(
certificateSigningRequest; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/certificates",
Dict{String,Any}("certificateSigningRequest" => certificateSigningRequest);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_certificate_from_csr(
certificateSigningRequest,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/certificates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("certificateSigningRequest" => certificateSigningRequest),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_certificate_provider(account_default_for_operations, certificate_provider_name, lambda_function_arn)
create_certificate_provider(account_default_for_operations, certificate_provider_name, lambda_function_arn, params::Dict{String,<:Any})
Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web
Services IoT Core certificate provider to customize how to sign a certificate signing
request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate
signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services
IoT Core Developer Guide. Requires permission to access the CreateCertificateProvider
action. After you create a certificate provider, the behavior of CreateCertificateFromCsr
API for fleet provisioning will change and all API calls to CreateCertificateFromCsr will
invoke the certificate provider to create the certificates. It can take up to a few minutes
for this behavior to change after a certificate provider is created.
# Arguments
- `account_default_for_operations`: A list of the operations that the certificate provider
will use to generate certificates. Valid value: CreateCertificateFromCsr.
- `certificate_provider_name`: The name of the certificate provider.
- `lambda_function_arn`: The ARN of the Lambda function that defines the authentication
logic.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientToken"`: A string that you can optionally pass in the CreateCertificateProvider
request to make sure the request is idempotent.
- `"tags"`: Metadata which can be used to manage the certificate provider.
"""
function create_certificate_provider(
accountDefaultForOperations,
certificateProviderName,
lambdaFunctionArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/certificate-providers/$(certificateProviderName)",
Dict{String,Any}(
"accountDefaultForOperations" => accountDefaultForOperations,
"lambdaFunctionArn" => lambdaFunctionArn,
"clientToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_certificate_provider(
accountDefaultForOperations,
certificateProviderName,
lambdaFunctionArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/certificate-providers/$(certificateProviderName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"accountDefaultForOperations" => accountDefaultForOperations,
"lambdaFunctionArn" => lambdaFunctionArn,
"clientToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_custom_metric(client_request_token, metric_name, metric_type)
create_custom_metric(client_request_token, metric_name, metric_type, params::Dict{String,<:Any})
Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
# Arguments
- `client_request_token`: Each custom metric must have a unique client request token. If
you try to create a new custom metric that already exists with a different token, an
exception occurs. If you omit this value, Amazon Web Services SDKs will automatically
generate a unique client request.
- `metric_name`: The name of the custom metric. This will be used in the metric report
submitted from the device/thing. The name can't begin with aws:. You can't change the name
after you define it.
- `metric_type`: The type of the custom metric. The type number only takes a single
metric value as an input, but when you submit the metrics value in the DeviceMetrics
report, you must pass it as an array with a single value.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"displayName"`: The friendly name in the console for the custom metric. This name
doesn't have to be unique. Don't use this name as the metric identifier in the device
metric report. You can update the friendly name after you define it.
- `"tags"`: Metadata that can be used to manage the custom metric.
"""
function create_custom_metric(
clientRequestToken,
metricName,
metricType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/custom-metric/$(metricName)",
Dict{String,Any}(
"clientRequestToken" => clientRequestToken, "metricType" => metricType
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_custom_metric(
clientRequestToken,
metricName,
metricType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/custom-metric/$(metricName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientRequestToken" => clientRequestToken, "metricType" => metricType
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dimension(client_request_token, name, string_values, type)
create_dimension(client_request_token, name, string_values, type, params::Dict{String,<:Any})
Create a dimension that you can use to limit the scope of a metric used in a security
profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can
narrow down the scope of the metric only to MQTT topics whose name match the pattern
specified in the dimension. Requires permission to access the CreateDimension action.
# Arguments
- `client_request_token`: Each dimension must have a unique client request token. If you
try to create a new dimension with the same token as a dimension that already exists, an
exception occurs. If you omit this value, Amazon Web Services SDKs will automatically
generate a unique client request.
- `name`: A unique identifier for the dimension. Choose something that describes the type
and value to make it easy to remember what it does.
- `string_values`: Specifies the value or list of values for the dimension. For
TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example,
\"admin/#\").
- `type`: Specifies the type of dimension. Supported types: TOPIC_FILTER.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: Metadata that can be used to manage the dimension.
"""
function create_dimension(
clientRequestToken,
name,
stringValues,
type;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/dimensions/$(name)",
Dict{String,Any}(
"clientRequestToken" => clientRequestToken,
"stringValues" => stringValues,
"type" => type,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dimension(
clientRequestToken,
name,
stringValues,
type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/dimensions/$(name)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientRequestToken" => clientRequestToken,
"stringValues" => stringValues,
"type" => type,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_domain_configuration(domain_configuration_name)
create_domain_configuration(domain_configuration_name, params::Dict{String,<:Any})
Creates a domain configuration. Requires permission to access the CreateDomainConfiguration
action.
# Arguments
- `domain_configuration_name`: The name of the domain configuration. This value must be
unique to a region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authorizerConfig"`: An object that specifies the authorization service for a domain.
- `"domainName"`: The name of the domain.
- `"serverCertificateArns"`: The ARNs of the certificates that IoT passes to the device
during the TLS handshake. Currently you can specify only one certificate ARN. This value is
not required for Amazon Web Services-managed domains.
- `"serverCertificateConfig"`: The server certificate configuration.
- `"serviceType"`: The type of service delivered by the endpoint. Amazon Web Services IoT
Core currently supports only the DATA service type.
- `"tags"`: Metadata which can be used to manage the domain configuration. For URI Request
parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter
use format: &&tags \"key1=value1&key2=value2...\" For the cli-input-json file
use format: \"tags\": \"key1=value1&key2=value2...\"
- `"tlsConfig"`: An object that specifies the TLS configuration for a domain.
- `"validationCertificateArn"`: The certificate used to validate the server certificate and
prove domain name ownership. This certificate must be signed by a public certificate
authority. This value is not required for Amazon Web Services-managed domains.
"""
function create_domain_configuration(
domainConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/domainConfigurations/$(domainConfigurationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_domain_configuration(
domainConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/domainConfigurations/$(domainConfigurationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dynamic_thing_group(query_string, thing_group_name)
create_dynamic_thing_group(query_string, thing_group_name, params::Dict{String,<:Any})
Creates a dynamic thing group. Requires permission to access the CreateDynamicThingGroup
action.
# Arguments
- `query_string`: The dynamic thing group search query string. See Query Syntax for
information about query string syntax.
- `thing_group_name`: The dynamic thing group name to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"indexName"`: The dynamic thing group index name. Currently one index is supported:
AWS_Things.
- `"queryVersion"`: The dynamic thing group query version. Currently one query version is
supported: \"2017-09-30\". If not specified, the query version defaults to this value.
- `"tags"`: Metadata which can be used to manage the dynamic thing group.
- `"thingGroupProperties"`: The dynamic thing group properties.
"""
function create_dynamic_thing_group(
queryString, thingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/dynamic-thing-groups/$(thingGroupName)",
Dict{String,Any}("queryString" => queryString);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dynamic_thing_group(
queryString,
thingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/dynamic-thing-groups/$(thingGroupName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("queryString" => queryString), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_fleet_metric(aggregation_field, aggregation_type, metric_name, period, query_string)
create_fleet_metric(aggregation_field, aggregation_type, metric_name, period, query_string, params::Dict{String,<:Any})
Creates a fleet metric. Requires permission to access the CreateFleetMetric action.
# Arguments
- `aggregation_field`: The field to aggregate.
- `aggregation_type`: The type of the aggregation query.
- `metric_name`: The name of the fleet metric to create.
- `period`: The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1
day)] and must be multiple of 60.
- `query_string`: The search query string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The fleet metric description.
- `"indexName"`: The name of the index to search.
- `"queryVersion"`: The query version.
- `"tags"`: Metadata, which can be used to manage the fleet metric.
- `"unit"`: Used to support unit transformation such as milliseconds to seconds. The unit
must be supported by CW metric. Default to null.
"""
function create_fleet_metric(
aggregationField,
aggregationType,
metricName,
period,
queryString;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/fleet-metric/$(metricName)",
Dict{String,Any}(
"aggregationField" => aggregationField,
"aggregationType" => aggregationType,
"period" => period,
"queryString" => queryString,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fleet_metric(
aggregationField,
aggregationType,
metricName,
period,
queryString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/fleet-metric/$(metricName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"aggregationField" => aggregationField,
"aggregationType" => aggregationType,
"period" => period,
"queryString" => queryString,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job(job_id, targets)
create_job(job_id, targets, params::Dict{String,<:Any})
Creates a job. Requires permission to access the CreateJob action.
# Arguments
- `job_id`: A job identifier which must be unique for your Amazon Web Services account. We
recommend using a UUID. Alpha-numeric characters, \"-\" and \"_\" are valid for use here.
- `targets`: A list of things and thing groups to which the job should be sent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"abortConfig"`: Allows you to create the criteria to abort a job.
- `"description"`: A short text description of the job.
- `"destinationPackageVersions"`: The package version Amazon Resource Names (ARNs) that are
installed on the device when the job successfully completes. The package version must be in
either the Published or Deprecated state when the job deploys. For more information, see
Package version lifecycle. Note:The following Length Constraints relates to a single ARN.
Up to 25 package version ARNs are allowed.
- `"document"`: The job document. Required if you don't specify a value for documentSource.
- `"documentParameters"`: Parameters of an Amazon Web Services managed template that you
can specify to create the job document. documentParameters can only be used when creating
jobs from Amazon Web Services managed templates. This parameter can't be used with custom
job templates or to create jobs from them.
- `"documentSource"`: An S3 link, or S3 object URL, to the job document. The link is an
Amazon S3 object URL and is required if you don't specify a value for document. For
example, --document-source
https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0 For more
information, see Methods for accessing a bucket.
- `"jobExecutionsRetryConfig"`: Allows you to create the criteria to retry a job.
- `"jobExecutionsRolloutConfig"`: Allows you to create a staged rollout of the job.
- `"jobTemplateArn"`: The ARN of the job template used to create the job.
- `"namespaceId"`: The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs
notifications to MQTT topics that contain the value in the following format.
aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature
is only supported by IoT Greengrass at this time. For more information, see Setting up IoT
Greengrass core devices.
- `"presignedUrlConfig"`: Configuration information for pre-signed S3 URLs.
- `"schedulingConfig"`: The configuration that allows you to schedule a job for a future
date and time in addition to specifying the end behavior for each job execution.
- `"tags"`: Metadata which can be used to manage the job.
- `"targetSelection"`: Specifies whether the job will continue to run (CONTINUOUS), or will
be complete after all those things specified as targets have completed the job (SNAPSHOT).
If continuous, the job may also be run on a thing when a change is detected in a target.
For example, a job will run on a thing when the thing is added to a target group, even
after the job was completed by all things originally in the group. We recommend that you
use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using
continuous jobs, devices that join the group receive the job execution even after the job
has been created.
- `"timeoutConfig"`: Specifies the amount of time each device has to finish its execution
of the job. The timer is started when the job execution status is set to IN_PROGRESS. If
the job execution status is not set to another terminal state before the time expires, it
will be automatically set to TIMED_OUT.
"""
function create_job(jobId, targets; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PUT",
"/jobs/$(jobId)",
Dict{String,Any}("targets" => targets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job(
jobId,
targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/jobs/$(jobId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("targets" => targets), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_job_template(description, job_template_id)
create_job_template(description, job_template_id, params::Dict{String,<:Any})
Creates a job template. Requires permission to access the CreateJobTemplate action.
# Arguments
- `description`: A description of the job document.
- `job_template_id`: A unique identifier for the job template. We recommend using a UUID.
Alpha-numeric characters, \"-\", and \"_\" are valid for use here.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"abortConfig"`:
- `"destinationPackageVersions"`: The package version Amazon Resource Names (ARNs) that are
installed on the device when the job successfully completes. The package version must be in
either the Published or Deprecated state when the job deploys. For more information, see
Package version lifecycle. Note:The following Length Constraints relates to a single ARN.
Up to 25 package version ARNs are allowed.
- `"document"`: The job document. Required if you don't specify a value for documentSource.
- `"documentSource"`: An S3 link, or S3 object URL, to the job document. The link is an
Amazon S3 object URL and is required if you don't specify a value for document. For
example, --document-source
https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0 For more
information, see Methods for accessing a bucket.
- `"jobArn"`: The ARN of the job to use as the basis for the job template.
- `"jobExecutionsRetryConfig"`: Allows you to create the criteria to retry a job.
- `"jobExecutionsRolloutConfig"`:
- `"maintenanceWindows"`: Allows you to configure an optional maintenance window for the
rollout of a job document to all devices in the target group for a job.
- `"presignedUrlConfig"`:
- `"tags"`: Metadata that can be used to manage the job template.
- `"timeoutConfig"`:
"""
function create_job_template(
description, jobTemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/job-templates/$(jobTemplateId)",
Dict{String,Any}("description" => description);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_job_template(
description,
jobTemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/job-templates/$(jobTemplateId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("description" => description), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_keys_and_certificate()
create_keys_and_certificate(params::Dict{String,<:Any})
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public
key. You can also call CreateKeysAndCertificate over MQTT from a device, for more
information, see Provisioning MQTT API. Note This is the only time IoT issues the private
key for this certificate, so it is important to keep it in a secure location. Requires
permission to access the CreateKeysAndCertificate action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"setAsActive"`: Specifies whether the certificate is active.
"""
function create_keys_and_certificate(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/keys-and-certificate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_keys_and_certificate(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/keys-and-certificate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_mitigation_action(action_name, action_params, role_arn)
create_mitigation_action(action_name, action_params, role_arn, params::Dict{String,<:Any})
Defines an action that can be applied to audit findings by using
StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to
specific check names. For more information, see Mitigation actions. Each mitigation action
can apply only one type of change. Requires permission to access the CreateMitigationAction
action.
# Arguments
- `action_name`: A friendly name for the action. Choose a friendly name that accurately
describes the action (for example, EnableLoggingAction).
- `action_params`: Defines the type of action and the parameters for that action.
- `role_arn`: The ARN of the IAM role that is used to apply the mitigation action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: Metadata that can be used to manage the mitigation action.
"""
function create_mitigation_action(
actionName, actionParams, roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/mitigationactions/actions/$(actionName)",
Dict{String,Any}("actionParams" => actionParams, "roleArn" => roleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_mitigation_action(
actionName,
actionParams,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/mitigationactions/actions/$(actionName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("actionParams" => actionParams, "roleArn" => roleArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_otaupdate(files, ota_update_id, role_arn, targets)
create_otaupdate(files, ota_update_id, role_arn, targets, params::Dict{String,<:Any})
Creates an IoT OTA update on a target group of things or groups. Requires permission to
access the CreateOTAUpdate action.
# Arguments
- `files`: The files to be streamed by the OTA update.
- `ota_update_id`: The ID of the OTA update to be created.
- `role_arn`: The IAM role that grants Amazon Web Services IoT Core access to the Amazon
S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
- `targets`: The devices targeted to receive OTA updates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalParameters"`: A list of additional OTA update parameters, which are
name-value pairs. They won't be sent to devices as a part of the Job document.
- `"awsJobAbortConfig"`: The criteria that determine when and how a job abort takes place.
- `"awsJobExecutionsRolloutConfig"`: Configuration for the rollout of OTA updates.
- `"awsJobPresignedUrlConfig"`: Configuration information for pre-signed URLs.
- `"awsJobTimeoutConfig"`: Specifies the amount of time each device has to finish its
execution of the job. A timer is started when the job execution status is set to
IN_PROGRESS. If the job execution status is not set to another terminal state before the
timer expires, it will be automatically set to TIMED_OUT.
- `"description"`: The description of the OTA update.
- `"protocols"`: The protocol used to transfer the OTA update image. Valid values are
[HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can
choose the protocol.
- `"tags"`: Metadata which can be used to manage updates.
- `"targetSelection"`: Specifies whether the update will continue to run (CONTINUOUS), or
will be complete after all the things specified as targets have completed the update
(SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected
in a target. For example, an update will run on a thing when the thing is added to a target
group, even after the update was completed by all things originally in the group. Valid
values: CONTINUOUS | SNAPSHOT.
"""
function create_otaupdate(
files, otaUpdateId, roleArn, targets; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/otaUpdates/$(otaUpdateId)",
Dict{String,Any}("files" => files, "roleArn" => roleArn, "targets" => targets);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_otaupdate(
files,
otaUpdateId,
roleArn,
targets,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/otaUpdates/$(otaUpdateId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"files" => files, "roleArn" => roleArn, "targets" => targets
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_package(package_name)
create_package(package_name, params::Dict{String,<:Any})
Creates an IoT software package that can be deployed to your fleet. Requires permission to
access the CreatePackage and GetIndexingConfiguration actions.
# Arguments
- `package_name`: The name of the new software package.
# 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.
- `"description"`: A summary of the package being created. This can be used to outline the
package's contents or purpose.
- `"tags"`: Metadata that can be used to manage the package.
"""
function create_package(packageName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PUT",
"/packages/$(packageName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_package(
packageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/packages/$(packageName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_package_version(package_name, version_name)
create_package_version(package_name, version_name, params::Dict{String,<:Any})
Creates a new version for an existing IoT software package. Requires permission to access
the CreatePackageVersion and GetIndexingConfiguration actions.
# Arguments
- `package_name`: The name of the associated software package.
- `version_name`: The name of the new package version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: Metadata that can be used to define a package version’s configuration.
For example, the S3 file location, configuration options that are being sent to the device
or fleet. The combined size of all the attributes on a package version is limited to 3KB.
- `"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.
- `"description"`: A summary of the package version being created. This can be used to
outline the package's contents or purpose.
- `"tags"`: Metadata that can be used to manage the package version.
"""
function create_package_version(
packageName, versionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/packages/$(packageName)/versions/$(versionName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_package_version(
packageName,
versionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/packages/$(packageName)/versions/$(versionName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_policy(policy_document, policy_name)
create_policy(policy_document, policy_name, params::Dict{String,<:Any})
Creates an IoT policy. The created policy is the default version for the policy. This
operation creates a policy version with a version identifier of 1 and sets 1 as the
policy's default version. Requires permission to access the CreatePolicy action.
# Arguments
- `policy_document`: The JSON document that describes the policy. policyDocument must have
a minimum length of 1, with a maximum length of 2048, excluding whitespace.
- `policy_name`: The policy name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: Metadata which can be used to manage the policy. For URI Request parameters
use format: ...key1=value1&key2=value2... For the CLI command-line parameter use
format: &&tags \"key1=value1&key2=value2...\" For the cli-input-json file use
format: \"tags\": \"key1=value1&key2=value2...\"
"""
function create_policy(
policyDocument, policyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/policies/$(policyName)",
Dict{String,Any}("policyDocument" => policyDocument);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_policy(
policyDocument,
policyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/policies/$(policyName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyDocument" => policyDocument), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_policy_version(policy_document, policy_name)
create_policy_version(policy_document, policy_name, params::Dict{String,<:Any})
Creates a new version of the specified IoT policy. To update a policy, create a new policy
version. A managed policy can have up to five versions. If the policy has five versions,
you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default
version is the operative version (that is, the version that is in effect for the
certificates to which the policy is attached). Requires permission to access the
CreatePolicyVersion action.
# Arguments
- `policy_document`: The JSON document that describes the policy. Minimum length of 1.
Maximum length of 2048, excluding whitespace.
- `policy_name`: The policy name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"setAsDefault"`: Specifies whether the policy version is set as the default. When this
parameter is true, the new policy version becomes the operative version (that is, the
version that is in effect for the certificates to which the policy is attached).
"""
function create_policy_version(
policyDocument, policyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/policies/$(policyName)/version",
Dict{String,Any}("policyDocument" => policyDocument);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_policy_version(
policyDocument,
policyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/policies/$(policyName)/version",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("policyDocument" => policyDocument), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_provisioning_claim(template_name)
create_provisioning_claim(template_name, params::Dict{String,<:Any})
Creates a provisioning claim. Requires permission to access the CreateProvisioningClaim
action.
# Arguments
- `template_name`: The name of the provisioning template to use.
"""
function create_provisioning_claim(
templateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/provisioning-templates/$(templateName)/provisioning-claim";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_provisioning_claim(
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/provisioning-templates/$(templateName)/provisioning-claim",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_provisioning_template(provisioning_role_arn, template_body, template_name)
create_provisioning_template(provisioning_role_arn, template_body, template_name, params::Dict{String,<:Any})
Creates a provisioning template. Requires permission to access the
CreateProvisioningTemplate action.
# Arguments
- `provisioning_role_arn`: The role ARN for the role associated with the provisioning
template. This IoT role grants permission to provision a device.
- `template_body`: The JSON formatted contents of the provisioning template.
- `template_name`: The name of the provisioning template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the provisioning template.
- `"enabled"`: True to enable the provisioning template, otherwise false.
- `"preProvisioningHook"`: Creates a pre-provisioning hook template. Only supports template
of type FLEET_PROVISIONING. For more information about provisioning template types, see
type.
- `"tags"`: Metadata which can be used to manage the provisioning template. For URI
Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line
parameter use format: &&tags \"key1=value1&key2=value2...\" For the
cli-input-json file use format: \"tags\": \"key1=value1&key2=value2...\"
- `"type"`: The type you define in a provisioning template. You can create a template with
only one type. You can't change the template type after its creation. The default value is
FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning
template.
"""
function create_provisioning_template(
provisioningRoleArn,
templateBody,
templateName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/provisioning-templates",
Dict{String,Any}(
"provisioningRoleArn" => provisioningRoleArn,
"templateBody" => templateBody,
"templateName" => templateName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_provisioning_template(
provisioningRoleArn,
templateBody,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/provisioning-templates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"provisioningRoleArn" => provisioningRoleArn,
"templateBody" => templateBody,
"templateName" => templateName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_provisioning_template_version(template_body, template_name)
create_provisioning_template_version(template_body, template_name, params::Dict{String,<:Any})
Creates a new version of a provisioning template. Requires permission to access the
CreateProvisioningTemplateVersion action.
# Arguments
- `template_body`: The JSON formatted contents of the provisioning template.
- `template_name`: The name of the provisioning template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"setAsDefault"`: Sets a fleet provision template version as the default version.
"""
function create_provisioning_template_version(
templateBody, templateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/provisioning-templates/$(templateName)/versions",
Dict{String,Any}("templateBody" => templateBody);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_provisioning_template_version(
templateBody,
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/provisioning-templates/$(templateName)/versions",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("templateBody" => templateBody), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_role_alias(role_alias, role_arn)
create_role_alias(role_alias, role_arn, params::Dict{String,<:Any})
Creates a role alias. Requires permission to access the CreateRoleAlias action.
# Arguments
- `role_alias`: The role alias that points to a role ARN. This allows you to change the
role without having to update the device.
- `role_arn`: The role ARN.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"credentialDurationSeconds"`: How long (in seconds) the credentials will be valid. The
default value is 3,600 seconds. This value must be less than or equal to the maximum
session duration of the IAM role that the role alias references.
- `"tags"`: Metadata which can be used to manage the role alias. For URI Request
parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter
use format: &&tags \"key1=value1&key2=value2...\" For the cli-input-json file
use format: \"tags\": \"key1=value1&key2=value2...\"
"""
function create_role_alias(
roleAlias, roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/role-aliases/$(roleAlias)",
Dict{String,Any}("roleArn" => roleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_role_alias(
roleAlias,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/role-aliases/$(roleAlias)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("roleArn" => roleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_scheduled_audit(frequency, scheduled_audit_name, target_check_names)
create_scheduled_audit(frequency, scheduled_audit_name, target_check_names, params::Dict{String,<:Any})
Creates a scheduled audit that is run at a specified time interval. Requires permission to
access the CreateScheduledAudit action.
# Arguments
- `frequency`: How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or
MONTHLY. The start time of each audit is determined by the system.
- `scheduled_audit_name`: The name you want to give to the scheduled audit. (Max. 128 chars)
- `target_check_names`: Which checks are performed during the scheduled audit. Checks must
be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all
checks, including those that are enabled or use UpdateAccountAuditConfiguration to select
which checks are enabled.)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dayOfMonth"`: The day of the month on which the scheduled audit takes place. This can
be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\" parameter
is set to MONTHLY. If days 29 to 31 are specified, and the month doesn't have that many
days, the audit takes place on the LAST day of the month.
- `"dayOfWeek"`: The day of the week on which the scheduled audit takes place, either SUN,
MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is set
to WEEKLY or BIWEEKLY.
- `"tags"`: Metadata that can be used to manage the scheduled audit.
"""
function create_scheduled_audit(
frequency,
scheduledAuditName,
targetCheckNames;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/audit/scheduledaudits/$(scheduledAuditName)",
Dict{String,Any}("frequency" => frequency, "targetCheckNames" => targetCheckNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_scheduled_audit(
frequency,
scheduledAuditName,
targetCheckNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/audit/scheduledaudits/$(scheduledAuditName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"frequency" => frequency, "targetCheckNames" => targetCheckNames
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_security_profile(security_profile_name)
create_security_profile(security_profile_name, params::Dict{String,<:Any})
Creates a Device Defender security profile. Requires permission to access the
CreateSecurityProfile action.
# Arguments
- `security_profile_name`: The name you are giving to the security profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalMetricsToRetain"`: Please use
CreateSecurityProfileRequestadditionalMetricsToRetainV2 instead. A list of metrics whose
data is retained (stored). By default, data is retained for any metric used in the
profile's behaviors, but it is also retained for any metric specified here. Can be used
with custom metrics; cannot be used with dimensions.
- `"additionalMetricsToRetainV2"`: A list of metrics whose data is retained (stored). By
default, data is retained for any metric used in the profile's behaviors, but it is also
retained for any metric specified here. Can be used with custom metrics; cannot be used
with dimensions.
- `"alertTargets"`: Specifies the destinations to which alerts are sent. (Alerts are always
sent to the console.) Alerts are generated when a device (thing) violates a behavior.
- `"behaviors"`: Specifies the behaviors that, when violated by a device (thing), cause an
alert.
- `"metricsExportConfig"`: Specifies the MQTT topic and role ARN required for metric export.
- `"securityProfileDescription"`: A description of the security profile.
- `"tags"`: Metadata that can be used to manage the security profile.
"""
function create_security_profile(
securityProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/security-profiles/$(securityProfileName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_security_profile(
securityProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/security-profiles/$(securityProfileName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_stream(files, role_arn, stream_id)
create_stream(files, role_arn, stream_id, params::Dict{String,<:Any})
Creates a stream for delivering one or more large files in chunks over MQTT. A stream
transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3.
You can have one or more files associated with a stream. Requires permission to access the
CreateStream action.
# Arguments
- `files`: The files to stream.
- `role_arn`: An IAM role that allows the IoT service principal to access your S3 files.
- `stream_id`: The stream ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: A description of the stream.
- `"tags"`: Metadata which can be used to manage streams.
"""
function create_stream(
files, roleArn, streamId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/streams/$(streamId)",
Dict{String,Any}("files" => files, "roleArn" => roleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_stream(
files,
roleArn,
streamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/streams/$(streamId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("files" => files, "roleArn" => roleArn), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_thing(thing_name)
create_thing(thing_name, params::Dict{String,<:Any})
Creates a thing record in the registry. If this call is made multiple times using the same
thing name and configuration, the call will succeed. If this call is made with the same
thing name but different configuration a ResourceAlreadyExistsException is thrown. This is
a control plane operation. See Authorization for information about authorizing control
plane actions. Requires permission to access the CreateThing action.
# Arguments
- `thing_name`: The name of the thing to create. You can't change a thing's name after you
create it. To change a thing's name, you must create a new thing, give it the new name, and
then delete the old thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributePayload"`: The attribute payload, which consists of up to three name/value
pairs in a JSON document. For example: {\"attributes\":{\"string1\":\"string2\"}}
- `"billingGroupName"`: The name of the billing group the thing will be added to.
- `"thingTypeName"`: The name of the thing type associated with the new thing.
"""
function create_thing(thingName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/things/$(thingName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_thing(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/things/$(thingName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_thing_group(thing_group_name)
create_thing_group(thing_group_name, params::Dict{String,<:Any})
Create a thing group. This is a control plane operation. See Authorization for information
about authorizing control plane actions. If the ThingGroup that you create has the exact
same attributes as an existing ThingGroup, you will get a 200 success response. Requires
permission to access the CreateThingGroup action.
# Arguments
- `thing_group_name`: The thing group name to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parentGroupName"`: The name of the parent thing group.
- `"tags"`: Metadata which can be used to manage the thing group.
- `"thingGroupProperties"`: The thing group properties.
"""
function create_thing_group(
thingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/thing-groups/$(thingGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_thing_group(
thingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/thing-groups/$(thingGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_thing_type(thing_type_name)
create_thing_type(thing_type_name, params::Dict{String,<:Any})
Creates a new thing type. Requires permission to access the CreateThingType action.
# Arguments
- `thing_type_name`: The name of the thing type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: Metadata which can be used to manage the thing type.
- `"thingTypeProperties"`: The ThingTypeProperties for the thing type to create. It
contains information about the new thing type including a description, and a list of
searchable thing attribute names.
"""
function create_thing_type(thingTypeName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/thing-types/$(thingTypeName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_thing_type(
thingTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/thing-types/$(thingTypeName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_topic_rule(rule_name, topic_rule_payload)
create_topic_rule(rule_name, topic_rule_payload, params::Dict{String,<:Any})
Creates a rule. Creating rules is an administrator-level action. Any user who has
permission to create rules will be able to access data processed by the rule. Requires
permission to access the CreateTopicRule action.
# Arguments
- `rule_name`: The name of the rule.
- `topic_rule_payload`: The rule payload.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"x-amz-tagging"`: Metadata which can be used to manage the topic rule. For URI Request
parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter
use format: --tags \"key1=value1&key2=value2...\" For the cli-input-json file use
format: \"tags\": \"key1=value1&key2=value2...\"
"""
function create_topic_rule(
ruleName, topicRulePayload; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/rules/$(ruleName)",
Dict{String,Any}("topicRulePayload" => topicRulePayload);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_topic_rule(
ruleName,
topicRulePayload,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/rules/$(ruleName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("topicRulePayload" => topicRulePayload), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_topic_rule_destination(destination_configuration)
create_topic_rule_destination(destination_configuration, params::Dict{String,<:Any})
Creates a topic rule destination. The destination must be confirmed prior to use. Requires
permission to access the CreateTopicRuleDestination action.
# Arguments
- `destination_configuration`: The topic rule destination configuration.
"""
function create_topic_rule_destination(
destinationConfiguration; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/destinations",
Dict{String,Any}("destinationConfiguration" => destinationConfiguration);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_topic_rule_destination(
destinationConfiguration,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/destinations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("destinationConfiguration" => destinationConfiguration),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_account_audit_configuration()
delete_account_audit_configuration(params::Dict{String,<:Any})
Restores the default settings for Device Defender audits for this account. Any
configuration data you entered is deleted and all audit checks are reset to disabled.
Requires permission to access the DeleteAccountAuditConfiguration action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deleteScheduledAudits"`: If true, all scheduled audits are deleted.
"""
function delete_account_audit_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/audit/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_account_audit_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/audit/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_audit_suppression(check_name, resource_identifier)
delete_audit_suppression(check_name, resource_identifier, params::Dict{String,<:Any})
Deletes a Device Defender audit suppression. Requires permission to access the
DeleteAuditSuppression action.
# Arguments
- `check_name`:
- `resource_identifier`:
"""
function delete_audit_suppression(
checkName, resourceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/audit/suppressions/delete",
Dict{String,Any}(
"checkName" => checkName, "resourceIdentifier" => resourceIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_audit_suppression(
checkName,
resourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/audit/suppressions/delete",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"checkName" => checkName, "resourceIdentifier" => resourceIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_authorizer(authorizer_name)
delete_authorizer(authorizer_name, params::Dict{String,<:Any})
Deletes an authorizer. Requires permission to access the DeleteAuthorizer action.
# Arguments
- `authorizer_name`: The name of the authorizer to delete.
"""
function delete_authorizer(
authorizerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/authorizer/$(authorizerName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_authorizer(
authorizerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/authorizer/$(authorizerName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_billing_group(billing_group_name)
delete_billing_group(billing_group_name, params::Dict{String,<:Any})
Deletes the billing group. Requires permission to access the DeleteBillingGroup action.
# Arguments
- `billing_group_name`: The name of the billing group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedVersion"`: The expected version of the billing group. If the version of the
billing group does not match the expected version specified in the request, the
DeleteBillingGroup request is rejected with a VersionConflictException.
"""
function delete_billing_group(
billingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/billing-groups/$(billingGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_billing_group(
billingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/billing-groups/$(billingGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_cacertificate(ca_certificate_id)
delete_cacertificate(ca_certificate_id, params::Dict{String,<:Any})
Deletes a registered CA certificate. Requires permission to access the DeleteCACertificate
action.
# Arguments
- `ca_certificate_id`: The ID of the certificate to delete. (The last part of the
certificate ARN contains the certificate ID.)
"""
function delete_cacertificate(
caCertificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/cacertificate/$(caCertificateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_cacertificate(
caCertificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/cacertificate/$(caCertificateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_certificate(certificate_id)
delete_certificate(certificate_id, params::Dict{String,<:Any})
Deletes the specified certificate. A certificate cannot be deleted if it has a policy or
IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first
use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action
to set the certificate to the INACTIVE status. Requires permission to access the
DeleteCertificate action.
# Arguments
- `certificate_id`: The ID of the certificate. (The last part of the certificate ARN
contains the certificate ID.)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"forceDelete"`: Forces the deletion of a certificate if it is inactive and is not
attached to an IoT thing.
"""
function delete_certificate(
certificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/certificates/$(certificateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_certificate(
certificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/certificates/$(certificateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_certificate_provider(certificate_provider_name)
delete_certificate_provider(certificate_provider_name, params::Dict{String,<:Any})
Deletes a certificate provider. Requires permission to access the DeleteCertificateProvider
action. If you delete the certificate provider resource, the behavior of
CreateCertificateFromCsr will resume, and IoT will create certificates signed by IoT from a
certificate signing request (CSR).
# Arguments
- `certificate_provider_name`: The name of the certificate provider.
"""
function delete_certificate_provider(
certificateProviderName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/certificate-providers/$(certificateProviderName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_certificate_provider(
certificateProviderName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/certificate-providers/$(certificateProviderName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_custom_metric(metric_name)
delete_custom_metric(metric_name, params::Dict{String,<:Any})
Deletes a Device Defender detect custom metric. Requires permission to access the
DeleteCustomMetric action. Before you can delete a custom metric, you must first remove
the custom metric from all security profiles it's a part of. The security profile
associated with the custom metric can be found using the ListSecurityProfiles API with
metricName set to your custom metric name.
# Arguments
- `metric_name`: The name of the custom metric.
"""
function delete_custom_metric(metricName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/custom-metric/$(metricName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_custom_metric(
metricName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/custom-metric/$(metricName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dimension(name)
delete_dimension(name, params::Dict{String,<:Any})
Removes the specified dimension from your Amazon Web Services accounts. Requires permission
to access the DeleteDimension action.
# Arguments
- `name`: The unique identifier for the dimension that you want to delete.
"""
function delete_dimension(name; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/dimensions/$(name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dimension(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/dimensions/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain_configuration(domain_configuration_name)
delete_domain_configuration(domain_configuration_name, params::Dict{String,<:Any})
Deletes the specified domain configuration. Requires permission to access the
DeleteDomainConfiguration action.
# Arguments
- `domain_configuration_name`: The name of the domain configuration to be deleted.
"""
function delete_domain_configuration(
domainConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/domainConfigurations/$(domainConfigurationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_domain_configuration(
domainConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/domainConfigurations/$(domainConfigurationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dynamic_thing_group(thing_group_name)
delete_dynamic_thing_group(thing_group_name, params::Dict{String,<:Any})
Deletes a dynamic thing group. Requires permission to access the DeleteDynamicThingGroup
action.
# Arguments
- `thing_group_name`: The name of the dynamic thing group to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedVersion"`: The expected version of the dynamic thing group to delete.
"""
function delete_dynamic_thing_group(
thingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/dynamic-thing-groups/$(thingGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dynamic_thing_group(
thingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/dynamic-thing-groups/$(thingGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fleet_metric(metric_name)
delete_fleet_metric(metric_name, params::Dict{String,<:Any})
Deletes the specified fleet metric. Returns successfully with no error if the deletion is
successful or you specify a fleet metric that doesn't exist. Requires permission to access
the DeleteFleetMetric action.
# Arguments
- `metric_name`: The name of the fleet metric to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedVersion"`: The expected version of the fleet metric to delete.
"""
function delete_fleet_metric(metricName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/fleet-metric/$(metricName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fleet_metric(
metricName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/fleet-metric/$(metricName)",
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 job and its related job executions. Deleting a job may take time, depending on
the number of job executions created for the job and various other factors. While the job
is being deleted, the status of the job will be shown as \"DELETION_IN_PROGRESS\".
Attempting to delete or cancel a job whose status is already \"DELETION_IN_PROGRESS\" will
result in an error. Only 10 jobs may have status \"DELETION_IN_PROGRESS\" at the same time,
or a LimitExceededException will occur. Requires permission to access the DeleteJob action.
# Arguments
- `job_id`: The ID of the job to be deleted. After a job deletion is completed, you may
reuse this jobId when you create a new job. However, this is not recommended, and you must
ensure that your devices are not using the jobId to refer to the deleted job.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: (Optional) When true, you can delete a job which is \"IN_PROGRESS\".
Otherwise, you can only delete a job which is in a terminal state (\"COMPLETED\" or
\"CANCELED\") or an exception will occur. The default is false. Deleting a job which is
\"IN_PROGRESS\", will cause a device which is executing the job to be unable to access job
information or update the job execution status. Use caution and ensure that each device
executing a job which is deleted is able to recover to a valid state.
- `"namespaceId"`: The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs
notifications to MQTT topics that contain the value in the following format.
aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature
is only supported by IoT Greengrass at this time. For more information, see Setting up IoT
Greengrass core devices.
"""
function delete_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE", "/jobs/$(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 iot(
"DELETE",
"/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_job_execution(execution_number, job_id, thing_name)
delete_job_execution(execution_number, job_id, thing_name, params::Dict{String,<:Any})
Deletes a job execution. Requires permission to access the DeleteJobExecution action.
# Arguments
- `execution_number`: The ID of the job execution to be deleted. The executionNumber refers
to the execution of a particular job on a particular device. Note that once a job execution
is deleted, the executionNumber may be reused by IoT, so be sure you get and use the
correct value here.
- `job_id`: The ID of the job whose execution on a particular device will be deleted.
- `thing_name`: The name of the thing whose job execution will be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"force"`: (Optional) When true, you can delete a job execution which is \"IN_PROGRESS\".
Otherwise, you can only delete a job execution which is in a terminal state (\"SUCCEEDED\",
\"FAILED\", \"REJECTED\", \"REMOVED\" or \"CANCELED\") or an exception will occur. The
default is false. Deleting a job execution which is \"IN_PROGRESS\", will cause the device
to be unable to access job information or update the job execution status. Use caution and
ensure that the device is able to recover to a valid state.
- `"namespaceId"`: The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs
notifications to MQTT topics that contain the value in the following format.
aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature
is only supported by IoT Greengrass at this time. For more information, see Setting up IoT
Greengrass core devices.
"""
function delete_job_execution(
executionNumber, jobId, thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/things/$(thingName)/jobs/$(jobId)/executionNumber/$(executionNumber)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_job_execution(
executionNumber,
jobId,
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/things/$(thingName)/jobs/$(jobId)/executionNumber/$(executionNumber)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_job_template(job_template_id)
delete_job_template(job_template_id, params::Dict{String,<:Any})
Deletes the specified job template.
# Arguments
- `job_template_id`: The unique identifier of the job template to delete.
"""
function delete_job_template(
jobTemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/job-templates/$(jobTemplateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_job_template(
jobTemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/job-templates/$(jobTemplateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_mitigation_action(action_name)
delete_mitigation_action(action_name, params::Dict{String,<:Any})
Deletes a defined mitigation action from your Amazon Web Services accounts. Requires
permission to access the DeleteMitigationAction action.
# Arguments
- `action_name`: The name of the mitigation action that you want to delete.
"""
function delete_mitigation_action(
actionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/mitigationactions/actions/$(actionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_mitigation_action(
actionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/mitigationactions/actions/$(actionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_otaupdate(ota_update_id)
delete_otaupdate(ota_update_id, params::Dict{String,<:Any})
Delete an OTA update. Requires permission to access the DeleteOTAUpdate action.
# Arguments
- `ota_update_id`: The ID of the OTA update to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deleteStream"`: When true, the stream created by the OTAUpdate process is deleted when
the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by
the user.
- `"forceDeleteAWSJob"`: When true, deletes the IoT job created by the OTAUpdate process
even if it is \"IN_PROGRESS\". Otherwise, if the job is not in a terminal state
(\"COMPLETED\" or \"CANCELED\") an exception will occur. The default is false.
"""
function delete_otaupdate(otaUpdateId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/otaUpdates/$(otaUpdateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_otaupdate(
otaUpdateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/otaUpdates/$(otaUpdateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_package(package_name)
delete_package(package_name, params::Dict{String,<:Any})
Deletes a specific version from a software package. Note: All package versions must be
deleted before deleting the software package. Requires permission to access the
DeletePackageVersion action.
# Arguments
- `package_name`: The name of the target software package.
# 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_package(packageName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/packages/$(packageName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_package(
packageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/packages/$(packageName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_package_version(package_name, version_name)
delete_package_version(package_name, version_name, params::Dict{String,<:Any})
Deletes a specific version from a software package. Note: If a package version is
designated as default, you must remove the designation from the software package using the
UpdatePackage action.
# Arguments
- `package_name`: The name of the associated software package.
- `version_name`: The name of the target package version.
# 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_package_version(
packageName, versionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/packages/$(packageName)/versions/$(versionName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_package_version(
packageName,
versionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/packages/$(packageName)/versions/$(versionName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy(policy_name)
delete_policy(policy_name, params::Dict{String,<:Any})
Deletes the specified policy. A policy cannot be deleted if it has non-default versions or
it is attached to any certificate. To delete a policy, use the DeletePolicyVersion action
to delete all non-default versions of the policy; use the DetachPolicy action to detach the
policy from any certificate; and then use the DeletePolicy action to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes
after a policy is detached before it's ready to be deleted. Requires permission to access
the DeletePolicy action.
# Arguments
- `policy_name`: The name of the policy to delete.
"""
function delete_policy(policyName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/policies/$(policyName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_policy(
policyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/policies/$(policyName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_policy_version(policy_name, policy_version_id)
delete_policy_version(policy_name, policy_version_id, params::Dict{String,<:Any})
Deletes the specified version of the specified policy. You cannot delete the default
version of a policy using this action. To delete the default version of a policy, use
DeletePolicy. To find out which version of a policy is marked as the default version, use
ListPolicyVersions. Requires permission to access the DeletePolicyVersion action.
# Arguments
- `policy_name`: The name of the policy.
- `policy_version_id`: The policy version ID.
"""
function delete_policy_version(
policyName, policyVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/policies/$(policyName)/version/$(policyVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_policy_version(
policyName,
policyVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/policies/$(policyName)/version/$(policyVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_provisioning_template(template_name)
delete_provisioning_template(template_name, params::Dict{String,<:Any})
Deletes a provisioning template. Requires permission to access the
DeleteProvisioningTemplate action.
# Arguments
- `template_name`: The name of the fleet provision template to delete.
"""
function delete_provisioning_template(
templateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/provisioning-templates/$(templateName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_provisioning_template(
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/provisioning-templates/$(templateName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_provisioning_template_version(template_name, version_id)
delete_provisioning_template_version(template_name, version_id, params::Dict{String,<:Any})
Deletes a provisioning template version. Requires permission to access the
DeleteProvisioningTemplateVersion action.
# Arguments
- `template_name`: The name of the provisioning template version to delete.
- `version_id`: The provisioning template version ID to delete.
"""
function delete_provisioning_template_version(
templateName, versionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/provisioning-templates/$(templateName)/versions/$(versionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_provisioning_template_version(
templateName,
versionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/provisioning-templates/$(templateName)/versions/$(versionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_registration_code()
delete_registration_code(params::Dict{String,<:Any})
Deletes a CA certificate registration code. Requires permission to access the
DeleteRegistrationCode action.
"""
function delete_registration_code(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/registrationcode";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_registration_code(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/registrationcode",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_role_alias(role_alias)
delete_role_alias(role_alias, params::Dict{String,<:Any})
Deletes a role alias Requires permission to access the DeleteRoleAlias action.
# Arguments
- `role_alias`: The role alias to delete.
"""
function delete_role_alias(roleAlias; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/role-aliases/$(roleAlias)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_role_alias(
roleAlias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/role-aliases/$(roleAlias)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_scheduled_audit(scheduled_audit_name)
delete_scheduled_audit(scheduled_audit_name, params::Dict{String,<:Any})
Deletes a scheduled audit. Requires permission to access the DeleteScheduledAudit action.
# Arguments
- `scheduled_audit_name`: The name of the scheduled audit you want to delete.
"""
function delete_scheduled_audit(
scheduledAuditName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/audit/scheduledaudits/$(scheduledAuditName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_scheduled_audit(
scheduledAuditName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/audit/scheduledaudits/$(scheduledAuditName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_security_profile(security_profile_name)
delete_security_profile(security_profile_name, params::Dict{String,<:Any})
Deletes a Device Defender security profile. Requires permission to access the
DeleteSecurityProfile action.
# Arguments
- `security_profile_name`: The name of the security profile to be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedVersion"`: The expected version of the security profile. A new version is
generated whenever the security profile is updated. If you specify a value that is
different from the actual version, a VersionConflictException is thrown.
"""
function delete_security_profile(
securityProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/security-profiles/$(securityProfileName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_security_profile(
securityProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/security-profiles/$(securityProfileName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_stream(stream_id)
delete_stream(stream_id, params::Dict{String,<:Any})
Deletes a stream. Requires permission to access the DeleteStream action.
# Arguments
- `stream_id`: The stream ID.
"""
function delete_stream(streamId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/streams/$(streamId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_stream(
streamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/streams/$(streamId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_thing(thing_name)
delete_thing(thing_name, params::Dict{String,<:Any})
Deletes the specified thing. Returns successfully with no error if the deletion is
successful or you specify a thing that doesn't exist. Requires permission to access the
DeleteThing action.
# Arguments
- `thing_name`: The name of the thing to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedVersion"`: The expected version of the thing record in the registry. If the
version of the record in the registry does not match the expected version specified in the
request, the DeleteThing request is rejected with a VersionConflictException.
"""
function delete_thing(thingName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/things/$(thingName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_thing(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/things/$(thingName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_thing_group(thing_group_name)
delete_thing_group(thing_group_name, params::Dict{String,<:Any})
Deletes a thing group. Requires permission to access the DeleteThingGroup action.
# Arguments
- `thing_group_name`: The name of the thing group to delete.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedVersion"`: The expected version of the thing group to delete.
"""
function delete_thing_group(
thingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/thing-groups/$(thingGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_thing_group(
thingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/thing-groups/$(thingGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_thing_type(thing_type_name)
delete_thing_type(thing_type_name, params::Dict{String,<:Any})
Deletes the specified thing type. You cannot delete a thing type if it has things
associated with it. To delete a thing type, first mark it as deprecated by calling
DeprecateThingType, then remove any associated things by calling UpdateThing to change the
thing type on any associated thing, and finally use DeleteThingType to delete the thing
type. Requires permission to access the DeleteThingType action.
# Arguments
- `thing_type_name`: The name of the thing type.
"""
function delete_thing_type(thingTypeName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/thing-types/$(thingTypeName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_thing_type(
thingTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/thing-types/$(thingTypeName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_topic_rule(rule_name)
delete_topic_rule(rule_name, params::Dict{String,<:Any})
Deletes the rule. Requires permission to access the DeleteTopicRule action.
# Arguments
- `rule_name`: The name of the rule.
"""
function delete_topic_rule(ruleName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"DELETE",
"/rules/$(ruleName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_topic_rule(
ruleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/rules/$(ruleName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_topic_rule_destination(arn)
delete_topic_rule_destination(arn, params::Dict{String,<:Any})
Deletes a topic rule destination. Requires permission to access the
DeleteTopicRuleDestination action.
# Arguments
- `arn`: The ARN of the topic rule destination to delete.
"""
function delete_topic_rule_destination(
arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/destinations/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_topic_rule_destination(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/destinations/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_v2_logging_level(target_name, target_type)
delete_v2_logging_level(target_name, target_type, params::Dict{String,<:Any})
Deletes a logging level. Requires permission to access the DeleteV2LoggingLevel action.
# Arguments
- `target_name`: The name of the resource for which you are configuring logging.
- `target_type`: The type of resource for which you are configuring logging. Must be
THING_Group.
"""
function delete_v2_logging_level(
targetName, targetType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/v2LoggingLevel",
Dict{String,Any}("targetName" => targetName, "targetType" => targetType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_v2_logging_level(
targetName,
targetType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/v2LoggingLevel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("targetName" => targetName, "targetType" => targetType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deprecate_thing_type(thing_type_name)
deprecate_thing_type(thing_type_name, params::Dict{String,<:Any})
Deprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
# Arguments
- `thing_type_name`: The name of the thing type to deprecate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"undoDeprecate"`: Whether to undeprecate a deprecated thing type. If true, the thing
type will not be deprecated anymore and you can associate it with things.
"""
function deprecate_thing_type(
thingTypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/thing-types/$(thingTypeName)/deprecate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deprecate_thing_type(
thingTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/thing-types/$(thingTypeName)/deprecate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_account_audit_configuration()
describe_account_audit_configuration(params::Dict{String,<:Any})
Gets information about the Device Defender audit settings for this account. Settings
include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the DescribeAccountAuditConfiguration action.
"""
function describe_account_audit_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_account_audit_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_audit_finding(finding_id)
describe_audit_finding(finding_id, params::Dict{String,<:Any})
Gets information about a single audit finding. Properties include the reason for
noncompliance, the severity of the issue, and the start time when the audit that returned
the finding. Requires permission to access the DescribeAuditFinding action.
# Arguments
- `finding_id`: A unique identifier for a single audit finding. You can use this identifier
to apply mitigation actions to the finding.
"""
function describe_audit_finding(
findingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/findings/$(findingId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_audit_finding(
findingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/audit/findings/$(findingId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_audit_mitigation_actions_task(task_id)
describe_audit_mitigation_actions_task(task_id, params::Dict{String,<:Any})
Gets information about an audit mitigation task that is used to apply mitigation actions to
a set of audit findings. Properties include the actions being applied, the audit checks to
which they're being applied, the task status, and aggregated task statistics.
# Arguments
- `task_id`: The unique identifier for the audit mitigation task.
"""
function describe_audit_mitigation_actions_task(
taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/mitigationactions/tasks/$(taskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_audit_mitigation_actions_task(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/mitigationactions/tasks/$(taskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_audit_suppression(check_name, resource_identifier)
describe_audit_suppression(check_name, resource_identifier, params::Dict{String,<:Any})
Gets information about a Device Defender audit suppression.
# Arguments
- `check_name`:
- `resource_identifier`:
"""
function describe_audit_suppression(
checkName, resourceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/audit/suppressions/describe",
Dict{String,Any}(
"checkName" => checkName, "resourceIdentifier" => resourceIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_audit_suppression(
checkName,
resourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/audit/suppressions/describe",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"checkName" => checkName, "resourceIdentifier" => resourceIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_audit_task(task_id)
describe_audit_task(task_id, params::Dict{String,<:Any})
Gets information about a Device Defender audit. Requires permission to access the
DescribeAuditTask action.
# Arguments
- `task_id`: The ID of the audit whose information you want to get.
"""
function describe_audit_task(taskId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/audit/tasks/$(taskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_audit_task(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/tasks/$(taskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_authorizer(authorizer_name)
describe_authorizer(authorizer_name, params::Dict{String,<:Any})
Describes an authorizer. Requires permission to access the DescribeAuthorizer action.
# Arguments
- `authorizer_name`: The name of the authorizer to describe.
"""
function describe_authorizer(
authorizerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/authorizer/$(authorizerName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_authorizer(
authorizerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/authorizer/$(authorizerName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_billing_group(billing_group_name)
describe_billing_group(billing_group_name, params::Dict{String,<:Any})
Returns information about a billing group. Requires permission to access the
DescribeBillingGroup action.
# Arguments
- `billing_group_name`: The name of the billing group.
"""
function describe_billing_group(
billingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/billing-groups/$(billingGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_billing_group(
billingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/billing-groups/$(billingGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_cacertificate(ca_certificate_id)
describe_cacertificate(ca_certificate_id, params::Dict{String,<:Any})
Describes a registered CA certificate. Requires permission to access the
DescribeCACertificate action.
# Arguments
- `ca_certificate_id`: The CA certificate identifier.
"""
function describe_cacertificate(
caCertificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/cacertificate/$(caCertificateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_cacertificate(
caCertificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/cacertificate/$(caCertificateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_certificate(certificate_id)
describe_certificate(certificate_id, params::Dict{String,<:Any})
Gets information about the specified certificate. Requires permission to access the
DescribeCertificate action.
# Arguments
- `certificate_id`: The ID of the certificate. (The last part of the certificate ARN
contains the certificate ID.)
"""
function describe_certificate(
certificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/certificates/$(certificateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_certificate(
certificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/certificates/$(certificateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_certificate_provider(certificate_provider_name)
describe_certificate_provider(certificate_provider_name, params::Dict{String,<:Any})
Describes a certificate provider. Requires permission to access the
DescribeCertificateProvider action.
# Arguments
- `certificate_provider_name`: The name of the certificate provider.
"""
function describe_certificate_provider(
certificateProviderName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/certificate-providers/$(certificateProviderName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_certificate_provider(
certificateProviderName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/certificate-providers/$(certificateProviderName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_custom_metric(metric_name)
describe_custom_metric(metric_name, params::Dict{String,<:Any})
Gets information about a Device Defender detect custom metric. Requires permission to
access the DescribeCustomMetric action.
# Arguments
- `metric_name`: The name of the custom metric.
"""
function describe_custom_metric(
metricName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/custom-metric/$(metricName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_custom_metric(
metricName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/custom-metric/$(metricName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_default_authorizer()
describe_default_authorizer(params::Dict{String,<:Any})
Describes the default authorizer. Requires permission to access the
DescribeDefaultAuthorizer action.
"""
function describe_default_authorizer(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/default-authorizer"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_default_authorizer(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/default-authorizer",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_detect_mitigation_actions_task(task_id)
describe_detect_mitigation_actions_task(task_id, params::Dict{String,<:Any})
Gets information about a Device Defender ML Detect mitigation action. Requires permission
to access the DescribeDetectMitigationActionsTask action.
# Arguments
- `task_id`: The unique identifier of the task.
"""
function describe_detect_mitigation_actions_task(
taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/detect/mitigationactions/tasks/$(taskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_detect_mitigation_actions_task(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/detect/mitigationactions/tasks/$(taskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dimension(name)
describe_dimension(name, params::Dict{String,<:Any})
Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
# Arguments
- `name`: The unique identifier for the dimension.
"""
function describe_dimension(name; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/dimensions/$(name)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_dimension(
name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/dimensions/$(name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_domain_configuration(domain_configuration_name)
describe_domain_configuration(domain_configuration_name, params::Dict{String,<:Any})
Gets summary information about a domain configuration. Requires permission to access the
DescribeDomainConfiguration action.
# Arguments
- `domain_configuration_name`: The name of the domain configuration.
"""
function describe_domain_configuration(
domainConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/domainConfigurations/$(domainConfigurationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_domain_configuration(
domainConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/domainConfigurations/$(domainConfigurationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_endpoint()
describe_endpoint(params::Dict{String,<:Any})
Returns or creates a unique endpoint specific to the Amazon Web Services account making the
call. The first time DescribeEndpoint is called, an endpoint is created. All subsequent
calls to DescribeEndpoint return the same endpoint. Requires permission to access the
DescribeEndpoint action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endpointType"`: The endpoint type. Valid endpoint types include: iot:Data - Returns
a VeriSign signed data endpoint. iot:Data-ATS - Returns an ATS signed data endpoint.
iot:CredentialProvider - Returns an IoT credentials provider API endpoint. iot:Jobs
- Returns an IoT device management Jobs API endpoint. We strongly recommend that
customers use the newer iot:Data-ATS endpoint type to avoid issues related to the
widespread distrust of Symantec certificate authorities. ATS Signed Certificates are more
secure and are trusted by most popular browsers.
"""
function describe_endpoint(; aws_config::AbstractAWSConfig=global_aws_config())
return iot("GET", "/endpoint"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function describe_endpoint(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET", "/endpoint", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_event_configurations()
describe_event_configurations(params::Dict{String,<:Any})
Describes event configurations. Requires permission to access the
DescribeEventConfigurations action.
"""
function describe_event_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/event-configurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_event_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/event-configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_fleet_metric(metric_name)
describe_fleet_metric(metric_name, params::Dict{String,<:Any})
Gets information about the specified fleet metric. Requires permission to access the
DescribeFleetMetric action.
# Arguments
- `metric_name`: The name of the fleet metric to describe.
"""
function describe_fleet_metric(
metricName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/fleet-metric/$(metricName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_fleet_metric(
metricName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/fleet-metric/$(metricName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_index(index_name)
describe_index(index_name, params::Dict{String,<:Any})
Describes a search index. Requires permission to access the DescribeIndex action.
# Arguments
- `index_name`: The index name.
"""
function describe_index(indexName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/indices/$(indexName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_index(
indexName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/indices/$(indexName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job(job_id)
describe_job(job_id, params::Dict{String,<:Any})
Describes a job. Requires permission to access the DescribeJob action.
# Arguments
- `job_id`: The unique identifier you assigned to this job when it was created.
"""
function describe_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/jobs/$(jobId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function describe_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job_execution(job_id, thing_name)
describe_job_execution(job_id, thing_name, params::Dict{String,<:Any})
Describes a job execution. Requires permission to access the DescribeJobExecution action.
# Arguments
- `job_id`: The unique identifier you assigned to this job when it was created.
- `thing_name`: The name of the thing on which the job execution is running.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"executionNumber"`: A string (consisting of the digits \"0\" through \"9\" which is used
to specify a particular job execution on a particular device.
"""
function describe_job_execution(
jobId, thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/things/$(thingName)/jobs/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_job_execution(
jobId,
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/things/$(thingName)/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_job_template(job_template_id)
describe_job_template(job_template_id, params::Dict{String,<:Any})
Returns information about a job template.
# Arguments
- `job_template_id`: The unique identifier of the job template.
"""
function describe_job_template(
jobTemplateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/job-templates/$(jobTemplateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_job_template(
jobTemplateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/job-templates/$(jobTemplateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_managed_job_template(template_name)
describe_managed_job_template(template_name, params::Dict{String,<:Any})
View details of a managed job template.
# Arguments
- `template_name`: The unique name of a managed job template, which is required.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"templateVersion"`: An optional parameter to specify version of a managed template. If
not specified, the pre-defined default version is returned.
"""
function describe_managed_job_template(
templateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/managed-job-templates/$(templateName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_managed_job_template(
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/managed-job-templates/$(templateName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_mitigation_action(action_name)
describe_mitigation_action(action_name, params::Dict{String,<:Any})
Gets information about a mitigation action. Requires permission to access the
DescribeMitigationAction action.
# Arguments
- `action_name`: The friendly name that uniquely identifies the mitigation action.
"""
function describe_mitigation_action(
actionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/mitigationactions/actions/$(actionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_mitigation_action(
actionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/mitigationactions/actions/$(actionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_provisioning_template(template_name)
describe_provisioning_template(template_name, params::Dict{String,<:Any})
Returns information about a provisioning template. Requires permission to access the
DescribeProvisioningTemplate action.
# Arguments
- `template_name`: The name of the provisioning template.
"""
function describe_provisioning_template(
templateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/provisioning-templates/$(templateName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_provisioning_template(
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/provisioning-templates/$(templateName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_provisioning_template_version(template_name, version_id)
describe_provisioning_template_version(template_name, version_id, params::Dict{String,<:Any})
Returns information about a provisioning template version. Requires permission to access
the DescribeProvisioningTemplateVersion action.
# Arguments
- `template_name`: The template name.
- `version_id`: The provisioning template version ID.
"""
function describe_provisioning_template_version(
templateName, versionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/provisioning-templates/$(templateName)/versions/$(versionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_provisioning_template_version(
templateName,
versionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/provisioning-templates/$(templateName)/versions/$(versionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_role_alias(role_alias)
describe_role_alias(role_alias, params::Dict{String,<:Any})
Describes a role alias. Requires permission to access the DescribeRoleAlias action.
# Arguments
- `role_alias`: The role alias to describe.
"""
function describe_role_alias(roleAlias; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/role-aliases/$(roleAlias)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_role_alias(
roleAlias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/role-aliases/$(roleAlias)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_scheduled_audit(scheduled_audit_name)
describe_scheduled_audit(scheduled_audit_name, params::Dict{String,<:Any})
Gets information about a scheduled audit. Requires permission to access the
DescribeScheduledAudit action.
# Arguments
- `scheduled_audit_name`: The name of the scheduled audit whose information you want to get.
"""
function describe_scheduled_audit(
scheduledAuditName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/scheduledaudits/$(scheduledAuditName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_scheduled_audit(
scheduledAuditName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/audit/scheduledaudits/$(scheduledAuditName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_security_profile(security_profile_name)
describe_security_profile(security_profile_name, params::Dict{String,<:Any})
Gets information about a Device Defender security profile. Requires permission to access
the DescribeSecurityProfile action.
# Arguments
- `security_profile_name`: The name of the security profile whose information you want to
get.
"""
function describe_security_profile(
securityProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/security-profiles/$(securityProfileName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_security_profile(
securityProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/security-profiles/$(securityProfileName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_stream(stream_id)
describe_stream(stream_id, params::Dict{String,<:Any})
Gets information about a stream. Requires permission to access the DescribeStream action.
# Arguments
- `stream_id`: The stream ID.
"""
function describe_stream(streamId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/streams/$(streamId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_stream(
streamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/streams/$(streamId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_thing(thing_name)
describe_thing(thing_name, params::Dict{String,<:Any})
Gets information about the specified thing. Requires permission to access the DescribeThing
action.
# Arguments
- `thing_name`: The name of the thing.
"""
function describe_thing(thingName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/things/$(thingName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_thing(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/things/$(thingName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_thing_group(thing_group_name)
describe_thing_group(thing_group_name, params::Dict{String,<:Any})
Describe a thing group. Requires permission to access the DescribeThingGroup action.
# Arguments
- `thing_group_name`: The name of the thing group.
"""
function describe_thing_group(
thingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/thing-groups/$(thingGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_thing_group(
thingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/thing-groups/$(thingGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_thing_registration_task(task_id)
describe_thing_registration_task(task_id, params::Dict{String,<:Any})
Describes a bulk thing provisioning task. Requires permission to access the
DescribeThingRegistrationTask action.
# Arguments
- `task_id`: The task ID.
"""
function describe_thing_registration_task(
taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/thing-registration-tasks/$(taskId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_thing_registration_task(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/thing-registration-tasks/$(taskId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_thing_type(thing_type_name)
describe_thing_type(thing_type_name, params::Dict{String,<:Any})
Gets information about the specified thing type. Requires permission to access the
DescribeThingType action.
# Arguments
- `thing_type_name`: The name of the thing type.
"""
function describe_thing_type(
thingTypeName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/thing-types/$(thingTypeName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_thing_type(
thingTypeName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/thing-types/$(thingTypeName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_policy(policy_name, target)
detach_policy(policy_name, target, params::Dict{String,<:Any})
Detaches a policy from the specified target. Because of the distributed nature of Amazon
Web Services, it can take up to five minutes after a policy is detached before it's ready
to be deleted. Requires permission to access the DetachPolicy action.
# Arguments
- `policy_name`: The policy to detach.
- `target`: The target from which the policy will be detached.
"""
function detach_policy(
policyName, target; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/target-policies/$(policyName)",
Dict{String,Any}("target" => target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_policy(
policyName,
target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/target-policies/$(policyName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("target" => target), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_principal_policy(policy_name, x-amzn-iot-principal)
detach_principal_policy(policy_name, x-amzn-iot-principal, params::Dict{String,<:Any})
Removes the specified policy from the specified certificate. Note: This action is
deprecated and works as expected for backward compatibility, but we won't add enhancements.
Use DetachPolicy instead. Requires permission to access the DetachPrincipalPolicy action.
# Arguments
- `policy_name`: The name of the policy to detach.
- `x-amzn-iot-principal`: The principal. Valid principals are CertificateArn
(arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
(arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
"""
function detach_principal_policy(
policyName, x_amzn_iot_principal; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/principal-policies/$(policyName)",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-iot-principal" => x_amzn_iot_principal)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_principal_policy(
policyName,
x_amzn_iot_principal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/principal-policies/$(policyName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" =>
Dict{String,Any}("x-amzn-iot-principal" => x_amzn_iot_principal),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_security_profile(security_profile_name, security_profile_target_arn)
detach_security_profile(security_profile_name, security_profile_target_arn, params::Dict{String,<:Any})
Disassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
# Arguments
- `security_profile_name`: The security profile that is detached.
- `security_profile_target_arn`: The ARN of the thing group from which the security profile
is detached.
"""
function detach_security_profile(
securityProfileName,
securityProfileTargetArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/security-profiles/$(securityProfileName)/targets",
Dict{String,Any}("securityProfileTargetArn" => securityProfileTargetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_security_profile(
securityProfileName,
securityProfileTargetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/security-profiles/$(securityProfileName)/targets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("securityProfileTargetArn" => securityProfileTargetArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
detach_thing_principal(thing_name, x-amzn-principal)
detach_thing_principal(thing_name, x-amzn-principal, params::Dict{String,<:Any})
Detaches the specified principal from the specified thing. A principal can be X.509
certificates, IAM users, groups, and roles, Amazon Cognito identities or federated
identities. This call is asynchronous. It might take several seconds for the detachment to
propagate. Requires permission to access the DetachThingPrincipal action.
# Arguments
- `thing_name`: The name of the thing.
- `x-amzn-principal`: If the principal is a certificate, this value must be ARN of the
certificate. If the principal is an Amazon Cognito identity, this value must be the ID of
the Amazon Cognito identity.
"""
function detach_thing_principal(
thingName, x_amzn_principal; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"DELETE",
"/things/$(thingName)/principals",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-principal" => x_amzn_principal)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function detach_thing_principal(
thingName,
x_amzn_principal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"DELETE",
"/things/$(thingName)/principals",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-principal" => x_amzn_principal)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_topic_rule(rule_name)
disable_topic_rule(rule_name, params::Dict{String,<:Any})
Disables the rule. Requires permission to access the DisableTopicRule action.
# Arguments
- `rule_name`: The name of the rule to disable.
"""
function disable_topic_rule(ruleName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/rules/$(ruleName)/disable";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_topic_rule(
ruleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/rules/$(ruleName)/disable",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_topic_rule(rule_name)
enable_topic_rule(rule_name, params::Dict{String,<:Any})
Enables the rule. Requires permission to access the EnableTopicRule action.
# Arguments
- `rule_name`: The name of the topic rule to enable.
"""
function enable_topic_rule(ruleName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/rules/$(ruleName)/enable";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_topic_rule(
ruleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/rules/$(ruleName)/enable",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_behavior_model_training_summaries()
get_behavior_model_training_summaries(params::Dict{String,<:Any})
Returns a Device Defender's ML Detect Security Profile training model's status. Requires
permission to access the GetBehaviorModelTrainingSummaries 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 one time. The default is 10.
- `"nextToken"`: The token for the next set of results.
- `"securityProfileName"`: The name of the security profile.
"""
function get_behavior_model_training_summaries(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/behavior-model-training/summaries";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_behavior_model_training_summaries(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/behavior-model-training/summaries",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_buckets_aggregation(aggregation_field, buckets_aggregation_type, query_string)
get_buckets_aggregation(aggregation_field, buckets_aggregation_type, query_string, params::Dict{String,<:Any})
Aggregates on indexed data with search queries pertaining to particular fields. Requires
permission to access the GetBucketsAggregation action.
# Arguments
- `aggregation_field`: The aggregation field.
- `buckets_aggregation_type`: The basic control of the response shape and the bucket
aggregation type to perform.
- `query_string`: The search query string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"indexName"`: The name of the index to search.
- `"queryVersion"`: The version of the query.
"""
function get_buckets_aggregation(
aggregationField,
bucketsAggregationType,
queryString;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/indices/buckets",
Dict{String,Any}(
"aggregationField" => aggregationField,
"bucketsAggregationType" => bucketsAggregationType,
"queryString" => queryString,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_buckets_aggregation(
aggregationField,
bucketsAggregationType,
queryString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/indices/buckets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"aggregationField" => aggregationField,
"bucketsAggregationType" => bucketsAggregationType,
"queryString" => queryString,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_cardinality(query_string)
get_cardinality(query_string, params::Dict{String,<:Any})
Returns the approximate count of unique values that match the query. Requires permission to
access the GetCardinality action.
# Arguments
- `query_string`: The search query string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"aggregationField"`: The field to aggregate.
- `"indexName"`: The name of the index to search.
- `"queryVersion"`: The query version.
"""
function get_cardinality(queryString; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/indices/cardinality",
Dict{String,Any}("queryString" => queryString);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_cardinality(
queryString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/indices/cardinality",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("queryString" => queryString), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_effective_policies()
get_effective_policies(params::Dict{String,<:Any})
Gets a list of the policies that have an effect on the authorization behavior of the
specified device when it connects to the IoT device gateway. Requires permission to access
the GetEffectivePolicies action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"cognitoIdentityPoolId"`: The Cognito identity pool ID.
- `"principal"`: The principal. Valid principals are CertificateArn
(arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
(arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
- `"thingName"`: The thing name.
"""
function get_effective_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/effective-policies";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_effective_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/effective-policies",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_indexing_configuration()
get_indexing_configuration(params::Dict{String,<:Any})
Gets the indexing configuration. Requires permission to access the GetIndexingConfiguration
action.
"""
function get_indexing_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/indexing/config"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_indexing_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/indexing/config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_job_document(job_id)
get_job_document(job_id, params::Dict{String,<:Any})
Gets a job document. Requires permission to access the GetJobDocument action.
# Arguments
- `job_id`: The unique identifier you assigned to this job when it was created.
"""
function get_job_document(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/jobs/$(jobId)/job-document";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_job_document(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/jobs/$(jobId)/job-document",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_logging_options()
get_logging_options(params::Dict{String,<:Any})
Gets the logging options. NOTE: use of this command is not recommended. Use
GetV2LoggingOptions instead. Requires permission to access the GetLoggingOptions action.
"""
function get_logging_options(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/loggingOptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_logging_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/loggingOptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_otaupdate(ota_update_id)
get_otaupdate(ota_update_id, params::Dict{String,<:Any})
Gets an OTA update. Requires permission to access the GetOTAUpdate action.
# Arguments
- `ota_update_id`: The OTA update ID.
"""
function get_otaupdate(otaUpdateId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/otaUpdates/$(otaUpdateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_otaupdate(
otaUpdateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/otaUpdates/$(otaUpdateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_package(package_name)
get_package(package_name, params::Dict{String,<:Any})
Gets information about the specified software package. Requires permission to access the
GetPackage action.
# Arguments
- `package_name`: The name of the target software package.
"""
function get_package(packageName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/packages/$(packageName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_package(
packageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/packages/$(packageName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_package_configuration()
get_package_configuration(params::Dict{String,<:Any})
Gets information about the specified software package's configuration. Requires permission
to access the GetPackageConfiguration action.
"""
function get_package_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/package-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_package_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/package-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_package_version(package_name, version_name)
get_package_version(package_name, version_name, params::Dict{String,<:Any})
Gets information about the specified package version. Requires permission to access the
GetPackageVersion action.
# Arguments
- `package_name`: The name of the associated package.
- `version_name`: The name of the target package version.
"""
function get_package_version(
packageName, versionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/packages/$(packageName)/versions/$(versionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_package_version(
packageName,
versionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/packages/$(packageName)/versions/$(versionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_percentiles(query_string)
get_percentiles(query_string, params::Dict{String,<:Any})
Groups the aggregated values that match the query into percentile groupings. The default
percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you
call GetPercentiles. This function returns a value for each percentile group specified (or
the default percentile groupings). The percentile group \"1\" contains the aggregated field
value that occurs in approximately one percent of the values that match the query. The
percentile group \"5\" contains the aggregated field value that occurs in approximately
five percent of the values that match the query, and so on. The result is an approximation,
the more values that match the query, the more accurate the percentile values. Requires
permission to access the GetPercentiles action.
# Arguments
- `query_string`: The search query string.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"aggregationField"`: The field to aggregate.
- `"indexName"`: The name of the index to search.
- `"percents"`: The percentile groups returned.
- `"queryVersion"`: The query version.
"""
function get_percentiles(queryString; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/indices/percentiles",
Dict{String,Any}("queryString" => queryString);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_percentiles(
queryString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/indices/percentiles",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("queryString" => queryString), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy(policy_name)
get_policy(policy_name, params::Dict{String,<:Any})
Gets information about the specified policy with the policy document of the default
version. Requires permission to access the GetPolicy action.
# Arguments
- `policy_name`: The name of the policy.
"""
function get_policy(policyName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/policies/$(policyName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_policy(
policyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/policies/$(policyName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy_version(policy_name, policy_version_id)
get_policy_version(policy_name, policy_version_id, params::Dict{String,<:Any})
Gets information about the specified policy version. Requires permission to access the
GetPolicyVersion action.
# Arguments
- `policy_name`: The name of the policy.
- `policy_version_id`: The policy version ID.
"""
function get_policy_version(
policyName, policyVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/policies/$(policyName)/version/$(policyVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_policy_version(
policyName,
policyVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/policies/$(policyName)/version/$(policyVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_registration_code()
get_registration_code(params::Dict{String,<:Any})
Gets a registration code used to register a CA certificate with IoT. IoT will create a
registration code as part of this API call if the registration code doesn't exist or has
been deleted. If you already have a registration code, this API call will return the same
registration code. Requires permission to access the GetRegistrationCode action.
"""
function get_registration_code(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/registrationcode"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_registration_code(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/registrationcode",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_statistics(query_string)
get_statistics(query_string, params::Dict{String,<:Any})
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard
deviation for the specified aggregated field. If the aggregation field is of type String,
only the count statistic is returned. Requires permission to access the GetStatistics
action.
# Arguments
- `query_string`: The query used to search. You can specify \"*\" for the query string to
get the count of all indexed things in your Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"aggregationField"`: The aggregation field name.
- `"indexName"`: The name of the index to search. The default value is AWS_Things.
- `"queryVersion"`: The version of the query used to search.
"""
function get_statistics(queryString; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/indices/statistics",
Dict{String,Any}("queryString" => queryString);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_statistics(
queryString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/indices/statistics",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("queryString" => queryString), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_topic_rule(rule_name)
get_topic_rule(rule_name, params::Dict{String,<:Any})
Gets information about the rule. Requires permission to access the GetTopicRule action.
# Arguments
- `rule_name`: The name of the rule.
"""
function get_topic_rule(ruleName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/rules/$(ruleName)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_topic_rule(
ruleName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/rules/$(ruleName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_topic_rule_destination(arn)
get_topic_rule_destination(arn, params::Dict{String,<:Any})
Gets information about a topic rule destination. Requires permission to access the
GetTopicRuleDestination action.
# Arguments
- `arn`: The ARN of the topic rule destination.
"""
function get_topic_rule_destination(arn; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/destinations/$(arn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_topic_rule_destination(
arn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/destinations/$(arn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_v2_logging_options()
get_v2_logging_options(params::Dict{String,<:Any})
Gets the fine grained logging options. Requires permission to access the
GetV2LoggingOptions action.
"""
function get_v2_logging_options(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/v2LoggingOptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_v2_logging_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/v2LoggingOptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_active_violations()
list_active_violations(params::Dict{String,<:Any})
Lists the active violations for a given Device Defender security profile. Requires
permission to access the ListActiveViolations action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"behaviorCriteriaType"`: The criteria for a behavior.
- `"listSuppressedAlerts"`: A list of all suppressed alerts.
- `"maxResults"`: The maximum number of results to return at one time.
- `"nextToken"`: The token for the next set of results.
- `"securityProfileName"`: The name of the Device Defender security profile for which
violations are listed.
- `"thingName"`: The name of the thing whose active violations are listed.
- `"verificationState"`: The verification state of the violation (detect alarm).
"""
function list_active_violations(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/active-violations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_active_violations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/active-violations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_attached_policies(target)
list_attached_policies(target, params::Dict{String,<:Any})
Lists the policies attached to the specified thing group. Requires permission to access the
ListAttachedPolicies action.
# Arguments
- `target`: The group or principal for which the policies will be listed. Valid principals
are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
(arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"marker"`: The token to retrieve the next set of results.
- `"pageSize"`: The maximum number of results to be returned per request.
- `"recursive"`: When true, recursively list attached policies.
"""
function list_attached_policies(target; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/attached-policies/$(target)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_attached_policies(
target, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/attached-policies/$(target)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_audit_findings()
list_audit_findings(params::Dict{String,<:Any})
Lists the findings (results) of a Device Defender audit or of the audits performed during a
specified time period. (Findings are retained for 90 days.) Requires permission to access
the ListAuditFindings action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"checkName"`: A filter to limit results to the findings for the specified audit check.
- `"endTime"`: A filter to limit results to those found before the specified time. You must
specify either the startTime and endTime or the taskId, but not both.
- `"listSuppressedFindings"`: Boolean flag indicating whether only the suppressed findings
or the unsuppressed findings should be listed. If this parameter isn't provided, the
response will list both suppressed and unsuppressed findings.
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
- `"nextToken"`: The token for the next set of results.
- `"resourceIdentifier"`: Information identifying the noncompliant resource.
- `"startTime"`: A filter to limit results to those found after the specified time. You
must specify either the startTime and endTime or the taskId, but not both.
- `"taskId"`: A filter to limit results to the audit with the specified ID. You must
specify either the taskId or the startTime and endTime, but not both.
"""
function list_audit_findings(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST", "/audit/findings"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_audit_findings(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/audit/findings",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_audit_mitigation_actions_executions(finding_id, task_id)
list_audit_mitigation_actions_executions(finding_id, task_id, params::Dict{String,<:Any})
Gets the status of audit mitigation action tasks that were executed. Requires permission to
access the ListAuditMitigationActionsExecutions action.
# Arguments
- `finding_id`: Specify this filter to limit results to those that were applied to a
specific audit finding.
- `task_id`: Specify this filter to limit results to actions for a specific audit
mitigation actions task.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"actionStatus"`: Specify this filter to limit results to those with a specific status.
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
- `"nextToken"`: The token for the next set of results.
"""
function list_audit_mitigation_actions_executions(
findingId, taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/mitigationactions/executions",
Dict{String,Any}("findingId" => findingId, "taskId" => taskId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_audit_mitigation_actions_executions(
findingId,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/audit/mitigationactions/executions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("findingId" => findingId, "taskId" => taskId),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_audit_mitigation_actions_tasks(end_time, start_time)
list_audit_mitigation_actions_tasks(end_time, start_time, params::Dict{String,<:Any})
Gets a list of audit mitigation action tasks that match the specified filters. Requires
permission to access the ListAuditMitigationActionsTasks action.
# Arguments
- `end_time`: Specify this filter to limit results to tasks that were completed or canceled
on or before a specific date and time.
- `start_time`: Specify this filter to limit results to tasks that began on or after a
specific date and time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"auditTaskId"`: Specify this filter to limit results to tasks that were applied to
results for a specific audit.
- `"findingId"`: Specify this filter to limit results to tasks that were applied to a
specific audit finding.
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
- `"nextToken"`: The token for the next set of results.
- `"taskStatus"`: Specify this filter to limit results to tasks that are in a specific
state.
"""
function list_audit_mitigation_actions_tasks(
endTime, startTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/mitigationactions/tasks",
Dict{String,Any}("endTime" => endTime, "startTime" => startTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_audit_mitigation_actions_tasks(
endTime,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/audit/mitigationactions/tasks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("endTime" => endTime, "startTime" => startTime),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_audit_suppressions()
list_audit_suppressions(params::Dict{String,<:Any})
Lists your Device Defender audit listings. Requires permission to access the
ListAuditSuppressions action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ascendingOrder"`: Determines whether suppressions are listed in ascending order by
expiration date or not. If parameter isn't provided, ascendingOrder=true.
- `"checkName"`:
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
- `"nextToken"`: The token for the next set of results.
- `"resourceIdentifier"`:
"""
function list_audit_suppressions(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/audit/suppressions/list";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_audit_suppressions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/audit/suppressions/list",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_audit_tasks(end_time, start_time)
list_audit_tasks(end_time, start_time, params::Dict{String,<:Any})
Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
# Arguments
- `end_time`: The end of the time period.
- `start_time`: The beginning of the time period. Audit information is retained for a
limited time (90 days). Requesting a start time prior to what is retained results in an
\"InvalidRequestException\".
# 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 token for the next set of results.
- `"taskStatus"`: A filter to limit the output to audits with the specified completion
status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".
- `"taskType"`: A filter to limit the output to the specified type of audit: can be one of
\"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".
"""
function list_audit_tasks(
endTime, startTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/tasks",
Dict{String,Any}("endTime" => endTime, "startTime" => startTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_audit_tasks(
endTime,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/audit/tasks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("endTime" => endTime, "startTime" => startTime),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_authorizers()
list_authorizers(params::Dict{String,<:Any})
Lists the authorizers registered in your account. Requires permission to access the
ListAuthorizers action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Return the list of authorizers in ascending alphabetical order.
- `"marker"`: A marker used to get the next set of results.
- `"pageSize"`: The maximum number of results to return at one time.
- `"status"`: The status of the list authorizers request.
"""
function list_authorizers(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/authorizers/"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_authorizers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/authorizers/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_billing_groups()
list_billing_groups(params::Dict{String,<:Any})
Lists the billing groups you have created. Requires permission to access the
ListBillingGroups 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 per request.
- `"namePrefixFilter"`: Limit the results to billing groups whose names have the given
prefix.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_billing_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/billing-groups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_billing_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/billing-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_cacertificates()
list_cacertificates(params::Dict{String,<:Any})
Lists the CA certificates registered for your Amazon Web Services account. The results are
paginated with a default page size of 25. You can use the returned marker to retrieve
additional results. Requires permission to access the ListCACertificates action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Determines the order of the results.
- `"marker"`: The marker for the next set of results.
- `"pageSize"`: The result page size.
- `"templateName"`: The name of the provisioning template.
"""
function list_cacertificates(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/cacertificates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_cacertificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/cacertificates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_certificate_providers()
list_certificate_providers(params::Dict{String,<:Any})
Lists all your certificate providers in your Amazon Web Services account. Requires
permission to access the ListCertificateProviders action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Returns the list of certificate providers in ascending alphabetical
order.
- `"nextToken"`: The token for the next set of results, or null if there are no more
results.
"""
function list_certificate_providers(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/certificate-providers/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_certificate_providers(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/certificate-providers/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_certificates()
list_certificates(params::Dict{String,<:Any})
Lists the certificates registered in your Amazon Web Services account. The results are
paginated with a default page size of 25. You can use the returned marker to retrieve
additional results. Requires permission to access the ListCertificates action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Specifies the order for results. If True, the results are returned
in ascending order, based on the creation date.
- `"marker"`: The marker for the next set of results.
- `"pageSize"`: The result page size.
"""
function list_certificates(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/certificates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/certificates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_certificates_by_ca(ca_certificate_id)
list_certificates_by_ca(ca_certificate_id, params::Dict{String,<:Any})
List the device certificates signed by the specified CA certificate. Requires permission to
access the ListCertificatesByCA action.
# Arguments
- `ca_certificate_id`: The ID of the CA certificate. This operation will list all
registered device certificate that were signed by this CA certificate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Specifies the order for results. If True, the results are returned
in ascending order, based on the creation date.
- `"marker"`: The marker for the next set of results.
- `"pageSize"`: The result page size.
"""
function list_certificates_by_ca(
caCertificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/certificates-by-ca/$(caCertificateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_certificates_by_ca(
caCertificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/certificates-by-ca/$(caCertificateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_custom_metrics()
list_custom_metrics(params::Dict{String,<:Any})
Lists your Device Defender detect custom metrics. Requires permission to access the
ListCustomMetrics 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 one time. The default is 25.
- `"nextToken"`: The token for the next set of results.
"""
function list_custom_metrics(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/custom-metrics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_custom_metrics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/custom-metrics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_detect_mitigation_actions_executions()
list_detect_mitigation_actions_executions(params::Dict{String,<:Any})
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endTime"`: The end of the time period for which ML Detect mitigation actions
executions are returned.
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
- `"nextToken"`: The token for the next set of results.
- `"startTime"`: A filter to limit results to those found after the specified time. You
must specify either the startTime and endTime or the taskId, but not both.
- `"taskId"`: The unique identifier of the task.
- `"thingName"`: The name of the thing whose mitigation actions are listed.
- `"violationId"`: The unique identifier of the violation.
"""
function list_detect_mitigation_actions_executions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/detect/mitigationactions/executions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_detect_mitigation_actions_executions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/detect/mitigationactions/executions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_detect_mitigation_actions_tasks(end_time, start_time)
list_detect_mitigation_actions_tasks(end_time, start_time, params::Dict{String,<:Any})
List of Device Defender ML Detect mitigation actions tasks. Requires permission to access
the ListDetectMitigationActionsTasks action.
# Arguments
- `end_time`: The end of the time period for which ML Detect mitigation actions tasks are
returned.
- `start_time`: A filter to limit results to those found after the specified time. You
must specify either the startTime and endTime or the taskId, but not both.
# 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 token for the next set of results.
"""
function list_detect_mitigation_actions_tasks(
endTime, startTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/detect/mitigationactions/tasks",
Dict{String,Any}("endTime" => endTime, "startTime" => startTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_detect_mitigation_actions_tasks(
endTime,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/detect/mitigationactions/tasks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("endTime" => endTime, "startTime" => startTime),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_dimensions()
list_dimensions(params::Dict{String,<:Any})
List the set of dimensions that are defined for your Amazon Web Services accounts. Requires
permission to access the ListDimensions action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to retrieve at one time.
- `"nextToken"`: The token for the next set of results.
"""
function list_dimensions(; aws_config::AbstractAWSConfig=global_aws_config())
return iot("GET", "/dimensions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_dimensions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET", "/dimensions", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_domain_configurations()
list_domain_configurations(params::Dict{String,<:Any})
Gets a list of domain configurations for the user. This list is sorted alphabetically by
domain configuration name. Requires permission to access the ListDomainConfigurations
action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"marker"`: The marker for the next set of results.
- `"pageSize"`: The result page size.
- `"serviceType"`: The type of service delivered by the endpoint.
"""
function list_domain_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/domainConfigurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_domain_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/domainConfigurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fleet_metrics()
list_fleet_metrics(params::Dict{String,<:Any})
Lists all your fleet metrics. Requires permission to access the ListFleetMetrics 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 in this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_fleet_metrics(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/fleet-metrics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_fleet_metrics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/fleet-metrics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_indices()
list_indices(params::Dict{String,<:Any})
Lists the search indices. Requires permission to access the ListIndices 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 one time.
- `"nextToken"`: The token used to get the next set of results, or null if there are no
additional results.
"""
function list_indices(; aws_config::AbstractAWSConfig=global_aws_config())
return iot("GET", "/indices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_indices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET", "/indices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_job_executions_for_job(job_id)
list_job_executions_for_job(job_id, params::Dict{String,<:Any})
Lists the job executions for a job. Requires permission to access the
ListJobExecutionsForJob action.
# Arguments
- `job_id`: The unique identifier you assigned to this job when it was created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per request.
- `"nextToken"`: The token to retrieve the next set of results.
- `"status"`: The status of the job.
"""
function list_job_executions_for_job(
jobId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/jobs/$(jobId)/things";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_job_executions_for_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/jobs/$(jobId)/things",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_job_executions_for_thing(thing_name)
list_job_executions_for_thing(thing_name, params::Dict{String,<:Any})
Lists the job executions for the specified thing. Requires permission to access the
ListJobExecutionsForThing action.
# Arguments
- `thing_name`: The thing name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"jobId"`: The unique identifier you assigned to this job when it was created.
- `"maxResults"`: The maximum number of results to be returned per request.
- `"namespaceId"`: The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs
notifications to MQTT topics that contain the value in the following format.
aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature
is only supported by IoT Greengrass at this time. For more information, see Setting up IoT
Greengrass core devices.
- `"nextToken"`: The token to retrieve the next set of results.
- `"status"`: An optional filter that lets you search for jobs that have the specified
status.
"""
function list_job_executions_for_thing(
thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/things/$(thingName)/jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_job_executions_for_thing(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/things/$(thingName)/jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_job_templates()
list_job_templates(params::Dict{String,<:Any})
Returns a list of job templates. Requires permission to access the ListJobTemplates 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 in the list.
- `"nextToken"`: The token to use to return the next set of results in the list.
"""
function list_job_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/job-templates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_job_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/job-templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_jobs()
list_jobs(params::Dict{String,<:Any})
Lists jobs. Requires permission to access the ListJobs 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 per request.
- `"namespaceId"`: The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs
notifications to MQTT topics that contain the value in the following format.
aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature
is only supported by IoT Greengrass at this time. For more information, see Setting up IoT
Greengrass core devices.
- `"nextToken"`: The token to retrieve the next set of results.
- `"status"`: An optional filter that lets you search for jobs that have the specified
status.
- `"targetSelection"`: Specifies whether the job will continue to run (CONTINUOUS), or will
be complete after all those things specified as targets have completed the job (SNAPSHOT).
If continuous, the job may also be run on a thing when a change is detected in a target.
For example, a job will run on a thing when the thing is added to a target group, even
after the job was completed by all things originally in the group. We recommend that you
use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using
continuous jobs, devices that join the group receive the job execution even after the job
has been created.
- `"thingGroupId"`: A filter that limits the returned jobs to those for the specified group.
- `"thingGroupName"`: A filter that limits the returned jobs to those for the specified
group.
"""
function list_jobs(; aws_config::AbstractAWSConfig=global_aws_config())
return iot("GET", "/jobs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_jobs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET", "/jobs", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_managed_job_templates()
list_managed_job_templates(params::Dict{String,<:Any})
Returns a list of managed job templates.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: Maximum number of entries that can be returned.
- `"nextToken"`: The token to retrieve the next set of results.
- `"templateName"`: An optional parameter for template name. If specified, only the
versions of the managed job templates that have the specified template name will be
returned.
"""
function list_managed_job_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/managed-job-templates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_managed_job_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/managed-job-templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_metric_values(end_time, metric_name, start_time, thing_name)
list_metric_values(end_time, metric_name, start_time, thing_name, params::Dict{String,<:Any})
Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side
metric, or custom metric) by the given thing during the specified time period.
# Arguments
- `end_time`: The end of the time period for which metric values are returned.
- `metric_name`: The name of the security profile metric for which values are returned.
- `start_time`: The start of the time period for which metric values are returned.
- `thing_name`: The name of the thing for which security profile metric values are returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dimensionName"`: The dimension name.
- `"dimensionValueOperator"`: The dimension value operator.
- `"maxResults"`: The maximum number of results to return at one time.
- `"nextToken"`: The token for the next set of results.
"""
function list_metric_values(
endTime,
metricName,
startTime,
thingName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/metric-values",
Dict{String,Any}(
"endTime" => endTime,
"metricName" => metricName,
"startTime" => startTime,
"thingName" => thingName,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_metric_values(
endTime,
metricName,
startTime,
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/metric-values",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime,
"metricName" => metricName,
"startTime" => startTime,
"thingName" => thingName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_mitigation_actions()
list_mitigation_actions(params::Dict{String,<:Any})
Gets a list of all mitigation actions that match the specified filter criteria. Requires
permission to access the ListMitigationActions action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"actionType"`: Specify a value to limit the result to mitigation actions with a specific
action type.
- `"maxResults"`: The maximum number of results to return at one time. The default is 25.
- `"nextToken"`: The token for the next set of results.
"""
function list_mitigation_actions(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/mitigationactions/actions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_mitigation_actions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/mitigationactions/actions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_otaupdates()
list_otaupdates(params::Dict{String,<:Any})
Lists OTA updates. Requires permission to access the ListOTAUpdates 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 one time.
- `"nextToken"`: A token used to retrieve the next set of results.
- `"otaUpdateStatus"`: The OTA update job status.
"""
function list_otaupdates(; aws_config::AbstractAWSConfig=global_aws_config())
return iot("GET", "/otaUpdates"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_otaupdates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET", "/otaUpdates", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_outgoing_certificates()
list_outgoing_certificates(params::Dict{String,<:Any})
Lists certificates that are being transferred but not yet accepted. Requires permission to
access the ListOutgoingCertificates action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Specifies the order for results. If True, the results are returned
in ascending order, based on the creation date.
- `"marker"`: The marker for the next set of results.
- `"pageSize"`: The result page size.
"""
function list_outgoing_certificates(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/certificates-out-going";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_outgoing_certificates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/certificates-out-going",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_package_versions(package_name)
list_package_versions(package_name, params::Dict{String,<:Any})
Lists the software package versions associated to the account. Requires permission to
access the ListPackageVersions action.
# Arguments
- `package_name`: The name of the target software package.
# 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.
- `"nextToken"`: The token for the next set of results.
- `"status"`: The status of the package version. For more information, see Package version
lifecycle.
"""
function list_package_versions(
packageName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/packages/$(packageName)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_package_versions(
packageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/packages/$(packageName)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_packages()
list_packages(params::Dict{String,<:Any})
Lists the software packages associated to the account. Requires permission to access the
ListPackages action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results returned at one time.
- `"nextToken"`: The token for the next set of results.
"""
function list_packages(; aws_config::AbstractAWSConfig=global_aws_config())
return iot("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 iot(
"GET", "/packages", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_policies()
list_policies(params::Dict{String,<:Any})
Lists your policies. Requires permission to access the ListPolicies action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Specifies the order for results. If true, the results are returned
in ascending creation order.
- `"marker"`: The marker for the next set of results.
- `"pageSize"`: The result page size.
"""
function list_policies(; aws_config::AbstractAWSConfig=global_aws_config())
return iot("GET", "/policies"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_policies(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET", "/policies", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_policy_principals(x-amzn-iot-policy)
list_policy_principals(x-amzn-iot-policy, params::Dict{String,<:Any})
Lists the principals associated with the specified policy. Note: This action is deprecated
and works as expected for backward compatibility, but we won't add enhancements. Use
ListTargetsForPolicy instead. Requires permission to access the ListPolicyPrincipals action.
# Arguments
- `x-amzn-iot-policy`: The policy name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Specifies the order for results. If true, the results are returned
in ascending creation order.
- `"marker"`: The marker for the next set of results.
- `"pageSize"`: The result page size.
"""
function list_policy_principals(
x_amzn_iot_policy; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/policy-principals",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-iot-policy" => x_amzn_iot_policy)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_policy_principals(
x_amzn_iot_policy,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/policy-principals",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-iot-policy" => x_amzn_iot_policy)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_policy_versions(policy_name)
list_policy_versions(policy_name, params::Dict{String,<:Any})
Lists the versions of the specified policy and identifies the default version. Requires
permission to access the ListPolicyVersions action.
# Arguments
- `policy_name`: The policy name.
"""
function list_policy_versions(policyName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/policies/$(policyName)/version";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_policy_versions(
policyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/policies/$(policyName)/version",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_principal_policies(x-amzn-iot-principal)
list_principal_policies(x-amzn-iot-principal, params::Dict{String,<:Any})
Lists the policies attached to the specified principal. If you use an Cognito identity, the
ID must be in AmazonCognito Identity format. Note: This action is deprecated and works as
expected for backward compatibility, but we won't add enhancements. Use
ListAttachedPolicies instead. Requires permission to access the ListPrincipalPolicies
action.
# Arguments
- `x-amzn-iot-principal`: The principal. Valid principals are CertificateArn
(arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
(arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Specifies the order for results. If true, results are returned in
ascending creation order.
- `"marker"`: The marker for the next set of results.
- `"pageSize"`: The result page size.
"""
function list_principal_policies(
x_amzn_iot_principal; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/principal-policies",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-iot-principal" => x_amzn_iot_principal)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_principal_policies(
x_amzn_iot_principal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/principal-policies",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" =>
Dict{String,Any}("x-amzn-iot-principal" => x_amzn_iot_principal),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_principal_things(x-amzn-principal)
list_principal_things(x-amzn-principal, params::Dict{String,<:Any})
Lists the things associated with the specified principal. A principal can be X.509
certificates, IAM users, groups, and roles, Amazon Cognito identities or federated
identities. Requires permission to access the ListPrincipalThings action.
# Arguments
- `x-amzn-principal`: The principal.
# 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 this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_principal_things(
x_amzn_principal; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/principals/things",
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-principal" => x_amzn_principal)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_principal_things(
x_amzn_principal,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/principals/things",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"headers" => Dict{String,Any}("x-amzn-principal" => x_amzn_principal)
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_provisioning_template_versions(template_name)
list_provisioning_template_versions(template_name, params::Dict{String,<:Any})
A list of provisioning template versions. Requires permission to access the
ListProvisioningTemplateVersions action.
# Arguments
- `template_name`: The name of the provisioning template.
# 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.
- `"nextToken"`: A token to retrieve the next set of results.
"""
function list_provisioning_template_versions(
templateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/provisioning-templates/$(templateName)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_provisioning_template_versions(
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/provisioning-templates/$(templateName)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_provisioning_templates()
list_provisioning_templates(params::Dict{String,<:Any})
Lists the provisioning templates in your Amazon Web Services account. Requires permission
to access the ListProvisioningTemplates 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 one time.
- `"nextToken"`: A token to retrieve the next set of results.
"""
function list_provisioning_templates(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/provisioning-templates";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_provisioning_templates(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/provisioning-templates",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_related_resources_for_audit_finding(finding_id)
list_related_resources_for_audit_finding(finding_id, params::Dict{String,<:Any})
The related resources of an Audit finding. The following resources can be returned from
calling this API: DEVICE_CERTIFICATE CA_CERTIFICATE IOT_POLICY
COGNITO_IDENTITY_POOL CLIENT_ID ACCOUNT_SETTINGS ROLE_ALIAS IAM_ROLE
ISSUER_CERTIFICATE This API is similar to DescribeAuditFinding's RelatedResources but
provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding
for the intermediate CA revoked for active device certificates check, RelatedResources will
not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the
certificates.
# Arguments
- `finding_id`: The finding 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 at one time.
- `"nextToken"`: A token that can be used to retrieve the next set of results, or null if
there are no additional results.
"""
function list_related_resources_for_audit_finding(
findingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/relatedResources",
Dict{String,Any}("findingId" => findingId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_related_resources_for_audit_finding(
findingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/audit/relatedResources",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("findingId" => findingId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_role_aliases()
list_role_aliases(params::Dict{String,<:Any})
Lists the role aliases registered in your account. Requires permission to access the
ListRoleAliases action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Return the list of role aliases in ascending alphabetical order.
- `"marker"`: A marker used to get the next set of results.
- `"pageSize"`: The maximum number of results to return at one time.
"""
function list_role_aliases(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/role-aliases"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_role_aliases(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/role-aliases",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_scheduled_audits()
list_scheduled_audits(params::Dict{String,<:Any})
Lists all of your scheduled audits. Requires permission to access the ListScheduledAudits
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 one time. The default is 25.
- `"nextToken"`: The token for the next set of results.
"""
function list_scheduled_audits(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/audit/scheduledaudits";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_scheduled_audits(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/audit/scheduledaudits",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_security_profiles()
list_security_profiles(params::Dict{String,<:Any})
Lists the Device Defender security profiles you've created. You can filter security
profiles by dimension or custom metric. Requires permission to access the
ListSecurityProfiles action. dimensionName and metricName cannot be used in the same
request.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dimensionName"`: A filter to limit results to the security profiles that use the
defined dimension. Cannot be used with metricName
- `"maxResults"`: The maximum number of results to return at one time.
- `"metricName"`: The name of the custom metric. Cannot be used with dimensionName.
- `"nextToken"`: The token for the next set of results.
"""
function list_security_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/security-profiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_security_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/security-profiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_security_profiles_for_target(security_profile_target_arn)
list_security_profiles_for_target(security_profile_target_arn, params::Dict{String,<:Any})
Lists the Device Defender security profiles attached to a target (thing group). Requires
permission to access the ListSecurityProfilesForTarget action.
# Arguments
- `security_profile_target_arn`: The ARN of the target (thing group) whose attached
security profiles you want to get.
# 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.
- `"nextToken"`: The token for the next set of results.
- `"recursive"`: If true, return child groups too.
"""
function list_security_profiles_for_target(
securityProfileTargetArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/security-profiles-for-target",
Dict{String,Any}("securityProfileTargetArn" => securityProfileTargetArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_security_profiles_for_target(
securityProfileTargetArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/security-profiles-for-target",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("securityProfileTargetArn" => securityProfileTargetArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_streams()
list_streams(params::Dict{String,<:Any})
Lists all of the streams in your Amazon Web Services account. Requires permission to access
the ListStreams action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"isAscendingOrder"`: Set to true to return the list of streams in ascending order.
- `"maxResults"`: The maximum number of results to return at a time.
- `"nextToken"`: A token used to get the next set of results.
"""
function list_streams(; aws_config::AbstractAWSConfig=global_aws_config())
return iot("GET", "/streams"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_streams(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET", "/streams", 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. Requires permission to access
the ListTagsForResource action.
# Arguments
- `resource_arn`: The ARN of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"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 iot(
"GET",
"/tags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_targets_for_policy(policy_name)
list_targets_for_policy(policy_name, params::Dict{String,<:Any})
List targets for the specified policy. Requires permission to access the
ListTargetsForPolicy action.
# Arguments
- `policy_name`: The policy name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"marker"`: A marker used to get the next set of results.
- `"pageSize"`: The maximum number of results to return at one time.
"""
function list_targets_for_policy(
policyName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/policy-targets/$(policyName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_targets_for_policy(
policyName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/policy-targets/$(policyName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_targets_for_security_profile(security_profile_name)
list_targets_for_security_profile(security_profile_name, params::Dict{String,<:Any})
Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
# Arguments
- `security_profile_name`: The security profile.
# 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.
- `"nextToken"`: The token for the next set of results.
"""
function list_targets_for_security_profile(
securityProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/security-profiles/$(securityProfileName)/targets";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_targets_for_security_profile(
securityProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/security-profiles/$(securityProfileName)/targets",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_thing_groups()
list_thing_groups(params::Dict{String,<:Any})
List the thing groups in your account. Requires permission to access the ListThingGroups
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 one time.
- `"namePrefixFilter"`: A filter that limits the results to those with the specified name
prefix.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"parentGroup"`: A filter that limits the results to those with the specified parent
group.
- `"recursive"`: If true, return child groups as well.
"""
function list_thing_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/thing-groups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_thing_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/thing-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_thing_groups_for_thing(thing_name)
list_thing_groups_for_thing(thing_name, params::Dict{String,<:Any})
List the thing groups to which the specified thing belongs. Requires permission to access
the ListThingGroupsForThing action.
# Arguments
- `thing_name`: The thing name.
# 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.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_thing_groups_for_thing(
thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/things/$(thingName)/thing-groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_thing_groups_for_thing(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/things/$(thingName)/thing-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_thing_principals(thing_name)
list_thing_principals(thing_name, params::Dict{String,<:Any})
Lists the principals associated with the specified thing. A principal can be X.509
certificates, IAM users, groups, and roles, Amazon Cognito identities or federated
identities. Requires permission to access the ListThingPrincipals action.
# Arguments
- `thing_name`: The name of the thing.
# 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 this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_thing_principals(thingName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/things/$(thingName)/principals";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_thing_principals(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/things/$(thingName)/principals",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_thing_registration_task_reports(report_type, task_id)
list_thing_registration_task_reports(report_type, task_id, params::Dict{String,<:Any})
Information about the thing registration tasks.
# Arguments
- `report_type`: The type of task report.
- `task_id`: The id of the task.
# 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 request.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_thing_registration_task_reports(
reportType, taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/thing-registration-tasks/$(taskId)/reports",
Dict{String,Any}("reportType" => reportType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_thing_registration_task_reports(
reportType,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/thing-registration-tasks/$(taskId)/reports",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("reportType" => reportType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_thing_registration_tasks()
list_thing_registration_tasks(params::Dict{String,<:Any})
List bulk thing provisioning tasks. Requires permission to access the
ListThingRegistrationTasks 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 one time.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"status"`: The status of the bulk thing provisioning task.
"""
function list_thing_registration_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET",
"/thing-registration-tasks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_thing_registration_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/thing-registration-tasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_thing_types()
list_thing_types(params::Dict{String,<:Any})
Lists the existing thing types. Requires permission to access the ListThingTypes 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 in this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"thingTypeName"`: The name of the thing type.
"""
function list_thing_types(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/thing-types"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_thing_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/thing-types",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_things()
list_things(params::Dict{String,<:Any})
Lists your things. Use the attributeName and attributeValue parameters to filter your
things. For example, calling ListThings with attributeName=Color and attributeValue=Red
retrieves all things in the registry that contain an attribute Color with the value Red.
For more information, see List Things from the Amazon Web Services IoT Core Developer
Guide. Requires permission to access the ListThings action. You will not be charged for
calling this API if an Access denied error is returned. You will also not be charged if no
attributes or pagination token was provided in request and no pagination token and no
results were returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributeName"`: The attribute name used to search for things.
- `"attributeValue"`: The attribute value used to search for things.
- `"maxResults"`: The maximum number of results to return in this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"thingTypeName"`: The name of the thing type used to search for things.
- `"usePrefixAttributeValue"`: When true, the action returns the thing resources with
attribute values that start with the attributeValue provided. When false, or not present,
the action returns only the thing resources with attribute values that match the entire
attributeValue provided.
"""
function list_things(; aws_config::AbstractAWSConfig=global_aws_config())
return iot("GET", "/things"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_things(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET", "/things", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_things_in_billing_group(billing_group_name)
list_things_in_billing_group(billing_group_name, params::Dict{String,<:Any})
Lists the things you have added to the given billing group. Requires permission to access
the ListThingsInBillingGroup action.
# Arguments
- `billing_group_name`: The name of the billing 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 per request.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_things_in_billing_group(
billingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/billing-groups/$(billingGroupName)/things";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_things_in_billing_group(
billingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/billing-groups/$(billingGroupName)/things",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_things_in_thing_group(thing_group_name)
list_things_in_thing_group(thing_group_name, params::Dict{String,<:Any})
Lists the things in the specified group. Requires permission to access the
ListThingsInThingGroup action.
# Arguments
- `thing_group_name`: The thing group name.
# 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.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"recursive"`: When true, list things in this thing group and in all child groups as well.
"""
function list_things_in_thing_group(
thingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/thing-groups/$(thingGroupName)/things";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_things_in_thing_group(
thingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/thing-groups/$(thingGroupName)/things",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_topic_rule_destinations()
list_topic_rule_destinations(params::Dict{String,<:Any})
Lists all the topic rule destinations in your Amazon Web Services account. Requires
permission to access the ListTopicRuleDestinations 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 one time.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_topic_rule_destinations(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/destinations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_topic_rule_destinations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/destinations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_topic_rules()
list_topic_rules(params::Dict{String,<:Any})
Lists the rules for the specific topic. Requires permission to access the ListTopicRules
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.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"ruleDisabled"`: Specifies whether the rule is disabled.
- `"topic"`: The topic.
"""
function list_topic_rules(; aws_config::AbstractAWSConfig=global_aws_config())
return iot("GET", "/rules"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET)
end
function list_topic_rules(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET", "/rules", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_v2_logging_levels()
list_v2_logging_levels(params::Dict{String,<:Any})
Lists logging levels. Requires permission to access the ListV2LoggingLevels 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 one time.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"targetType"`: The type of resource for which you are configuring logging. Must be
THING_Group.
"""
function list_v2_logging_levels(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"GET", "/v2LoggingLevel"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_v2_logging_levels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/v2LoggingLevel",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_violation_events(end_time, start_time)
list_violation_events(end_time, start_time, params::Dict{String,<:Any})
Lists the Device Defender security profile violations discovered during the given time
period. You can use filters to limit the results to those alerts issued for a particular
security profile, behavior, or thing (device). Requires permission to access the
ListViolationEvents action.
# Arguments
- `end_time`: The end time for the alerts to be listed.
- `start_time`: The start time for the alerts to be listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"behaviorCriteriaType"`: The criteria for a behavior.
- `"listSuppressedAlerts"`: A list of all suppressed alerts.
- `"maxResults"`: The maximum number of results to return at one time.
- `"nextToken"`: The token for the next set of results.
- `"securityProfileName"`: A filter to limit results to those alerts generated by the
specified security profile.
- `"thingName"`: A filter to limit results to those alerts caused by the specified thing.
- `"verificationState"`: The verification state of the violation (detect alarm).
"""
function list_violation_events(
endTime, startTime; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"GET",
"/violation-events",
Dict{String,Any}("endTime" => endTime, "startTime" => startTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_violation_events(
endTime,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"GET",
"/violation-events",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("endTime" => endTime, "startTime" => startTime),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_verification_state_on_violation(verification_state, violation_id)
put_verification_state_on_violation(verification_state, violation_id, params::Dict{String,<:Any})
Set a verification state and provide a description of that verification state on a
violation (detect alarm).
# Arguments
- `verification_state`: The verification state of the violation.
- `violation_id`: The violation ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"verificationStateDescription"`: The description of the verification state of the
violation (detect alarm).
"""
function put_verification_state_on_violation(
verificationState, violationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/violations/verification-state/$(violationId)",
Dict{String,Any}("verificationState" => verificationState);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_verification_state_on_violation(
verificationState,
violationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/violations/verification-state/$(violationId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("verificationState" => verificationState), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_cacertificate(ca_certificate)
register_cacertificate(ca_certificate, params::Dict{String,<:Any})
Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the
number of CA certificates you can register in your Amazon Web Services account. You can
register up to 10 CA certificates with the same CA subject field per Amazon Web Services
account. Requires permission to access the RegisterCACertificate action.
# Arguments
- `ca_certificate`: The CA certificate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"allowAutoRegistration"`: Allows this CA certificate to be used for auto registration of
device certificates.
- `"certificateMode"`: Describes the certificate mode in which the Certificate Authority
(CA) will be registered. If the verificationCertificate field is not provided, set
certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set
certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to
DEFAULT. All the device certificates that are registered using this CA will be registered
in the same certificate mode as the CA. For more information about certificate mode for
device certificates, see certificate mode.
- `"registrationConfig"`: Information about the registration configuration.
- `"setAsActive"`: A boolean value that specifies if the CA certificate is set to active.
Valid values: ACTIVE | INACTIVE
- `"tags"`: Metadata which can be used to manage the CA certificate. For URI Request
parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter
use format: &&tags \"key1=value1&key2=value2...\" For the cli-input-json file
use format: \"tags\": \"key1=value1&key2=value2...\"
- `"verificationCertificate"`: The private key verification certificate. If certificateMode
is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT
or not provided, the verificationCertificate field must not be empty.
"""
function register_cacertificate(
caCertificate; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/cacertificate",
Dict{String,Any}("caCertificate" => caCertificate);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_cacertificate(
caCertificate,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/cacertificate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("caCertificate" => caCertificate), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_certificate(certificate_pem)
register_certificate(certificate_pem, params::Dict{String,<:Any})
Registers a device certificate with IoT in the same certificate mode as the signing CA. If
you have more than one CA certificate that has the same subject field, you must specify the
CA certificate that was used to sign the device certificate being registered. Requires
permission to access the RegisterCertificate action.
# Arguments
- `certificate_pem`: The certificate data, in PEM format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"caCertificatePem"`: The CA certificate used to sign the device certificate being
registered.
- `"setAsActive"`: A boolean value that specifies if the certificate is set to active.
Valid values: ACTIVE | INACTIVE
- `"status"`: The status of the register certificate request. Valid values that you can use
include ACTIVE, INACTIVE, and REVOKED.
"""
function register_certificate(
certificatePem; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/certificate/register",
Dict{String,Any}("certificatePem" => certificatePem);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_certificate(
certificatePem,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/certificate/register",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("certificatePem" => certificatePem), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_certificate_without_ca(certificate_pem)
register_certificate_without_ca(certificate_pem, params::Dict{String,<:Any})
Register a certificate that does not have a certificate authority (CA). For supported
certificates, consult Certificate signing algorithms supported by IoT.
# Arguments
- `certificate_pem`: The certificate data, in PEM format.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"status"`: The status of the register certificate request.
"""
function register_certificate_without_ca(
certificatePem; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/certificate/register-no-ca",
Dict{String,Any}("certificatePem" => certificatePem);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_certificate_without_ca(
certificatePem,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/certificate/register-no-ca",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("certificatePem" => certificatePem), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_thing(template_body)
register_thing(template_body, params::Dict{String,<:Any})
Provisions a thing in the device registry. RegisterThing calls other IoT control plane
APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle
errors. Please contact Amazon Web Services Customer Support to raise your throttling limits
if necessary. Requires permission to access the RegisterThing action.
# Arguments
- `template_body`: The provisioning template. See Provisioning Devices That Have Device
Certificates for more information.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"parameters"`: The parameters for provisioning a thing. See Provisioning Templates for
more information.
"""
function register_thing(templateBody; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/things",
Dict{String,Any}("templateBody" => templateBody);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_thing(
templateBody,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/things",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("templateBody" => templateBody), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_certificate_transfer(certificate_id)
reject_certificate_transfer(certificate_id, params::Dict{String,<:Any})
Rejects a pending certificate transfer. After IoT rejects a certificate transfer, the
certificate status changes from PENDING_TRANSFER to INACTIVE. To check for pending
certificate transfers, call ListCertificates to enumerate your certificates. This operation
can only be called by the transfer destination. After it is called, the certificate will be
returned to the source's account in the INACTIVE state. Requires permission to access the
RejectCertificateTransfer action.
# Arguments
- `certificate_id`: The ID of the certificate. (The last part of the certificate ARN
contains the certificate ID.)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"rejectReason"`: The reason the certificate transfer was rejected.
"""
function reject_certificate_transfer(
certificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/reject-certificate-transfer/$(certificateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reject_certificate_transfer(
certificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/reject-certificate-transfer/$(certificateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_thing_from_billing_group()
remove_thing_from_billing_group(params::Dict{String,<:Any})
Removes the given thing from the billing group. Requires permission to access the
RemoveThingFromBillingGroup action. This call is asynchronous. It might take several
seconds for the detachment to propagate.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"billingGroupArn"`: The ARN of the billing group.
- `"billingGroupName"`: The name of the billing group.
- `"thingArn"`: The ARN of the thing to be removed from the billing group.
- `"thingName"`: The name of the thing to be removed from the billing group.
"""
function remove_thing_from_billing_group(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/billing-groups/removeThingFromBillingGroup";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_thing_from_billing_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/billing-groups/removeThingFromBillingGroup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_thing_from_thing_group()
remove_thing_from_thing_group(params::Dict{String,<:Any})
Remove the specified thing from the specified group. You must specify either a
thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a
thingName to identify the thing to remove from the thing group. Requires permission to
access the RemoveThingFromThingGroup action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"thingArn"`: The ARN of the thing to remove from the group.
- `"thingGroupArn"`: The group ARN.
- `"thingGroupName"`: The group name.
- `"thingName"`: The name of the thing to remove from the group.
"""
function remove_thing_from_thing_group(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PUT",
"/thing-groups/removeThingFromThingGroup";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_thing_from_thing_group(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/thing-groups/removeThingFromThingGroup",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
replace_topic_rule(rule_name, topic_rule_payload)
replace_topic_rule(rule_name, topic_rule_payload, params::Dict{String,<:Any})
Replaces the rule. You must specify all parameters for the new rule. Creating rules is an
administrator-level action. Any user who has permission to create rules will be able to
access data processed by the rule. Requires permission to access the ReplaceTopicRule
action.
# Arguments
- `rule_name`: The name of the rule.
- `topic_rule_payload`: The rule payload.
"""
function replace_topic_rule(
ruleName, topicRulePayload; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/rules/$(ruleName)",
Dict{String,Any}("topicRulePayload" => topicRulePayload);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function replace_topic_rule(
ruleName,
topicRulePayload,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/rules/$(ruleName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("topicRulePayload" => topicRulePayload), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
search_index(query_string)
search_index(query_string, params::Dict{String,<:Any})
The query search index. Requires permission to access the SearchIndex action.
# Arguments
- `query_string`: The search query string. For more information about the search query
syntax, see Query syntax.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"indexName"`: The search index name.
- `"maxResults"`: The maximum number of results to return per page at one time. This
maximum number cannot exceed 100. The response might contain fewer results but will never
contain more. You can use nextToken to retrieve the next set of results until nextToken
returns NULL.
- `"nextToken"`: The token used to get the next set of results, or null if there are no
additional results.
- `"queryVersion"`: The query version.
"""
function search_index(queryString; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/indices/search",
Dict{String,Any}("queryString" => queryString);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function search_index(
queryString,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/indices/search",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("queryString" => queryString), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_default_authorizer(authorizer_name)
set_default_authorizer(authorizer_name, params::Dict{String,<:Any})
Sets the default authorizer. This will be used if a websocket connection is made without
specifying an authorizer. Requires permission to access the SetDefaultAuthorizer action.
# Arguments
- `authorizer_name`: The authorizer name.
"""
function set_default_authorizer(
authorizerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/default-authorizer",
Dict{String,Any}("authorizerName" => authorizerName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_default_authorizer(
authorizerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/default-authorizer",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("authorizerName" => authorizerName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_default_policy_version(policy_name, policy_version_id)
set_default_policy_version(policy_name, policy_version_id, params::Dict{String,<:Any})
Sets the specified version of the specified policy as the policy's default (operative)
version. This action affects all certificates to which the policy is attached. To list the
principals the policy is attached to, use the ListPrincipalPolicies action. Requires
permission to access the SetDefaultPolicyVersion action.
# Arguments
- `policy_name`: The policy name.
- `policy_version_id`: The policy version ID.
"""
function set_default_policy_version(
policyName, policyVersionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/policies/$(policyName)/version/$(policyVersionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_default_policy_version(
policyName,
policyVersionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/policies/$(policyName)/version/$(policyVersionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_logging_options(logging_options_payload)
set_logging_options(logging_options_payload, params::Dict{String,<:Any})
Sets the logging options. NOTE: use of this command is not recommended. Use
SetV2LoggingOptions instead. Requires permission to access the SetLoggingOptions action.
# Arguments
- `logging_options_payload`: The logging options payload.
"""
function set_logging_options(
loggingOptionsPayload; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/loggingOptions",
Dict{String,Any}("loggingOptionsPayload" => loggingOptionsPayload);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_logging_options(
loggingOptionsPayload,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/loggingOptions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("loggingOptionsPayload" => loggingOptionsPayload),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_v2_logging_level(log_level, log_target)
set_v2_logging_level(log_level, log_target, params::Dict{String,<:Any})
Sets the logging level. Requires permission to access the SetV2LoggingLevel action.
# Arguments
- `log_level`: The log level.
- `log_target`: The log target.
"""
function set_v2_logging_level(
logLevel, logTarget; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/v2LoggingLevel",
Dict{String,Any}("logLevel" => logLevel, "logTarget" => logTarget);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function set_v2_logging_level(
logLevel,
logTarget,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/v2LoggingLevel",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("logLevel" => logLevel, "logTarget" => logTarget),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
set_v2_logging_options()
set_v2_logging_options(params::Dict{String,<:Any})
Sets the logging options for the V2 logging service. Requires permission to access the
SetV2LoggingOptions action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"defaultLogLevel"`: The default logging level.
- `"disableAllLogs"`: If true all logs are disabled. The default is false.
- `"roleArn"`: The ARN of the role that allows IoT to write to Cloudwatch logs.
"""
function set_v2_logging_options(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST", "/v2LoggingOptions"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function set_v2_logging_options(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/v2LoggingOptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_audit_mitigation_actions_task(audit_check_to_actions_mapping, client_request_token, target, task_id)
start_audit_mitigation_actions_task(audit_check_to_actions_mapping, client_request_token, target, task_id, params::Dict{String,<:Any})
Starts a task that applies a set of mitigation actions to the specified target. Requires
permission to access the StartAuditMitigationActionsTask action.
# Arguments
- `audit_check_to_actions_mapping`: For an audit check, specifies which mitigation actions
to apply. Those actions must be defined in your Amazon Web Services accounts.
- `client_request_token`: Each audit mitigation task must have a unique client request
token. If you try to start a new task with the same token as a task that already exists, an
exception occurs. If you omit this value, a unique client request token is generated
automatically.
- `target`: Specifies the audit findings to which the mitigation actions are applied. You
can apply them to a type of audit check, to all findings from an audit, or to a specific
set of findings.
- `task_id`: A unique identifier for the task. You can use this identifier to check the
status of the task or to cancel it.
"""
function start_audit_mitigation_actions_task(
auditCheckToActionsMapping,
clientRequestToken,
target,
taskId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/audit/mitigationactions/tasks/$(taskId)",
Dict{String,Any}(
"auditCheckToActionsMapping" => auditCheckToActionsMapping,
"clientRequestToken" => clientRequestToken,
"target" => target,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_audit_mitigation_actions_task(
auditCheckToActionsMapping,
clientRequestToken,
target,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/audit/mitigationactions/tasks/$(taskId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"auditCheckToActionsMapping" => auditCheckToActionsMapping,
"clientRequestToken" => clientRequestToken,
"target" => target,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_detect_mitigation_actions_task(actions, client_request_token, target, task_id)
start_detect_mitigation_actions_task(actions, client_request_token, target, task_id, params::Dict{String,<:Any})
Starts a Device Defender ML Detect mitigation actions task. Requires permission to access
the StartDetectMitigationActionsTask action.
# Arguments
- `actions`: The actions to be performed when a device has unexpected behavior.
- `client_request_token`: Each mitigation action task must have a unique client request
token. If you try to create a new task with the same token as a task that already exists,
an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically
generate a unique client request.
- `target`: Specifies the ML Detect findings to which the mitigation actions are applied.
- `task_id`: The unique identifier of the task.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeOnlyActiveViolations"`: Specifies to list only active violations.
- `"includeSuppressedAlerts"`: Specifies to include suppressed alerts.
- `"violationEventOccurrenceRange"`: Specifies the time period of which violation events
occurred between.
"""
function start_detect_mitigation_actions_task(
actions,
clientRequestToken,
target,
taskId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/detect/mitigationactions/tasks/$(taskId)",
Dict{String,Any}(
"actions" => actions,
"clientRequestToken" => clientRequestToken,
"target" => target,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_detect_mitigation_actions_task(
actions,
clientRequestToken,
target,
taskId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/detect/mitigationactions/tasks/$(taskId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"actions" => actions,
"clientRequestToken" => clientRequestToken,
"target" => target,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_on_demand_audit_task(target_check_names)
start_on_demand_audit_task(target_check_names, params::Dict{String,<:Any})
Starts an on-demand Device Defender audit. Requires permission to access the
StartOnDemandAuditTask action.
# Arguments
- `target_check_names`: Which checks are performed during the audit. The checks you specify
must be enabled for your account or an exception occurs. Use
DescribeAccountAuditConfiguration to see the list of all checks, including those that are
enabled or UpdateAccountAuditConfiguration to select which checks are enabled.
"""
function start_on_demand_audit_task(
targetCheckNames; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/audit/tasks",
Dict{String,Any}("targetCheckNames" => targetCheckNames);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_on_demand_audit_task(
targetCheckNames,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/audit/tasks",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("targetCheckNames" => targetCheckNames), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_thing_registration_task(input_file_bucket, input_file_key, role_arn, template_body)
start_thing_registration_task(input_file_bucket, input_file_key, role_arn, template_body, params::Dict{String,<:Any})
Creates a bulk thing provisioning task. Requires permission to access the
StartThingRegistrationTask action.
# Arguments
- `input_file_bucket`: The S3 bucket that contains the input file.
- `input_file_key`: The name of input file within the S3 bucket. This file contains a
newline delimited JSON file. Each line contains the parameter values to provision one
device (thing).
- `role_arn`: The IAM role ARN that grants permission the input file.
- `template_body`: The provisioning template.
"""
function start_thing_registration_task(
inputFileBucket,
inputFileKey,
roleArn,
templateBody;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/thing-registration-tasks",
Dict{String,Any}(
"inputFileBucket" => inputFileBucket,
"inputFileKey" => inputFileKey,
"roleArn" => roleArn,
"templateBody" => templateBody,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_thing_registration_task(
inputFileBucket,
inputFileKey,
roleArn,
templateBody,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/thing-registration-tasks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"inputFileBucket" => inputFileBucket,
"inputFileKey" => inputFileKey,
"roleArn" => roleArn,
"templateBody" => templateBody,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
stop_thing_registration_task(task_id)
stop_thing_registration_task(task_id, params::Dict{String,<:Any})
Cancels a bulk thing provisioning task. Requires permission to access the
StopThingRegistrationTask action.
# Arguments
- `task_id`: The bulk thing provisioning task ID.
"""
function stop_thing_registration_task(
taskId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/thing-registration-tasks/$(taskId)/cancel";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function stop_thing_registration_task(
taskId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/thing-registration-tasks/$(taskId)/cancel",
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. Requires permission to access the TagResource action.
# 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 iot(
"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 iot(
"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
"""
test_authorization(auth_infos)
test_authorization(auth_infos, params::Dict{String,<:Any})
Tests if a specified principal is authorized to perform an IoT action on a specified
resource. Use this to test and debug the authorization behavior of devices that connect to
the IoT device gateway. Requires permission to access the TestAuthorization action.
# Arguments
- `auth_infos`: A list of authorization info objects. Simulating authorization will create
a response for each authInfo object in the list.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"clientId"`: The MQTT client ID.
- `"cognitoIdentityPoolId"`: The Cognito identity pool ID.
- `"policyNamesToAdd"`: When testing custom authorization, the policies specified here are
treated as if they are attached to the principal being authorized.
- `"policyNamesToSkip"`: When testing custom authorization, the policies specified here are
treated as if they are not attached to the principal being authorized.
- `"principal"`: The principal. Valid principals are CertificateArn
(arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
(arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
"""
function test_authorization(authInfos; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST",
"/test-authorization",
Dict{String,Any}("authInfos" => authInfos);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_authorization(
authInfos,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/test-authorization",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("authInfos" => authInfos), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_invoke_authorizer(authorizer_name)
test_invoke_authorizer(authorizer_name, params::Dict{String,<:Any})
Tests a custom authorization behavior by invoking a specified custom authorizer. Use this
to test and debug the custom authorization behavior of devices that connect to the IoT
device gateway. Requires permission to access the TestInvokeAuthorizer action.
# Arguments
- `authorizer_name`: The custom authorizer name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"httpContext"`: Specifies a test HTTP authorization request.
- `"mqttContext"`: Specifies a test MQTT authorization request.
- `"tlsContext"`: Specifies a test TLS authorization request.
- `"token"`: The token returned by your custom authentication service.
- `"tokenSignature"`: The signature made with the token and your custom authentication
service's private key. This value must be Base-64-encoded.
"""
function test_invoke_authorizer(
authorizerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/authorizer/$(authorizerName)/test";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_invoke_authorizer(
authorizerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/authorizer/$(authorizerName)/test",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
transfer_certificate(certificate_id, target_aws_account)
transfer_certificate(certificate_id, target_aws_account, params::Dict{String,<:Any})
Transfers the specified certificate to the specified Amazon Web Services account. Requires
permission to access the TransferCertificate action. You can cancel the transfer until it
is acknowledged by the recipient. No notification is sent to the transfer destination's
account. It is up to the caller to notify the transfer target. The certificate being
transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to
deactivate it. The certificate must not have any policies attached to it. You can use the
DetachPolicy action to detach them.
# Arguments
- `certificate_id`: The ID of the certificate. (The last part of the certificate ARN
contains the certificate ID.)
- `target_aws_account`: The Amazon Web Services account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"transferMessage"`: The transfer message.
"""
function transfer_certificate(
certificateId, targetAwsAccount; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/transfer-certificate/$(certificateId)",
Dict{String,Any}("targetAwsAccount" => targetAwsAccount);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function transfer_certificate(
certificateId,
targetAwsAccount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/transfer-certificate/$(certificateId)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("targetAwsAccount" => targetAwsAccount), 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. Requires permission to access the
UntagResource action.
# 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 iot(
"POST",
"/untag",
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 iot(
"POST",
"/untag",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resourceArn" => resourceArn, "tagKeys" => tagKeys),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_account_audit_configuration()
update_account_audit_configuration(params::Dict{String,<:Any})
Configures or reconfigures the Device Defender audit settings for this account. Settings
include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the UpdateAccountAuditConfiguration action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"auditCheckConfigurations"`: Specifies which audit checks are enabled and disabled for
this account. Use DescribeAccountAuditConfiguration to see the list of all checks,
including those that are currently enabled. Some data collection might start immediately
when certain checks are enabled. When a check is disabled, any data collected so far in
relation to the check is deleted. You cannot disable a check if it's used by any scheduled
audit. You must first delete the check from the scheduled audit or delete the scheduled
audit itself. On the first call to UpdateAccountAuditConfiguration, this parameter is
required and must specify at least one enabled check.
- `"auditNotificationTargetConfigurations"`: Information about the targets to which audit
notifications are sent.
- `"roleArn"`: The Amazon Resource Name (ARN) of the role that grants permission to IoT to
access information about your devices, policies, certificates, and other items as required
when performing an audit.
"""
function update_account_audit_configuration(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/audit/configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_account_audit_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/audit/configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_audit_suppression(check_name, resource_identifier)
update_audit_suppression(check_name, resource_identifier, params::Dict{String,<:Any})
Updates a Device Defender audit suppression.
# Arguments
- `check_name`:
- `resource_identifier`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the audit suppression.
- `"expirationDate"`: The expiration date (epoch timestamp in seconds) that you want the
suppression to adhere to.
- `"suppressIndefinitely"`: Indicates whether a suppression should exist indefinitely or
not.
"""
function update_audit_suppression(
checkName, resourceIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/audit/suppressions/update",
Dict{String,Any}(
"checkName" => checkName, "resourceIdentifier" => resourceIdentifier
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_audit_suppression(
checkName,
resourceIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/audit/suppressions/update",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"checkName" => checkName, "resourceIdentifier" => resourceIdentifier
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_authorizer(authorizer_name)
update_authorizer(authorizer_name, params::Dict{String,<:Any})
Updates an authorizer. Requires permission to access the UpdateAuthorizer action.
# Arguments
- `authorizer_name`: The authorizer name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authorizerFunctionArn"`: The ARN of the authorizer's Lambda function.
- `"enableCachingForHttp"`: When true, the result from the authorizer’s Lambda function
is cached for the time specified in refreshAfterInSeconds. The cached result is used while
the device reuses the same HTTP connection.
- `"status"`: The status of the update authorizer request.
- `"tokenKeyName"`: The key used to extract the token from the HTTP headers.
- `"tokenSigningPublicKeys"`: The public keys used to verify the token signature.
"""
function update_authorizer(
authorizerName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/authorizer/$(authorizerName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_authorizer(
authorizerName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/authorizer/$(authorizerName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_billing_group(billing_group_name, billing_group_properties)
update_billing_group(billing_group_name, billing_group_properties, params::Dict{String,<:Any})
Updates information about the billing group. Requires permission to access the
UpdateBillingGroup action.
# Arguments
- `billing_group_name`: The name of the billing group.
- `billing_group_properties`: The properties of the billing group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedVersion"`: The expected version of the billing group. If the version of the
billing group does not match the expected version specified in the request, the
UpdateBillingGroup request is rejected with a VersionConflictException.
"""
function update_billing_group(
billingGroupName,
billingGroupProperties;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/billing-groups/$(billingGroupName)",
Dict{String,Any}("billingGroupProperties" => billingGroupProperties);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_billing_group(
billingGroupName,
billingGroupProperties,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/billing-groups/$(billingGroupName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("billingGroupProperties" => billingGroupProperties),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_cacertificate(ca_certificate_id)
update_cacertificate(ca_certificate_id, params::Dict{String,<:Any})
Updates a registered CA certificate. Requires permission to access the UpdateCACertificate
action.
# Arguments
- `ca_certificate_id`: The CA certificate identifier.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"newAutoRegistrationStatus"`: The new value for the auto registration status. Valid
values are: \"ENABLE\" or \"DISABLE\".
- `"newStatus"`: The updated status of the CA certificate. Note: The status value
REGISTER_INACTIVE is deprecated and should not be used.
- `"registrationConfig"`: Information about the registration configuration.
- `"removeAutoRegistration"`: If true, removes auto registration.
"""
function update_cacertificate(
caCertificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/cacertificate/$(caCertificateId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_cacertificate(
caCertificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/cacertificate/$(caCertificateId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_certificate(certificate_id, new_status)
update_certificate(certificate_id, new_status, params::Dict{String,<:Any})
Updates the status of the specified certificate. This operation is idempotent. Requires
permission to access the UpdateCertificate action. Certificates must be in the ACTIVE state
to authenticate devices that use a certificate to connect to IoT. Within a few minutes of
updating a certificate from the ACTIVE state to any other state, IoT disconnects all
devices that used that certificate to connect. Devices cannot use a certificate that is not
in the ACTIVE state to reconnect.
# Arguments
- `certificate_id`: The ID of the certificate. (The last part of the certificate ARN
contains the certificate ID.)
- `new_status`: The new status. Note: Setting the status to PENDING_TRANSFER or
PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and
PENDING_ACTIVATION are statuses used internally by IoT. They are not intended for developer
use. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
"""
function update_certificate(
certificateId, newStatus; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/certificates/$(certificateId)",
Dict{String,Any}("newStatus" => newStatus);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_certificate(
certificateId,
newStatus,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/certificates/$(certificateId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("newStatus" => newStatus), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_certificate_provider(certificate_provider_name)
update_certificate_provider(certificate_provider_name, params::Dict{String,<:Any})
Updates a certificate provider. Requires permission to access the UpdateCertificateProvider
action.
# Arguments
- `certificate_provider_name`: The name of the certificate provider.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"accountDefaultForOperations"`: A list of the operations that the certificate provider
will use to generate certificates. Valid value: CreateCertificateFromCsr.
- `"lambdaFunctionArn"`: The Lambda function ARN that's associated with the certificate
provider.
"""
function update_certificate_provider(
certificateProviderName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/certificate-providers/$(certificateProviderName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_certificate_provider(
certificateProviderName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/certificate-providers/$(certificateProviderName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_custom_metric(display_name, metric_name)
update_custom_metric(display_name, metric_name, params::Dict{String,<:Any})
Updates a Device Defender detect custom metric. Requires permission to access the
UpdateCustomMetric action.
# Arguments
- `display_name`: Field represents a friendly name in the console for the custom metric,
it doesn't have to be unique. Don't use this name as the metric identifier in the device
metric report. Can be updated.
- `metric_name`: The name of the custom metric. Cannot be updated.
"""
function update_custom_metric(
displayName, metricName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/custom-metric/$(metricName)",
Dict{String,Any}("displayName" => displayName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_custom_metric(
displayName,
metricName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/custom-metric/$(metricName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("displayName" => displayName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dimension(name, string_values)
update_dimension(name, string_values, params::Dict{String,<:Any})
Updates the definition for a dimension. You cannot change the type of a dimension after it
is created (you can delete it and recreate it). Requires permission to access the
UpdateDimension action.
# Arguments
- `name`: A unique identifier for the dimension. Choose something that describes the type
and value to make it easy to remember what it does.
- `string_values`: Specifies the value or list of values for the dimension. For
TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example,
\"admin/#\").
"""
function update_dimension(
name, stringValues; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/dimensions/$(name)",
Dict{String,Any}("stringValues" => stringValues);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dimension(
name,
stringValues,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/dimensions/$(name)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("stringValues" => stringValues), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_domain_configuration(domain_configuration_name)
update_domain_configuration(domain_configuration_name, params::Dict{String,<:Any})
Updates values stored in the domain configuration. Domain configurations for default
endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration
action.
# Arguments
- `domain_configuration_name`: The name of the domain configuration to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"authorizerConfig"`: An object that specifies the authorization service for a domain.
- `"domainConfigurationStatus"`: The status to which the domain configuration should be
updated.
- `"removeAuthorizerConfig"`: Removes the authorization configuration from a domain.
- `"serverCertificateConfig"`: The server certificate configuration.
- `"tlsConfig"`: An object that specifies the TLS configuration for a domain.
"""
function update_domain_configuration(
domainConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/domainConfigurations/$(domainConfigurationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_domain_configuration(
domainConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/domainConfigurations/$(domainConfigurationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dynamic_thing_group(thing_group_name, thing_group_properties)
update_dynamic_thing_group(thing_group_name, thing_group_properties, params::Dict{String,<:Any})
Updates a dynamic thing group. Requires permission to access the UpdateDynamicThingGroup
action.
# Arguments
- `thing_group_name`: The name of the dynamic thing group to update.
- `thing_group_properties`: The dynamic thing group properties to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedVersion"`: The expected version of the dynamic thing group to update.
- `"indexName"`: The dynamic thing group index to update. Currently one index is
supported: AWS_Things.
- `"queryString"`: The dynamic thing group search query string to update.
- `"queryVersion"`: The dynamic thing group query version to update. Currently one query
version is supported: \"2017-09-30\". If not specified, the query version defaults to this
value.
"""
function update_dynamic_thing_group(
thingGroupName, thingGroupProperties; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/dynamic-thing-groups/$(thingGroupName)",
Dict{String,Any}("thingGroupProperties" => thingGroupProperties);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dynamic_thing_group(
thingGroupName,
thingGroupProperties,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/dynamic-thing-groups/$(thingGroupName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("thingGroupProperties" => thingGroupProperties),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_event_configurations()
update_event_configurations(params::Dict{String,<:Any})
Updates the event configurations. Requires permission to access the
UpdateEventConfigurations action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"eventConfigurations"`: The new event configuration values.
"""
function update_event_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PATCH",
"/event-configurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_event_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/event-configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_fleet_metric(index_name, metric_name)
update_fleet_metric(index_name, metric_name, params::Dict{String,<:Any})
Updates the data for a fleet metric. Requires permission to access the UpdateFleetMetric
action.
# Arguments
- `index_name`: The name of the index to search.
- `metric_name`: The name of the fleet metric to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"aggregationField"`: The field to aggregate.
- `"aggregationType"`: The type of the aggregation query.
- `"description"`: The description of the fleet metric.
- `"expectedVersion"`: The expected version of the fleet metric record in the registry.
- `"period"`: The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1
day)] and must be multiple of 60.
- `"queryString"`: The search query string.
- `"queryVersion"`: The version of the query.
- `"unit"`: Used to support unit transformation such as milliseconds to seconds. The unit
must be supported by CW metric.
"""
function update_fleet_metric(
indexName, metricName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/fleet-metric/$(metricName)",
Dict{String,Any}("indexName" => indexName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_fleet_metric(
indexName,
metricName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/fleet-metric/$(metricName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("indexName" => indexName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_indexing_configuration()
update_indexing_configuration(params::Dict{String,<:Any})
Updates the search configuration. Requires permission to access the
UpdateIndexingConfiguration action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"thingGroupIndexingConfiguration"`: Thing group indexing configuration.
- `"thingIndexingConfiguration"`: Thing indexing configuration.
"""
function update_indexing_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"POST", "/indexing/config"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_indexing_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/indexing/config",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_job(job_id)
update_job(job_id, params::Dict{String,<:Any})
Updates supported fields of the specified job. Requires permission to access the UpdateJob
action.
# Arguments
- `job_id`: The ID of the job to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"abortConfig"`: Allows you to create criteria to abort a job.
- `"description"`: A short text description of the job.
- `"jobExecutionsRetryConfig"`: Allows you to create the criteria to retry a job.
- `"jobExecutionsRolloutConfig"`: Allows you to create a staged rollout of the job.
- `"namespaceId"`: The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs
notifications to MQTT topics that contain the value in the following format.
aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature
is only supported by IoT Greengrass at this time. For more information, see Setting up IoT
Greengrass core devices.
- `"presignedUrlConfig"`: Configuration information for pre-signed S3 URLs.
- `"timeoutConfig"`: Specifies the amount of time each device has to finish its execution
of the job. The timer is started when the job execution status is set to IN_PROGRESS. If
the job execution status is not set to another terminal state before the time expires, it
will be automatically set to TIMED_OUT.
"""
function update_job(jobId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PATCH", "/jobs/$(jobId)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_job(
jobId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_mitigation_action(action_name)
update_mitigation_action(action_name, params::Dict{String,<:Any})
Updates the definition for the specified mitigation action. Requires permission to access
the UpdateMitigationAction action.
# Arguments
- `action_name`: The friendly name for the mitigation action. You cannot change the name by
using UpdateMitigationAction. Instead, you must delete and recreate the mitigation action
with the new name.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"actionParams"`: Defines the type of action and the parameters for that action.
- `"roleArn"`: The ARN of the IAM role that is used to apply the mitigation action.
"""
function update_mitigation_action(
actionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/mitigationactions/actions/$(actionName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_mitigation_action(
actionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/mitigationactions/actions/$(actionName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_package(package_name)
update_package(package_name, params::Dict{String,<:Any})
Updates the supported fields for a specific software package. Requires permission to access
the UpdatePackage and GetIndexingConfiguration actions.
# Arguments
- `package_name`: The name of the target software package.
# 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.
- `"defaultVersionName"`: The name of the default package version. Note: You cannot name a
defaultVersion and set unsetDefaultVersion equal to true at the same time.
- `"description"`: The package description.
- `"unsetDefaultVersion"`: Indicates whether you want to remove the named default package
version from the software package. Set as true to remove the default package version.
Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true at the
same time.
"""
function update_package(packageName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PATCH",
"/packages/$(packageName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_package(
packageName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/packages/$(packageName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_package_configuration()
update_package_configuration(params::Dict{String,<:Any})
Updates the software package configuration. Requires permission to access the
UpdatePackageConfiguration and iam:PassRole actions.
# 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.
- `"versionUpdateByJobsConfig"`: Configuration to manage job's package version reporting.
This updates the thing's reserved named shadow that the job targets.
"""
function update_package_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PATCH",
"/package-configuration",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_package_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/package-configuration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_package_version(package_name, version_name)
update_package_version(package_name, version_name, params::Dict{String,<:Any})
Updates the supported fields for a specific package version. Requires permission to access
the UpdatePackageVersion and GetIndexingConfiguration actions.
# Arguments
- `package_name`: The name of the associated software package.
- `version_name`: The name of the target package version.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"action"`: The status that the package version should be assigned. For more information,
see Package version lifecycle.
- `"attributes"`: Metadata that can be used to define a package version’s configuration.
For example, the Amazon S3 file location, configuration options that are being sent to the
device or fleet. Note: Attributes can be updated only when the package version is in a
draft state. The combined size of all the attributes on a package version is limited to 3KB.
- `"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.
- `"description"`: The package version description.
"""
function update_package_version(
packageName, versionName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/packages/$(packageName)/versions/$(versionName)",
Dict{String,Any}("clientToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_package_version(
packageName,
versionName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/packages/$(packageName)/versions/$(versionName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("clientToken" => string(uuid4())), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_provisioning_template(template_name)
update_provisioning_template(template_name, params::Dict{String,<:Any})
Updates a provisioning template. Requires permission to access the
UpdateProvisioningTemplate action.
# Arguments
- `template_name`: The name of the provisioning template.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"defaultVersionId"`: The ID of the default provisioning template version.
- `"description"`: The description of the provisioning template.
- `"enabled"`: True to enable the provisioning template, otherwise false.
- `"preProvisioningHook"`: Updates the pre-provisioning hook template. Only supports
template of type FLEET_PROVISIONING. For more information about provisioning template
types, see type.
- `"provisioningRoleArn"`: The ARN of the role associated with the provisioning template.
This IoT role grants permission to provision a device.
- `"removePreProvisioningHook"`: Removes pre-provisioning hook template.
"""
function update_provisioning_template(
templateName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/provisioning-templates/$(templateName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_provisioning_template(
templateName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/provisioning-templates/$(templateName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_role_alias(role_alias)
update_role_alias(role_alias, params::Dict{String,<:Any})
Updates a role alias. Requires permission to access the UpdateRoleAlias action.
# Arguments
- `role_alias`: The role alias to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"credentialDurationSeconds"`: The number of seconds the credential will be valid. This
value must be less than or equal to the maximum session duration of the IAM role that the
role alias references.
- `"roleArn"`: The role ARN.
"""
function update_role_alias(roleAlias; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PUT",
"/role-aliases/$(roleAlias)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_role_alias(
roleAlias,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/role-aliases/$(roleAlias)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_scheduled_audit(scheduled_audit_name)
update_scheduled_audit(scheduled_audit_name, params::Dict{String,<:Any})
Updates a scheduled audit, including which checks are performed and how often the audit
takes place. Requires permission to access the UpdateScheduledAudit action.
# Arguments
- `scheduled_audit_name`: The name of the scheduled audit. (Max. 128 chars)
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dayOfMonth"`: The day of the month on which the scheduled audit takes place. This can
be 1 through 31 or LAST. This field is required if the frequency parameter is set to
MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit
takes place on the \"LAST\" day of the month.
- `"dayOfWeek"`: The day of the week on which the scheduled audit takes place. This can be
one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the \"frequency\"
parameter is set to WEEKLY or BIWEEKLY.
- `"frequency"`: How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY,
or MONTHLY. The start time of each audit is determined by the system.
- `"targetCheckNames"`: Which checks are performed during the scheduled audit. Checks must
be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all
checks, including those that are enabled or use UpdateAccountAuditConfiguration to select
which checks are enabled.)
"""
function update_scheduled_audit(
scheduledAuditName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/audit/scheduledaudits/$(scheduledAuditName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_scheduled_audit(
scheduledAuditName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/audit/scheduledaudits/$(scheduledAuditName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_security_profile(security_profile_name)
update_security_profile(security_profile_name, params::Dict{String,<:Any})
Updates a Device Defender security profile. Requires permission to access the
UpdateSecurityProfile action.
# Arguments
- `security_profile_name`: The name of the security profile you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"additionalMetricsToRetain"`: Please use
UpdateSecurityProfileRequestadditionalMetricsToRetainV2 instead. A list of metrics whose
data is retained (stored). By default, data is retained for any metric used in the
profile's behaviors, but it is also retained for any metric specified here. Can be used
with custom metrics; cannot be used with dimensions.
- `"additionalMetricsToRetainV2"`: A list of metrics whose data is retained (stored). By
default, data is retained for any metric used in the profile's behaviors, but it is also
retained for any metric specified here. Can be used with custom metrics; cannot be used
with dimensions.
- `"alertTargets"`: Where the alerts are sent. (Alerts are always sent to the console.)
- `"behaviors"`: Specifies the behaviors that, when violated by a device (thing), cause an
alert.
- `"deleteAdditionalMetricsToRetain"`: If true, delete all additionalMetricsToRetain
defined for this security profile. If any additionalMetricsToRetain are defined in the
current invocation, an exception occurs.
- `"deleteAlertTargets"`: If true, delete all alertTargets defined for this security
profile. If any alertTargets are defined in the current invocation, an exception occurs.
- `"deleteBehaviors"`: If true, delete all behaviors defined for this security profile. If
any behaviors are defined in the current invocation, an exception occurs.
- `"deleteMetricsExportConfig"`: Set the value as true to delete metrics export related
configurations.
- `"expectedVersion"`: The expected version of the security profile. A new version is
generated whenever the security profile is updated. If you specify a value that is
different from the actual version, a VersionConflictException is thrown.
- `"metricsExportConfig"`: Specifies the MQTT topic and role ARN required for metric export.
- `"securityProfileDescription"`: A description of the security profile.
"""
function update_security_profile(
securityProfileName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/security-profiles/$(securityProfileName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_security_profile(
securityProfileName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/security-profiles/$(securityProfileName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_stream(stream_id)
update_stream(stream_id, params::Dict{String,<:Any})
Updates an existing stream. The stream version will be incremented by one. Requires
permission to access the UpdateStream action.
# Arguments
- `stream_id`: The stream ID.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the stream.
- `"files"`: The files associated with the stream.
- `"roleArn"`: An IAM role that allows the IoT service principal assumes to access your S3
files.
"""
function update_stream(streamId; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PUT",
"/streams/$(streamId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_stream(
streamId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PUT",
"/streams/$(streamId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_thing(thing_name)
update_thing(thing_name, params::Dict{String,<:Any})
Updates the data for a thing. Requires permission to access the UpdateThing action.
# Arguments
- `thing_name`: The name of the thing to update. You can't change a thing's name. To change
a thing's name, you must create a new thing, give it the new name, and then delete the old
thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributePayload"`: A list of thing attributes, a JSON string containing name-value
pairs. For example: {\"attributes\":{\"name1\":\"value2\"}} This data is used to add new
attributes or update existing attributes.
- `"expectedVersion"`: The expected version of the thing record in the registry. If the
version of the record in the registry does not match the expected version specified in the
request, the UpdateThing request is rejected with a VersionConflictException.
- `"removeThingType"`: Remove a thing type association. If true, the association is removed.
- `"thingTypeName"`: The name of the thing type.
"""
function update_thing(thingName; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PATCH",
"/things/$(thingName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_thing(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/things/$(thingName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_thing_group(thing_group_name, thing_group_properties)
update_thing_group(thing_group_name, thing_group_properties, params::Dict{String,<:Any})
Update a thing group. Requires permission to access the UpdateThingGroup action.
# Arguments
- `thing_group_name`: The thing group to update.
- `thing_group_properties`: The thing group properties.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"expectedVersion"`: The expected version of the thing group. If this does not match the
version of the thing group being updated, the update will fail.
"""
function update_thing_group(
thingGroupName, thingGroupProperties; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/thing-groups/$(thingGroupName)",
Dict{String,Any}("thingGroupProperties" => thingGroupProperties);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_thing_group(
thingGroupName,
thingGroupProperties,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/thing-groups/$(thingGroupName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("thingGroupProperties" => thingGroupProperties),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_thing_groups_for_thing()
update_thing_groups_for_thing(params::Dict{String,<:Any})
Updates the groups to which the thing belongs. Requires permission to access the
UpdateThingGroupsForThing action.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"overrideDynamicGroups"`: Override dynamic thing groups with static thing groups when
10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those
groups are dynamic thing groups, adding a thing to a static group removes the thing from
the last dynamic group.
- `"thingGroupsToAdd"`: The groups to which the thing will be added.
- `"thingGroupsToRemove"`: The groups from which the thing will be removed.
- `"thingName"`: The thing whose group memberships will be updated.
"""
function update_thing_groups_for_thing(; aws_config::AbstractAWSConfig=global_aws_config())
return iot(
"PUT",
"/thing-groups/updateThingGroupsForThing";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_thing_groups_for_thing(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PUT",
"/thing-groups/updateThingGroupsForThing",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_topic_rule_destination(arn, status)
update_topic_rule_destination(arn, status, params::Dict{String,<:Any})
Updates a topic rule destination. You use this to change the status, endpoint URL, or
confirmation URL of the destination. Requires permission to access the
UpdateTopicRuleDestination action.
# Arguments
- `arn`: The ARN of the topic rule destination.
- `status`: The status of the topic rule destination. Valid values are: IN_PROGRESS A
topic rule destination was created but has not been confirmed. You can set status to
IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination
causes a new confirmation challenge to be sent to your confirmation endpoint. ENABLED
Confirmation was completed, and traffic to this destination is allowed. You can set status
to DISABLED by calling UpdateTopicRuleDestination. DISABLED Confirmation was completed,
and traffic to this destination is not allowed. You can set status to ENABLED by calling
UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for example if the
confirmation timed out. You can call GetTopicRuleDestination for details about the error.
You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your
confirmation endpoint.
"""
function update_topic_rule_destination(
arn, status; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"PATCH",
"/destinations",
Dict{String,Any}("arn" => arn, "status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_topic_rule_destination(
arn,
status,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"PATCH",
"/destinations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("arn" => arn, "status" => status), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
validate_security_profile_behaviors(behaviors)
validate_security_profile_behaviors(behaviors, params::Dict{String,<:Any})
Validates a Device Defender security profile behaviors specification. Requires permission
to access the ValidateSecurityProfileBehaviors action.
# Arguments
- `behaviors`: Specifies the behaviors that, when violated by a device (thing), cause an
alert.
"""
function validate_security_profile_behaviors(
behaviors; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot(
"POST",
"/security-profile-behaviors/validate",
Dict{String,Any}("behaviors" => behaviors);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function validate_security_profile_behaviors(
behaviors,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot(
"POST",
"/security-profile-behaviors/validate",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("behaviors" => behaviors), 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 | 14212 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iot_1click_devices_service
using AWS.Compat
using AWS.UUIDs
"""
claim_devices_by_claim_code(claim_code)
claim_devices_by_claim_code(claim_code, params::Dict{String,<:Any})
Adds device(s) to your account (i.e., claim one or more devices) if and only if you
received a claim code with the device(s).
# Arguments
- `claim_code`: The claim code, starting with \"C-\", as provided by the device
manufacturer.
"""
function claim_devices_by_claim_code(
claimCode; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_devices_service(
"PUT",
"/claims/$(claimCode)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function claim_devices_by_claim_code(
claimCode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_devices_service(
"PUT",
"/claims/$(claimCode)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_device(device_id)
describe_device(device_id, params::Dict{String,<:Any})
Given a device ID, returns a DescribeDeviceResponse object describing the
details of the
device.
# Arguments
- `device_id`: The unique identifier of the device.
"""
function describe_device(deviceId; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_devices_service(
"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 iot_1click_devices_service(
"GET",
"/devices/$(deviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
finalize_device_claim(device_id)
finalize_device_claim(device_id, params::Dict{String,<:Any})
Given a device ID, finalizes the claim request for the associated device.
Claiming a
device consists of initiating a claim, then publishing a device event,
and finalizing the
claim. For a device of type button, a device event can
be published by simply clicking the
device.
# Arguments
- `device_id`: The unique identifier of the device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: A collection of key/value pairs defining the resource tags. For example, {
\"tags\": {\"key1\": \"value1\", \"key2\": \"value2\"} }. For more information, see AWS
Tagging Strategies.
"""
function finalize_device_claim(deviceId; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_devices_service(
"PUT",
"/devices/$(deviceId)/finalize-claim";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function finalize_device_claim(
deviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_devices_service(
"PUT",
"/devices/$(deviceId)/finalize-claim",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_methods(device_id)
get_device_methods(device_id, params::Dict{String,<:Any})
Given a device ID, returns the invokable methods associated with the device.
# Arguments
- `device_id`: The unique identifier of the device.
"""
function get_device_methods(deviceId; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_devices_service(
"GET",
"/devices/$(deviceId)/methods";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_methods(
deviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_devices_service(
"GET",
"/devices/$(deviceId)/methods",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
initiate_device_claim(device_id)
initiate_device_claim(device_id, params::Dict{String,<:Any})
Given a device ID, initiates a claim request for the associated device.
Claiming a device
consists of initiating a claim, then publishing a device event,
and finalizing the claim.
For a device of type button, a device event can
be published by simply clicking the
device.
# Arguments
- `device_id`: The unique identifier of the device.
"""
function initiate_device_claim(deviceId; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_devices_service(
"PUT",
"/devices/$(deviceId)/initiate-claim";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function initiate_device_claim(
deviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_devices_service(
"PUT",
"/devices/$(deviceId)/initiate-claim",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
invoke_device_method(device_id)
invoke_device_method(device_id, params::Dict{String,<:Any})
Given a device ID, issues a request to invoke a named device method (with possible
parameters). See the \"Example POST\" code snippet below.
# Arguments
- `device_id`: The unique identifier of the device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deviceMethod"`: The device method to invoke.
- `"deviceMethodParameters"`: A JSON encoded string containing the device method request
parameters.
"""
function invoke_device_method(deviceId; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_devices_service(
"POST",
"/devices/$(deviceId)/methods";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function invoke_device_method(
deviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_devices_service(
"POST",
"/devices/$(deviceId)/methods",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_device_events(device_id, from_time_stamp, to_time_stamp)
list_device_events(device_id, from_time_stamp, to_time_stamp, params::Dict{String,<:Any})
Using a device ID, returns a DeviceEventsResponse object containing an
array of events for
the device.
# Arguments
- `device_id`: The unique identifier of the device.
- `from_time_stamp`: The start date for the device event query, in ISO8061 format. For
example,
2018-03-28T15:45:12.880Z
- `to_time_stamp`: The end date for the device event query, in ISO8061 format. For
example,
2018-03-28T15:45:12.880Z
# 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 request. If not set, a
default value of
100 is used.
- `"nextToken"`: The token to retrieve the next set of results.
"""
function list_device_events(
deviceId, fromTimeStamp, toTimeStamp; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_devices_service(
"GET",
"/devices/$(deviceId)/events",
Dict{String,Any}("fromTimeStamp" => fromTimeStamp, "toTimeStamp" => toTimeStamp);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_device_events(
deviceId,
fromTimeStamp,
toTimeStamp,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_devices_service(
"GET",
"/devices/$(deviceId)/events",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"fromTimeStamp" => fromTimeStamp, "toTimeStamp" => toTimeStamp
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_devices()
list_devices(params::Dict{String,<:Any})
Lists the 1-Click compatible devices associated with your AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deviceType"`: The type of the device, such as \"button\".
- `"maxResults"`: The maximum number of results to return per request. If not set, a
default value of
100 is used.
- `"nextToken"`: The token to retrieve the next set of results.
"""
function list_devices(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_devices_service(
"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 iot_1click_devices_service(
"GET", "/devices", 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 the specified resource ARN.
# Arguments
- `resource-arn`: The ARN of the resource.
"""
function list_tags_for_resource(
resource_arn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_devices_service(
"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 iot_1click_devices_service(
"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 or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service
Limits for the maximum number of tags allowed per
resource.
# Arguments
- `resource-arn`: The ARN of the resource.
- `tags`: A collection of key/value pairs defining the resource tags. For example, {
\"tags\": {\"key1\": \"value1\", \"key2\": \"value2\"} }. For more information, see AWS
Tagging Strategies.
"""
function tag_resource(resource_arn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_devices_service(
"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 iot_1click_devices_service(
"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
"""
unclaim_device(device_id)
unclaim_device(device_id, params::Dict{String,<:Any})
Disassociates a device from your AWS account using its device ID.
# Arguments
- `device_id`: The unique identifier of the device.
"""
function unclaim_device(deviceId; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_devices_service(
"PUT",
"/devices/$(deviceId)/unclaim";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function unclaim_device(
deviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_devices_service(
"PUT",
"/devices/$(deviceId)/unclaim",
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})
Using tag keys, deletes the tags (key/value pairs) associated with the specified
resource
ARN.
# Arguments
- `resource-arn`: The ARN of the resource.
- `tag_keys`: A collections of tag keys. For example, {\"key1\",\"key2\"}
"""
function untag_resource(
resource_arn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_devices_service(
"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 iot_1click_devices_service(
"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_device_state(device_id)
update_device_state(device_id, params::Dict{String,<:Any})
Using a Boolean value (true or false), this operation
enables or disables the device given
a device ID.
# Arguments
- `device_id`: The unique identifier of the device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"enabled"`: If true, the device is enabled. If false, the device is
disabled.
"""
function update_device_state(deviceId; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_devices_service(
"PUT",
"/devices/$(deviceId)/state";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_device_state(
deviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_devices_service(
"PUT",
"/devices/$(deviceId)/state",
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 | 19158 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iot_1click_projects
using AWS.Compat
using AWS.UUIDs
"""
associate_device_with_placement(device_id, device_template_name, placement_name, project_name)
associate_device_with_placement(device_id, device_template_name, placement_name, project_name, params::Dict{String,<:Any})
Associates a physical device with a placement.
# Arguments
- `device_id`: The ID of the physical device to be associated with the given placement in
the project. Note that a mandatory 4 character prefix is required for all deviceId values.
- `device_template_name`: The device template name to associate with the device ID.
- `placement_name`: The name of the placement in which to associate the device.
- `project_name`: The name of the project containing the placement in which to associate
the device.
"""
function associate_device_with_placement(
deviceId,
deviceTemplateName,
placementName,
projectName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"PUT",
"/projects/$(projectName)/placements/$(placementName)/devices/$(deviceTemplateName)",
Dict{String,Any}("deviceId" => deviceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_device_with_placement(
deviceId,
deviceTemplateName,
placementName,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"PUT",
"/projects/$(projectName)/placements/$(placementName)/devices/$(deviceTemplateName)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("deviceId" => deviceId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_placement(placement_name, project_name)
create_placement(placement_name, project_name, params::Dict{String,<:Any})
Creates an empty placement.
# Arguments
- `placement_name`: The name of the placement to be created.
- `project_name`: The name of the project in which to create the placement.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: Optional user-defined key/value pairs providing contextual data (such as
location or function) for the placement.
"""
function create_placement(
placementName, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_projects(
"POST",
"/projects/$(projectName)/placements",
Dict{String,Any}("placementName" => placementName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_placement(
placementName,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"POST",
"/projects/$(projectName)/placements",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("placementName" => placementName), 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 project with a placement template. A project contains zero or more
placements that adhere to the placement template defined in the project.
# Arguments
- `project_name`: The name of the project to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: An optional description for the project.
- `"placementTemplate"`: The schema defining the placement to be created. A placement
template defines placement default attributes and device templates. You cannot add or
remove device templates after the project has been created. However, you can update
callbackOverrides for the device templates using the UpdateProject API.
- `"tags"`: Optional tags (metadata key/value pairs) to be associated with the project. For
example, { {\"key1\": \"value1\", \"key2\": \"value2\"} }. For more information, see AWS
Tagging Strategies.
"""
function create_project(projectName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_projects(
"POST",
"/projects",
Dict{String,Any}("projectName" => projectName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_project(
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"POST",
"/projects",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("projectName" => projectName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_placement(placement_name, project_name)
delete_placement(placement_name, project_name, params::Dict{String,<:Any})
Deletes a placement. To delete a placement, it must not have any devices associated with
it. When you delete a placement, all associated data becomes irretrievable.
# Arguments
- `placement_name`: The name of the empty placement to delete.
- `project_name`: The project containing the empty placement to delete.
"""
function delete_placement(
placementName, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_projects(
"DELETE",
"/projects/$(projectName)/placements/$(placementName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_placement(
placementName,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"DELETE",
"/projects/$(projectName)/placements/$(placementName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_project(project_name)
delete_project(project_name, params::Dict{String,<:Any})
Deletes a project. To delete a project, it must not have any placements associated with it.
When you delete a project, all associated data becomes irretrievable.
# Arguments
- `project_name`: The name of the empty project to delete.
"""
function delete_project(projectName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_projects(
"DELETE",
"/projects/$(projectName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_project(
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"DELETE",
"/projects/$(projectName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_placement(placement_name, project_name)
describe_placement(placement_name, project_name, params::Dict{String,<:Any})
Describes a placement in a project.
# Arguments
- `placement_name`: The name of the placement within a project.
- `project_name`: The project containing the placement to be described.
"""
function describe_placement(
placementName, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_projects(
"GET",
"/projects/$(projectName)/placements/$(placementName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_placement(
placementName,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"GET",
"/projects/$(projectName)/placements/$(placementName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_project(project_name)
describe_project(project_name, params::Dict{String,<:Any})
Returns an object describing a project.
# Arguments
- `project_name`: The name of the project to be described.
"""
function describe_project(projectName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_projects(
"GET",
"/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 iot_1click_projects(
"GET",
"/projects/$(projectName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_device_from_placement(device_template_name, placement_name, project_name)
disassociate_device_from_placement(device_template_name, placement_name, project_name, params::Dict{String,<:Any})
Removes a physical device from a placement.
# Arguments
- `device_template_name`: The device ID that should be removed from the placement.
- `placement_name`: The name of the placement that the device should be removed from.
- `project_name`: The name of the project that contains the placement.
"""
function disassociate_device_from_placement(
deviceTemplateName,
placementName,
projectName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"DELETE",
"/projects/$(projectName)/placements/$(placementName)/devices/$(deviceTemplateName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_device_from_placement(
deviceTemplateName,
placementName,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"DELETE",
"/projects/$(projectName)/placements/$(placementName)/devices/$(deviceTemplateName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_devices_in_placement(placement_name, project_name)
get_devices_in_placement(placement_name, project_name, params::Dict{String,<:Any})
Returns an object enumerating the devices in a placement.
# Arguments
- `placement_name`: The name of the placement to get the devices from.
- `project_name`: The name of the project containing the placement.
"""
function get_devices_in_placement(
placementName, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_projects(
"GET",
"/projects/$(projectName)/placements/$(placementName)/devices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_devices_in_placement(
placementName,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"GET",
"/projects/$(projectName)/placements/$(placementName)/devices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_placements(project_name)
list_placements(project_name, params::Dict{String,<:Any})
Lists the placement(s) of a project.
# Arguments
- `project_name`: The project containing the placements to be listed.
# 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 request. If not set, a
default value of 100 is used.
- `"nextToken"`: The token to retrieve the next set of results.
"""
function list_placements(projectName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_projects(
"GET",
"/projects/$(projectName)/placements";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_placements(
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"GET",
"/projects/$(projectName)/placements",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_projects()
list_projects(params::Dict{String,<:Any})
Lists the AWS IoT 1-Click project(s) associated with your AWS account and 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 per request. If not set, a
default value of 100 is used.
- `"nextToken"`: The token to retrieve the next set of results.
"""
function list_projects(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_projects(
"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 iot_1click_projects(
"GET", "/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})
Lists the tags (metadata key/value pairs) which you have assigned to the resource.
# Arguments
- `resource_arn`: The ARN of the resource whose tags you want to list.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_projects(
"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 iot_1click_projects(
"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})
Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be
used to manage a resource. For more information, see AWS Tagging Strategies.
# Arguments
- `resource_arn`: The ARN of the resouce for which tag(s) should be added or modified.
- `tags`: The new or modifying tag(s) for the resource. See AWS IoT 1-Click Service Limits
for the maximum number of tags allowed per resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_projects(
"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 iot_1click_projects(
"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 (metadata key/value pairs) from a resource.
# Arguments
- `resource_arn`: The ARN of the resource whose tag you want to remove.
- `tag_keys`: The keys of those tags which you want to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_projects(
"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 iot_1click_projects(
"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_placement(placement_name, project_name)
update_placement(placement_name, project_name, params::Dict{String,<:Any})
Updates a placement with the given attributes. To clear an attribute, pass an empty value
(i.e., \"\").
# Arguments
- `placement_name`: The name of the placement to update.
- `project_name`: The name of the project containing the placement to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"attributes"`: The user-defined object of attributes used to update the placement. The
maximum number of key/value pairs is 50.
"""
function update_placement(
placementName, projectName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_1click_projects(
"PUT",
"/projects/$(projectName)/placements/$(placementName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_placement(
placementName,
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"PUT",
"/projects/$(projectName)/placements/$(placementName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_project(project_name)
update_project(project_name, params::Dict{String,<:Any})
Updates a project associated with your AWS account and region. With the exception of device
template names, you can pass just the values that need to be updated because the update
request will change only the values that are provided. To clear a value, pass the empty
string (i.e., \"\").
# Arguments
- `project_name`: The name of the project to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: An optional user-defined description for the project.
- `"placementTemplate"`: An object defining the project update. Once a project has been
created, you cannot add device template names to the project. However, for a given
placementTemplate, you can update the associated callbackOverrides for the device
definition using this API.
"""
function update_project(projectName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_1click_projects(
"PUT",
"/projects/$(projectName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_project(
projectName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_1click_projects(
"PUT",
"/projects/$(projectName)",
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 | 10431 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iot_data_plane
using AWS.Compat
using AWS.UUIDs
"""
delete_thing_shadow(thing_name)
delete_thing_shadow(thing_name, params::Dict{String,<:Any})
Deletes the shadow for the specified thing. Requires permission to access the
DeleteThingShadow action. For more information, see DeleteThingShadow in the IoT Developer
Guide.
# Arguments
- `thing_name`: The name of the thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: The name of the shadow.
"""
function delete_thing_shadow(thingName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_data_plane(
"DELETE",
"/things/$(thingName)/shadow";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_thing_shadow(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_data_plane(
"DELETE",
"/things/$(thingName)/shadow",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_retained_message(topic)
get_retained_message(topic, params::Dict{String,<:Any})
Gets the details of a single retained message for the specified topic. This action returns
the message payload of the retained message, which can incur messaging costs. To list only
the topic names of the retained messages, call ListRetainedMessages. Requires permission to
access the GetRetainedMessage action. For more information about messaging costs, see
Amazon Web Services IoT Core pricing - Messaging.
# Arguments
- `topic`: The topic name of the retained message to retrieve.
"""
function get_retained_message(topic; aws_config::AbstractAWSConfig=global_aws_config())
return iot_data_plane(
"GET",
"/retainedMessage/$(topic)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_retained_message(
topic, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_data_plane(
"GET",
"/retainedMessage/$(topic)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_thing_shadow(thing_name)
get_thing_shadow(thing_name, params::Dict{String,<:Any})
Gets the shadow for the specified thing. Requires permission to access the GetThingShadow
action. For more information, see GetThingShadow in the IoT Developer Guide.
# Arguments
- `thing_name`: The name of the thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: The name of the shadow.
"""
function get_thing_shadow(thingName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_data_plane(
"GET",
"/things/$(thingName)/shadow";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_thing_shadow(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_data_plane(
"GET",
"/things/$(thingName)/shadow",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_named_shadows_for_thing(thing_name)
list_named_shadows_for_thing(thing_name, params::Dict{String,<:Any})
Lists the shadows for the specified thing. Requires permission to access the
ListNamedShadowsForThing action.
# Arguments
- `thing_name`: The name of the thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"nextToken"`: The token to retrieve the next set of results.
- `"pageSize"`: The result page size.
"""
function list_named_shadows_for_thing(
thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_data_plane(
"GET",
"/api/things/shadow/ListNamedShadowsForThing/$(thingName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_named_shadows_for_thing(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_data_plane(
"GET",
"/api/things/shadow/ListNamedShadowsForThing/$(thingName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_retained_messages()
list_retained_messages(params::Dict{String,<:Any})
Lists summary information about the retained messages stored for the account. This action
returns only the topic names of the retained messages. It doesn't return any message
payloads. Although this action doesn't return a message payload, it can still incur
messaging costs. To get the message payload of a retained message, call GetRetainedMessage
with the topic name of the retained message. Requires permission to access the
ListRetainedMessages action. For more information about messaging costs, see Amazon Web
Services IoT Core pricing - Messaging.
# 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.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_retained_messages(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_data_plane(
"GET", "/retainedMessage"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_retained_messages(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_data_plane(
"GET",
"/retainedMessage",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
publish(topic)
publish(topic, params::Dict{String,<:Any})
Publishes an MQTT message. Requires permission to access the Publish action. For more
information about MQTT messages, see MQTT Protocol in the IoT Developer Guide. For more
information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.
# Arguments
- `topic`: The name of the MQTT topic.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contentType"`: A UTF-8 encoded string that describes the content of the publishing
message.
- `"messageExpiry"`: A user-defined integer value that represents the message expiry
interval in seconds. If absent, the message doesn't expire. For more information about the
limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol
limits and quotas from the Amazon Web Services Reference Guide.
- `"payload"`: The message body. MQTT accepts text, binary, and empty (null) message
payloads. Publishing an empty (null) payload with retain = true deletes the retained
message identified by topic from Amazon Web Services IoT Core.
- `"qos"`: The Quality of Service (QoS) level. The default QoS level is 0.
- `"responseTopic"`: A UTF-8 encoded string that's used as the topic name for a response
message. The response topic is used to describe the topic which the receiver should publish
to as part of the request-response flow. The topic must not contain wildcard characters.
- `"retain"`: A Boolean value that determines whether to set the RETAIN flag when the
message is published. Setting the RETAIN flag causes the message to be retained and sent to
new subscribers to the topic. Valid values: true | false Default value: false
- `"x-amz-mqtt5-correlation-data"`: The base64-encoded binary data used by the sender of
the request message to identify which request the response message is for when it's
received. correlationData is an HTTP header value in the API.
- `"x-amz-mqtt5-payload-format-indicator"`: An Enum string value that indicates whether the
payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
- `"x-amz-mqtt5-user-properties"`: A JSON string that contains an array of JSON objects. If
you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64
format before adding it to the HTTP header. userProperties is an HTTP header value in the
API. The following example userProperties parameter is a JSON string which represents two
User Properties. Note that it needs to be base64-encoded: [{\"deviceName\": \"alpha\"},
{\"deviceCnt\": \"45\"}]
"""
function publish(topic; aws_config::AbstractAWSConfig=global_aws_config())
return iot_data_plane(
"POST", "/topics/$(topic)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function publish(
topic, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_data_plane(
"POST",
"/topics/$(topic)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_thing_shadow(payload, thing_name)
update_thing_shadow(payload, thing_name, params::Dict{String,<:Any})
Updates the shadow for the specified thing. Requires permission to access the
UpdateThingShadow action. For more information, see UpdateThingShadow in the IoT Developer
Guide.
# Arguments
- `payload`: The state information, in JSON format.
- `thing_name`: The name of the thing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"name"`: The name of the shadow.
"""
function update_thing_shadow(
payload, thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_data_plane(
"POST",
"/things/$(thingName)/shadow",
Dict{String,Any}("payload" => payload);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_thing_shadow(
payload,
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_data_plane(
"POST",
"/things/$(thingName)/shadow",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("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 | 32464 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iot_events
using AWS.Compat
using AWS.UUIDs
"""
create_alarm_model(alarm_model_name, alarm_rule, role_arn)
create_alarm_model(alarm_model_name, alarm_rule, role_arn, params::Dict{String,<:Any})
Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm
to get notified when the value is outside a specified range. For more information, see
Create an alarm model in the AWS IoT Events Developer Guide.
# Arguments
- `alarm_model_name`: A unique name that helps you identify the alarm model. You can't
change this name after you create the alarm model.
- `alarm_rule`: Defines when your alarm is invoked.
- `role_arn`: The ARN of the IAM role that allows the alarm to perform actions and access
AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General
Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alarmCapabilities"`: Contains the configuration information of alarm state changes.
- `"alarmEventActions"`: Contains information about one or more alarm actions.
- `"alarmModelDescription"`: A description that tells you what the alarm model detects.
- `"alarmNotification"`: Contains information about one or more notification actions.
- `"key"`: An input attribute used as a key to create an alarm. AWS IoT Events routes
inputs associated with this key to the alarm.
- `"severity"`: A non-negative integer that reflects the severity level of the alarm.
- `"tags"`: A list of key-value pairs that contain metadata for the alarm model. The tags
help you manage the alarm model. For more information, see Tagging your AWS IoT Events
resources in the AWS IoT Events Developer Guide. You can create up to 50 tags for one alarm
model.
"""
function create_alarm_model(
alarmModelName, alarmRule, roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"POST",
"/alarm-models",
Dict{String,Any}(
"alarmModelName" => alarmModelName,
"alarmRule" => alarmRule,
"roleArn" => roleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_alarm_model(
alarmModelName,
alarmRule,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"POST",
"/alarm-models",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"alarmModelName" => alarmModelName,
"alarmRule" => alarmRule,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_detector_model(detector_model_definition, detector_model_name, role_arn)
create_detector_model(detector_model_definition, detector_model_name, role_arn, params::Dict{String,<:Any})
Creates a detector model.
# Arguments
- `detector_model_definition`: Information that defines how the detectors operate.
- `detector_model_name`: The name of the detector model.
- `role_arn`: The ARN of the role that grants permission to AWS IoT Events to perform its
operations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"detectorModelDescription"`: A brief description of the detector model.
- `"evaluationMethod"`: Information about the order in which events are evaluated and how
actions are executed.
- `"key"`: The input attribute key used to identify a device or system to create a detector
(an instance of the detector model) and then to route each input received to the
appropriate detector (instance). This parameter uses a JSON-path expression in the message
payload of each input to specify the attribute-value pair that is used to identify the
device associated with the input.
- `"tags"`: Metadata that can be used to manage the detector model.
"""
function create_detector_model(
detectorModelDefinition,
detectorModelName,
roleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"POST",
"/detector-models",
Dict{String,Any}(
"detectorModelDefinition" => detectorModelDefinition,
"detectorModelName" => detectorModelName,
"roleArn" => roleArn,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_detector_model(
detectorModelDefinition,
detectorModelName,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"POST",
"/detector-models",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorModelDefinition" => detectorModelDefinition,
"detectorModelName" => detectorModelName,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_input(input_definition, input_name)
create_input(input_definition, input_name, params::Dict{String,<:Any})
Creates an input.
# Arguments
- `input_definition`: The definition of the input.
- `input_name`: The name you want to give to the input.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"inputDescription"`: A brief description of the input.
- `"tags"`: Metadata that can be used to manage the input.
"""
function create_input(
inputDefinition, inputName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"POST",
"/inputs",
Dict{String,Any}("inputDefinition" => inputDefinition, "inputName" => inputName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_input(
inputDefinition,
inputName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"POST",
"/inputs",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"inputDefinition" => inputDefinition, "inputName" => inputName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_alarm_model(alarm_model_name)
delete_alarm_model(alarm_model_name, params::Dict{String,<:Any})
Deletes an alarm model. Any alarm instances that were created based on this alarm model are
also deleted. This action can't be undone.
# Arguments
- `alarm_model_name`: The name of the alarm model.
"""
function delete_alarm_model(
alarmModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"DELETE",
"/alarm-models/$(alarmModelName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_alarm_model(
alarmModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"DELETE",
"/alarm-models/$(alarmModelName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_detector_model(detector_model_name)
delete_detector_model(detector_model_name, params::Dict{String,<:Any})
Deletes a detector model. Any active instances of the detector model are also deleted.
# Arguments
- `detector_model_name`: The name of the detector model to be deleted.
"""
function delete_detector_model(
detectorModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"DELETE",
"/detector-models/$(detectorModelName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_detector_model(
detectorModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"DELETE",
"/detector-models/$(detectorModelName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_input(input_name)
delete_input(input_name, params::Dict{String,<:Any})
Deletes an input.
# Arguments
- `input_name`: The name of the input to delete.
"""
function delete_input(inputName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events(
"DELETE",
"/inputs/$(inputName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_input(
inputName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"DELETE",
"/inputs/$(inputName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_alarm_model(alarm_model_name)
describe_alarm_model(alarm_model_name, params::Dict{String,<:Any})
Retrieves information about an alarm model. If you don't specify a value for the
alarmModelVersion parameter, the latest version is returned.
# Arguments
- `alarm_model_name`: The name of the alarm model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The version of the alarm model.
"""
function describe_alarm_model(
alarmModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"GET",
"/alarm-models/$(alarmModelName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_alarm_model(
alarmModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"GET",
"/alarm-models/$(alarmModelName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_detector_model(detector_model_name)
describe_detector_model(detector_model_name, params::Dict{String,<:Any})
Describes a detector model. If the version parameter is not specified, information about
the latest version is returned.
# Arguments
- `detector_model_name`: The name of the detector model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"version"`: The version of the detector model.
"""
function describe_detector_model(
detectorModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"GET",
"/detector-models/$(detectorModelName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_detector_model(
detectorModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"GET",
"/detector-models/$(detectorModelName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_detector_model_analysis(analysis_id)
describe_detector_model_analysis(analysis_id, params::Dict{String,<:Any})
Retrieves runtime information about a detector model analysis. After AWS IoT Events starts
analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
# Arguments
- `analysis_id`: The ID of the analysis result that you want to retrieve.
"""
function describe_detector_model_analysis(
analysisId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"GET",
"/analysis/detector-models/$(analysisId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_detector_model_analysis(
analysisId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"GET",
"/analysis/detector-models/$(analysisId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_input(input_name)
describe_input(input_name, params::Dict{String,<:Any})
Describes an input.
# Arguments
- `input_name`: The name of the input.
"""
function describe_input(inputName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events(
"GET",
"/inputs/$(inputName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_input(
inputName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"GET",
"/inputs/$(inputName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_logging_options()
describe_logging_options(params::Dict{String,<:Any})
Retrieves the current settings of the AWS IoT Events logging options.
"""
function describe_logging_options(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events(
"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 iot_events(
"GET", "/logging", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_detector_model_analysis_results(analysis_id)
get_detector_model_analysis_results(analysis_id, params::Dict{String,<:Any})
Retrieves one or more analysis results of the detector model. After AWS IoT Events starts
analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
# Arguments
- `analysis_id`: The ID of the analysis result that you want to retrieve.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per request.
- `"nextToken"`: The token that you can use to return the next set of results.
"""
function get_detector_model_analysis_results(
analysisId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"GET",
"/analysis/detector-models/$(analysisId)/results";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_detector_model_analysis_results(
analysisId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"GET",
"/analysis/detector-models/$(analysisId)/results",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_alarm_model_versions(alarm_model_name)
list_alarm_model_versions(alarm_model_name, params::Dict{String,<:Any})
Lists all the versions of an alarm model. The operation returns only the metadata
associated with each alarm model version.
# Arguments
- `alarm_model_name`: The name of the alarm model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per request.
- `"nextToken"`: The token that you can use to return the next set of results.
"""
function list_alarm_model_versions(
alarmModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"GET",
"/alarm-models/$(alarmModelName)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_alarm_model_versions(
alarmModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"GET",
"/alarm-models/$(alarmModelName)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_alarm_models()
list_alarm_models(params::Dict{String,<:Any})
Lists the alarm models that you created. The operation returns only the metadata associated
with each alarm model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per request.
- `"nextToken"`: The token that you can use to return the next set of results.
"""
function list_alarm_models(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events(
"GET", "/alarm-models"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_alarm_models(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"GET",
"/alarm-models",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_detector_model_versions(detector_model_name)
list_detector_model_versions(detector_model_name, params::Dict{String,<:Any})
Lists all the versions of a detector model. Only the metadata associated with each detector
model version is returned.
# Arguments
- `detector_model_name`: The name of the detector model whose versions are returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per request.
- `"nextToken"`: The token that you can use to return the next set of results.
"""
function list_detector_model_versions(
detectorModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"GET",
"/detector-models/$(detectorModelName)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_detector_model_versions(
detectorModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"GET",
"/detector-models/$(detectorModelName)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_detector_models()
list_detector_models(params::Dict{String,<:Any})
Lists the detector models you have created. Only the metadata associated with each detector
model is returned.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per request.
- `"nextToken"`: The token that you can use to return the next set of results.
"""
function list_detector_models(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events(
"GET", "/detector-models"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_detector_models(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"GET",
"/detector-models",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_input_routings(input_identifier)
list_input_routings(input_identifier, params::Dict{String,<:Any})
Lists one or more input routings.
# Arguments
- `input_identifier`: The identifer of the routed input.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per request.
- `"nextToken"`: The token that you can use to return the next set of results.
"""
function list_input_routings(
inputIdentifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"POST",
"/input-routings",
Dict{String,Any}("inputIdentifier" => inputIdentifier);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_input_routings(
inputIdentifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"POST",
"/input-routings",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("inputIdentifier" => inputIdentifier), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_inputs()
list_inputs(params::Dict{String,<:Any})
Lists the inputs you have created.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per request.
- `"nextToken"`: The token that you can use to return the next set of results.
"""
function list_inputs(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events(
"GET", "/inputs"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_inputs(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"GET", "/inputs", 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 iot_events(
"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 iot_events(
"GET",
"/tags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), 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 or updates the AWS IoT Events logging options. If you update the value of any
loggingOptions field, it takes up to one minute for the change to take effect. If you
change the policy attached to the role you specified in the roleArn field (for example, to
correct an invalid policy), it takes up to five minutes for that change to take effect.
# Arguments
- `logging_options`: The new values of the AWS IoT Events logging options.
"""
function put_logging_options(
loggingOptions; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"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 iot_events(
"PUT",
"/logging",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("loggingOptions" => loggingOptions), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_detector_model_analysis(detector_model_definition)
start_detector_model_analysis(detector_model_definition, params::Dict{String,<:Any})
Performs an analysis of your detector model. For more information, see Troubleshooting a
detector model in the AWS IoT Events Developer Guide.
# Arguments
- `detector_model_definition`:
"""
function start_detector_model_analysis(
detectorModelDefinition; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"POST",
"/analysis/detector-models/",
Dict{String,Any}("detectorModelDefinition" => detectorModelDefinition);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_detector_model_analysis(
detectorModelDefinition,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"POST",
"/analysis/detector-models/",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("detectorModelDefinition" => detectorModelDefinition),
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 that 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 iot_events(
"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 iot_events(
"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 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 iot_events(
"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 iot_events(
"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_alarm_model(alarm_model_name, alarm_rule, role_arn)
update_alarm_model(alarm_model_name, alarm_rule, role_arn, params::Dict{String,<:Any})
Updates an alarm model. Any alarms that were created based on the previous version are
deleted and then created again as new data arrives.
# Arguments
- `alarm_model_name`: The name of the alarm model.
- `alarm_rule`: Defines when your alarm is invoked.
- `role_arn`: The ARN of the IAM role that allows the alarm to perform actions and access
AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General
Reference.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"alarmCapabilities"`: Contains the configuration information of alarm state changes.
- `"alarmEventActions"`: Contains information about one or more alarm actions.
- `"alarmModelDescription"`: The description of the alarm model.
- `"alarmNotification"`: Contains information about one or more notification actions.
- `"severity"`: A non-negative integer that reflects the severity level of the alarm.
"""
function update_alarm_model(
alarmModelName, alarmRule, roleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"POST",
"/alarm-models/$(alarmModelName)",
Dict{String,Any}("alarmRule" => alarmRule, "roleArn" => roleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_alarm_model(
alarmModelName,
alarmRule,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"POST",
"/alarm-models/$(alarmModelName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("alarmRule" => alarmRule, "roleArn" => roleArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_detector_model(detector_model_definition, detector_model_name, role_arn)
update_detector_model(detector_model_definition, detector_model_name, role_arn, params::Dict{String,<:Any})
Updates a detector model. Detectors (instances) spawned by the previous version are deleted
and then re-created as new inputs arrive.
# Arguments
- `detector_model_definition`: Information that defines how a detector operates.
- `detector_model_name`: The name of the detector model that is updated.
- `role_arn`: The ARN of the role that grants permission to AWS IoT Events to perform its
operations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"detectorModelDescription"`: A brief description of the detector model.
- `"evaluationMethod"`: Information about the order in which events are evaluated and how
actions are executed.
"""
function update_detector_model(
detectorModelDefinition,
detectorModelName,
roleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"POST",
"/detector-models/$(detectorModelName)",
Dict{String,Any}(
"detectorModelDefinition" => detectorModelDefinition, "roleArn" => roleArn
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_detector_model(
detectorModelDefinition,
detectorModelName,
roleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"POST",
"/detector-models/$(detectorModelName)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"detectorModelDefinition" => detectorModelDefinition,
"roleArn" => roleArn,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_input(input_definition, input_name)
update_input(input_definition, input_name, params::Dict{String,<:Any})
Updates an input.
# Arguments
- `input_definition`: The definition of the input.
- `input_name`: The name of the input you want to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"inputDescription"`: A brief description of the input.
"""
function update_input(
inputDefinition, inputName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events(
"PUT",
"/inputs/$(inputName)",
Dict{String,Any}("inputDefinition" => inputDefinition);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_input(
inputDefinition,
inputName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events(
"PUT",
"/inputs/$(inputName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("inputDefinition" => inputDefinition), 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 | 14244 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iot_events_data
using AWS.Compat
using AWS.UUIDs
"""
batch_acknowledge_alarm(acknowledge_action_requests)
batch_acknowledge_alarm(acknowledge_action_requests, params::Dict{String,<:Any})
Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you
acknowledge them.
# Arguments
- `acknowledge_action_requests`: The list of acknowledge action requests. You can specify
up to 10 requests per operation.
"""
function batch_acknowledge_alarm(
acknowledgeActionRequests; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events_data(
"POST",
"/alarms/acknowledge",
Dict{String,Any}("acknowledgeActionRequests" => acknowledgeActionRequests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_acknowledge_alarm(
acknowledgeActionRequests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"POST",
"/alarms/acknowledge",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("acknowledgeActionRequests" => acknowledgeActionRequests),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_detector(detectors)
batch_delete_detector(detectors, params::Dict{String,<:Any})
Deletes one or more detectors that were created. When a detector is deleted, its state will
be cleared and the detector will be removed from the list of detectors. The deleted
detector will no longer appear if referenced in the ListDetectors API call.
# Arguments
- `detectors`: The list of one or more detectors to be deleted.
"""
function batch_delete_detector(detectors; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events_data(
"POST",
"/detectors/delete",
Dict{String,Any}("detectors" => detectors);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_detector(
detectors,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"POST",
"/detectors/delete",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("detectors" => detectors), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_disable_alarm(disable_action_requests)
batch_disable_alarm(disable_action_requests, params::Dict{String,<:Any})
Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
# Arguments
- `disable_action_requests`: The list of disable action requests. You can specify up to 10
requests per operation.
"""
function batch_disable_alarm(
disableActionRequests; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events_data(
"POST",
"/alarms/disable",
Dict{String,Any}("disableActionRequests" => disableActionRequests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_disable_alarm(
disableActionRequests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"POST",
"/alarms/disable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("disableActionRequests" => disableActionRequests),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_enable_alarm(enable_action_requests)
batch_enable_alarm(enable_action_requests, params::Dict{String,<:Any})
Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
# Arguments
- `enable_action_requests`: The list of enable action requests. You can specify up to 10
requests per operation.
"""
function batch_enable_alarm(
enableActionRequests; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events_data(
"POST",
"/alarms/enable",
Dict{String,Any}("enableActionRequests" => enableActionRequests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_enable_alarm(
enableActionRequests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"POST",
"/alarms/enable",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("enableActionRequests" => enableActionRequests),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_put_message(messages)
batch_put_message(messages, params::Dict{String,<:Any})
Sends a set of messages to the IoT Events system. Each message payload is transformed into
the input you specify (\"inputName\") and ingested into any detectors that monitor that
input. If multiple messages are sent, the order in which the messages are processed isn't
guaranteed. To guarantee ordering, you must send messages one at a time and wait for a
successful response.
# Arguments
- `messages`: The list of messages to send. Each message has the following format: '{
\"messageId\": \"string\", \"inputName\": \"string\", \"payload\": \"string\"}'
"""
function batch_put_message(messages; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events_data(
"POST",
"/inputs/messages",
Dict{String,Any}("messages" => messages);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_message(
messages,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"POST",
"/inputs/messages",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("messages" => messages), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_reset_alarm(reset_action_requests)
batch_reset_alarm(reset_action_requests, params::Dict{String,<:Any})
Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
# Arguments
- `reset_action_requests`: The list of reset action requests. You can specify up to 10
requests per operation.
"""
function batch_reset_alarm(
resetActionRequests; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events_data(
"POST",
"/alarms/reset",
Dict{String,Any}("resetActionRequests" => resetActionRequests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_reset_alarm(
resetActionRequests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"POST",
"/alarms/reset",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("resetActionRequests" => resetActionRequests),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_snooze_alarm(snooze_action_requests)
batch_snooze_alarm(snooze_action_requests, params::Dict{String,<:Any})
Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED
state after you set them to the snooze mode.
# Arguments
- `snooze_action_requests`: The list of snooze action requests. You can specify up to 10
requests per operation.
"""
function batch_snooze_alarm(
snoozeActionRequests; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events_data(
"POST",
"/alarms/snooze",
Dict{String,Any}("snoozeActionRequests" => snoozeActionRequests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_snooze_alarm(
snoozeActionRequests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"POST",
"/alarms/snooze",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("snoozeActionRequests" => snoozeActionRequests),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_update_detector(detectors)
batch_update_detector(detectors, params::Dict{String,<:Any})
Updates the state, variable values, and timer settings of one or more detectors (instances)
of a specified detector model.
# Arguments
- `detectors`: The list of detectors (instances) to update, along with the values to update.
"""
function batch_update_detector(detectors; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events_data(
"POST",
"/detectors",
Dict{String,Any}("detectors" => detectors);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_update_detector(
detectors,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"POST",
"/detectors",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("detectors" => detectors), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_alarm(alarm_model_name)
describe_alarm(alarm_model_name, params::Dict{String,<:Any})
Retrieves information about an alarm.
# Arguments
- `alarm_model_name`: The name of the alarm model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"keyValue"`: The value of the key used as a filter to select only the alarms associated
with the key.
"""
function describe_alarm(alarmModelName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events_data(
"GET",
"/alarms/$(alarmModelName)/keyValues/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_alarm(
alarmModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"GET",
"/alarms/$(alarmModelName)/keyValues/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_detector(detector_model_name)
describe_detector(detector_model_name, params::Dict{String,<:Any})
Returns information about the specified detector (instance).
# Arguments
- `detector_model_name`: The name of the detector model whose detectors (instances) you
want information about.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"keyValue"`: A filter used to limit results to detectors (instances) created because of
the given key ID.
"""
function describe_detector(
detectorModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events_data(
"GET",
"/detectors/$(detectorModelName)/keyValues/";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_detector(
detectorModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"GET",
"/detectors/$(detectorModelName)/keyValues/",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_alarms(alarm_model_name)
list_alarms(alarm_model_name, params::Dict{String,<:Any})
Lists one or more alarms. The operation returns only the metadata associated with each
alarm.
# Arguments
- `alarm_model_name`: The name of the alarm model.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per request.
- `"nextToken"`: The token that you can use to return the next set of results.
"""
function list_alarms(alarmModelName; aws_config::AbstractAWSConfig=global_aws_config())
return iot_events_data(
"GET",
"/alarms/$(alarmModelName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_alarms(
alarmModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"GET",
"/alarms/$(alarmModelName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_detectors(detector_model_name)
list_detectors(detector_model_name, params::Dict{String,<:Any})
Lists detectors (the instances of a detector model).
# Arguments
- `detector_model_name`: The name of the detector model whose detectors (instances) are
listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: The maximum number of results to be returned per request.
- `"nextToken"`: The token that you can use to return the next set of results.
- `"stateName"`: A filter that limits results to those detectors (instances) in the given
state.
"""
function list_detectors(
detectorModelName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_events_data(
"GET",
"/detectors/$(detectorModelName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_detectors(
detectorModelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_events_data(
"GET",
"/detectors/$(detectorModelName)",
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 | 7136 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iot_jobs_data_plane
using AWS.Compat
using AWS.UUIDs
"""
describe_job_execution(job_id, thing_name)
describe_job_execution(job_id, thing_name, params::Dict{String,<:Any})
Gets details of a job execution.
# Arguments
- `job_id`: The unique identifier assigned to this job when it was created.
- `thing_name`: The thing name associated with the device the job execution is running on.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"executionNumber"`: Optional. A number that identifies a particular job execution on a
particular device. If not specified, the latest job execution is returned.
- `"includeJobDocument"`: Optional. When set to true, the response contains the job
document. The default is false.
"""
function describe_job_execution(
jobId, thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_jobs_data_plane(
"GET",
"/things/$(thingName)/jobs/$(jobId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_job_execution(
jobId,
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_jobs_data_plane(
"GET",
"/things/$(thingName)/jobs/$(jobId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_pending_job_executions(thing_name)
get_pending_job_executions(thing_name, params::Dict{String,<:Any})
Gets the list of all jobs for a thing that are not in a terminal status.
# Arguments
- `thing_name`: The name of the thing that is executing the job.
"""
function get_pending_job_executions(
thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_jobs_data_plane(
"GET",
"/things/$(thingName)/jobs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_pending_job_executions(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_jobs_data_plane(
"GET",
"/things/$(thingName)/jobs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_next_pending_job_execution(thing_name)
start_next_pending_job_execution(thing_name, params::Dict{String,<:Any})
Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
# Arguments
- `thing_name`: The name of the thing associated with the device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"statusDetails"`: A collection of name/value pairs that describe the status of the job
execution. If not specified, the statusDetails are unchanged.
- `"stepTimeoutInMinutes"`: Specifies the amount of time this device has to finish
execution of this job. If the job execution status is not set to a terminal state before
this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting
the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes)
the job execution status will be automatically set to TIMED_OUT. Note that setting this
timeout has no effect on that job execution timeout which may have been specified when the
job was created (CreateJob using field timeoutConfig).
"""
function start_next_pending_job_execution(
thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_jobs_data_plane(
"PUT",
"/things/$(thingName)/jobs/$next";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_next_pending_job_execution(
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_jobs_data_plane(
"PUT",
"/things/$(thingName)/jobs/$next",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_job_execution(job_id, status, thing_name)
update_job_execution(job_id, status, thing_name, params::Dict{String,<:Any})
Updates the status of a job execution.
# Arguments
- `job_id`: The unique identifier assigned to this job when it was created.
- `status`: The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or
REJECTED). This must be specified on every update.
- `thing_name`: The name of the thing associated with the device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"executionNumber"`: Optional. A number that identifies a particular job execution on a
particular device.
- `"expectedVersion"`: Optional. The expected current version of the job execution. Each
time you update the job execution, its version is incremented. If the version of the job
execution stored in Jobs does not match, the update is rejected with a VersionMismatch
error, and an ErrorResponse that contains the current job execution status data is
returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in
order to obtain the job execution status data.)
- `"includeJobDocument"`: Optional. When set to true, the response contains the job
document. The default is false.
- `"includeJobExecutionState"`: Optional. When included and set to true, the response
contains the JobExecutionState data. The default is false.
- `"statusDetails"`: Optional. A collection of name/value pairs that describe the status
of the job execution. If not specified, the statusDetails are unchanged.
- `"stepTimeoutInMinutes"`: Specifies the amount of time this device has to finish
execution of this job. If the job execution status is not set to a terminal state before
this timer expires, or before the timer is reset (by again calling UpdateJobExecution,
setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job
execution status will be automatically set to TIMED_OUT. Note that setting or resetting
this timeout has no effect on that job execution timeout which may have been specified when
the job was created (CreateJob using field timeoutConfig).
"""
function update_job_execution(
jobId, status, thingName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_jobs_data_plane(
"POST",
"/things/$(thingName)/jobs/$(jobId)",
Dict{String,Any}("status" => status);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_job_execution(
jobId,
status,
thingName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_jobs_data_plane(
"POST",
"/things/$(thingName)/jobs/$(jobId)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("status" => status), 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 | 131985 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iot_wireless
using AWS.Compat
using AWS.UUIDs
"""
associate_aws_account_with_partner_account(sidewalk)
associate_aws_account_with_partner_account(sidewalk, params::Dict{String,<:Any})
Associates a partner account with your AWS account.
# Arguments
- `sidewalk`: The Sidewalk account credentials.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Each resource must have a unique client request token. The client
token is used to implement idempotency. It ensures that the request completes no more than
one time. If you retry a request with the same token and the same parameters, the request
will complete successfully. However, if you try to create a new resource using the same
token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS
SDKs will automatically generate a unique client request. For more information about
idempotency, see Ensuring idempotency in Amazon EC2 API requests.
- `"Tags"`: The tags to attach to the specified resource. Tags are metadata that you can
use to manage a resource.
"""
function associate_aws_account_with_partner_account(
Sidewalk; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/partner-accounts",
Dict{String,Any}("Sidewalk" => Sidewalk, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_aws_account_with_partner_account(
Sidewalk,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/partner-accounts",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Sidewalk" => Sidewalk, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_multicast_group_with_fuota_task(id, multicast_group_id)
associate_multicast_group_with_fuota_task(id, multicast_group_id, params::Dict{String,<:Any})
Associate a multicast group with a FUOTA task.
# Arguments
- `id`:
- `multicast_group_id`:
"""
function associate_multicast_group_with_fuota_task(
Id, MulticastGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PUT",
"/fuota-tasks/$(Id)/multicast-group",
Dict{String,Any}("MulticastGroupId" => MulticastGroupId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_multicast_group_with_fuota_task(
Id,
MulticastGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PUT",
"/fuota-tasks/$(Id)/multicast-group",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("MulticastGroupId" => MulticastGroupId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_wireless_device_with_fuota_task(id, wireless_device_id)
associate_wireless_device_with_fuota_task(id, wireless_device_id, params::Dict{String,<:Any})
Associate a wireless device with a FUOTA task.
# Arguments
- `id`:
- `wireless_device_id`:
"""
function associate_wireless_device_with_fuota_task(
Id, WirelessDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PUT",
"/fuota-tasks/$(Id)/wireless-device",
Dict{String,Any}("WirelessDeviceId" => WirelessDeviceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_wireless_device_with_fuota_task(
Id,
WirelessDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PUT",
"/fuota-tasks/$(Id)/wireless-device",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WirelessDeviceId" => WirelessDeviceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_wireless_device_with_multicast_group(id, wireless_device_id)
associate_wireless_device_with_multicast_group(id, wireless_device_id, params::Dict{String,<:Any})
Associates a wireless device with a multicast group.
# Arguments
- `id`:
- `wireless_device_id`:
"""
function associate_wireless_device_with_multicast_group(
Id, WirelessDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PUT",
"/multicast-groups/$(Id)/wireless-device",
Dict{String,Any}("WirelessDeviceId" => WirelessDeviceId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_wireless_device_with_multicast_group(
Id,
WirelessDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PUT",
"/multicast-groups/$(Id)/wireless-device",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("WirelessDeviceId" => WirelessDeviceId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_wireless_device_with_thing(id, thing_arn)
associate_wireless_device_with_thing(id, thing_arn, params::Dict{String,<:Any})
Associates a wireless device with a thing.
# Arguments
- `id`: The ID of the resource to update.
- `thing_arn`: The ARN of the thing to associate with the wireless device.
"""
function associate_wireless_device_with_thing(
Id, ThingArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PUT",
"/wireless-devices/$(Id)/thing",
Dict{String,Any}("ThingArn" => ThingArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_wireless_device_with_thing(
Id,
ThingArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PUT",
"/wireless-devices/$(Id)/thing",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ThingArn" => ThingArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_wireless_gateway_with_certificate(id, iot_certificate_id)
associate_wireless_gateway_with_certificate(id, iot_certificate_id, params::Dict{String,<:Any})
Associates a wireless gateway with a certificate.
# Arguments
- `id`: The ID of the resource to update.
- `iot_certificate_id`: The ID of the certificate to associate with the wireless gateway.
"""
function associate_wireless_gateway_with_certificate(
Id, IotCertificateId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PUT",
"/wireless-gateways/$(Id)/certificate",
Dict{String,Any}("IotCertificateId" => IotCertificateId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_wireless_gateway_with_certificate(
Id,
IotCertificateId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PUT",
"/wireless-gateways/$(Id)/certificate",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("IotCertificateId" => IotCertificateId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_wireless_gateway_with_thing(id, thing_arn)
associate_wireless_gateway_with_thing(id, thing_arn, params::Dict{String,<:Any})
Associates a wireless gateway with a thing.
# Arguments
- `id`: The ID of the resource to update.
- `thing_arn`: The ARN of the thing to associate with the wireless gateway.
"""
function associate_wireless_gateway_with_thing(
Id, ThingArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PUT",
"/wireless-gateways/$(Id)/thing",
Dict{String,Any}("ThingArn" => ThingArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_wireless_gateway_with_thing(
Id,
ThingArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PUT",
"/wireless-gateways/$(Id)/thing",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("ThingArn" => ThingArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_multicast_group_session(id)
cancel_multicast_group_session(id, params::Dict{String,<:Any})
Cancels an existing multicast group session.
# Arguments
- `id`:
"""
function cancel_multicast_group_session(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/multicast-groups/$(Id)/session";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_multicast_group_session(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/multicast-groups/$(Id)/session",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_destination(expression, expression_type, name, role_arn)
create_destination(expression, expression_type, name, role_arn, params::Dict{String,<:Any})
Creates a new destination that maps a device message to an AWS IoT rule.
# Arguments
- `expression`: The rule name or topic rule to send messages to.
- `expression_type`: The type of value in Expression.
- `name`: The name of the new resource.
- `role_arn`: The ARN of the IAM Role that authorizes the destination.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Each resource must have a unique client request token. The client
token is used to implement idempotency. It ensures that the request completes no more than
one time. If you retry a request with the same token and the same parameters, the request
will complete successfully. However, if you try to create a new resource using the same
token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS
SDKs will automatically generate a unique client request. For more information about
idempotency, see Ensuring idempotency in Amazon EC2 API requests.
- `"Description"`: The description of the new resource.
- `"Tags"`: The tags to attach to the new destination. Tags are metadata that you can use
to manage a resource.
"""
function create_destination(
Expression,
ExpressionType,
Name,
RoleArn;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/destinations",
Dict{String,Any}(
"Expression" => Expression,
"ExpressionType" => ExpressionType,
"Name" => Name,
"RoleArn" => RoleArn,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_destination(
Expression,
ExpressionType,
Name,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/destinations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"Expression" => Expression,
"ExpressionType" => ExpressionType,
"Name" => Name,
"RoleArn" => RoleArn,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_device_profile()
create_device_profile(params::Dict{String,<:Any})
Creates a new device profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Each resource must have a unique client request token. The client
token is used to implement idempotency. It ensures that the request completes no more than
one time. If you retry a request with the same token and the same parameters, the request
will complete successfully. However, if you try to create a new resource using the same
token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS
SDKs will automatically generate a unique client request. For more information about
idempotency, see Ensuring idempotency in Amazon EC2 API requests.
- `"LoRaWAN"`: The device profile information to use to create the device profile.
- `"Name"`: The name of the new resource.
- `"Sidewalk"`: The Sidewalk-related information for creating the Sidewalk device profile.
- `"Tags"`: The tags to attach to the new device profile. Tags are metadata that you can
use to manage a resource.
"""
function create_device_profile(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"POST",
"/device-profiles",
Dict{String,Any}("ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_device_profile(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/device-profiles",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_fuota_task(firmware_update_image, firmware_update_role)
create_fuota_task(firmware_update_image, firmware_update_role, params::Dict{String,<:Any})
Creates a FUOTA task.
# Arguments
- `firmware_update_image`:
- `firmware_update_role`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"Description"`:
- `"FragmentIntervalMS"`:
- `"FragmentSizeBytes"`:
- `"LoRaWAN"`:
- `"Name"`:
- `"RedundancyPercent"`:
- `"Tags"`:
"""
function create_fuota_task(
FirmwareUpdateImage,
FirmwareUpdateRole;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/fuota-tasks",
Dict{String,Any}(
"FirmwareUpdateImage" => FirmwareUpdateImage,
"FirmwareUpdateRole" => FirmwareUpdateRole,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_fuota_task(
FirmwareUpdateImage,
FirmwareUpdateRole,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/fuota-tasks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"FirmwareUpdateImage" => FirmwareUpdateImage,
"FirmwareUpdateRole" => FirmwareUpdateRole,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_multicast_group(lo_ra_wan)
create_multicast_group(lo_ra_wan, params::Dict{String,<:Any})
Creates a multicast group.
# Arguments
- `lo_ra_wan`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Each resource must have a unique client request token. The client
token is used to implement idempotency. It ensures that the request completes no more than
one time. If you retry a request with the same token and the same parameters, the request
will complete successfully. However, if you try to create a new resource using the same
token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS
SDKs will automatically generate a unique client request. For more information about
idempotency, see Ensuring idempotency in Amazon EC2 API requests.
- `"Description"`: The description of the multicast group.
- `"Name"`:
- `"Tags"`:
"""
function create_multicast_group(LoRaWAN; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"POST",
"/multicast-groups",
Dict{String,Any}("LoRaWAN" => LoRaWAN, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_multicast_group(
LoRaWAN, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/multicast-groups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoRaWAN" => LoRaWAN, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_network_analyzer_configuration(name)
create_network_analyzer_configuration(name, params::Dict{String,<:Any})
Creates a new network analyzer configuration.
# Arguments
- `name`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"Description"`:
- `"MulticastGroups"`: Multicast Group resources to add to the network analyzer
configruation. Provide the MulticastGroupId of the resource to add in the input array.
- `"Tags"`:
- `"TraceContent"`:
- `"WirelessDevices"`: Wireless device resources to add to the network analyzer
configuration. Provide the WirelessDeviceId of the resource to add in the input array.
- `"WirelessGateways"`: Wireless gateway resources to add to the network analyzer
configuration. Provide the WirelessGatewayId of the resource to add in the input array.
"""
function create_network_analyzer_configuration(
Name; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/network-analyzer-configurations",
Dict{String,Any}("Name" => Name, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_network_analyzer_configuration(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/network-analyzer-configurations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Name" => Name, "ClientRequestToken" => string(uuid4())),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_service_profile()
create_service_profile(params::Dict{String,<:Any})
Creates a new service profile.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Each resource must have a unique client request token. The client
token is used to implement idempotency. It ensures that the request completes no more than
one time. If you retry a request with the same token and the same parameters, the request
will complete successfully. However, if you try to create a new resource using the same
token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS
SDKs will automatically generate a unique client request. For more information about
idempotency, see Ensuring idempotency in Amazon EC2 API requests.
- `"LoRaWAN"`: The service profile information to use to create the service profile.
- `"Name"`: The name of the new resource.
- `"Tags"`: The tags to attach to the new service profile. Tags are metadata that you can
use to manage a resource.
"""
function create_service_profile(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"POST",
"/service-profiles",
Dict{String,Any}("ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_service_profile(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/service-profiles",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("ClientRequestToken" => string(uuid4())), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_wireless_device(destination_name, type)
create_wireless_device(destination_name, type, params::Dict{String,<:Any})
Provisions a wireless device.
# Arguments
- `destination_name`: The name of the destination to assign to the new wireless device.
- `type`: The wireless device type.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Each resource must have a unique client request token. The client
token is used to implement idempotency. It ensures that the request completes no more than
one time. If you retry a request with the same token and the same parameters, the request
will complete successfully. However, if you try to create a new resource using the same
token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS
SDKs will automatically generate a unique client request. For more information about
idempotency, see Ensuring idempotency in Amazon EC2 API requests.
- `"Description"`: The description of the new resource.
- `"LoRaWAN"`: The device configuration information to use to create the wireless device.
- `"Name"`: The name of the new resource.
- `"Positioning"`: FPort values for the GNSS, stream, and ClockSync functions of the
positioning information.
- `"Sidewalk"`: The device configuration information to use to create the Sidewalk device.
- `"Tags"`: The tags to attach to the new wireless device. Tags are metadata that you can
use to manage a resource.
"""
function create_wireless_device(
DestinationName, Type; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/wireless-devices",
Dict{String,Any}(
"DestinationName" => DestinationName,
"Type" => Type,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_wireless_device(
DestinationName,
Type,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/wireless-devices",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationName" => DestinationName,
"Type" => Type,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_wireless_gateway(lo_ra_wan)
create_wireless_gateway(lo_ra_wan, params::Dict{String,<:Any})
Provisions a wireless gateway. When provisioning a wireless gateway, you might run into
duplication errors for the following reasons. If you specify a GatewayEui value that
already exists. If you used a ClientRequestToken with the same parameters within the last
10 minutes. To avoid this error, make sure that you use unique identifiers and parameters
for each request within the specified time period.
# Arguments
- `lo_ra_wan`: The gateway configuration information to use to create the wireless gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Each resource must have a unique client request token. The client
token is used to implement idempotency. It ensures that the request completes no more than
one time. If you retry a request with the same token and the same parameters, the request
will complete successfully. However, if you try to create a new resource using the same
token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS
SDKs will automatically generate a unique client request. For more information about
idempotency, see Ensuring idempotency in Amazon EC2 API requests.
- `"Description"`: The description of the new resource.
- `"Name"`: The name of the new resource.
- `"Tags"`: The tags to attach to the new wireless gateway. Tags are metadata that you can
use to manage a resource.
"""
function create_wireless_gateway(LoRaWAN; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"POST",
"/wireless-gateways",
Dict{String,Any}("LoRaWAN" => LoRaWAN, "ClientRequestToken" => string(uuid4()));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_wireless_gateway(
LoRaWAN, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/wireless-gateways",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"LoRaWAN" => LoRaWAN, "ClientRequestToken" => string(uuid4())
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_wireless_gateway_task(id, wireless_gateway_task_definition_id)
create_wireless_gateway_task(id, wireless_gateway_task_definition_id, params::Dict{String,<:Any})
Creates a task for a wireless gateway.
# Arguments
- `id`: The ID of the resource to update.
- `wireless_gateway_task_definition_id`: The ID of the WirelessGatewayTaskDefinition.
"""
function create_wireless_gateway_task(
Id, WirelessGatewayTaskDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/wireless-gateways/$(Id)/tasks",
Dict{String,Any}(
"WirelessGatewayTaskDefinitionId" => WirelessGatewayTaskDefinitionId
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_wireless_gateway_task(
Id,
WirelessGatewayTaskDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/wireless-gateways/$(Id)/tasks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"WirelessGatewayTaskDefinitionId" => WirelessGatewayTaskDefinitionId
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_wireless_gateway_task_definition(auto_create_tasks)
create_wireless_gateway_task_definition(auto_create_tasks, params::Dict{String,<:Any})
Creates a gateway task definition.
# Arguments
- `auto_create_tasks`: Whether to automatically create tasks using this task definition for
all gateways with the specified current version. If false, the task must me created by
calling CreateWirelessGatewayTask.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`: Each resource must have a unique client request token. The client
token is used to implement idempotency. It ensures that the request completes no more than
one time. If you retry a request with the same token and the same parameters, the request
will complete successfully. However, if you try to create a new resource using the same
token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS
SDKs will automatically generate a unique client request. For more information about
idempotency, see Ensuring idempotency in Amazon EC2 API requests.
- `"Name"`: The name of the new resource.
- `"Tags"`: The tags to attach to the specified resource. Tags are metadata that you can
use to manage a resource.
- `"Update"`: Information about the gateways to update.
"""
function create_wireless_gateway_task_definition(
AutoCreateTasks; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/wireless-gateway-task-definitions",
Dict{String,Any}(
"AutoCreateTasks" => AutoCreateTasks, "ClientRequestToken" => string(uuid4())
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_wireless_gateway_task_definition(
AutoCreateTasks,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/wireless-gateway-task-definitions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AutoCreateTasks" => AutoCreateTasks,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_destination(name)
delete_destination(name, params::Dict{String,<:Any})
Deletes a destination.
# Arguments
- `name`: The name of the resource to delete.
"""
function delete_destination(Name; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"DELETE",
"/destinations/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_destination(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/destinations/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_device_profile(id)
delete_device_profile(id, params::Dict{String,<:Any})
Deletes a device profile.
# Arguments
- `id`: The ID of the resource to delete.
"""
function delete_device_profile(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"DELETE",
"/device-profiles/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_device_profile(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/device-profiles/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_fuota_task(id)
delete_fuota_task(id, params::Dict{String,<:Any})
Deletes a FUOTA task.
# Arguments
- `id`:
"""
function delete_fuota_task(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"DELETE",
"/fuota-tasks/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_fuota_task(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/fuota-tasks/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_multicast_group(id)
delete_multicast_group(id, params::Dict{String,<:Any})
Deletes a multicast group if it is not in use by a fuota task.
# Arguments
- `id`:
"""
function delete_multicast_group(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"DELETE",
"/multicast-groups/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_multicast_group(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/multicast-groups/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_network_analyzer_configuration(configuration_name)
delete_network_analyzer_configuration(configuration_name, params::Dict{String,<:Any})
Deletes a network analyzer configuration.
# Arguments
- `configuration_name`:
"""
function delete_network_analyzer_configuration(
ConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/network-analyzer-configurations/$(ConfigurationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_network_analyzer_configuration(
ConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"DELETE",
"/network-analyzer-configurations/$(ConfigurationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_queued_messages(id, message_id)
delete_queued_messages(id, message_id, params::Dict{String,<:Any})
Remove queued messages from the downlink queue.
# Arguments
- `id`: The ID of a given wireless device for which downlink messages will be deleted.
- `message_id`: If message ID is \"*\", it cleares the entire downlink queue for a given
device, specified by the wireless device ID. Otherwise, the downlink message with the
specified message ID will be deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"WirelessDeviceType"`: The wireless device type, which can be either Sidewalk or LoRaWAN.
"""
function delete_queued_messages(
Id, messageId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-devices/$(Id)/data",
Dict{String,Any}("messageId" => messageId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_queued_messages(
Id,
messageId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"DELETE",
"/wireless-devices/$(Id)/data",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("messageId" => messageId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_service_profile(id)
delete_service_profile(id, params::Dict{String,<:Any})
Deletes a service profile.
# Arguments
- `id`: The ID of the resource to delete.
"""
function delete_service_profile(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"DELETE",
"/service-profiles/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_service_profile(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/service-profiles/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_wireless_device(id)
delete_wireless_device(id, params::Dict{String,<:Any})
Deletes a wireless device.
# Arguments
- `id`: The ID of the resource to delete.
"""
function delete_wireless_device(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"DELETE",
"/wireless-devices/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_wireless_device(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-devices/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_wireless_device_import_task(id)
delete_wireless_device_import_task(id, params::Dict{String,<:Any})
Delete an import task.
# Arguments
- `id`: The unique identifier of the import task to be deleted.
"""
function delete_wireless_device_import_task(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless_device_import_task/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_wireless_device_import_task(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless_device_import_task/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_wireless_gateway(id)
delete_wireless_gateway(id, params::Dict{String,<:Any})
Deletes a wireless gateway. When deleting a wireless gateway, you might run into
duplication errors for the following reasons. If you specify a GatewayEui value that
already exists. If you used a ClientRequestToken with the same parameters within the last
10 minutes. To avoid this error, make sure that you use unique identifiers and parameters
for each request within the specified time period.
# Arguments
- `id`: The ID of the resource to delete.
"""
function delete_wireless_gateway(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"DELETE",
"/wireless-gateways/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_wireless_gateway(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-gateways/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_wireless_gateway_task(id)
delete_wireless_gateway_task(id, params::Dict{String,<:Any})
Deletes a wireless gateway task.
# Arguments
- `id`: The ID of the resource to delete.
"""
function delete_wireless_gateway_task(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"DELETE",
"/wireless-gateways/$(Id)/tasks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_wireless_gateway_task(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-gateways/$(Id)/tasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_wireless_gateway_task_definition(id)
delete_wireless_gateway_task_definition(id, params::Dict{String,<:Any})
Deletes a wireless gateway task definition. Deleting this task definition does not affect
tasks that are currently in progress.
# Arguments
- `id`: The ID of the resource to delete.
"""
function delete_wireless_gateway_task_definition(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-gateway-task-definitions/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_wireless_gateway_task_definition(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-gateway-task-definitions/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_wireless_device(identifier)
deregister_wireless_device(identifier, params::Dict{String,<:Any})
Deregister a wireless device from AWS IoT Wireless.
# Arguments
- `identifier`: The identifier of the wireless device to deregister from AWS IoT Wireless.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"WirelessDeviceType"`: The type of wireless device to deregister from AWS IoT Wireless,
which can be LoRaWAN or Sidewalk.
"""
function deregister_wireless_device(
Identifier; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/wireless-devices/$(Identifier)/deregister";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_wireless_device(
Identifier,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PATCH",
"/wireless-devices/$(Identifier)/deregister",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_aws_account_from_partner_account(partner_account_id, partner_type)
disassociate_aws_account_from_partner_account(partner_account_id, partner_type, params::Dict{String,<:Any})
Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType
are null, disassociates your AWS account from all partner accounts.
# Arguments
- `partner_account_id`: The partner account ID to disassociate from the AWS account.
- `partner_type`: The partner type.
"""
function disassociate_aws_account_from_partner_account(
PartnerAccountId, partnerType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/partner-accounts/$(PartnerAccountId)",
Dict{String,Any}("partnerType" => partnerType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_aws_account_from_partner_account(
PartnerAccountId,
partnerType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"DELETE",
"/partner-accounts/$(PartnerAccountId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("partnerType" => partnerType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_multicast_group_from_fuota_task(id, multicast_group_id)
disassociate_multicast_group_from_fuota_task(id, multicast_group_id, params::Dict{String,<:Any})
Disassociates a multicast group from a fuota task.
# Arguments
- `id`:
- `multicast_group_id`:
"""
function disassociate_multicast_group_from_fuota_task(
Id, MulticastGroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/fuota-tasks/$(Id)/multicast-groups/$(MulticastGroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_multicast_group_from_fuota_task(
Id,
MulticastGroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"DELETE",
"/fuota-tasks/$(Id)/multicast-groups/$(MulticastGroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_wireless_device_from_fuota_task(id, wireless_device_id)
disassociate_wireless_device_from_fuota_task(id, wireless_device_id, params::Dict{String,<:Any})
Disassociates a wireless device from a FUOTA task.
# Arguments
- `id`:
- `wireless_device_id`:
"""
function disassociate_wireless_device_from_fuota_task(
Id, WirelessDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/fuota-tasks/$(Id)/wireless-devices/$(WirelessDeviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_wireless_device_from_fuota_task(
Id,
WirelessDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"DELETE",
"/fuota-tasks/$(Id)/wireless-devices/$(WirelessDeviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_wireless_device_from_multicast_group(id, wireless_device_id)
disassociate_wireless_device_from_multicast_group(id, wireless_device_id, params::Dict{String,<:Any})
Disassociates a wireless device from a multicast group.
# Arguments
- `id`:
- `wireless_device_id`:
"""
function disassociate_wireless_device_from_multicast_group(
Id, WirelessDeviceId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/multicast-groups/$(Id)/wireless-devices/$(WirelessDeviceId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_wireless_device_from_multicast_group(
Id,
WirelessDeviceId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"DELETE",
"/multicast-groups/$(Id)/wireless-devices/$(WirelessDeviceId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_wireless_device_from_thing(id)
disassociate_wireless_device_from_thing(id, params::Dict{String,<:Any})
Disassociates a wireless device from its currently associated thing.
# Arguments
- `id`: The ID of the resource to update.
"""
function disassociate_wireless_device_from_thing(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-devices/$(Id)/thing";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_wireless_device_from_thing(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-devices/$(Id)/thing",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_wireless_gateway_from_certificate(id)
disassociate_wireless_gateway_from_certificate(id, params::Dict{String,<:Any})
Disassociates a wireless gateway from its currently associated certificate.
# Arguments
- `id`: The ID of the resource to update.
"""
function disassociate_wireless_gateway_from_certificate(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-gateways/$(Id)/certificate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_wireless_gateway_from_certificate(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-gateways/$(Id)/certificate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_wireless_gateway_from_thing(id)
disassociate_wireless_gateway_from_thing(id, params::Dict{String,<:Any})
Disassociates a wireless gateway from its currently associated thing.
# Arguments
- `id`: The ID of the resource to update.
"""
function disassociate_wireless_gateway_from_thing(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-gateways/$(Id)/thing";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_wireless_gateway_from_thing(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/wireless-gateways/$(Id)/thing",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_destination(name)
get_destination(name, params::Dict{String,<:Any})
Gets information about a destination.
# Arguments
- `name`: The name of the resource to get.
"""
function get_destination(Name; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET",
"/destinations/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_destination(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/destinations/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_device_profile(id)
get_device_profile(id, params::Dict{String,<:Any})
Gets information about a device profile.
# Arguments
- `id`: The ID of the resource to get.
"""
function get_device_profile(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET",
"/device-profiles/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_device_profile(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/device-profiles/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_event_configuration_by_resource_types()
get_event_configuration_by_resource_types(params::Dict{String,<:Any})
Get the event configuration based on resource types.
"""
function get_event_configuration_by_resource_types(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/event-configurations-resource-types";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_event_configuration_by_resource_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/event-configurations-resource-types",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_fuota_task(id)
get_fuota_task(id, params::Dict{String,<:Any})
Gets information about a FUOTA task.
# Arguments
- `id`:
"""
function get_fuota_task(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET", "/fuota-tasks/$(Id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_fuota_task(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/fuota-tasks/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_log_levels_by_resource_types()
get_log_levels_by_resource_types(params::Dict{String,<:Any})
Returns current default log levels or log levels by resource types. Based on resource
types, log levels can be for wireless device log options or wireless gateway log options.
"""
function get_log_levels_by_resource_types(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET", "/log-levels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_log_levels_by_resource_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET", "/log-levels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_metric_configuration()
get_metric_configuration(params::Dict{String,<:Any})
Get the metric configuration status for this AWS account.
"""
function get_metric_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET",
"/metric-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_metric_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/metric-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_metrics()
get_metrics(params::Dict{String,<:Any})
Get the summary metrics for this AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SummaryMetricQueries"`: The list of queries to retrieve the summary metrics.
"""
function get_metrics(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"POST", "/metrics"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_metrics(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST", "/metrics", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
get_multicast_group(id)
get_multicast_group(id, params::Dict{String,<:Any})
Gets information about a multicast group.
# Arguments
- `id`:
"""
function get_multicast_group(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET",
"/multicast-groups/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_multicast_group(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/multicast-groups/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_multicast_group_session(id)
get_multicast_group_session(id, params::Dict{String,<:Any})
Gets information about a multicast group session.
# Arguments
- `id`:
"""
function get_multicast_group_session(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET",
"/multicast-groups/$(Id)/session";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_multicast_group_session(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/multicast-groups/$(Id)/session",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_network_analyzer_configuration(configuration_name)
get_network_analyzer_configuration(configuration_name, params::Dict{String,<:Any})
Get network analyzer configuration.
# Arguments
- `configuration_name`:
"""
function get_network_analyzer_configuration(
ConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/network-analyzer-configurations/$(ConfigurationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_network_analyzer_configuration(
ConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"GET",
"/network-analyzer-configurations/$(ConfigurationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_partner_account(partner_account_id, partner_type)
get_partner_account(partner_account_id, partner_type, params::Dict{String,<:Any})
Gets information about a partner account. If PartnerAccountId and PartnerType are null,
returns all partner accounts.
# Arguments
- `partner_account_id`: The partner account ID to disassociate from the AWS account.
- `partner_type`: The partner type.
"""
function get_partner_account(
PartnerAccountId, partnerType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/partner-accounts/$(PartnerAccountId)",
Dict{String,Any}("partnerType" => partnerType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_partner_account(
PartnerAccountId,
partnerType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"GET",
"/partner-accounts/$(PartnerAccountId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("partnerType" => partnerType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_position(resource_identifier, resource_type)
get_position(resource_identifier, resource_type, params::Dict{String,<:Any})
Get the position information for a given resource. This action is no longer supported.
Calls to retrieve the position information should use the GetResourcePosition API operation
instead.
# Arguments
- `resource_identifier`: Resource identifier used to retrieve the position information.
- `resource_type`: Resource type of the resource for which position information is
retrieved.
"""
function get_position(
ResourceIdentifier, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/positions/$(ResourceIdentifier)",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_position(
ResourceIdentifier,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"GET",
"/positions/$(ResourceIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_position_configuration(resource_identifier, resource_type)
get_position_configuration(resource_identifier, resource_type, params::Dict{String,<:Any})
Get position configuration for a given resource. This action is no longer supported. Calls
to retrieve the position configuration should use the GetResourcePosition API operation
instead.
# Arguments
- `resource_identifier`: Resource identifier used in a position configuration.
- `resource_type`: Resource type of the resource for which position configuration is
retrieved.
"""
function get_position_configuration(
ResourceIdentifier, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/position-configurations/$(ResourceIdentifier)",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_position_configuration(
ResourceIdentifier,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"GET",
"/position-configurations/$(ResourceIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_position_estimate()
get_position_estimate(params::Dict{String,<:Any})
Get estimated position information as a payload in GeoJSON format. The payload measurement
data is resolved using solvers that are provided by third-party vendors.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"CellTowers"`: Retrieves an estimated device position by resolving measurement data from
cellular radio towers. The position is resolved using HERE's cellular-based solver.
- `"Gnss"`: Retrieves an estimated device position by resolving the global navigation
satellite system (GNSS) scan data. The position is resolved using the GNSS solver powered
by LoRa Cloud.
- `"Ip"`: Retrieves an estimated device position by resolving the IP address information
from the device. The position is resolved using MaxMind's IP-based solver.
- `"Timestamp"`: Optional information that specifies the time when the position information
will be resolved. It uses the Unix timestamp format. If not specified, the time at which
the request was received will be used.
- `"WiFiAccessPoints"`: Retrieves an estimated device position by resolving WLAN
measurement data. The position is resolved using HERE's Wi-Fi based solver.
"""
function get_position_estimate(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"POST", "/position-estimate"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_position_estimate(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/position-estimate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_event_configuration(identifier, identifier_type)
get_resource_event_configuration(identifier, identifier_type, params::Dict{String,<:Any})
Get the event configuration for a particular resource identifier.
# Arguments
- `identifier`: Resource identifier to opt in for event messaging.
- `identifier_type`: Identifier type of the particular resource identifier for event
configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"partnerType"`: Partner type of the resource if the identifier type is PartnerAccountId.
"""
function get_resource_event_configuration(
Identifier, identifierType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/event-configurations/$(Identifier)",
Dict{String,Any}("identifierType" => identifierType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_event_configuration(
Identifier,
identifierType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"GET",
"/event-configurations/$(Identifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifierType" => identifierType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_log_level(resource_identifier, resource_type)
get_resource_log_level(resource_identifier, resource_type, params::Dict{String,<:Any})
Fetches the log-level override, if any, for a given resource-ID and resource-type. It can
be used for a wireless device or a wireless gateway.
# Arguments
- `resource_identifier`:
- `resource_type`: The type of the resource, which can be WirelessDevice or WirelessGateway.
"""
function get_resource_log_level(
ResourceIdentifier, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/log-levels/$(ResourceIdentifier)",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_log_level(
ResourceIdentifier,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"GET",
"/log-levels/$(ResourceIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_resource_position(resource_identifier, resource_type)
get_resource_position(resource_identifier, resource_type, params::Dict{String,<:Any})
Get the position information for a given wireless device or a wireless gateway resource.
The position information uses the World Geodetic System (WGS84).
# Arguments
- `resource_identifier`: The identifier of the resource for which position information is
retrieved. It can be the wireless device ID or the wireless gateway ID, depending on the
resource type.
- `resource_type`: The type of resource for which position information is retrieved, which
can be a wireless device or a wireless gateway.
"""
function get_resource_position(
ResourceIdentifier, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/resource-positions/$(ResourceIdentifier)",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_resource_position(
ResourceIdentifier,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"GET",
"/resource-positions/$(ResourceIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_endpoint()
get_service_endpoint(params::Dict{String,<:Any})
Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or
LoRaWAN Network Server (LNS) connections.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"serviceType"`: The service type for which to get endpoint information about. Can be
CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network
Server endpoint or CLAIM for the global endpoint.
"""
function get_service_endpoint(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET", "/service-endpoint"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_service_endpoint(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/service-endpoint",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_service_profile(id)
get_service_profile(id, params::Dict{String,<:Any})
Gets information about a service profile.
# Arguments
- `id`: The ID of the resource to get.
"""
function get_service_profile(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET",
"/service-profiles/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_service_profile(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/service-profiles/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_wireless_device(identifier, identifier_type)
get_wireless_device(identifier, identifier_type, params::Dict{String,<:Any})
Gets information about a wireless device.
# Arguments
- `identifier`: The identifier of the wireless device to get.
- `identifier_type`: The type of identifier used in identifier.
"""
function get_wireless_device(
Identifier, identifierType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-devices/$(Identifier)",
Dict{String,Any}("identifierType" => identifierType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_wireless_device(
Identifier,
identifierType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"GET",
"/wireless-devices/$(Identifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifierType" => identifierType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_wireless_device_import_task(id)
get_wireless_device_import_task(id, params::Dict{String,<:Any})
Get information about an import task and count of device onboarding summary information for
the import task.
# Arguments
- `id`: The identifier of the import task for which information is requested.
"""
function get_wireless_device_import_task(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless_device_import_task/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_wireless_device_import_task(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless_device_import_task/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_wireless_device_statistics(id)
get_wireless_device_statistics(id, params::Dict{String,<:Any})
Gets operating information about a wireless device.
# Arguments
- `id`: The ID of the wireless device for which to get the data.
"""
function get_wireless_device_statistics(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-devices/$(Id)/statistics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_wireless_device_statistics(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-devices/$(Id)/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_wireless_gateway(identifier, identifier_type)
get_wireless_gateway(identifier, identifier_type, params::Dict{String,<:Any})
Gets information about a wireless gateway.
# Arguments
- `identifier`: The identifier of the wireless gateway to get.
- `identifier_type`: The type of identifier used in identifier.
"""
function get_wireless_gateway(
Identifier, identifierType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateways/$(Identifier)",
Dict{String,Any}("identifierType" => identifierType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_wireless_gateway(
Identifier,
identifierType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"GET",
"/wireless-gateways/$(Identifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifierType" => identifierType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_wireless_gateway_certificate(id)
get_wireless_gateway_certificate(id, params::Dict{String,<:Any})
Gets the ID of the certificate that is currently associated with a wireless gateway.
# Arguments
- `id`: The ID of the resource to get.
"""
function get_wireless_gateway_certificate(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateways/$(Id)/certificate";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_wireless_gateway_certificate(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateways/$(Id)/certificate",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_wireless_gateway_firmware_information(id)
get_wireless_gateway_firmware_information(id, params::Dict{String,<:Any})
Gets the firmware version and other information about a wireless gateway.
# Arguments
- `id`: The ID of the resource to get.
"""
function get_wireless_gateway_firmware_information(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateways/$(Id)/firmware-information";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_wireless_gateway_firmware_information(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateways/$(Id)/firmware-information",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_wireless_gateway_statistics(id)
get_wireless_gateway_statistics(id, params::Dict{String,<:Any})
Gets operating information about a wireless gateway.
# Arguments
- `id`: The ID of the wireless gateway for which to get the data.
"""
function get_wireless_gateway_statistics(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateways/$(Id)/statistics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_wireless_gateway_statistics(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateways/$(Id)/statistics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_wireless_gateway_task(id)
get_wireless_gateway_task(id, params::Dict{String,<:Any})
Gets information about a wireless gateway task.
# Arguments
- `id`: The ID of the resource to get.
"""
function get_wireless_gateway_task(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET",
"/wireless-gateways/$(Id)/tasks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_wireless_gateway_task(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateways/$(Id)/tasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_wireless_gateway_task_definition(id)
get_wireless_gateway_task_definition(id, params::Dict{String,<:Any})
Gets information about a wireless gateway task definition.
# Arguments
- `id`: The ID of the resource to get.
"""
function get_wireless_gateway_task_definition(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateway-task-definitions/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_wireless_gateway_task_definition(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateway-task-definitions/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_destinations()
list_destinations(params::Dict{String,<:Any})
Lists the destinations registered to your AWS 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 in this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_destinations(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET", "/destinations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_destinations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/destinations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_device_profiles()
list_device_profiles(params::Dict{String,<:Any})
Lists the device profiles registered to your AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"deviceProfileType"`: A filter to list only device profiles that use this type, which
can be LoRaWAN or Sidewalk.
- `"maxResults"`: The maximum number of results to return in this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_device_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET", "/device-profiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_device_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/device-profiles",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_devices_for_wireless_device_import_task(id)
list_devices_for_wireless_device_import_task(id, params::Dict{String,<:Any})
List the Sidewalk devices in an import task and their onboarding status.
# Arguments
- `id`: The identifier of the import task for which wireless devices are listed.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"status"`: The status of the devices in the import task.
"""
function list_devices_for_wireless_device_import_task(
id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless_device_import_task",
Dict{String,Any}("id" => id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_devices_for_wireless_device_import_task(
id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless_device_import_task",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("id" => id), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_event_configurations(resource_type)
list_event_configurations(resource_type, params::Dict{String,<:Any})
List event configurations where at least one event topic has been enabled.
# Arguments
- `resource_type`: Resource type to filter event configurations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_event_configurations(
resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/event-configurations",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_event_configurations(
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"GET",
"/event-configurations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_fuota_tasks()
list_fuota_tasks(params::Dict{String,<:Any})
Lists the FUOTA tasks registered to your AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_fuota_tasks(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET", "/fuota-tasks"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_fuota_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/fuota-tasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_multicast_groups()
list_multicast_groups(params::Dict{String,<:Any})
Lists the multicast groups registered to your AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_multicast_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET", "/multicast-groups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_multicast_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/multicast-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_multicast_groups_by_fuota_task(id)
list_multicast_groups_by_fuota_task(id, params::Dict{String,<:Any})
List all multicast groups associated with a fuota task.
# Arguments
- `id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_multicast_groups_by_fuota_task(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/fuota-tasks/$(Id)/multicast-groups";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_multicast_groups_by_fuota_task(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/fuota-tasks/$(Id)/multicast-groups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_network_analyzer_configurations()
list_network_analyzer_configurations(params::Dict{String,<:Any})
Lists the network analyzer configurations.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_network_analyzer_configurations(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/network-analyzer-configurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_network_analyzer_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/network-analyzer-configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_partner_accounts()
list_partner_accounts(params::Dict{String,<:Any})
Lists the partner accounts associated with your AWS 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 in this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_partner_accounts(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET", "/partner-accounts"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_partner_accounts(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/partner-accounts",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_position_configurations()
list_position_configurations(params::Dict{String,<:Any})
List position configurations for a given resource, such as positioning solvers. This
action is no longer supported. Calls to retrieve position information should use the
GetResourcePosition API operation instead.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"resourceType"`: Resource type for which position configurations are listed.
"""
function list_position_configurations(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET",
"/position-configurations";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_position_configurations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/position-configurations",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_queued_messages(id)
list_queued_messages(id, params::Dict{String,<:Any})
List queued messages in the downlink queue.
# Arguments
- `id`: The ID of a given wireless device which the downlink message packets are being sent.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"WirelessDeviceType"`: The wireless device type, whic can be either Sidewalk or LoRaWAN.
- `"maxResults"`: The maximum number of results to return in this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_queued_messages(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET",
"/wireless-devices/$(Id)/data";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_queued_messages(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-devices/$(Id)/data",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_service_profiles()
list_service_profiles(params::Dict{String,<:Any})
Lists the service profiles registered to your AWS 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 in this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_service_profiles(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET", "/service-profiles"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_service_profiles(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/service-profiles",
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 for which you want to list tags.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"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 iot_wireless(
"GET",
"/tags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_wireless_device_import_tasks()
list_wireless_device_import_tasks(params::Dict{String,<:Any})
List wireless devices that have been added to an import task.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`:
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_wireless_device_import_tasks(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless_device_import_tasks";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_wireless_device_import_tasks(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless_device_import_tasks",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_wireless_devices()
list_wireless_devices(params::Dict{String,<:Any})
Lists the wireless devices registered to your AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"destinationName"`: A filter to list only the wireless devices that use this destination.
- `"deviceProfileId"`: A filter to list only the wireless devices that use this device
profile.
- `"fuotaTaskId"`:
- `"maxResults"`: The maximum number of results to return in this operation.
- `"multicastGroupId"`:
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"serviceProfileId"`: A filter to list only the wireless devices that use this service
profile.
- `"wirelessDeviceType"`: A filter to list only the wireless devices that use this wireless
device type.
"""
function list_wireless_devices(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET", "/wireless-devices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_wireless_devices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-devices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_wireless_gateway_task_definitions()
list_wireless_gateway_task_definitions(params::Dict{String,<:Any})
List the wireless gateway tasks definitions registered to your AWS 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 in this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
- `"taskDefinitionType"`: A filter to list only the wireless gateway task definitions that
use this task definition type.
"""
function list_wireless_gateway_task_definitions(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateway-task-definitions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_wireless_gateway_task_definitions(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateway-task-definitions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_wireless_gateways()
list_wireless_gateways(params::Dict{String,<:Any})
Lists the wireless gateways registered to your AWS 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 in this operation.
- `"nextToken"`: To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
"""
function list_wireless_gateways(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"GET", "/wireless-gateways"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_wireless_gateways(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"GET",
"/wireless-gateways",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_position_configuration(resource_identifier, resource_type)
put_position_configuration(resource_identifier, resource_type, params::Dict{String,<:Any})
Put position configuration for a given resource. This action is no longer supported. Calls
to update the position configuration should use the UpdateResourcePosition API operation
instead.
# Arguments
- `resource_identifier`: Resource identifier used to update the position configuration.
- `resource_type`: Resource type of the resource for which you want to update the position
configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Destination"`: The position data destination that describes the AWS IoT rule that
processes the device's position data for use by AWS IoT Core for LoRaWAN.
- `"Solvers"`: The positioning solvers used to update the position configuration of the
resource.
"""
function put_position_configuration(
ResourceIdentifier, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PUT",
"/position-configurations/$(ResourceIdentifier)",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_position_configuration(
ResourceIdentifier,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PUT",
"/position-configurations/$(ResourceIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_resource_log_level(log_level, resource_identifier, resource_type)
put_resource_log_level(log_level, resource_identifier, resource_type, params::Dict{String,<:Any})
Sets the log-level override for a resource-ID and resource-type. This option can be
specified for a wireless gateway or a wireless device. A limit of 200 log level override
can be set per account.
# Arguments
- `log_level`:
- `resource_identifier`:
- `resource_type`: The type of the resource, which can be WirelessDevice or WirelessGateway.
"""
function put_resource_log_level(
LogLevel,
ResourceIdentifier,
resourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PUT",
"/log-levels/$(ResourceIdentifier)",
Dict{String,Any}("LogLevel" => LogLevel, "resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_resource_log_level(
LogLevel,
ResourceIdentifier,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PUT",
"/log-levels/$(ResourceIdentifier)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("LogLevel" => LogLevel, "resourceType" => resourceType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_all_resource_log_levels()
reset_all_resource_log_levels(params::Dict{String,<:Any})
Removes the log-level overrides for all resources; both wireless devices and wireless
gateways.
"""
function reset_all_resource_log_levels(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"DELETE", "/log-levels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function reset_all_resource_log_levels(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/log-levels",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reset_resource_log_level(resource_identifier, resource_type)
reset_resource_log_level(resource_identifier, resource_type, params::Dict{String,<:Any})
Removes the log-level override, if any, for a specific resource-ID and resource-type. It
can be used for a wireless device or a wireless gateway.
# Arguments
- `resource_identifier`:
- `resource_type`: The type of the resource, which can be WirelessDevice or WirelessGateway.
"""
function reset_resource_log_level(
ResourceIdentifier, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"DELETE",
"/log-levels/$(ResourceIdentifier)",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function reset_resource_log_level(
ResourceIdentifier,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"DELETE",
"/log-levels/$(ResourceIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_data_to_multicast_group(id, payload_data, wireless_metadata)
send_data_to_multicast_group(id, payload_data, wireless_metadata, params::Dict{String,<:Any})
Sends the specified data to a multicast group.
# Arguments
- `id`:
- `payload_data`:
- `wireless_metadata`:
"""
function send_data_to_multicast_group(
Id, PayloadData, WirelessMetadata; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/multicast-groups/$(Id)/data",
Dict{String,Any}(
"PayloadData" => PayloadData, "WirelessMetadata" => WirelessMetadata
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_data_to_multicast_group(
Id,
PayloadData,
WirelessMetadata,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/multicast-groups/$(Id)/data",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PayloadData" => PayloadData, "WirelessMetadata" => WirelessMetadata
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
send_data_to_wireless_device(id, payload_data, transmit_mode)
send_data_to_wireless_device(id, payload_data, transmit_mode, params::Dict{String,<:Any})
Sends a decrypted application data frame to a device.
# Arguments
- `id`: The ID of the wireless device to receive the data.
- `payload_data`:
- `transmit_mode`: The transmit mode to use to send data to the wireless device. Can be: 0
for UM (unacknowledge mode) or 1 for AM (acknowledge mode).
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"WirelessMetadata"`: Metadata about the message request.
"""
function send_data_to_wireless_device(
Id, PayloadData, TransmitMode; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/wireless-devices/$(Id)/data",
Dict{String,Any}("PayloadData" => PayloadData, "TransmitMode" => TransmitMode);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function send_data_to_wireless_device(
Id,
PayloadData,
TransmitMode,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/wireless-devices/$(Id)/data",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"PayloadData" => PayloadData, "TransmitMode" => TransmitMode
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_bulk_associate_wireless_device_with_multicast_group(id)
start_bulk_associate_wireless_device_with_multicast_group(id, params::Dict{String,<:Any})
Starts a bulk association of all qualifying wireless devices with a multicast group.
# Arguments
- `id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"QueryString"`:
- `"Tags"`:
"""
function start_bulk_associate_wireless_device_with_multicast_group(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/multicast-groups/$(Id)/bulk";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_bulk_associate_wireless_device_with_multicast_group(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/multicast-groups/$(Id)/bulk",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_bulk_disassociate_wireless_device_from_multicast_group(id)
start_bulk_disassociate_wireless_device_from_multicast_group(id, params::Dict{String,<:Any})
Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.
# Arguments
- `id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"QueryString"`:
- `"Tags"`:
"""
function start_bulk_disassociate_wireless_device_from_multicast_group(
Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/multicast-groups/$(Id)/bulk";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_bulk_disassociate_wireless_device_from_multicast_group(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/multicast-groups/$(Id)/bulk",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_fuota_task(id)
start_fuota_task(id, params::Dict{String,<:Any})
Starts a FUOTA task.
# Arguments
- `id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"LoRaWAN"`:
"""
function start_fuota_task(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"PUT", "/fuota-tasks/$(Id)"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function start_fuota_task(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PUT",
"/fuota-tasks/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_multicast_group_session(id, lo_ra_wan)
start_multicast_group_session(id, lo_ra_wan, params::Dict{String,<:Any})
Starts a multicast group session.
# Arguments
- `id`:
- `lo_ra_wan`:
"""
function start_multicast_group_session(
Id, LoRaWAN; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PUT",
"/multicast-groups/$(Id)/session",
Dict{String,Any}("LoRaWAN" => LoRaWAN);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_multicast_group_session(
Id,
LoRaWAN,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PUT",
"/multicast-groups/$(Id)/session",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("LoRaWAN" => LoRaWAN), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_single_wireless_device_import_task(destination_name, sidewalk)
start_single_wireless_device_import_task(destination_name, sidewalk, params::Dict{String,<:Any})
Start import task for a single wireless device.
# Arguments
- `destination_name`: The name of the Sidewalk destination that describes the IoT rule to
route messages from the device in the import task that will be onboarded to AWS IoT
Wireless.
- `sidewalk`: The Sidewalk-related parameters for importing a single wireless device.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"DeviceName"`: The name of the wireless device for which an import task is being started.
- `"Tags"`:
"""
function start_single_wireless_device_import_task(
DestinationName, Sidewalk; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/wireless_single_device_import_task",
Dict{String,Any}(
"DestinationName" => DestinationName,
"Sidewalk" => Sidewalk,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_single_wireless_device_import_task(
DestinationName,
Sidewalk,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/wireless_single_device_import_task",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationName" => DestinationName,
"Sidewalk" => Sidewalk,
"ClientRequestToken" => string(uuid4()),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_wireless_device_import_task(destination_name, sidewalk)
start_wireless_device_import_task(destination_name, sidewalk, params::Dict{String,<:Any})
Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.
# Arguments
- `destination_name`: The name of the Sidewalk destination that describes the IoT rule to
route messages from the devices in the import task that are onboarded to AWS IoT Wireless.
- `sidewalk`: The Sidewalk-related parameters for importing wireless devices that need to
be provisioned in bulk.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ClientRequestToken"`:
- `"Tags"`:
"""
function start_wireless_device_import_task(
DestinationName, Sidewalk; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/wireless_device_import_task",
Dict{String,Any}(
"DestinationName" => DestinationName,
"Sidewalk" => Sidewalk,
"ClientRequestToken" => string(uuid4()),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_wireless_device_import_task(
DestinationName,
Sidewalk,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"POST",
"/wireless_device_import_task",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DestinationName" => DestinationName,
"Sidewalk" => Sidewalk,
"ClientRequestToken" => 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 a tag to a resource.
# Arguments
- `tags`: Adds to or modifies the tags of the given resource. Tags are metadata that you
can use to manage a resource.
- `resource_arn`: The ARN of the resource to add tags to.
"""
function tag_resource(Tags, resourceArn; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"POST",
"/tags",
Dict{String,Any}("Tags" => Tags, "resourceArn" => resourceArn);
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 iot_wireless(
"POST",
"/tags",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Tags" => Tags, "resourceArn" => resourceArn),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
test_wireless_device(id)
test_wireless_device(id, params::Dict{String,<:Any})
Simulates a provisioned device by sending an uplink data payload of Hello.
# Arguments
- `id`: The ID of the wireless device to test.
"""
function test_wireless_device(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"POST",
"/wireless-devices/$(Id)/test";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function test_wireless_device(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/wireless-devices/$(Id)/test",
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 resource.
# Arguments
- `resource_arn`: The ARN of the resource to remove tags from.
- `tag_keys`: A list of the keys of the tags to remove from the resource.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"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 iot_wireless(
"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_destination(name)
update_destination(name, params::Dict{String,<:Any})
Updates properties of a destination.
# Arguments
- `name`: The new name of the resource.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A new description of the resource.
- `"Expression"`: The new rule name or topic rule to send messages to.
- `"ExpressionType"`: The type of value in Expression.
- `"RoleArn"`: The ARN of the IAM Role that authorizes the destination.
"""
function update_destination(Name; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"PATCH",
"/destinations/$(Name)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_destination(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/destinations/$(Name)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_event_configuration_by_resource_types()
update_event_configuration_by_resource_types(params::Dict{String,<:Any})
Update the event configuration based on resource types.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionStatus"`: Connection status resource type event configuration object for
enabling and disabling wireless gateway topic.
- `"DeviceRegistrationState"`: Device registration state resource type event configuration
object for enabling and disabling wireless gateway topic.
- `"Join"`: Join resource type event configuration object for enabling and disabling
wireless device topic.
- `"MessageDeliveryStatus"`: Message delivery status resource type event configuration
object for enabling and disabling wireless device topic.
- `"Proximity"`: Proximity resource type event configuration object for enabling and
disabling wireless gateway topic.
"""
function update_event_configuration_by_resource_types(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/event-configurations-resource-types";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_event_configuration_by_resource_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/event-configurations-resource-types",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_fuota_task(id)
update_fuota_task(id, params::Dict{String,<:Any})
Updates properties of a FUOTA task.
# Arguments
- `id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`:
- `"FirmwareUpdateImage"`:
- `"FirmwareUpdateRole"`:
- `"FragmentIntervalMS"`:
- `"FragmentSizeBytes"`:
- `"LoRaWAN"`:
- `"Name"`:
- `"RedundancyPercent"`:
"""
function update_fuota_task(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"PATCH",
"/fuota-tasks/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_fuota_task(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/fuota-tasks/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_log_levels_by_resource_types()
update_log_levels_by_resource_types(params::Dict{String,<:Any})
Set default log level, or log levels by resource types. This can be for wireless device log
options or wireless gateways log options and is used to control the log messages that'll be
displayed in CloudWatch.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultLogLevel"`:
- `"WirelessDeviceLogOptions"`:
- `"WirelessGatewayLogOptions"`:
"""
function update_log_levels_by_resource_types(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST", "/log-levels"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function update_log_levels_by_resource_types(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"POST",
"/log-levels",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_metric_configuration()
update_metric_configuration(params::Dict{String,<:Any})
Update the summary metric configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"SummaryMetric"`: The value to be used to set summary metric configuration.
"""
function update_metric_configuration(; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"PUT",
"/metric-configuration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_metric_configuration(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PUT",
"/metric-configuration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_multicast_group(id)
update_multicast_group(id, params::Dict{String,<:Any})
Updates properties of a multicast group session.
# Arguments
- `id`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`:
- `"LoRaWAN"`:
- `"Name"`:
"""
function update_multicast_group(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"PATCH",
"/multicast-groups/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_multicast_group(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/multicast-groups/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_network_analyzer_configuration(configuration_name)
update_network_analyzer_configuration(configuration_name, params::Dict{String,<:Any})
Update network analyzer configuration.
# Arguments
- `configuration_name`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`:
- `"MulticastGroupsToAdd"`: Multicast group resources to add to the network analyzer
configuration. Provide the MulticastGroupId of the resource to add in the input array.
- `"MulticastGroupsToRemove"`: Multicast group resources to remove from the network
analyzer configuration. Provide the MulticastGroupId of the resources to remove in the
input array.
- `"TraceContent"`:
- `"WirelessDevicesToAdd"`: Wireless device resources to add to the network analyzer
configuration. Provide the WirelessDeviceId of the resource to add in the input array.
- `"WirelessDevicesToRemove"`: Wireless device resources to remove from the network
analyzer configuration. Provide the WirelessDeviceId of the resources to remove in the
input array.
- `"WirelessGatewaysToAdd"`: Wireless gateway resources to add to the network analyzer
configuration. Provide the WirelessGatewayId of the resource to add in the input array.
- `"WirelessGatewaysToRemove"`: Wireless gateway resources to remove from the network
analyzer configuration. Provide the WirelessGatewayId of the resources to remove in the
input array.
"""
function update_network_analyzer_configuration(
ConfigurationName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/network-analyzer-configurations/$(ConfigurationName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_network_analyzer_configuration(
ConfigurationName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PATCH",
"/network-analyzer-configurations/$(ConfigurationName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_partner_account(partner_account_id, sidewalk, partner_type)
update_partner_account(partner_account_id, sidewalk, partner_type, params::Dict{String,<:Any})
Updates properties of a partner account.
# Arguments
- `partner_account_id`: The ID of the partner account to update.
- `sidewalk`: The Sidewalk account credentials.
- `partner_type`: The partner type.
"""
function update_partner_account(
PartnerAccountId,
Sidewalk,
partnerType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PATCH",
"/partner-accounts/$(PartnerAccountId)",
Dict{String,Any}("Sidewalk" => Sidewalk, "partnerType" => partnerType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_partner_account(
PartnerAccountId,
Sidewalk,
partnerType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PATCH",
"/partner-accounts/$(PartnerAccountId)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Sidewalk" => Sidewalk, "partnerType" => partnerType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_position(position, resource_identifier, resource_type)
update_position(position, resource_identifier, resource_type, params::Dict{String,<:Any})
Update the position information of a resource. This action is no longer supported. Calls
to update the position information should use the UpdateResourcePosition API operation
instead.
# Arguments
- `position`: The position information of the resource.
- `resource_identifier`: Resource identifier of the resource for which position is updated.
- `resource_type`: Resource type of the resource for which position is updated.
"""
function update_position(
Position,
ResourceIdentifier,
resourceType;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PATCH",
"/positions/$(ResourceIdentifier)",
Dict{String,Any}("Position" => Position, "resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_position(
Position,
ResourceIdentifier,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PATCH",
"/positions/$(ResourceIdentifier)",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("Position" => Position, "resourceType" => resourceType),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_event_configuration(identifier, identifier_type)
update_resource_event_configuration(identifier, identifier_type, params::Dict{String,<:Any})
Update the event configuration for a particular resource identifier.
# Arguments
- `identifier`: Resource identifier to opt in for event messaging.
- `identifier_type`: Identifier type of the particular resource identifier for event
configuration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectionStatus"`: Event configuration for the connection status event.
- `"DeviceRegistrationState"`: Event configuration for the device registration state event.
- `"Join"`: Event configuration for the join event.
- `"MessageDeliveryStatus"`: Event configuration for the message delivery status event.
- `"Proximity"`: Event configuration for the proximity event.
- `"partnerType"`: Partner type of the resource if the identifier type is PartnerAccountId
"""
function update_resource_event_configuration(
Identifier, identifierType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/event-configurations/$(Identifier)",
Dict{String,Any}("identifierType" => identifierType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_event_configuration(
Identifier,
identifierType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PATCH",
"/event-configurations/$(Identifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("identifierType" => identifierType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_resource_position(resource_identifier, resource_type)
update_resource_position(resource_identifier, resource_type, params::Dict{String,<:Any})
Update the position information of a given wireless device or a wireless gateway resource.
The position coordinates are based on the World Geodetic System (WGS84).
# Arguments
- `resource_identifier`: The identifier of the resource for which position information is
updated. It can be the wireless device ID or the wireless gateway ID, depending on the
resource type.
- `resource_type`: The type of resource for which position information is updated, which
can be a wireless device or a wireless gateway.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"GeoJsonPayload"`: The position information of the resource, displayed as a JSON
payload. The payload uses the GeoJSON format, which a format that's used to encode
geographic data structures. For more information, see GeoJSON.
"""
function update_resource_position(
ResourceIdentifier, resourceType; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/resource-positions/$(ResourceIdentifier)",
Dict{String,Any}("resourceType" => resourceType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_resource_position(
ResourceIdentifier,
resourceType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PATCH",
"/resource-positions/$(ResourceIdentifier)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceType" => resourceType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_wireless_device(id)
update_wireless_device(id, params::Dict{String,<:Any})
Updates properties of a wireless device.
# Arguments
- `id`: The ID of the resource to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A new description of the resource.
- `"DestinationName"`: The name of the new destination for the device.
- `"LoRaWAN"`: The updated wireless device's configuration.
- `"Name"`: The new name of the resource.
- `"Positioning"`: FPort values for the GNSS, stream, and ClockSync functions of the
positioning information.
"""
function update_wireless_device(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"PATCH",
"/wireless-devices/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_wireless_device(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/wireless-devices/$(Id)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_wireless_device_import_task(id, sidewalk)
update_wireless_device_import_task(id, sidewalk, params::Dict{String,<:Any})
Update an import task to add more devices to the task.
# Arguments
- `id`: The identifier of the import task to be updated.
- `sidewalk`: The Sidewalk-related parameters of the import task to be updated.
"""
function update_wireless_device_import_task(
Id, Sidewalk; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/wireless_device_import_task/$(Id)",
Dict{String,Any}("Sidewalk" => Sidewalk);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_wireless_device_import_task(
Id,
Sidewalk,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iot_wireless(
"PATCH",
"/wireless_device_import_task/$(Id)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("Sidewalk" => Sidewalk), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_wireless_gateway(id)
update_wireless_gateway(id, params::Dict{String,<:Any})
Updates properties of a wireless gateway.
# Arguments
- `id`: The ID of the resource to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Description"`: A new description of the resource.
- `"JoinEuiFilters"`:
- `"MaxEirp"`: The MaxEIRP value.
- `"Name"`: The new name of the resource.
- `"NetIdFilters"`:
"""
function update_wireless_gateway(Id; aws_config::AbstractAWSConfig=global_aws_config())
return iot_wireless(
"PATCH",
"/wireless-gateways/$(Id)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_wireless_gateway(
Id, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iot_wireless(
"PATCH",
"/wireless-gateways/$(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 | 43688 | # This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: iotanalytics
using AWS.Compat
using AWS.UUIDs
"""
batch_put_message(channel_name, messages)
batch_put_message(channel_name, messages, params::Dict{String,<:Any})
Sends messages to a channel.
# Arguments
- `channel_name`: The name of the channel where the messages are sent.
- `messages`: The list of messages to be sent. Each message has the format: {
\"messageId\": \"string\", \"payload\": \"string\"}. The field names of message payloads
(data) that you send to IoT Analytics: Must contain only alphanumeric characters and
undescores (_). No other special characters are allowed. Must begin with an alphabetic
character or single underscore (_). Cannot contain hyphens (-). In regular expression
terms: \"^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)\". Cannot be more than 255
characters. Are case insensitive. (Fields named foo and FOO in the same payload are
considered duplicates.) For example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid,
but {\"temp-01\": 29}, {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message
payloads.
"""
function batch_put_message(
channelName, messages; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"POST",
"/messages/batch",
Dict{String,Any}("channelName" => channelName, "messages" => messages);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_put_message(
channelName,
messages,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"POST",
"/messages/batch",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("channelName" => channelName, "messages" => messages),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_pipeline_reprocessing(pipeline_name, reprocessing_id)
cancel_pipeline_reprocessing(pipeline_name, reprocessing_id, params::Dict{String,<:Any})
Cancels the reprocessing of data through the pipeline.
# Arguments
- `pipeline_name`: The name of pipeline for which data reprocessing is canceled.
- `reprocessing_id`: The ID of the reprocessing task (returned by
StartPipelineReprocessing).
"""
function cancel_pipeline_reprocessing(
pipelineName, reprocessingId; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"DELETE",
"/pipelines/$(pipelineName)/reprocessing/$(reprocessingId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_pipeline_reprocessing(
pipelineName,
reprocessingId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"DELETE",
"/pipelines/$(pipelineName)/reprocessing/$(reprocessingId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_channel(channel_name)
create_channel(channel_name, params::Dict{String,<:Any})
Used to create a channel. A channel collects data from an MQTT topic and archives the raw,
unprocessed messages before publishing the data to a pipeline.
# Arguments
- `channel_name`: The name of the channel.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelStorage"`: Where channel data is stored. You can choose one of serviceManagedS3
or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't
change this storage option after the channel is created.
- `"retentionPeriod"`: How long, in days, message data is kept for the channel. When
customerManagedS3 storage is selected, this parameter is ignored.
- `"tags"`: Metadata which can be used to manage the channel.
"""
function create_channel(channelName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"POST",
"/channels",
Dict{String,Any}("channelName" => channelName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_channel(
channelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"POST",
"/channels",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("channelName" => channelName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset(actions, dataset_name)
create_dataset(actions, dataset_name, params::Dict{String,<:Any})
Used to create a dataset. A dataset stores data retrieved from a data store by applying a
queryAction (a SQL query) or a containerAction (executing a containerized application).
This operation creates the skeleton of a dataset. The dataset can be populated manually by
calling CreateDatasetContent or automatically according to a trigger you specify.
# Arguments
- `actions`: A list of actions that create the dataset contents.
- `dataset_name`: The name of the dataset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contentDeliveryRules"`: When dataset contents are created, they are delivered to
destinations specified here.
- `"lateDataRules"`: A list of data rules that send notifications to CloudWatch, when data
arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
- `"retentionPeriod"`: Optional. How long, in days, versions of dataset contents are kept
for the dataset. If not specified or set to null, versions of dataset contents are retained
for at most 90 days. The number of versions of dataset contents retained is determined by
the versioningConfiguration parameter. For more information, see Keeping Multiple Versions
of IoT Analytics datasets in the IoT Analytics User Guide.
- `"tags"`: Metadata which can be used to manage the dataset.
- `"triggers"`: A list of triggers. A trigger causes dataset contents to be populated at a
specified time interval or when another dataset's contents are created. The list of
triggers can be empty or contain up to five DataSetTrigger objects.
- `"versioningConfiguration"`: Optional. How many versions of dataset contents are kept. If
not specified or set to null, only the latest version plus the latest succeeded version (if
they are different) are kept for the time period specified by the retentionPeriod
parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in
the IoT Analytics User Guide.
"""
function create_dataset(
actions, datasetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"POST",
"/datasets",
Dict{String,Any}("actions" => actions, "datasetName" => datasetName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset(
actions,
datasetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"POST",
"/datasets",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("actions" => actions, "datasetName" => datasetName),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_dataset_content(dataset_name)
create_dataset_content(dataset_name, params::Dict{String,<:Any})
Creates the content of a dataset by applying a queryAction (a SQL query) or a
containerAction (executing a containerized application).
# Arguments
- `dataset_name`: The name of the dataset.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionId"`: The version ID of the dataset content. To specify versionId for a dataset
content, the dataset must use a DeltaTimer filter.
"""
function create_dataset_content(
datasetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"POST",
"/datasets/$(datasetName)/content";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_dataset_content(
datasetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"POST",
"/datasets/$(datasetName)/content",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_datastore(datastore_name)
create_datastore(datastore_name, params::Dict{String,<:Any})
Creates a data store, which is a repository for messages.
# Arguments
- `datastore_name`: The name of the data store.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datastorePartitions"`: Contains information about the partition dimensions in a data
store.
- `"datastoreStorage"`: Where data in a data store is stored.. You can choose
serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage
storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage
after your data store is created.
- `"fileFormatConfiguration"`: Contains the configuration information of file formats. IoT
Analytics data stores support JSON and Parquet. The default file format is JSON. You can
specify only one format. You can't change the file format after you create the data store.
- `"retentionPeriod"`: How long, in days, message data is kept for the data store. When
customerManagedS3 storage is selected, this parameter is ignored.
- `"tags"`: Metadata which can be used to manage the data store.
"""
function create_datastore(datastoreName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"POST",
"/datastores",
Dict{String,Any}("datastoreName" => datastoreName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_datastore(
datastoreName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"POST",
"/datastores",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("datastoreName" => datastoreName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_pipeline(pipeline_activities, pipeline_name)
create_pipeline(pipeline_activities, pipeline_name, params::Dict{String,<:Any})
Creates a pipeline. A pipeline consumes messages from a channel and allows you to process
the messages before storing them in a data store. You must specify both a channel and a
datastore activity and, optionally, as many as 23 additional activities in the
pipelineActivities array.
# Arguments
- `pipeline_activities`: A list of PipelineActivity objects. Activities perform
transformations on your messages, such as removing, renaming or adding message attributes;
filtering messages based on attribute values; invoking your Lambda unctions on messages for
advanced processing; or performing mathematical transformations to normalize device data.
The list can be 2-25 PipelineActivity objects and must contain both a channel and a
datastore activity. Each entry in the list must contain only one activity. For example:
pipelineActivities = [ { \"channel\": { ... } }, { \"lambda\": { ... } }, ... ]
- `pipeline_name`: The name of the pipeline.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"tags"`: Metadata which can be used to manage the pipeline.
"""
function create_pipeline(
pipelineActivities, pipelineName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"POST",
"/pipelines",
Dict{String,Any}(
"pipelineActivities" => pipelineActivities, "pipelineName" => pipelineName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_pipeline(
pipelineActivities,
pipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"POST",
"/pipelines",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"pipelineActivities" => pipelineActivities,
"pipelineName" => pipelineName,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_channel(channel_name)
delete_channel(channel_name, params::Dict{String,<:Any})
Deletes the specified channel.
# Arguments
- `channel_name`: The name of the channel to delete.
"""
function delete_channel(channelName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"DELETE",
"/channels/$(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 iotanalytics(
"DELETE",
"/channels/$(channelName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset(dataset_name)
delete_dataset(dataset_name, params::Dict{String,<:Any})
Deletes the specified dataset. You do not have to delete the content of the dataset before
you perform this operation.
# Arguments
- `dataset_name`: The name of the dataset to delete.
"""
function delete_dataset(datasetName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"DELETE",
"/datasets/$(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 iotanalytics(
"DELETE",
"/datasets/$(datasetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_dataset_content(dataset_name)
delete_dataset_content(dataset_name, params::Dict{String,<:Any})
Deletes the content of the specified dataset.
# Arguments
- `dataset_name`: The name of the dataset whose content is deleted.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionId"`: The version of the dataset whose content is deleted. You can also use the
strings \"LATEST\" or \"LATEST_SUCCEEDED\" to delete the latest or latest successfully
completed data set. If not specified, \"LATEST_SUCCEEDED\" is the default.
"""
function delete_dataset_content(
datasetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"DELETE",
"/datasets/$(datasetName)/content";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_dataset_content(
datasetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"DELETE",
"/datasets/$(datasetName)/content",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_datastore(datastore_name)
delete_datastore(datastore_name, params::Dict{String,<:Any})
Deletes the specified data store.
# Arguments
- `datastore_name`: The name of the data store to delete.
"""
function delete_datastore(datastoreName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"DELETE",
"/datastores/$(datastoreName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_datastore(
datastoreName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"DELETE",
"/datastores/$(datastoreName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_pipeline(pipeline_name)
delete_pipeline(pipeline_name, params::Dict{String,<:Any})
Deletes the specified pipeline.
# Arguments
- `pipeline_name`: The name of the pipeline to delete.
"""
function delete_pipeline(pipelineName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"DELETE",
"/pipelines/$(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 iotanalytics(
"DELETE",
"/pipelines/$(pipelineName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_channel(channel_name)
describe_channel(channel_name, params::Dict{String,<:Any})
Retrieves information about a channel.
# Arguments
- `channel_name`: The name of the channel whose information is retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeStatistics"`: If true, additional statistical information about the channel is
included in the response. This feature can't be used with a channel whose S3 storage is
customer-managed.
"""
function describe_channel(channelName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"GET",
"/channels/$(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 iotanalytics(
"GET",
"/channels/$(channelName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_dataset(dataset_name)
describe_dataset(dataset_name, params::Dict{String,<:Any})
Retrieves information about a dataset.
# Arguments
- `dataset_name`: The name of the dataset whose information is retrieved.
"""
function describe_dataset(datasetName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"GET",
"/datasets/$(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 iotanalytics(
"GET",
"/datasets/$(datasetName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_datastore(datastore_name)
describe_datastore(datastore_name, params::Dict{String,<:Any})
Retrieves information about a data store.
# Arguments
- `datastore_name`: The name of the data store
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeStatistics"`: If true, additional statistical information about the data store
is included in the response. This feature can't be used with a data store whose S3 storage
is customer-managed.
"""
function describe_datastore(
datastoreName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"GET",
"/datastores/$(datastoreName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_datastore(
datastoreName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"GET",
"/datastores/$(datastoreName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_logging_options()
describe_logging_options(params::Dict{String,<:Any})
Retrieves the current settings of the IoT Analytics logging options.
"""
function describe_logging_options(; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"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 iotanalytics(
"GET", "/logging", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
describe_pipeline(pipeline_name)
describe_pipeline(pipeline_name, params::Dict{String,<:Any})
Retrieves information about a pipeline.
# Arguments
- `pipeline_name`: The name of the pipeline whose information is retrieved.
"""
function describe_pipeline(pipelineName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"GET",
"/pipelines/$(pipelineName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_pipeline(
pipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"GET",
"/pipelines/$(pipelineName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_dataset_content(dataset_name)
get_dataset_content(dataset_name, params::Dict{String,<:Any})
Retrieves the contents of a dataset as presigned URIs.
# Arguments
- `dataset_name`: The name of the dataset whose contents are retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"versionId"`: The version of the dataset whose contents are retrieved. You can also use
the strings \"LATEST\" or \"LATEST_SUCCEEDED\" to retrieve the contents of the latest or
latest successfully completed dataset. If not specified, \"LATEST_SUCCEEDED\" is the
default.
"""
function get_dataset_content(datasetName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"GET",
"/datasets/$(datasetName)/content";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_dataset_content(
datasetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"GET",
"/datasets/$(datasetName)/content",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_channels()
list_channels(params::Dict{String,<:Any})
Retrieves a list of channels.
# 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 this request. The default
value is 100.
- `"nextToken"`: The token for the next set of results.
"""
function list_channels(; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"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 iotanalytics(
"GET", "/channels", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_dataset_contents(dataset_name)
list_dataset_contents(dataset_name, params::Dict{String,<:Any})
Lists information about dataset contents that have been created.
# Arguments
- `dataset_name`: The name of the dataset whose contents information 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 in this request.
- `"nextToken"`: The token for the next set of results.
- `"scheduledBefore"`: A filter to limit results to those dataset contents whose creation
is scheduled before the given time. See the field triggers.schedule in the CreateDataset
request. (timestamp)
- `"scheduledOnOrAfter"`: A filter to limit results to those dataset contents whose
creation is scheduled on or after the given time. See the field triggers.schedule in the
CreateDataset request. (timestamp)
"""
function list_dataset_contents(
datasetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"GET",
"/datasets/$(datasetName)/contents";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_dataset_contents(
datasetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"GET",
"/datasets/$(datasetName)/contents",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_datasets()
list_datasets(params::Dict{String,<:Any})
Retrieves information about datasets.
# 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 this request. The default
value is 100.
- `"nextToken"`: The token for the next set of results.
"""
function list_datasets(; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"GET", "/datasets"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_datasets(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"GET", "/datasets", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_datastores()
list_datastores(params::Dict{String,<:Any})
Retrieves a list of data stores.
# 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 this request. The default
value is 100.
- `"nextToken"`: The token for the next set of results.
"""
function list_datastores(; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"GET", "/datastores"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_datastores(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"GET", "/datastores", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_pipelines()
list_pipelines(params::Dict{String,<:Any})
Retrieves a list of pipelines.
# 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 this request. The default
value is 100.
- `"nextToken"`: The token for the next set of results.
"""
function list_pipelines(; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"GET", "/pipelines"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_pipelines(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"GET", "/pipelines", 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) that you have assigned to the resource.
# Arguments
- `resource_arn`: The ARN of the resource whose tags you want to list.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"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 iotanalytics(
"GET",
"/tags",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("resourceArn" => resourceArn), 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 or updates the IoT Analytics logging options. If you update the value of any
loggingOptions field, it takes up to one minute for the change to take effect. Also, if you
change the policy attached to the role you specified in the roleArn field (for example, to
correct an invalid policy), it takes up to five minutes for that change to take effect.
# Arguments
- `logging_options`: The new values of the IoT Analytics logging options.
"""
function put_logging_options(
loggingOptions; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"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 iotanalytics(
"PUT",
"/logging",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("loggingOptions" => loggingOptions), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
run_pipeline_activity(payloads, pipeline_activity)
run_pipeline_activity(payloads, pipeline_activity, params::Dict{String,<:Any})
Simulates the results of running a pipeline activity on a message payload.
# Arguments
- `payloads`: The sample message payloads on which the pipeline activity is run.
- `pipeline_activity`: The pipeline activity that is run. This must not be a channel
activity or a data store activity because these activities are used in a pipeline only to
load the original message and to store the (possibly) transformed message. If a Lambda
activity is specified, only short-running Lambda functions (those with a timeout of less
than 30 seconds or less) can be used.
"""
function run_pipeline_activity(
payloads, pipelineActivity; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"POST",
"/pipelineactivities/run",
Dict{String,Any}("payloads" => payloads, "pipelineActivity" => pipelineActivity);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function run_pipeline_activity(
payloads,
pipelineActivity,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"POST",
"/pipelineactivities/run",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"payloads" => payloads, "pipelineActivity" => pipelineActivity
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
sample_channel_data(channel_name)
sample_channel_data(channel_name, params::Dict{String,<:Any})
Retrieves a sample of messages from the specified channel ingested during the specified
timeframe. Up to 10 messages can be retrieved.
# Arguments
- `channel_name`: The name of the channel whose message samples are retrieved.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endTime"`: The end of the time window from which sample messages are retrieved.
- `"maxMessages"`: The number of sample messages to be retrieved. The limit is 10. The
default is also 10.
- `"startTime"`: The start of the time window from which sample messages are retrieved.
"""
function sample_channel_data(channelName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"GET",
"/channels/$(channelName)/sample";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function sample_channel_data(
channelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"GET",
"/channels/$(channelName)/sample",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
start_pipeline_reprocessing(pipeline_name)
start_pipeline_reprocessing(pipeline_name, params::Dict{String,<:Any})
Starts the reprocessing of raw message data through the pipeline.
# Arguments
- `pipeline_name`: The name of the pipeline on which to start reprocessing.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelMessages"`: Specifies one or more sets of channel messages that you want to
reprocess. If you use the channelMessages object, you must not specify a value for
startTime and endTime.
- `"endTime"`: The end time (exclusive) of raw message data that is reprocessed. If you
specify a value for the endTime parameter, you must not use the channelMessages object.
- `"startTime"`: The start time (inclusive) of raw message data that is reprocessed. If you
specify a value for the startTime parameter, you must not use the channelMessages object.
"""
function start_pipeline_reprocessing(
pipelineName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"POST",
"/pipelines/$(pipelineName)/reprocessing";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function start_pipeline_reprocessing(
pipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"POST",
"/pipelines/$(pipelineName)/reprocessing",
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 that can be used to
manage a resource.
# Arguments
- `resource_arn`: The ARN of the resource whose tags you want to modify.
- `tags`: The new or modified tags for the resource.
"""
function tag_resource(resourceArn, tags; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"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 iotanalytics(
"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 the given tags (metadata) from the resource.
# Arguments
- `resource_arn`: The ARN of the resource whose tags you want to remove.
- `tag_keys`: The keys of those tags which you want to remove.
"""
function untag_resource(
resourceArn, tagKeys; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"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 iotanalytics(
"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_channel(channel_name)
update_channel(channel_name, params::Dict{String,<:Any})
Used to update the settings of a channel.
# Arguments
- `channel_name`: The name of the channel to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"channelStorage"`: Where channel data is stored. You can choose one of serviceManagedS3
or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't
change this storage option after the channel is created.
- `"retentionPeriod"`: How long, in days, message data is kept for the channel. The
retention period can't be updated if the channel's Amazon S3 storage is customer-managed.
"""
function update_channel(channelName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"PUT",
"/channels/$(channelName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_channel(
channelName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"PUT",
"/channels/$(channelName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_dataset(actions, dataset_name)
update_dataset(actions, dataset_name, params::Dict{String,<:Any})
Updates the settings of a dataset.
# Arguments
- `actions`: A list of DatasetAction objects.
- `dataset_name`: The name of the dataset to update.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"contentDeliveryRules"`: When dataset contents are created, they are delivered to
destinations specified here.
- `"lateDataRules"`: A list of data rules that send notifications to CloudWatch, when data
arrives late. To specify lateDataRules, the dataset must use a DeltaTimer filter.
- `"retentionPeriod"`: How long, in days, dataset contents are kept for the dataset.
- `"triggers"`: A list of DatasetTrigger objects. The list can be empty or can contain up
to five DatasetTrigger objects.
- `"versioningConfiguration"`: Optional. How many versions of dataset contents are kept. If
not specified or set to null, only the latest version plus the latest succeeded version (if
they are different) are kept for the time period specified by the retentionPeriod
parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in
the IoT Analytics User Guide.
"""
function update_dataset(
actions, datasetName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"PUT",
"/datasets/$(datasetName)",
Dict{String,Any}("actions" => actions);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_dataset(
actions,
datasetName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"PUT",
"/datasets/$(datasetName)",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("actions" => actions), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_datastore(datastore_name)
update_datastore(datastore_name, params::Dict{String,<:Any})
Used to update the settings of a data store.
# Arguments
- `datastore_name`: The name of the data store to be updated.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"datastoreStorage"`: Where data in a data store is stored.. You can choose
serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage
storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage
after your data store is created.
- `"fileFormatConfiguration"`: Contains the configuration information of file formats. IoT
Analytics data stores support JSON and Parquet. The default file format is JSON. You can
specify only one format. You can't change the file format after you create the data store.
- `"retentionPeriod"`: How long, in days, message data is kept for the data store. The
retention period can't be updated if the data store's Amazon S3 storage is customer-managed.
"""
function update_datastore(datastoreName; aws_config::AbstractAWSConfig=global_aws_config())
return iotanalytics(
"PUT",
"/datastores/$(datastoreName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_datastore(
datastoreName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"PUT",
"/datastores/$(datastoreName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
update_pipeline(pipeline_activities, pipeline_name)
update_pipeline(pipeline_activities, pipeline_name, params::Dict{String,<:Any})
Updates the settings of a pipeline. You must specify both a channel and a datastore
activity and, optionally, as many as 23 additional activities in the pipelineActivities
array.
# Arguments
- `pipeline_activities`: A list of PipelineActivity objects. Activities perform
transformations on your messages, such as removing, renaming or adding message attributes;
filtering messages based on attribute values; invoking your Lambda functions on messages
for advanced processing; or performing mathematical transformations to normalize device
data. The list can be 2-25 PipelineActivity objects and must contain both a channel and a
datastore activity. Each entry in the list must contain only one activity. For example:
pipelineActivities = [ { \"channel\": { ... } }, { \"lambda\": { ... } }, ... ]
- `pipeline_name`: The name of the pipeline to update.
"""
function update_pipeline(
pipelineActivities, pipelineName; aws_config::AbstractAWSConfig=global_aws_config()
)
return iotanalytics(
"PUT",
"/pipelines/$(pipelineName)",
Dict{String,Any}("pipelineActivities" => pipelineActivities);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function update_pipeline(
pipelineActivities,
pipelineName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return iotanalytics(
"PUT",
"/pipelines/$(pipelineName)",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("pipelineActivities" => pipelineActivities), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
| AWS | https://github.com/JuliaCloud/AWS.jl.git |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.